These instructions only apply to publishers enrolled in the Offerwall custom choice closed beta program. Contact your account manager to learn more.
Adding a custom choice allows you to implement your own monetization solution as an additional user choice on Offerwall messages. For example, you can let site visitors sign in and purchase your existing site subscription.
What you should know
Before you add a custom choice to your Offerwall, you should be aware of the following:
- You will need to write and deploy your own JavaScript in order to use this choice. Enabling custom choice without a correct implementation will result in Offerwall not displaying to end users.
- You can preview the location and text of the custom user choice in the message builder in Privacy & messaging. However, you won’t be able to preview the custom choice screen behavior. This choice will look and behave as configured with your custom JavaScript.
- You can only add one custom user choice to an Offerwall.
- You can test your custom JavaScript implementation against a subset of your site’s paths by utilizing the page inclusions and exclusions settings when you create an Offerwall.
Implement a custom choice
Complete the following steps to implement a custom choice in an Offerwall message:
- Define and register your monetization solution as a choice in your Offerwall. Complete the following steps in the HTML code of the site where you plan to display the Offerwall:
You must implement the Monetization Provider API (including all mandatory components) before you turn on the "Custom choice" toggle in the next step, otherwise your Offerwall will not appear.
- Follow the steps in the Monetization Provider API to both define and register your monetization solution as a choice in the Offerwall.
- Place your custom JavaScript between the
<head>and</head>tags in your site’s HTML code before other tags, such as ad tags or the Funding Choices tag.
- Set up the "Custom choice" option. When you create or edit an Offerwall in the message builder, click Set up to add a custom choice to your Offerwall. This will allow the Offerwall to recognize the custom monetization implementation on your site.
- Check the checkbox to confirm that you have implemented the Monetization Provider API, including all mandatory components.
- Enter a title for the custom choice. This text will be displayed as an option on your Offerwall.
- Enter a subtitle for the custom choice. The subtitle will be displayed below the title on your Offerwall and should provide additional descriptive context for the custom choice.
- Click Next to add the custom choice to your Offerwall.
- (Optional) Configure the custom choice text for multiple languages. If your Offerwall will be available in more than one language, add translations of the custom choice title and subtitle for each language in which it will be displayed. This text must be updated for each language before the Offerwall can be published.
To add additional languages to your Offerwall message, open the message builder, click Setup in the sidebar, and select languages from the "Additional languages" dropdown list. Selected languages will be added to the language preview dropdown list located in the message builder header.
- To configure your custom choice for multiple languages, edit your Offerwall in the message builder, select a language from the language preview dropdown list, and complete the following steps:
- Edit the subtitle of the custom user choice and enter the translated text. The default label is "Custom text," displayed in the selected language.
- (Optional) Edit the Already supporting us? and Sign in footer text, as needed. The intention of this footer is to provide a sign-in link for users who have already met your custom user choice’s requirements (for example, they already have an account and active subscription with your site).
This footer will always appear in the message preview when a custom choice has been added to your Offerwall. However, it will only be visible to your site visitors if your custom JavaScript supports the optional monetization portal type
PORTAL_SIGN_IN, as described in the Monetization Provider API.
