Sortable-Hosted CMP Integration Guide

This page describes how to integrate Sortable's Hosted CMP on a site.

1. Set up Google Demand

Sortable Enterprise Customers Only

Note: This step only applies to Sortable Enterprise customers (e.g. customers who integrated Sortable using their own DFP account).

Follow Google's recommendations to prepare your DFP. Make note of the technology providers you select for later.

Update Google Tags

If you choose to have Sortable manage Google consent, the hosted CMP prompts the user, and depending on the consent given, Sortable will either:

  • Call googletag.pubads().setRequestNonPersonalizedAds(1) to serve non-personalized ads, or
  • Disable ad serving. There is no additional integration required by the publisher.

If you choose to manage Google consent yourself, follow Google's guide on how to configure your Google tags.

2. Configure the CMP

In order to configure the hosted CMP, Sortable needs the following:

  • IAB Vendor IDs you would like to enable. Sortable automatically includes the IDs of any partners we load from our container. However, if you have other partners that collect data on your site and they are registered on the vendor list, you can include them in the UI. One example is comScore, ID 77.
  • Custom publisher purposes you want to display. If you have partners that collect data on your site that are not listed on the IAB Vendor list, you can choose to create a custom purpose for these partners.
  • The list of Google technology providers from step 1 (Set up Google Demand). This only applies for Sortable Enterprise customers that choose to have Sortable manager Google consent.

    You can download this list from DFP by visiting the EU user consent admin page (under Admin > EU user consent). You have the option to configure and download a CSV.

3. Link to the Consent Tool

Once the CMP is configured, it is automatically injected on any page where the Sortable ad script is loaded, for users in the EEA.

GDPR requires websites to provide a way for a user to review and revoke consent after the initial pop-up. Therefore, publishers may need to provide a link/button to trigger the consent tool pop-up for the user.

Sortable provides an API window.deployads.showConsentTool() to trigger the consent pop-up.

The following example creates a link that the user can click to show the consent UI: 

<a href="javascript:window.deployads.showConsentTool()">Manage Consent</a>

Sortable provides a mechanism to only show the link to users where the CMP is active. An element with the class name sortable-consent can be placed on a page and Sortable displays this element only to users where the CMP is active. Here is an example:

<li class="sortable-consent" style="display:none">
    <a href="javascript:window.deployads.showConsentTool()">Manage Consent</a>
</li>

4. Test the CMP

Once the CMP is set up, you can test it using two query parameters:

  • sortable-cmp=true – This query parameter enables the CMP outside of the EEA
  • sortable-cmp-popup=true – This query parameter forces the CMP to pop up, even if the user has already made a decision.

For example:

http://www.example.com/page1.html?sortable-cmp=true&sortable-cmp-popup=true