DIL Use Cases and Code Samples

Code samples and descriptions for specific DIL use cases.

Send Data Elements to Audience Manager with DIL

Create an object variable that sends information about page elements to Audience Manager. This is useful for general data collection or as an alternative to gathering data with Analytics variables.

Description

The following code demonstrates how to collect page data and send it to Audience Manager with DIL. These examples use a variable to hold data elements in a flat list or an array. Remember, pass in variables as key-value pairs. Also, note the c_ prefix before the key in the key-value pair. This required prefix identifies information as user-defined data. In the first example, you need to manually append c_ to the key. In the second example, DIL does this for you automatically.

Keep Value Properties Consistent

Remember to keep the value properties the same when passing in data. For example, if you have two identical keys with different values, the value of the last key-value pair takes precedence over the preceding value objects. For example, passing in color:blue and color:red sets the returned value to red (overwrites blue).

Example 1: Send Data as Key-Value Pairs

This basic example sends color and price data to Audience Manager in the form of key-value pairs. Your code could look similar to the following:

var sample_dil = DIL.create({partner:"partner name"});
sample_dil.api.signals({
   c_color:"blue",
   c_price:"900"
});
sample_dil.api.submit();

Example 2: Send Data in an Object

This advanced example demonstrates how to send data in an object to Audience Manager. When working with this method, DIL lets you pass an object as a function parameter into the signals() method. DIL Your code could look similar to the following:

var my_object = {
   color : "blue",
   price : "900"
};

var sample_dil = DIL.create({ partner : "partner name" });
//Load the object and append "c_" to all keys in the key-value pairs and send data to AudienceManager.
sample_dil.api.signals(my_object,"c_").submit();

Example 3: Send Page Data in an Array

In this case, the variable my_object uses an array to hold data. This example builds on the information passed in by the recommended method above, but adds an additional layer to accommodate a product type and model. Your code could look similar to the following:

var my_objects = [{
   color : "blue",
   price : "900"
}, {
   type : "acura",
   model : "tl"
}];

var sample_dil = DIL.create({ partner : "partner name" });

for (var i = 0; i < my_objects.length; i++)
//Load the object and append "c_" to all the keys in the key-value pairs.
{
    sample_dil.api.signals(my_objects[i], "c_");
}
sample_dil.api.submit();

Capture Referring URL

Capture and send a referring URL to Audience Manager.

Code Sample

Your code could look similar to the following:

var adobe_dil = DIL.create({ partner : "partner name" });
adobe_dil.api.signals({ d_referer : document.referrer }).submit();

Capture Search Engine Types and Keyword Search Terms

Send information about search engine type and keyword searches to Audience Manager.

Supported Search Engines

By default, DIL.getSearchReferrer recognizes searches from these search engines (including international variations):

Description

The following code demonstrates how to get the search referrer for any of the supported search engines. In this case, let’s assume a user searched on the term “homes” from Google Canada ( www.google.ca). This code will help you capture those search terms and send them to Audience Manager.

Basic Code

Basic code for getting the search referrer (from google.com, for example) looks like this:

var search_referrer = DIL.tools.getSearchReferrer();

Listed Search Engine Code Sample

In this case, let’s assume that a user searched for the term “homes” from Google Canada ( www.google.ca). Note how the code prefixes the required c_ parameter to search engine ( c_se) and search term ( c_st). c_ is a required prefix that identifies these as customer-defined variables to Audience Manager.

var adobe_dil = DIL.create({partner:"partner name"});
var search_referrer = DIL.tools.getSearchReferrer();

if (search_referrer && search_referrer.valid) {
  adobe_dil.api.signals({
    c_se : se.name,
    c_st : se.keywords
  }).submit();
}

Unlisted Search Engine Code Sample

In this case, let’s assume that a user searched for the term “homes” from dogpile.com. Because Dogpile is not supported by default, you can configure DIL to recognize this search engine and return the search terms to Audience Manager. Your code could look similar to the following:

var adobe_dil = DIL.create({partner:"partner name"});
var search_referrer = DIL.tools.getSearchReferrer(document.referrer, {
    hostPattern:/dogpile\./,
    queryParam:"q"
});

if (search_referrer && search_referrer.valid) {
  adobe_dil.api.signals({
    c_se : se.name,
    c_st : se.keywords
  }).submit();
}

Map Key Values to Other Keys

Associate the value from a key-value pair to another key.

Description

In a key-value pair, the c_ prefix appended to the key identifies the signal as customer-defined data. Customer-defined data is used for targeting on the specific site that passed in data on an event call. However, sometimes you want this information available across all properties in your Audience Manager account. To do this, map the value in a c_ key-value pair to a platform level key. A platform level key is prefixed with d_ and makes the signal available for targeting across all properties in your account.

As an example, you collect ZIP code data from a particular site but want to target it to all your Audience Manager properties. To make the ZIP code available at the platform level, you could map your customer-defined ZIP code key (e.g. c_zip) to a platform defined key as shown below.

Code Sample

Your code could look similar to the following:

var adobe_dil = DIL.create({
    partner : "adobe",
    mappings : {
        c_zip : 'd_zip',
        d_key2 : 'h_dil_key2'
    }
});
adobe_dil.api.signals({c_zip : '10010'}).submit();
// Request will look like /event?c_zip=10010&d_zip=10010

Traffic DIL in Google Tag Manager (GTM)

Set up and serve DIL with a GTM tag.

This procedure assumes you have a Google Tag Manager account, some working knowledge of that product, and your Audience Manager dil.js file.

To traffic the dil.js file in GTM: