This article describes how to add and configure the Adobe Target tag.

In this article:

Prerequisites

  • Adobe Marketing Cloud Account Service
  • Tealium Universal Tag (utag.js) version 4.26 or greater
  • Adobe Target Extension

If you will be using the Adobe Experience Cloud ID Service tag, add it and order it before the Adobe Target tag.

If you are using Internet Explorer (IE), only version 9.x and above is supported.

Supported Versions

The following versions of the Adobe Target tag are currently supported:

  • 1.7.0, 1.7.1
  • 1.8.0, 1.8.1, 1.8.2
  • 2.0.0, 2.1.1, 2.2.0, 2.3.0, 2.3.1, 2.3.2, 2.3.3

Tag Configuration

Go to the Tealium Tag Marketplace and add the Adobe Target tag to your profile. For information on adding tags, see Tags.

In the Adobe Target Tag Settings dialog, configure the following settings:

  • Client Code: The version of the Target library. Template must be dropped to receive new versions. Version 2.x includes the changes for Multiple Offers and SPA.
  • Timeout: Set to 5000 or greater. This is the time (in ms) to wait for a response from Target before assuming the Target server is not responding.
  • Adobe Org ID: Used for visitor tracking across Adobe Target and Site Catalyst. Found in the mbox.js file. For example: var imsOrgId = 'XXXXXXXXXXXXXXXXXXXXXXXX@AdobeOrg'
  • Library Endpoint Path: The path variable in the library call (generally does not need to be changed).
  • Auto Create Global mbox: Indicates whether the global mbox request should be fired or not.
  • Global mbox Name: Adobe typically uses "target-global-mbox" for the name of the globally hidden mbox. This tag automatically calls mboxCreate to create this mbox.

Load Rules

In the Adobe Target Tag Settings dialog, click Next to create a load rule for the Adobe Target tag, or to select an existing load rule. Load rules determine when and where to load an instance of this tag on your site. For more information, see Load Rules.

Data Mappings

Click Next to configure Data Mappings. Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see Data Mappings.

The destination variables for the Adobe Target tag are built into the Data Mapping tab. The following tables describe the variables for each category.

Standard

Destination Name Description
Client Code (config.clientCode) The client name (for example, mycompany in mycompany.tt.omtrdc.net).
Organization ID (config.imsOrgId) Used for visitor tracking across Adobe Target and Site Catalyst. Found in the mbox.js:
var imsOrgId = 'XXXXXXXXXXXXXXXXXXXXX@AdobeOrg' 
Server Domain (config.serverDomain) Represents Target edge server.
Enable Cross Domain (config.crossDomain) Indicates whether cross-domain tracking is enabled or not.
  Set to 5000 or greater. This is time (in ms) to wait for a response from Target before assuming the Target server is not responding.
Global Mbox Name (config.globalMboxName) Adobe typically uses "target-global-mbox" for the name of the globally hidden mbox. This tag automatically calls mboxCreate to create this mbox.
Enable Global Mbox Creation [Boolean] (config.globalMboxAutoCreate) Indicates whether the global mbox request should be fired or not.
  The path variable in the library call (generally does not need to be changed).
Default Content Hidden Style (config.defaultContentHiddenStyle) Used only to wrap mboxes that use DIV with class name "mboxDefault" and are executed via mboxCreate() , mboxUpdate() , or mboxDefine() . Hides default content.
Default Content Visible Style (config.defaultContentVisibleStyle) Used only to wrap mboxes that use DIV with class name "mboxDefault" and are executed via mboxCreate() , mboxUpdate() , or mboxDefine() . Reveals applied offer, if any, or default content.
Body Hidden Style (config.bodyHiddenStyle) Used only when globalMboxAutocreate is set to true to minimize the chance of flicker.
Enable Body Hidding [Boolean] (config.bodyHidingEnabled) Used to control flicker when target-global-mbox is used to deliver offers created in the Visual Experience Composer (also known as visual offers).
Device Id Lifetime [Number] (config.deviceIdLifetime) The time (in ms) to retain the device ID.
Session Id Lifetime [Number] (config.sessionIdLifetime) The time (in ms) to retain the session ID.
Selectors Polling Timeout [Number] (config.selectorsPollingTimeout) Indicates how long the client waits for all the elements identified by selectors to appear on the page.
Activities created via the Visual Experience Composer (VEC) have offers that contain selectors.
Visitor API Timeout [Number] (config.visitorApiTimeout) Represents the Visitor API request timeout.
Enable Mbox Edge Server Override (config.overrideMboxEdgeServer) Indicates the domain to use:  .tt.omtrdc.net or mboxedge.tt.omtrdc.net.
If this value is true, mboxedge.tt.omtrdc.net domain is saved to a cookie.
Override Mbox Edge Server Timeout [Number] (config.overrideMboxEdgeServerTimeout) Indicates the lifetime of the cookie that contains the mboxedge.tt.omtrdc.net value.
Enable Optout [Boolean] (config.optoutEnabled) Indicates whether Target should call the Visitor API isOptedOut() function. This is part of Device Graph enablement.
Enable Optin [Boolean] (config.optinEnabled) Indicates whether Target should call the Visitor API isOptedIn() function. This is part of Device Graph enablement.
Secure Requests Only [Boolean] (config.secureOnly) Indicates whether at.js should use HTTPS only or switch between HTTP and HTTPS based on the page protocol.
Enable Page Load [Boolean] (config.pageLoadEnabled) Enable page load.
Enable Views [Boolean] (config.viewsEnabled) Enable views.
Authoring Script URL (config.authoringScriptUrl) Used to set the authoring script URL.

