Perkswall
AdsPostX is now MomentScience! 🎉
We have rebranded AdsPostX to MomentScience. All the latest documentation and updates can now be found at MomentScience Documentation.
Perkswall by AdsPostX allows publishers to display several Offers/Perks at once to their users in a branded experience. These may optionally include LoyaltyBoost Offers as well (LoyaltyBoost Offers reward users with points or other virtual currency for engaging with Offers). To enable Perkswall features, please contact your account manager.
A Perkswall experience can be implemented in two ways: 1. Direct (Webview/IFRAME) - The Perkswall experience is mobile-responsive and can be activated simply by linking out to a standalone URL or embedded directly into an existing web page or webview (for mobile apps).
2. API - Alternatively, the publishers can ingest AdsPostX Offers/Perks via an API call that will to supplement their own roster of offerings or to have complete control on how to present AdsPostX Offers/Perks to their users. Learn more about the Perkswall API
Click the link below to experience a basic implementation of the AdsPostX Perkswall.
The link for the example above is as follows:
Pass your SDK ID into the accountId parameter in the URL.
By default, AdsPostX returns all Offers available to the Perkswall and progressively loads as the user scrolls.
The example above is for demonstration purposes and is in it's most basic form. To optimize the experience for your users and generate higher revenue yield, read on for information on how to customize the Perkswall experience.
Make life easier! Discover how to personalize your Perkswall with our easy-to-use Perkswall Integration Page
When constructing the Perkswall URL, there are a number of configuration options that can be passed into the URL itself.
For example, you can limit the initial number of Offers returned by passing offer_count=number_of_offers in the URL of the Perkswall.
If you would like to have users manually load more Offers, you can also pass auto_show=false in the URL as well.
In the example below, we are initially displaying 9 offers and the user must press Show more to load more Offers progressively.
A full list of parameters that can be passed into the Perkswall URL is available below. All fields apart from accountId are optional.
Parameter | Description |
|---|---|
accountId | Your accountId/SDK ID |
adpx_fp | A unique identifier of the user |
offer_count | Number of Offers to display by default |
auto_show | Options: true|false Default: true Display more Offers as user scrolls; if set to false, display "Show more" button |
show_logo | Options: true|false Default: true Display logo in header of Perkswall; Logo can be set in Configuration in the AdsPostX Publisher Dashboard. |
logo_width | Logo width in pixels (numeric value) Default: auto No effect if only logo_width is specified. |
logo_height | Logo height in pixels (numeric value) Default: 100 If only logo_height is provided the aspect ratio will be preserved. |
show_header | Options: true|false Default: true Display text in the header of Perkswall. |
template_background | Background color of individual Offer tiles (in hex code) |
show_image | Options: true|false Default: true Display an Offer's creative on the Perkswall. |
btn_background | Button color in Offer tile (in hex code) |
btn_text_color | Button text color in Offer tile (in hex code) |
btn_hover_color | Button color (when hovered over) in Offer tile (in hex code) |
btn_stroke_color | Button border color in Offer tile (in hex code) |
btn_radius | Button radius in pixels (numeric value) |
background | Background color of the Perkswall (in hex code) |
tile_radius | Offer tile radius in pixels (numeric value) |
tile_hover_background | Offer tile background color (when hovered over) (in hex code) |
border_thickness | Offer tile border thickness in pixels (numeric value) |
border_color | Offer tile border color (in hex code) |
While all of the parameters above are optional with the exception of accountId, we highly recommend passing a value for adpx_fp. The adpx_fp parameter is a unique identifier for the user. It can be passed in any format and be anonymized/hashed. The adpx_fp parameter allows AdsPostX to optimize the Perkswall for a user both by surfacing relevant Offers based on past interactions as well as excluding Offers that have already been engaged with.
Below is an example using parameters as described above.
To embed the AdsPostX Perkswall into an existing web page, simply insert an IFRAME tag with the src attribute set to the Perkswall URL.
Because the Perkswall is being loaded into an IFRAME, we disabled the logo from showing using show_logo=false. We also are hiding the header text with show_header=false. Depending on your implementation you may decide to leave these visible.
Apart from the standard configuration parameters that can be passed into the Perkswall URL, AdsPostX also supports the passing of payload parameters that are helpful in two ways.
- Reporting
- Targeting
For example, if you're interested in knowing how the Perkswall performed based on being referred to from an e-mail campaign versus a mobile push notification, you may pass a new parameter into the Perkswall URL called refsource and then set to push or email.
The Perkswall URL would then look like the following:
Note the added parameter at the end of the Perkswall URL &refsource=push.
Any number of parameters can be passed into the Perkswall URL and then be referenced later in reporting.
AdsPostX supports advanced targeting using ad-hoc payload parameters that are passed into the Perkswall URL to maximize revenue yield. Pass any key-value pairs as parameters into the Perkswall URL and AdsPostX will attempt to match Offers based on the payload information provided.
For example, you may pass the zip code into the Perkswall URL such that AdsPostX will display Offers that target users in the specific zip code.
Note the added parameter at the end of the Perkswall URL &zipcode=78099
Any number of parameters can be passed into the Perkswall URL such that they are available for AdsPostX to target against.
Publishers can retrieve Perkswall Offers fragments via the Perkswall API and use those fragments to construct Offers to populate into their own Perkswall experience.
Please refer to the documentation on the Perkswall API