Global

Members

ConsentDecision :array

Source:
Properties:
Name Type Description
type string

the type of consent, will be either 'implicit' or 'explicit'

An array of CMP group names that have permission to run.

Also includes a 'type' property that indicates whether the consent decision is IMPLICIT or EXPLICT.

Type:
  • array
Example
var exampleConsentDecision = window.tealiumCmpIntegration.getCurrentConsentDecision()

JSON.stringify(exampleConsentDecision)
// ["Google Analytics","Another Tag","Tealium iQ Tag Management"]

exampleConsentDecision.type
// "explicit"

exampleConsentDecision.length
// 3

GroupToTagMap :object

Source:

Assigns Tealium iQ Tags to CMP Group names. Each group can contain multiple tags, but each tag can only be assigned to a single service. If the same tag UID appears in multiple Service arrays, all but one will be ignored.

The keys for the main object are the configuration ID from the CMP, inside that are key/value pairs where the key is a CMP group name (granularity is flexible), and the value is an array of TagUIDs from Tealium iQ.

This needs to be provided as per the example below, in tealiumCmpIntegration.map.

Type:
  • object
Example
window.tealiumCmpIntegration = window.tealiumCmpIntegration || {}
window.tealiumCmpIntegration.map = {
  'yPyIAIIxY': {
    'Google Analytics': [6, 8, 10],
    'Mouseflow': [7, 9],
    'Another Tag': [11]
  }
}

QueuedEvent :object

Source:
Properties:
Name Type Description
event string

the type of tracking event, generally 'view' for pageviews or 'link' for other events
data object

the Universal Data Object associated with the event (from utag_data or the b object)
cfg object

an optional configuration object that can have a 'cb' property (for a callback function) and a 'uids' array, which is a list of tag UIDs that should be triggered by the event, regardless of whether load rules are met.

An object from the implicitEventQueue or earlyEventQueue, which represents a Tealium iQ tracking event that's been processed based on an IMPLICIT ConsentDecision

Heavily based on the argument passed to utag.track, since it's designed to be processed by that method.

Initial pageviews (handled in the utag.loader.initdata override) will NOT have metadata like cookies, qps, etc - utag.track calls (handled in the utag.handler.trigger override) will. That's a byproduct of using utag.handler.trigger, which is later in the load - those metadata will be re-read when the queue is processed, and since this queue isn't persisted between pages, it should be fine like that - the only strange behavior will be that any metadata that aren't present on re-read will still be present after the re-read - only values that are still present will be replaced with new values.

An alternative approach could be to manually remove 'cp.*', 'dom.*', 'ut.*', 'qp.*', 'meta.*' and possibly 'tealium_*' (except 'tealium_event') from the 'data' object before queueing - that hasn't been done so far.

Type:
  • object
Example
{
    "event": "view",
    "data": {
        "cp.utag_main_v_id": "0180d6afbfe5001fb3c58332996b05079004c07100fb8",
        "cp.utag_main__sn": "1",
        "cp.utag_main__se": "5",
        "cp.utag_main__ss": "0",
        "cp.utag_main__st": "1652872155220",
        "cp.utag_main_ses_id": "1652869283813",
        "cp.utag_main__pn": "3",
        "cp.utagdb": "true",
        "dom.referrer": "",
        "dom.title": "Usercentrics v2 Test",
        "dom.domain": "solutions.tealium.net",
        "dom.query_string": "",
        "dom.hash": "",
        "dom.url": "https://solutions.tealium.net/hosted/usercentrics-v2/test-page-standard.html",
        "dom.pathname": "/hosted/usercentrics-v2/test-page-standard.html",
        "dom.viewport_height": 1336,
        "dom.viewport_width": 976,
        "ut.domain": "tealium.net",
        "ut.version": "ut4.46.202205181037",
        "ut.event": "view",
        "ut.visitor_id": "0180d6afbfe5001fb3c58332996b05079004c07100fb8",
        "ut.session_id": "1652869283813",
        "ut.account": "services-caleb",
        "ut.profile": "usercentrics-v2-by-tag",
        "ut.env": "qa",
        "tealium_event": "view",
        "tealium_visitor_id": "0180d6afbfe5001fb3c58332996b05079004c07100fb8",
        "tealium_session_id": "1652869283813",
        "tealium_session_number": "1",
        "tealium_session_event_number": "5",
        "tealium_datasource": "",
        "tealium_account": "services-caleb",
        "tealium_profile": "usercentrics-v2-by-tag",
        "tealium_environment": "qa",
        "tealium_random": "8882989585076650",
        "tealium_library_name": "utag.js",
        "tealium_library_version": "4.46.0",
        "tealium_timestamp_epoch": 1652870355,
        "tealium_timestamp_utc": "2022-05-18T10:39:15.221Z",
        "tealium_timestamp_local": "2022-05-18T12:39:15.221",
        "purposes_with_consent_all": [
            "Tealium iQ Tag Management",
            "Mouseflow",
            "Usercentrics Consent Management Platform"
        ],
        "consent_type": "implicit",
        "purposes_with_consent_unprocessed": [],
        "purposes_with_consent_processed": [
            "Tealium iQ Tag Management",
            "Mouseflow",
            "Usercentrics Consent Management Platform"
        ]
    },
    "cfg": {
        "cb": null,
        "uids": [
            10,
            7
        ],
        "originalUids": [
            7,
            10
        ],
        "blockedTagUids": [
            10
        ]
    }
}

TagToGroupMap :object

Source:

A simple lookup, with Tealium iQ tag UIDs as keys and the associated CMP Groups as values. Each group can be associated with multiple tags, but each tag can be associated with one group.

The example is based on the GroupToTagMap example, where the CMP Lookup Key (a Usercentrics Settings ID, in this case) on the active page is 'yPyIAIIxY'.

This object is automatically generated by the getTagBasedMap method, and made available globally in tealiumCmpIntegration.tagBasedMap for debugging and use within the extensions.

Type:
  • object
Example
{
  6: 'Google Analytics',
  7: 'Mouseflow',
  8: 'Google Analytics',
  9: 'Mouseflow',
  10: 'Google Analytics',
  11: 'Another Tag'
}