Track Events

Use either Mbox Parameters, which is a complete object, or Mbox Parameters Item, which is individual parameters that are used to build an object.

Destination Name Description
Mbox Name (evt.mbox) The name of the mbox.
CSS Selectors (sevt.elector) CSS selectors used to find the HTML elements. The event listeners are attached to found elements.
HTML Event Type (evt.type) Represents a registered event type. It can be both HTML known events such as click, mousedown, etc., or custom HTML events.
Use Prevent Default [Boolean] (evt.preventDefault) Indicates whether to use event.preventDefault() in the event listener callback. Defaults to false.
Mbox Parameters [Object] (evt.params) An object of key-value pairs that has the following structure:
{"param1": "value1", "param2": "value2"}
The number of parameters required varies depending on the implementation.
Mbox Parameters Item (evt.params.###) Change ### to the name of your parameter. Add parameters to the mbox to provide data to your Target implementation for segmentation and targeting.
Timeout [Number] (evt.timeout) Timeout in milliseconds.
Success Function [function] (evt.success) A callback function used to signal that an event has been reported.
Error Function [function] (evt.error) A callback function used to signal that an event could not be reported.

Parameters

Destination Name Description
mboxParams.### Change ### to the name of your parameter. Add parameters to the mbox to provide data to your Target implementation for segmentation and targeting.
targetPageParamsAll.### Change ### to the name of your parameter. Add parameters to the global mbox.
targetPageParams.### Change ### to the name of your parameter. Add parameters to all mboxes on the page.
targetPageParams.at_property Preconfigured parameter used to define the at_property .

Multiple Offers and SPA

Destination Name Description
Get Offers Request Type (request_type) The type for the getOffers() request. Either prefetch or execute.
Fetch All Views (offers.fetchViews) Calls getOffers() to retrieve all views for the selected request type.
Consumer Id (offers.consumerId) Default value is client's global mbox if not provided. This key is used to generate the supplemental data ID used for A4T integration.
Request Timeout (offers.timeout) The request timeout. If not specified, the default at.js timeout is used.
Request Id (offers.id) One of tntId , thirdPartyId , or marketingCloudVisitorId is required.
Request Id - thirdPartyId (offers.id.thirdPartyId) The third-party ID. Maximum size = 128.
Views Array (offers.views) [Array] An array of objects that pass in parameters to be used to retrieve relevant views in active activities.
PageLoad Array (offers.pageLoad) [Array] An array of objects that retrieve offers with specified parameters when page loads.
Mboxes Array (offers.mboxes) [Array] An array of objects that pass in parameters to be used to retrieve relevant mboxes.
CSS Selectors (selector) [Array] An array of CSS selectors to be applied to the response object. Must match number of views/pageload/mboxes in response.
Response Object (offersResponse) The response object to apply. Response objects received from getOffers() are placed into the u.offersReceived array.
View Name (viewName) Specifies the view name as a string type. This view name appears in the Modifications panel of the VEC for marketers to create actions and run their A/B and XT activities.
Increase Impression Count (countPage) [Boolean] When set to true, notifications are sent to the Target backend for incrementing impression count. Default value is true.

Using Adobe Target Tag 2.x

To call getOffers(), you need to map the following:

  • An array of views or mboxes, or an object of pageLoad parameters.

For more information, refer to the Adobe getOffers() documentation.

Response objects received from getOffers() are placed into the tag template array variable named u.offersReceived where they can be accessed before being sent to applyOffers(). Response data is not modified by the tag template.

To call applyOffers(), map the following:

  • A response object.
  • (Optional) An array of CSS selectors to be applied to the response object in the order they are given.

For more information, refer to the Adobe applyOffers() documentation.

The mboxes, views, and pageLoad arrays need to be generated on the page or in an extension.

For information on the format of these arrays, refer to the Adobe getOffers() documentation.

Version history
Last update:
2 weeks ago
Updated by: