Show Menu
TOPICS×

Adobe Analytics tool

You can deploy Adobe Analytics (Standard and Premium) using Dynamic Tag Management by creating the Adobe Analytics tool and configuring the page code either automatically or manually. The automatic method is recommended for most users.
For improved visitor tracking, it is strongly recommended that you enable Experience Cloud ID Service .

Add an Adobe Analytics tool

  1. Click <Web Property Name> > Overview > Add a Tool > Adobe Analytics .
  2. Fill in the fields:
    • Tool Type
      The type of tool, such as Adobe Analytics.
    • Tool Name
      A descriptive name for this tool. This name displays on the Overview tab under Installed Tools.
    • Configuration Method
      Automatic (Recommended): Use Dynamic Tag Management to manage the configuration. This method enables automatic synchronization of Adobe Analytics report suites via an Experience Cloud login or Web Services ID, and manages the AppMeasurement code.
      After the accounts are connected, Dynamic Tag Management pulls the Adobe Analytics report suite IDs and names into the tool configuration interface, allowing for increased speed in tool deployment with less possibility for user errors.
      You must choose the Automatic option if you are an Adobe Analytics Premium customer. See Enabling Adobe Analytics Premium below.
      Fill in the fields specific to automatic configuration:
      • Experience Cloud : (Default) Uses Experience Cloud single sign-on. Specify your Experience Cloud ID and password.
      • Web Services : Specify your Web Services username and shared secret.
        Shared secret credentials are located in Admin Tools > Company Settings > Web Services .
        Developers, see Get Web Service Access to the Enterprise API for help with obtaining Web Services credentials.
      Manual : Manually manage the AppMeasurement code. You can download the Analytics AppMeasurement code from Admin Tools > Code Manager .
      Click JavaScript (new) for information about downloading the code locally to copy and paste in the Edit Code field in Library Management .
      Fill in the fields specific to a manual configuration:
      • Production Account ID: (Required) Your production account for data collection. For Analytics, this is your report suite ID. Dynamic Tag Management automatically installs the correct account in the production and staging environment.
      • Staging Account ID: (Required) Used in your development or test environment. For Analytics, this is your report suite ID. A staging account keeps your testing data separate from production.
      • Tracking Server: Specify the information for your tracking server.
        The Tracking Server and SSL Tracking Server variables are used for first-party cookie implementation to specify the domain at which the image request and cookie is written. For more information, see the Correctly Populate the trackingServer and trackingServerSecure Variable article.
      • SSL Tracking Server: Specify the information for your SSL tracking server.
  3. Click Create Tool to create the tool and display it for editing.
    Tools are displayed on the Overview tab, under Installed Tools.
  4. (Conditional) Configure the tool further as necessary by following the directions in the links below ( General, Library Management, Global Variables, Pageviews & Content, Link Tracking, Referrers & Campaigns, Cookies, and Customize Page Code).
See FAQ - Adobe Analytics Tool for additional information about this tool.

Edit an existing Adobe Analytics tool

You can edit an existing Adobe Analytics tool to change its configuration settings.
  1. Click the Settings icon next to an installed tool from the Overview tab.
  2. Edit the fields as desired.
    The following table includes only those elements that differ from the elements available when you are creating an Analytics tool, as described above. However, you can change any element on the page, as described in both tables.
Element
Description
Enable Automatic Configuration
This option lets Dynamic Tag Management automatically retrieve your Adobe Analytics account's configuration. The latest available AppMeasurement code is used and upgrade notifications are displayed for selection as new versions become available. You can also roll back to previous AppMeasurement versions as necessary, such as for compatibility reasons. Up to five previous versions are displayed. Enabling this setting changes a manually configured implementation to the automatic configuration method described in Configuration Method.
Update Credentials
Refresh the API, for example, to update report suites associated with a user.
  1. (Conditional) Configure the tool further as necessary by following the directions in the sections below ( General, Library Management, Global Variables, Pageviews & Content, Link Tracking, Referrers & Campaigns, Cookies, and Customize Page Code).
  2. Click Save Changes .

Enabling Adobe Analytics Premium

If you are an Adobe Analytics Premium customer, Dynamic Tag Management lets you take advantage of advanced features and additional eVars and events.
The following table displays the number of eVars and events available in each Analytics account type:
Adobe Analytics (Point Product)
Adobe Analytics (Standard)
Adobe Analytics Premium
eVars
75
100
250
Events
100
1,000
1,000
You add the Adobe Analytics Premium tool using Dynamic Tag Management the same way you add Adobe Analytics (Standard). In order to get the Analytics Premium functionality (if applicable), you must do the following:
  • Use the Automatic configuration method (explained above).
  • Use the Experience Cloud or Web Services authentication method (explained above).
