Optional client configuration parameters

In additional to the required client configuration parameters for a web implementation your organization can also utilize optional parameters for further customizations unique to your implementation. The optional client configuration parameters can be categorized into the following groups: 


Optional overall client configuration parameters

In the table below, please find the available parameters for your implementation.

Optional configuration Description Data type
authId Allows your organization to pass a consent identifier to Sourcepoint to be used with authenticated consent. Click here to learn more.   
authCookie Allows your organization to configure a unique name for Sourcepoint's authId cookie. Click here for more information on authId. String
campaignEnv

When set to stage, the implementation will default to campaigns configured in your stage campaign environment.

  Note: This parameter defaults to your public campaign environment unless otherwise indicated.

String
isSPA

When set to true, will confirm the implementation for a single page application and will show a message only when window._sp_.executeMessaging(); is triggered.

Click here to learn more about single page application functions.

Boolean
joinHref

When set to true, will ensure that all directory regular expression functionality works in conjunction with the propertyHref parameter.

The joinHref parameter is solely used to test your implementation across different servers while still allowing for URL RegEx matching.

Boolean
targetingParams

Targeting params allow a developer to set arbitrary key/value pairs. These key/value pairs are sent to Sourcepoint servers where they can be used to take a decision within the scenario builder.

  Note: targetingParams set at either within the CCPA or GDPR objectwill override this configuration.

targetingParams: {               
                    key1: valueA,
                    key2: valueB
                }
Object literal
//Example
window._sp_queue = [];
window._sp_ = {
    config: {
        accountId: 1584,
        baseEndpoint: 'https://cdn.privacy-mgmt.com',
        ccpa: { },
        gdpr: { },
        propertyHref: 'https://www.testdemo.com',
        authCookie: 'test_uuid',
        campaignEnv: 'stage',
        isSPA: true,
        joinHref: true,
        targetingParams:{
            darkmode: true
          },

Optional CCPA client configuration parameters

In the table below, please find the available parameters specific to CCPA. These parameters should be implemented within the ccpa: { } object.

Optional configuration Description Data type
alwaysDisplayDNS Setting this parameter to true enables use cases where a Sourcepoint Do Not Sell (my data) notification is hardcoded. Boolean
groupPmId

Allows your organization to use the Privacy Manager ID for the property group's Privacy Manager ID.

  Note: Call window._sp_.ccpa.loadPrivacyManagerModal() without passing a parameter and the Privacy Manager that displays will be that property's version of the groupPmId Privacy Manager.

Number
targetingParams

Targeting params allow a developer to set arbitrary key/value pairs. These key/value pairs are sent to Sourcepoint servers where they can be used to take a decision within the scenario builder.

  Note: targetingParams set within the ccpa object will override overall targetingParams.

targetingParams: {               
                    key1: valueA,
                    key2: valueB
                }
Object literal
//Example
window._sp_queue = [];
window._sp_ = {
    config: {
        accountId: 1584,
        baseEndpoint: 'https://cdn.privacy-mgmt.com',
        ccpa: { 
            alwaysDisplayDNS: false,
groupPmId: 123456, targetingParams:{ darkmode: true } }, gdpr: { }, propertyHref: 'https://www.testdemo.com',

Optional GDPR client configuration parameters

In the table below, please find the available parameters specific to GDPR. These parameters should be implemented within the gdpr: { } object.

Optional configuration Description Data type
consentLanguage

Ensure that the purposes or stack names listed in a consent message remain in the same language regardless of an end-user's browser language setting. Click here for a list of ISO 639-1 language codes.

If this parameter is absent, the stacks and purposes will appear according the user's preferred language.

String
groupPmId

Allows your organization to use the privacy manager ID for the property group's privacy manager.

  Note: Call window._sp_.gdpr.loadPrivacyManagerModal() without passing a parameter and the privacy manager that displays will be that property's version of the groupPmId privacy manager.

Number
targetingParams

Targeting params allow a developer to set arbitrary key/value pairs. These key/value pairs are sent to Sourcepoint servers where they can be used to take a decision within the scenario builder.

  Note: targetingParams set within the gdpr object will override overall targetingParams.

targetingParams: {               
                    key1: valueA,
                    key2: valueB
                }
Object literal
//Example
window._sp_queue = [];
window._sp_ = {
    config: {
        accountId: 1584,
        baseEndpoint: 'https://cdn.privacy-mgmt.com',
        ccpa: { },
        gdpr: {
            consentLanguage: "fi"
            groupPmId: 123456,
            targetingParams:{
                darkmode: false
              }
        },
        propertyHref: 'https://www.demotest.com',

 

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