Consent Integrations - Custom CMP Integration (Early Access)

To add a new custom integration, you can use the existing integrations and the provided example as a guide. The CMP-specific component of the integration is defined using the window.tealiumCmpIntegration object.

The window.tealiumCmpIntegration object consists of a name .cmpName, version .cmpIntegrationVersion, and the following functions:

Integration functions

Determine operating mode

• .cmpCheckIfOptInModel - determines whether the integration should operate on the opt-in or opt-out model. Returns a boolean value.

Fetch decision

• .cmpFetchCurrentConsentDecision - retrieves the current raw version of the consent decision (raw version, from the CMP). The result must be an object and is passed as an argument to all subsequent functions.

Validate and standardize the decision

• .cmpCheckForWellFormedDecision - checks if the raw version of the consent decision is well-formed and understandable. Returns a boolean value.

• .cmpCheckForTiqConsent - determines whether the raw consent decision contains permission for data processing by Tealium iQ. If false, nothing is executed. Returns a boolean value.

• .cmpCheckForExplicitConsentDecision - determines whether the raw consent decision is explicit or implicit. Returns a boolean value.

• .cmpConvertResponseToGroupList - converts the raw decision into a simple array of allowed purpose keys for downstream enforcement. Returns an array of consented purpose keys.

Debugging custom integrations

For detailed debugging tips for both prebuilt and custom integrations, see Validating and debugging Consent Integrations.