This article describes how to set up and use the Consent Preferences Manager tool.

In this article:

Table of Contents Placeholder

About

The Consent Preferences Manager makes it easy to deploy a tracking preferences option to your website to allow customers to specify which categories of tags they will allow. This tools offers full access to customize the code that generates the preferences pop-up and the ability to translate content for your global customers.

How It Works

The Consent Preferences Manager works together with the Consent Prompt Manager to present tracking options to your customers. The Consent Preferences Manager replaces the functionality previously offered by the Privacy Manager extension. Once a customer opts-in or opts-out, the prompt no longer displays but the user can access preferences about the types of tracking to allow via the consent preferences pop-up. The preferences manager also puts categorizes tags based on their function and purpose, such as "Analytics", "Display Ads", or "Email Marketing". These categories are presented to the customer and displayed as toggle buttons to allow or disallow that tracking to occur.

Preferences pop-up example:

consent-preferences-prompt.png

The iQ Tag Management Consent Preferences Manager simplifies the creation and deployment of a tracking preferences prompt to your website using your existing installation. Once published, you will add a simple JavaScript function call to your page code to trigger the pop-up.

Features

The Consent Preferences Manager offers the following features:

  • Display Templates
  • Customizable Style and Layout
  • Multi-Language Support
  • Tag Categories

All of the configuration is bundled with your existing installation of the JavaScript library (utag.js).

Once you activate and configure the preferences prompt, the changes are released in your next publish.

JavaScript Code

Once enabled and published, the consent preferences pop-up introduces a JavaScript function into the utag namespace to allow you to integrate additional functionality.

Use the following function to launch the consent preference dialog:

utag.gdpr.showConsentPreferences()

Displays the consent preferences pop-up. This function should be integrated into your site to provide visitors a way to change their consent preferences.

Example:

<a href="#" onClick="utag.gdpr.showConsentPreferences()">Consent Preferences</a>

To set the language dynamically, pass a language code value to the function. This will override both the window.utag_cfg_ovrd.gdprDLRef configuration and the browser detection logic.

Examples:

utag.gdpr.showConsentPreferences('de-DE'); // German/Germany
utag.gdpr.showConsentPreferences('fr'); // French

Setting up the Consent Preferences Manager

The Consent Preferences Manager is configured using the following tabs:
Consent Manager_Consent Preferences Dialog.jpg

  • Content
    This tab is used to enter the message displayed to your customers, add multiple language translations, and provide your company's logo URL and privacy policy link.
  • Customization
    From this tab, you can customize the design and layout of your prompt by editing the CSS, HTML, and JavaScript used to display the pop-up.
  • Categories
    In this tab, you can groups your tags into categories based on their purpose or function.
  • Options
    This tab allows you to adjust additional options, such as logging consent changes using DataAccess or marking non-tracking tags that are not governed by consent management, for example, a chat widget.

Global Settings

The Consent Preferences Manager can be configured for multiple profiles at once using global settings. This allows you to configure the preferences pop-up at the account level and have each profile inherit the global configuration. (Learn More)

Getting Started

Use the following steps to begin setting up the Consent Preferences Manager:

  1. In the left sidebar, go to Client-Side Tools > Consent Management.In the Consent Preferences Dialog section, click Get Started to launch the configuration modal.
    Consent Manager_Consent Preferences Dialog_Get Started.jpg
    If your prompt is already set up, you can toggle it on or off from this screen.

Content

On the Content screen you will customize the message displayed in the preferences pop-up, add languages for translated content, define custom parameters, and see a preview of the pop-up.

The pop-up is templatized so that the content is separated from the code. The code uses parameters to substitute content using placeholder parameters. Parameters are referenced using the format: {{parameter_name}}.

The standard built-in content parameters are:

  • Title {{title}}
    The main heading of the consent prompt.
  • Message {{message}}
    Your message to customers to inform them about your tracking intentions and links to other resources such as a privacy policy or contact form.
  • Opt-in/Opt-out {{opt_in}} / {{opt_out}}
    The two options available: opt-in - grant consent, opt-out - deny consent.
  • Confirmation Button {{confirmation_button}}
    The label on the submission button.

