Preferences implementation guide (web)

Sourcepoint offers messaging capabiltiies to capture, store, and sync an end-user's marketing preferences via Preference Center messages. In this article, we will walk you through the essential steps to launch your Preference Center messaging campaign on your web property.

• Overview
• Portal configuration
• Install Preferences code on property
• Install resurface Preference Center message code on property
• Launch campaign

Overview

Portal configuration

Use the table below to track the necessary configurations that need to be performed within the Sourcepoint portal before adding the required code onto the property and launching your Preferences campaign.

Install Preferences code on property

When you have completed the portal configuration for your property, click Properties on the left-hand panel and select Properties from the subsequent menu. 

Click <> inline with the property name.

Use the dropdown menu to select Preferences. The implementation code snippet will automatically populate in the provided space.

Click Copy Code and add the implementation code snippet to your property.

The Sourcepoint Preferences implementation code snippet is comprised of two scripts. Review the sections below for additional information and possible configuration options to suit your organization's use cases.

• Client configuration script
• URL to messaging library

<script>
  window._sp_queue = [];
  window._sp_ = {
      config: {
          accountId: 1584,
          baseEndpoint: 'https://cdn.privacy-mgmt.com',
          preferences: {
            id: 'email@testdemo.com'
          },
          propertyId: 123456,
          events: {
              onMessageChoiceSelect: function() {
                  console.log('[event] onMessageChoiceSelect', arguments);
              },
              onMessageReady: function() {
                  console.log('[event] onMessageReady', arguments);
              },
              onMessageChoiceError: function() {
                  console.log('[event] onMessageChoiceError', arguments);
              },
              onPrivacyManagerAction: function() {
                  console.log('[event] onPrivacyManagerAction', arguments);
              },
              onPMCancel: function() {
                  console.log('[event] onPMCancel', arguments);
              },
              onMessageReceiveData: function() {
                  console.log('[event] onMessageReceiveData', arguments);
              },
              onSPPMObjectReady: function() {
                  console.log('[event] onSPPMObjectReady', arguments);
              },
              onConsentReady: function (consentUUID, euconsent) {
                  console.log('[event] onConsentReady', arguments);
              },
              onError: function() {
                  console.log('[event] onError', arguments);
              },
          }
      }
  }
  </script>
  <script src='https://cdn.privacy-mgmt.com/unified/wrapperMessagingWithoutDetection.js' async</script>
      

Client configuration script

The client configuration script contains your organization's specific account configuration parameters. This configuration includes the necessary and optional parameters for your property to communicate with the Sourcepoint messaging platform and consent service libraries.

Currently, there are four required parameters to successfully deliver an end-user notification:

In addition to the required parameters (above), your organization can further implement additional parameters and customizations in the code snippet for different use cases. Follow the resources below for additional information:

• Configure subdomain with CNAME
• Client configuration parameters
• Event callbacks (Preferences)

  window._sp_queue = [];
  window._sp_ = {
      config: {
          accountId: 1584,
          baseEndpoint: 'https://cdn.privacy-mgmt.com',
          preferences: {
            id: 'email@testdemo.com'
          },
          propertyId: 123456,
...

URL to messaging library

The final script is a URL that points to Sourcepoint's messaging libraries. The default URL is as follows and only needs to be included once regardless of how many different types of messaging campaigns you run on the property:

• https://cdn.privacy-mgmt.com/unified/wrapperMessagingWithoutDetection.js

In the developer console, the URL to the messaging library can return the following regardless of whether a message was shown to the user:

Install resurface Preference Center message code on property

Many organizations will want to add a button/link onto their web property that allows an end-user to resurface the Preference Center message so they can manage their marketing preferences on an ongoing basis.

Typically, the JavaScript code on their page will attach the function to the onclick event of a page element. Click here for more information on how to implement the JavaScript code.

Launch campaign

With the property configured in the portal and Sourcepoint's implementation code snippet added to the web property, your organization can now launch a Preferences campaign on the property.