Adobe Analytics (Omniture) Integration – Dynamic Yield Knowledge Base

The Dynamic Yield integration with Adobe Analytics lets you track and analyze visitors who have seen a specific variation of your Dynamic Yield campaigns and experiments directly in your Adobe account.

This guide walks you through how to set up this integration on both the Dynamic Yield and Adobe Analytics platforms.

How Does it Work?

The Integration with Adobe Analytics passes data on the experiences served by Dynamic Yield (variation name and its corresponding campaign) directly into Adobe Analytics by first storing the data as Adobe Analytics variables (eVars) and then passing these variables via the Adobe Analytics API. The API call is made only once per page (at it’s late state). This method allows Dynamic Yield to report on all of the running experiments at once, notwithstanding their timing on the page. It also ensures that this integration does not impact your Adobe Analytics implementation.

For example, if you have an experiment setup in Dynamic Yield A/B testing design variations of a hero banner. You are targeting two groups of visitors – visitors coming from cold weather and visitors from hot climates – and you are testing two variations for each group. When a visitor lands on the page of the experiment, a variation is selected and rendered. The variation name (in this case A or B) and its corresponding experience (cold or hot) is stored as an eVar. Once the page is fully loaded, an API call is made to Adobe to push this data, along with any additional experiment data running on the page, onto your Adobe Analytics account.

You can then leverage all your existing Adobe Analytics reports to view how visitors exposed to these four variations (hot weather A, hot weather B, cold weather A, cold weather B) behaved on your site.

Set Up

The Adobe Analytics Integration is a simple two step configuration within the Dynamic Yield platform:

Configuring Dynamic yield experience data as Adobe Analytics Variables
Configuring the Adobe Analytics API to push this data to Adobe.

Once these are set up, you can enable the integration on both platforms. Below is a step by step description for the integration, set up, and enablement.

Configuring Dynamic Yield data as Adobe eVars

To store experience data as eVars, configure a Javascript code for every time a test or campaign variation is selected and rendered for a visitor on your site. This snippet of code stores the experience and variation information as the designated Adobe Analytics variables.

Go to Settings › Integrations.
Click Custom Analytics Platform and click Enable Integration.
Check Variation Impressions.

Paste the following code and click Save:

function afterVariationSelected(tagId, tagName, experienceName, experience, variations, isNoAction) {
    function getTestName() {
        return tagName + " - " + experienceName.split("|")[0].trim() + " - " + decodeURIComponent(variations[0].name).trim();
    }
 
    function setEvars(evars, value) {
        for (var i = 0; i < evars.length; i++) {
            if (typeof s["eVar" + evars[i]] == "undefined") {
                s["eVar" + evars[i]] = value;
                DY.CS = DY.CS || {};
                DY.CS.dataForAdobeAnalytics = true;
            }
        }
    }
 
    function waitForOmniture(eVars, value) {
        var delay = 10;
 
        if (typeof window.s !== "undefined") {
            setEvars(eVars, value);
        } else {
            var interval = setInterval(function() {
                if (typeof window.s !== "undefined") {
                    setEvars(eVars, value);
                    clearInterval(interval);
                }
            }, delay);
        }
    }
 
    function getEVars(experienceName) {
        if (experienceName.indexOf("|") == -1) {
            return [];
        }
 
        return experienceName.split("|")[1].split(",").map(function(item) {
            return item.trim()
        }).filter(function(item) {
            return item.length > 0;
        });
    }
 
    var name = getTestName();
    var eVars = getEVars(experienceName);
    waitForOmniture(eVars, name);
}

Configuring Adobe Analytics API Call

To call the Adobe API, configure a Javascript Custom Action to run a snippet of code to pass experiment data stored as eVars back to your Adobe Analytics account. This API call is made once per pageview, only for pages running Dynamic Yield experiments.

Go to Site Personalization › New Campaign and click Custom Code.
Select to trigger the JS action on ‘page load’. Do not worry! We do not run this action immediately – the actual script calls for the function ‘beforeunload’.
In the Advanced Settings, disable the Enable custom integration option.
Click Next.
Click on the Variation tab (leaving the Targeting tab untouched)
Click New Variation and select the Custom Code template.
Go to Design and go to the JS tab.

Paste the following code:

window.addEventListener("beforeunload", function() {
    if (typeof DY.CS !== "undefined" && DY.CS.dataForAdobeAnalytics) {
        s.tl();
    }
})

Click Save Variation.
Select any goal as your primary metric, keeping in mind, you are not setting up an actual experiment, but a custom action to make the API call, so any goal will do. Make sure the allocation is set to send 100% of the traffic to your variation.
Click Save Experience and Save & Publish the Custom Action.

Enablement

Dynamic Yield does not automatically report on all running experiments to Adobe Analytics. To enable the integration:

Allocate an eVar in Adobe Analytics for each Dynamic Yield experiment you would like to track.
Associate the eVar and enable the integration for each experiment in Dynamic Yield.

Allocating eVars in Adobe Analytics

Reserve an eVar for each Dynamic Yield experience you would like to track in Adobe Analytics and set the following:
1. Name: Provide the eVar with a descriptive name we recommend adding DY to the title for example Hero banner – DY.
2. Allocation: select ‘Most Recent (last)’
3. Expire After: Configure the eVar’s persistence in Adobe Analytics with the corresponding Attribution Duration of the experience in Dynamic Yield:
  
  Attribution Duration (Dynamic Yield) eVar Expiration (Adobe Analytics)
  
  Session Attribution Visit
  
  Unlimited Attribution never
4. Status: We recommend setting it as ‘Full subrelations’ or ‘Basic Subrelations’.
5. Reset. Allow resetting.

Keep note of the eVars, as they will need to be associated to the correct experiment in Dynamic Yield.

Associating eVars in Dynamic Yield

To associate between the reserved eVar in Adobe Analytic and the the experiment in Dynamic Yield, you would need to explicitly state the eVar number within the title of the experience in the following format: Experience name | eVar number. There should be no other pipes (|) in the experience name.

‘Hero Banner’ experience will populate eVar12. You will be able to choose the eVar as a dimension and compare the performance of its values. For example:
- Hero Banner – hot weather – A
- Hero Banner – hot weather – B
- Hero Banner – cold weather – A
- Hero Banner – cold weather – B
Enabling the integration must be done at the campaign or experiment level. To send data to Adobe Analytics, check the ‘Enable custom integration’ in the campaign’s advanced settings, and save.

Disabling this checkbox will prevent the experiment from storing any data in the user’s eVar, and will not pass over any information to your Adobe Analytics account.

Attribution Duration (Dynamic Yield)	eVar Expiration (Adobe Analytics)
Session Attribution	Visit
Unlimited Attribution	never