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
- Optional U.S. Privacy - CCPA client configuration parameters
- Optional GDPR client configuration parameters
- Optional Custom Messaging client configuration parameters
Optional overall client configuration parameters
In the tables below, please find the available parameters for your implementation.
authId |
Data type |
Allows your organization to pass a consent identifier to Sourcepoint to be used with authenticated consent. Click here to learn more. |
authCookie |
Data type |
Allows your organization to configure a unique name for Sourcepoint's authId cookie. Click here for more information on authId . |
String |
campaignEnv |
Data type |
Designates which campaign environment to use and accepts either of the following values:
When set to Note: This parameter defaults to your |
String |
isSPA |
Data type |
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 |
Data type |
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.For these reasons, Sourcepoint strongly recommends that joinHref is set to true to ensure full CMP functionality. |
Boolean |
targetingParams |
Data type |
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. Click here to learn more. Note:
|
Object literal |
propertyHref |
Data type |
Maps the implementation to a specific URL as set up in the Sourcepoint account dashboard. Click here for more information and best practices. Note: Use the
|
String |
propertyId |
Data type |
Maps the message to a specific property (website, app, OTT) as set up in Sourcepoint account dashboard. | Integer |
//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 U.S. Privacy - CCPA client configuration parameters
In the tables below, please find the available parameters specific to U.S. Privacy - CCPA. These parameters should be implemented within the ccpa: { }
object.
Note: In order to surface a U.S. Privacy - CCPA message to your clients, you will need to include the ccpa:{
}
object in your client configuration script regardless of whether you configure any optional parameters.
alwaysDisplayDNS |
Data type |
Setting this parameter to true enables use cases where a Sourcepoint Do Not Sell (my data) notification is hardcoded. |
Boolean |
targetingParams |
Data type |
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. Click here to learn more. Note:
|
Object literal |
includeGppApi |
Data type |
Setting this parameter to |
Boolean |
//Example
window._sp_queue = [];
window._sp_ = {
config: {
accountId: 1584,
baseEndpoint: 'https://cdn.privacy-mgmt.com',
ccpa: {
alwaysDisplayDNS: false,
targetingParams:{
darkmode: true
},
includeGppApi: true
},
gdpr: { },
propertyHref: 'https://www.testdemo.com',
Optional GDPR client configuration parameters
In the tables below, please find the available parameters specific to GDPR. These parameters should be implemented within the gdpr: { }
object.
Note: In order to surface a GDPR message to your clients, you will need to include the gdpr:{
}
object in your client configuration script regardless of whether you configure any optional parameters.
consentLanguage |
Data type |
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 |
Data type |
Allows your organization to use the privacy manager ID for the property group's privacy manager. Note: Call |
Number |
targetingParams |
Data type |
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. Click here to learn more. Note:
|
Object literal |
shortCircuitPartialConsent |
Data type |
When set to Note: When this parameter is set to |
Boolean |
//Example
window._sp_queue = [];
window._sp_ = {
config: {
accountId: 1584,
baseEndpoint: 'https://cdn.privacy-mgmt.com',
consentLanguage: "fi",
ccpa: { },
gdpr: {
groupPmId: 123456,
targetingParams:{
darkmode: false
},
shortCircuitPartialConsent: true
},
propertyHref: 'https://www.demotest.com',
Optional Custom Messaging client configuration parameters
In the tables below, please find the available parameters specific to Custom Messaging. These parameters should be implemented within the custom: { }
object.
Note: In order to surface a custom message to your clients, you will need to include the custom:{
}
object in your client configuration script regardless of whether you configure any optional parameters.
targetingParams |
Data type |
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. Click here to learn more. Note:
|
Object literal |
//Example
window._sp_queue = [];
window._sp_ = {
config: {
accountId: 1584,
baseEndpoint: 'https://cdn.privacy-mgmt.com',
custom: {
targetingParams:{
darkmode: false
}
},
propertyHref: 'https://www.demotest.com',
Comments
0 comments