Permission: Campaign entities

  Note: The following requirements are needed to serve consent paywall banners:

  • Subscription/Payment solution
  • Login support
  • Support of deeplinks
  • PUR Model Feature Enabled on the account (please contact your dedicated Account Manager to enable this feature)
  • Custom Choice Enabled on the account (please contact your dedicated Account Manager to enable this feature)
For app developers the Sourcepoint SDK versions (iOS 6.5.0 or Android 6.4.0) is required.

A consent paywall is a type of consent message where the user is given the choice to accept or reject consent to the use of personal data directly from the first layer in exchange for the purchase of a subscription on the publisher’s site. A consent paywall message is composed of the following:

  • IAB legal text
  • The option to opt in
  • Space to describe the alternative to consent
  • Login option for subscribed users (Optional)
  • The option to opt out and buy a subscription

This documentation will assist you in setting up a consent paywall with Sourcepoint CMP

Flow process

The implementation of the subscription flow process will differ according to the needs of the publisher however a typical model is shown here. Your organization should cater for the events where:


An end-user is already subscribed and/or their consent profile exists

In such an event a CMP message will not be shown and the end-user proceeds directly to the website's content. The process ends.

The CMP message will show if no consent profile exists, where the end-user visits for the first time, or the end-user in a non-subscriber. The logic in the Scenario builder is described here.

An end-user opts-in to show advertising

The CMP message is displayed because the end-user visits for the first time or has not subscribed. When the end-user gives consent to tracking & accepts advertising the usual CMP process is followed; a consent profile is created and saved and the end-user proceeds to the website or app content. The process ends.

An end-user logs into their account

If the end-user is already a subscriber they can either log in through a button on the CMP message (optional) or through the publisher homepage or through the app. Either way the end-user will be redirected to the page to enter their credentials. The process ends.

An end-user opts-out of advertising

If an end-user opts-out of advertising they are given options to subscribe to your organization's content usually through some payment plan or trial period. This process is handled by your organization. A button on the CMP message can redirect the end-user to your organization's subscription page. On completion of subscription the process ends.

If the subscription is cancelled at any point the end-user is redirected to your organization's website or app where the the CMP message is shown again.

Message builder - web implementation

End-users can choose to opt-out of advertising and subscribe to your service or log into their account. An end-user will therefore need to be redirected from the CMP message to the relevant page on your site depending on their choice.

The redirect from the CMP message to the page can set in the message builder, as shown in the following example. A 'Subscribe' button on the CMP message can be set to redirect by setting the choice option to 'Redirect'. Enter the url for your organization's subscription page.


An optional 'Login' button can be set to allow an end-user to access their account from the CMP message. This is set the same way as the 'Subscribe' button where the specific page for login should to be entered. If an end-user decides to cancel the subscription (or login) procedure your organization should provide a button to redirect back to the homepage of your site. The CMP message should automatically be shown again.

Message builder - app implementation

End-users who choose to opt-out of advertising and subscribe to your service or log into their account should be redirected from the CMP message to the relevant page on your site. In the CMP message builder for an app campaign, set the choice option for the Subscribe button to 'Custom Action' and assign a value for the custom action value.


The custom action value will be returned by the SDK when the user interacts with the Subscribe button, using the SDK delegate method called onAction. The onAction method gets called each time a user clicks a button in the app CMP message and returns, among other values, the customActionId. This is the custom action value linked to the Subscribe button.

This information allows the publisher to listen to the right signals before using a deep link to redirect the user to the subscription page.

When the onAction method is called, read the string in the customActionId and redirect to your subscription page when the customActionId is equal to the value set in the message builder. More information can be found from our app CMP implementation Github page.

Scenario Builder

Your organization should test whether the end-user is a subscriber or is logged in. Your organization will need to communicate this status to Sourcepoint's CMP to prevent messages appearing for your customers that are subscribed or logged in.

This can be done using key-value pair targeting. In the scenario builder you specify a variable (the key) and a value that will show the CMP message if the condition is met. In this example the key is called subscribed and its value must match false for the message to show.


In the CMP stub code you include the key described in the scenario builder and a default value in a targetingParams object, shown in the following examples for web and iOS.

Web example iOS example
window._sp_queue = [];
   window._sp_ = {
   config: {
      accountId: 1732,
      propertyHref: '',
      baseEndpoint: '',
      usnat: {  },
      gdpr: { includeTcfApi: true },
         subscribed: false          
      events: {
         onMessageReady: function () {
            console.log('[event] onMessageReady', arguments);            
         onMessageChoiceSelect: function () {
            console.log('[event] onMessageChoiceSelect', arguments);

For subscribers

Your organization needs to identify visitors who are subscribers and update the key subscribed to value true when a subscribed end-user visits your website or uses your app. In this example the value true ends the CMP process and the CMP message is not shown.

For non-subscribed visitors

Your organization should set the key subscribed to value false for new or unsubscribed end-users visiting your website or using your app.

For visitors who are not subscribers and accept ads, the flow process would be the same for a typical end-user. The end-user would click 'Accept' on the CMP first layer message and proceed to the website or app.

On their next visit the end-user would not see the CMP message because the scenario logic specifies the message is shown for end-users who have not acted on the CMP message and who have not subscribed. If an end-user has previously acted on the CMP message or is a subscriber the condition is not met, the message will not be shown.

Was this article helpful?
2 out of 2 found this helpful



Article is closed for comments.