To edit the content of the standard parameters, modify the text fields and click Finish.

Sample HTML code with parameters:

<div class="example_body">
<div class="privacy_prompt">
<div class="privacy_prompt_content">
<h1>{{title}}</h1>
<p>{{message}}</p>
</div>
<div class="privacy_prompt_footer">
<div class="button right">{{confirmation_button}}</div>
</div>
<div class="close_btn_thick"></div>
</div>
</div>

Custom Parameters

Custom parameters can be added to further customize the pop-up. Custom parameters can be referenced within the standard parameters or in the CSS/HTML/JavaScript code.

Best Practice: Avoid putting translatable text directly in the HTML or JavaScript. Instead, construct the code with {{parameters}} and define the values using custom parameters.

To add a custom parameter:

  1. Click + Add Parameter.
    The Custom Parameter dialog displays.
  2. Enter a name for the parameter.
  3. Click Apply.
    The new custom parameter displays in the list.
  4. Enter a value for the new parameter.
    This value will be substituted any place that the parameter is referenced.
  5. Click Finish.

Languages

The preferences pop-up is built with automatic language detection. The browser's language setting of the browser is detected (two-character language code, for example 'de' for German) and the pop-up presents the corresponding version of the content (if that language has been configured). The preferences pop-up is configured in English (en) as the default.

You can however override the language with a value provided in the data layer (provided it is in the ISO format). Add this code as a preloader extension. This will tell the Consent which variable to use to switch the language. This will affect the language shown for both explicit and preferences manager.

window.utag_cfg_ovrd = window.utag_cfg_ovrd || {}; 
window.utag_cfg_ovrd.gdprDLRef = "<some data layer var e.g. meta.lang/page_lang>";

Use the following steps to add a language:

  1. In the Language side panel, click + Add.
    The Add Language dialog displays.
  2. Select the desired language and click Apply.
    The new language displays in the Language side panel.
  3. Click the new language to configure its content.
  4. Enter the translated values in the standard parameter boxes (Title, Message, and Confirmation button).
  5. Click Finish.

Set a default language by checking the box named Make Default Language located in the language title bar. The default language will be used to display the preferences pop-up when the customer's detected browser language does not have a matching language configured in the consent prompt manager.

consent-prompt-content-make-default.png

Preview

Preview your configuration by clicking Preview from the language title bar.

Customization (CSS, HTML, JavaScript)

On the Customization screen you will see the code behind the consent prompt – the CSS, HTML, and JavaScript that runs the prompt. This code can be edited to adjust the look and design of the pop-up to match your website.

Categories

On the Categories screen you will adjust the categories that tags are grouped into. The categories are presented to the customer as options to toggle on or off.

Use the following steps to adjust a tag category:

  1. Select a category from the sidebar.
    The list of tags displays in the main panel.
  2. Click the drop-down menu and select a new category for the tag.
  3. Click Finish.

Options

On the Options screen you can configure the Tealium cookie behavior and tags to omit.

Cookie Preferences

Select whether or not to retain the Tealium cookie. This setting will override any other preferences that disable tracking. The Tealium cookie is used for visitor, session and timestamp information. It addition, it can be used with the Persist Data Values extension to store custom values.

Default State for Categories

This setting applies to two (2) scenarios where a default state for the categories is needed:

  • Explicit consent prompt is active but the user ignores it
    When the consent preferences modal is shown the default state for categories is used.
    • On
      Categories are enabled by default in the preferences modal until the user makes changes, but tracking follows the consent prompt policy until the user gives consent.
    • Off
      Categories are disabled by default in the preferences modal until the user makes changes, but tracking follows the consent prompt policy until the user gives consent.
  • Explicit consent prompt is inactive and the user has not set preferences
    The default state for categories will determine if tags should fire.
    • On
      Tracking occurs until preference categories are disabled
    • Off
      Tracking is suppressed until preference categories are enabled

Tag to Omit

Not all tags deployed via iQ Tag Management are for tracking or data collection. Tags and extensions can also be used to serve site functionality, such as pop-up modals, product feedback, site support, or chat clients. Use the Tags to Omit setting to create a list of tags to be exempted from the consent preferences pop-up.