There is no "switch" to enable Analytics Premium functionality. Verification is done behind the scenes by API checks via the automatic configuration. The additional eVars are added to the UI if the account is authenticated as an Analytics Premium customer.
If you downgrade to standard Analytics in the future, the added premium eVars that are out of the standard range will be grayed out in both tools/rules. You can view any configured variables that are now out of range and make any necessary changes to an in-range variable. You cannot add or edit any of these out-of-range variables, but you will be able to view them and delete them.

General

Field descriptions for the General settings in dynamic tag manager, for deploying Adobe Analytics.
Property > Settings > General
  • Enable EU compliance for Adobe Analytics Enables or disables tracking based on the EU privacy cookie.
    When a page is loaded, the system checks to see if a cookie called sat_track is set (or the custom cookie name specified on the Edit Property page). Consider the following information:
    • If the cookie does not exist or if the cookie exists and is set to anything but true , the loading of the tool is skipped when this setting is enabled. Meaning, any portion of a rule that uses the tool will not apply.
      If a rule has analytics with EU compliance on and third-party code, and the cookie is set to false , the third-party code still runs. However, the analytics variables will not be set.
    • If the cookie exists but it is set to true , the tool loads normally.
    You are responsible for setting the sat_track (or custom named) cookie to false if a visitor opts out. You can accomplish this using custom code:
    _satellite.setCookie(“sat_track”, “false”);
    
    
    You must also have a mechanism to set that cookie to true if you want a visitor to be able to opt in later:
    _satellite.setCookie(“sat_track”, “true");
    
    
  • Character Set
    Displays the available character encoding sets.
  • Currency Code
    Displays the supported currency codes for selection.
  • Tracking Server
    The domain at which the image request and cookie is written.
  • SSL Tracking Server
    The domain at which the image request and cookie is written. Used for secure pages. If not defined, SSL data goes to trackingServer .
  • Data Center
    The Adobe data center used for data collection.

Library management

Descriptions of the fields and options in the Library Management settings in Dynamic Tag Management.
Property > Settings Edit Tool > Library Management
If more than one Adobe Analytics tool is used in a single web property, each tool must have a unique tracker variable name. Duplicative object variable names between Adobe Analytics tools within a single web property will cause conflicts.
  • Page code is already present
    Prevents Dynamic Tag Management from installing Adobe Analytics page code if the code is already present on your site.
    This feature allows you to use Dynamic Tag Management to add to your existing implementation rather than starting from scratch. Be sure to properly set your tracker variable name when checking this box.
  • Load library at < Page Top or Page Bottom >
    Specifies where and when to load the page code. Regardless of your selection, any rules using the Analytics tool will need to have the same setting.
  • Managed by Adobe (Recommended)
    Enable Dynamic Tag Management to manage your library.
    If you select this option, the following option becomes available:
    Library Version: Select the latest version from the Library Version menu. Dynamic Tag Management notifies you when new versions are available. You can revert to a previous version as necessary.
  • Custom
    You can configure the library code.
    If you select this option, the following options become available:
    Set report suites using custom code below: When this box is checked, Dynamic Tag Management looks for a variable in your custom code called s_account . This variable should contain a comma-separated list of the report suites to which you want to send data.
    Code Hosted: Choose an option to host the s_code:
    • In DTM : You can host the s_code within Dynamic Tag Management. Click Edit Code to cut and paste the file directly into the editor.
    • URL : If you have a good s_code file and are happy with the process of updating it, you can provide the URL to the file here. Dynamic Tag Management then consumes that s_code file for its implementation of Adobe Analytics.
    Open Editor: Lets you insert core AppMeasurement code . This code is populated automatically when using the automatic configuration method described in Adobe Analytics Settings .
    Tracker Variable Name: If you want to run two instances of Adobe Analytics in parallel (one within Dynamic Tag Management and one natively), you can rename the main s object. Renaming the object name avoids collisions.

Insert core AppMeasurement code

Insert AppMeasurement code when manually deploying Dynamic Tag Management in Adobe Analytics.
  1. On the Adobe Analytics tool page, expand the General section, then click Open Editor .
  2. Unzip the AppMeasurement_JavaScript*.zip file you downloaded in deploy Adobe Analytics .
    If you opt for custom library, when you open the window it will already have the most recent code version present. There is no need to download the zip from the Admin Console.
  3. Open AppMeasurement.js in a text editor.
  4. Copy and paste the contents into the Edit Code window.
  5. Adobe recommends adding the following code above the Do Not Alter Anything Below This Line :
    var s_account="INSERT-RSID-HERE"
    var s=s_gi(s_account)
    
    
    
    If you add this code, it is recommended that you also select the Set report suites using custom code below checkbox in the overall library settings.
  6. Click Save and Close .
    If you are using the Media Module, Integrate Module, or implementation plug-ins, you can copy them into the code section as well. The managed code in dynamic tag manager can be configured exactly like the JavaScript file in a typical implementation.

Global variables

Field descriptions and information about variables when using Dynamic Tag Management to deploy Adobe Analytics.
These variables fire on all page load rule beacons. You can accomplish the same effect by using a Page-Load rule set to fire on all pages. These variables might not fire in Direct Call and Event-Based rules.

Global variables - field descriptions

Property > Settings icon > Edit Tool > Global Variables
Element
Description
Server
The predefined variable populates the Servers report in Adobe Analytics.
eVars
The eVar variables are used for building custom conversion reports.
Props
Property (prop) variables are used for building custom traffic reports.
Dynamic Variable Prefix
A special prefix to the start of the value. The default prefix is D= .

Page views and content

Field descriptions in Dynamic Tag Management for page views and content settings when deploying Analytics.
Property > Settings icon > Edit Tool > Page Views & Content
Element
Description
Page Name
The name of each page on your site.
Page URL Override
Overrides the actual URL of the page.
Channel (Site Section)
Identifies a section of your site.
Hierarchy
Determines the location of a page in your site's hierarchy.

Link tracking

Field descriptions in Dynamic Tag Management for link tracking when deploying Analytics.
Property > Settings icon > Edit Tool > Link Tracking
  • Enable ClickMap
    Determines whether visitor click map data is gathered.
  • Track download links
    Tracks links to downloadable files on your site.
  • Download Extensions
    If your site contains links to files with any of the listed extensions, the URLs of these links will appear in reporting.
  • Track outbound links
    Determines whether any link clicked is an exit link.
    Single-Page App Considerations: Because of the way some SPA websites are coded, an internal link to a page on the SPA site might look like it is an outbound link.
    You can use one of the following methods to track outbound links from SPA sites:
    • If you do not want to track any outbound links from your SPA, insert an entry into the Never Track section.
      For example, `https://testsite.com/spa/#`
      All # links to this host are ignored. All outbound links to other hosts are tracked, such as `https://www.google.com`.
    • If there are some links that you want to track on your SPA, use the Always Track section.
      For example, if you have a spa/#/about page, you could put "about" in the Always Track section.
      The "about" page is the only outbound link that is tracked. Any other links on the page (for example, `https://www.google.com`) are not tracked.
    Note that these two options are mutually exclusive.
  • Keep URL Parameters
    Preserves query strings.

Referrers and campaigns

Field descriptions in Dynamic Tag Management for referrers and campaign options when deploying Dynamic Tag Management in Adobe Analytics.
Property > Settings icon > Edit Tool > Referrers & Campaigns
Element
Description
Referrer Override
Overrides the value set in the s.referrer variable, which is typically populated by the referrer set in the browser.
Campaign
A variable that identifies marketing campaigns used to bring visitors to your site. The value of campaign is usually taken from a query string parameter.
Use the DTM interface to choose whether you want to use a Query String or Value (which could pull from a data element):
You can either enter your query string directly in the interface, or you can reference a separate data element if you have other means of tracking a campaign.

Cookies

Field descriptions for the Cookies global settings used for deploying Dynamic Tag Management in Adobe Analytics.
Property > Settings icon > Edit Tool > Cookies
Element
Description
Visitor ID
Unique value that represents a customer in both the online and offline systems.
Visitor Namespace
Variable to identify the domain with which cookies are set.
Domain Periods
The domain on which the Analytics cookie s_cc and s_sq are set by determining the number of periods in the domain of the page URL. This variable is also used by some plug-ins in determining the correct domain to set the plug-in's cookie.
FP Domain Periods
The fpCookieDomainPeriods variable is for cookies set by JavaScript ( s_sq , s_cc plug-ins) that are inherently first-party cookies, even if your implementation uses the third-party 2o7.net or omtrdc.net domains.
Transaction ID
Unique value that represents an online transaction that resulted in offline activity.
Cookie Lifetime
Determines the life span of a cookie.

Customize page code

Use field descriptions in Dynamic Tag Management to customize page code when deploying Analytics.
Add plugins to ensure that the code runs at the same time as the Analytics tool.
Property > Settings icon > Edit Tool > Customize Page Code
Element
Description
Open Editor
You can insert any JavaScript call that must be triggered before the final s.t() call, which is contained in the s_code .
Execute
Before UI settings: Interface settings take precedence over the custom code (for example, if you want to override an eVar if a setting in the interface was enabled). After UI settings: Custom code takes precedence over interface settings.

FAQ for Adobe Analytics release - July 24 2014

Dynamic Tag Management feature information and FAQ for Adobe Analytics released on July 24, 2014.

New features

This release offers several key usability improvements for Adobe Analytics:
Automatic Configuration Method
Enables automatic synchronization of Adobe Analytics report suites via a Experience Cloud login or Web Services ID.
Add a Tool > Adobe Analytics

Frequently asked questions

Question
Answer
Is this a new Adobe Analytics tool, or a change to the existing tool?
A change to the existing tool. If you currently have an implementation of Adobe Analytics in Dynamic Tag Management, it will continue to function.
If I make configuration changes in the new version of the tool, can I test in staging before publishing to production?
Yes. All changes can be tested in staging just like you normally would before deploying to a production environment. If you choose not to publish, because you notice issues in staging, the production code will continue to function as it did before the new integration was released.
If I switch from manual configuration (the default setting for existing tools) to automatic configuration, will my current settings be affected?
No.
If I switch from manual library management to Managed by Adobe, will my current settings or code be affected?
Any user code that you have specified is overwritten with the base AppMeasurement library. You must move this code to the new Custom Page Code section at the end of the tool configuration so that the code continues executing. This method allows the AppMeasurement library to be managed (and upgraded) separately from the user's custom code.
Will the revision history for the Adobe Analytics tool be retained when the new integration is released?
Yes.

Potential pitfalls

There is a small chance that the new integration could cause data collection issues if you currently use Adobe Analytics. These issues could arise only if you publish your library to production subsequent to the release. (Production code remains intact until publishing occurs.)
To avoid these issues, ensure that:
  • Report suite IDs are correctly entered in the tool.
  • Report suite IDs in the tool match the IDs in the AppMeasurement code.
  • The currency code, character set, tracking server, and SSL tracking server configuration fields are correctly set with supported values.
  • Custom code is defined in Library Management.

Manually implement Adobe Analytics (legacy)

Create an Adobe Analytics tool for deployment using Dynamic Tag Management. This procedure describes a manual (legacy) implementation.
For information about automatic implementation management, see Configure Adobe Analytics .
If you want to change a manual configuration to automatic, edit a tool and click Enable Automatic Configuration .
  1. Download Analytics measurement code:
    1. In Adobe Experience Cloud, click Reports & Analytics > Admin Tools .
    2. Click Code Manager .
    3. Click JavaScript (new) to download the code locally.
  2. In Dynamic Tag Management, create a web property .
    After you create the web property, it is available for editing on the Web Properties tab on the Dashboard. Activating the web property is not required
  3. Add an Adobe Analytics tool to the property:
    1. On the Web Properties tab, click the property.
    2. On the Overview tab, click Add a Tool .
    3. From the Tool Type menu, select Adobe Analytics .
    4. Configure the following fields:
      Element
      Description
      Tool Type
      The Experience Cloud solution, such as Analytics, Target, Social, and so on.
      Tool Name
      The name for this tool. This name displays on the Overview tab under Installed Tools.
      Production Account ID
      A number for your production account for data collection. Dynamic Tag Management automatically installs the correct account in the production and staging environment.
      Staging Account ID
      A number used in your development or test environment. A staging account keeps your testing data separate from production.
  4. Click Create Tool .
    The installed tool displays on the Overview tab.
  5. To configure the code, click the Settings icon.
    At a minimum, click Cookies and configure your tracking server and SSL tracking server.
  6. Define a page load rule to collect Analyticsdata.
    You are now ready to define rules to collect analytics data. You might want to define a few data elements first. Data elements let you extract data from the page that you can use to configure your rule. To get started, you can define a page load rule that does not have any conditions to collect Analytics data on each page.
  7. For staging, you can leave the default Amazon hosting option. You can change it if needed before your production rollout.
  8. (Optional) Click the Settings icon on the Options tab, and configure the Adobe Analytics code.
    The settings on the Adobe Analytics page (General, Cookies, and so on) override settings in your s_code . If these settings exist in your s_code , there is no need to reiterate them here.