Validate and debug consent integrations

Validate consent integrations before publishing

Validate and debug your consent integration by pasting the integration template into your site’s JavaScript console without any other dependencies. Consent integration templates can be edited and are designed to be stand-alone, which enables debugging from the website console.

Templates can be used to write custom integrations, to retrieve your vendor ID, purpose keys, or ensure that the default template works for your instance of a CMP without customization before configuration. For more information about current templates with validation snippets, see Supported vendor integrations.

Activate debug mode after publishing

The Tealium iQ debug mode contains detailed status and error messages from your consent integrations when the feature is active, unless an exemption applies. When exempt, window.tealiumCmpIntegration is defined and displays your active exemption in window.tealiumCmpIntegration.exemptionMap.

Use /SENDING|\\\\*/ as a filter in the console output to show only relevant debug messages.

Validate consent integrations after publishing

Client-side consent integrations create a global object in the DOM called window.tealiumCmpIntegration that has a number of helpful properties for debugging. You can also call the component functions individually to facilitate debugging and validation. For details about the component functions, see Custom CMP Integrations

Example

This example describes how to retrieve important information about your CMP integration.

Complete the following steps to see important information about your CMP integration and confirm that it correctly captures customer decisions:

1. Visit this demo site or any site with an active consent integration and paste the following snippet into your browser console:

   var outputString = `${tealiumCmpIntegration.cmpName} - ${tealiumCmpIntegration.cmpCheckIfOptInModel() ? 'Opt-in' : 'Opt-out'} Model
   
   Checks:
     - vendor id:            ${tealiumCmpIntegration.cmpFetchCurrentLookupKey()}
     - well-formed decision: ${tealiumCmpIntegration.cmpCheckForWellFormedDecision(tealiumCmpIntegration.cmpFetchCurrentConsentDecision())}
     - explicit decision:    ${tealiumCmpIntegration.cmpCheckForExplicitConsentDecision(tealiumCmpIntegration.cmpFetchCurrentConsentDecision())}
     - consented purposes:   ${JSON.stringify(tealiumCmpIntegration.cmpConvertResponseToGroupList(tealiumCmpIntegration.cmpFetchCurrentConsentDecision()).sort(),null, 8)}
   `
   console.log(outputString)
   

2. Paste the above snippet into the console of the demo site, it returns:

   OneTrust - Opt-in Model
   
   Checks:
     - vendor id:            b38364e4-b2c4-4349-8e4e-48cf28a35db8
     - well-formed decision: true
     - explicit decision:    false
     - consented purposes:   [
           "C0001"
   ]
   

3. Click Accept All Cookies on the web page and paste the same snippet again. The following output indicates that the decision was correctly understood and captured by the integration:

   OneTrust - Opt-in Model
   
   Checks:
     - vendor id:            b38364e4-b2c4-4349-8e4e-48cf28a35db8
     - well-formed decision: true
     - explicit decision:    true
     - consented purposes:   [
           "C0001",
           "C0002",
           "C0003",
           "C0004"
   ]
   

Debug collisions and Enforcement Rules after publishing

Use window.tealiumCmpIntegration to inspect consent enforcement, identify collisions, and troubleshoot blocked tags after publishing.

The object contains the following properties:

• loadRules: Contains properties that identify which consent integrations are enforced and whether a collision occurred. A collision blocks Tag Management and all tags.

• map and tagBasedMap: Show different mappings between tag UIDs and purpose keys.

• tiqGroupName: Maps the purpose key to Tag Management.

• cmpName: Identifies the active Consent Management Platform (CMP), as determined by the integration template.

• cmpIntegrationVersion: Identifies the version of the vendor-specific integration template.

• version: Identifies the version of the underlying consent enforcement framework.

• originalEvents: Stores the original event payload for each event that triggers enforcement, keyed by event ID (tci.event_id). Event IDs are assigned automatically and passed downstream in the data layer.

• blockedTagsByEvent: Records tags blocked by consent decisions, organized by event. Each key uses the format <tci.event_id>||<consent-type> (for example, 1234567890||implicit). Each value is an object containing blocked tag UIDs set to 1.

  To inspect the event payload associated with a blocked tag, use the event ID to find the corresponding entry in originalEvents.

  Blocked tags are logged to the browser console whenever blocking occurs. Starting with version 1.4.0, blockedTagsByEvent includes only tags blocked by consent decisions. Tags that do not meet load rule conditions are excluded.

For more information about integration-specific properties, see Custom CMP integrations.