DocumentationAudience ManagerAudience Manager User Guide

OpenX as an Audience Manager Destination openx-as-an-audience-manager-destination

Last update: Tue Apr 13 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

Set up OpenX as a destination and send Audience Manager segment data to that platform.

NOTE
For onsite ad server targeting only.

OpenX Destination Requirements openx-requirements

Standards for code placement, supported key-value formats, reports, and the type of segment data sent to OpenX.

Review the following before setting up OpenX as an Audience Manager destination:

  • DIL: Data Integration Library code should be deployed on your site. DIL helps eliminate the need to write special code for data collection, integration, reading cookie values, and recovering page data.
  • get_aamCookie Function: Code that captures the Audience Manager user ID and cookie data. Place this code on the top of the page or inside the <head> codeblock.
  • Send Delivery Logs to Audience Manager: If you want a segment delivery report (optional), provide Audience Manager with a daily log that contains impression-level delivery data. The data can be in a raw format, but each record must contain the Audience Manager UUID. Audience Manager can pick up or receive these via FTP.

Key-Value Data: Format Requirements

Audience Manager sends data in the form of key-value pairs. Create key-value pairs according to the following specifications:

  • Preface keys with c. (e.g., c.color or c.price).
  • Separate serialized values attached to a single key with a comma (e.g., c.color = red, green, blue).
  • Separate multiple key-value pairs with an ampersand (e.g., c.color=red & c.price = 100 & c.condition = new).
  • Key names should not contain special characters like accent and punctuation marks or other symbols.

Only Qualified Segments are Sent to OpenX

The amount data passed in to OpenX depends on how many segments a particular user qualifies for. For example, say you set up 100 Audience Manager segments. If a site visitor qualifies for five of them, then only those five segments get sent to OpenX (not all 100).

Create an OpenX Destination openx-destination

Create a cookie destination for OpenX in Audience Manager.

In Audience Manager, a destination is any other system (ad server, DSP, ad network, etc.) that you want to share data with. Destination Builder provides the tools that let you create and manage these data delivery processes. Audience Manager destination features are located in Audience Data > Destinations. To get started, click Add New Destination and follow the steps below.

Step 1: Basic Information

To complete the Basic Information section:

  1. Name the destination.
  2. Select “Cookie” from the Type drop-down list.
  3. Click Next and move on to the Configuration and Segment Mappings sections.

Step 2: Configuration Information

To complete the Configuration section:

  1. Cookie Name: Provide a short, descriptive name for your cookie.
  2. Cookie Domain: Leave blank to set a cookie in the domain of the user’s current page. If you want to specify a domain, prefix the name with a period like this, .mydomain.com.
  3. Choose a key option in the Data Format section.
  4. If your keys use data with serialized values, select the Serialize control and specify the serial delimiter (the character that separates the serialized values).
  5. Click Save and expand the Segment Mappings section.

Step 3: Segment Mappings

To add a segment to a cookie destination:

  1. Find segments: The Segment Mappings section provides two search tools to help locate segments. To find a segment:

    • Option 1: Start typing a segment name in the search field. The field updates automatically based on the text. Click Add once you find the segment you want to use.
    • Option 2: Click Browse All Segments to open a window that lets you browse for segments by name or storage location. Click Add Selected Segments when done.

  2. Add Mappings: In the mappings pop, enter the segment ID in the mappings field and click Save.

  3. Click Done.

OpenX Setup openx-code-setup

Modify OpenX settings to work with Audience Manager segment data.

To set up OpenX:

  • Install DIL code across your site.

  • Create OpenX as a cookie destination in Audience Manager.

  • Place the get_aamCookie function at the top of the page, ideally within the <head> codeblock. The get_aamCookie code is available here.

  • Modify your ad tag to call the get_aamCookie function and include the cookie name you provided when setting up the OpenX destination. For example, if you named the cookie test_cookie, then the ad tag should call get_aamCookie and reference the cookie name.

  • Your ad tag could look similar to the example below.

    code language-none 
    <a href= "https://client.adserver.net/?" + get_aamCookie('test_cookie') +
 "&etc&xid=" + get_aamCookie('aam_uuid')

Remember to include xid= . It holds the actual unique user ID (UUID) passed in during an ad call.

The fully formed ad call could look similar to this:

https://client.adserver.net/?c.key1=val1&c.key2=val2&etc& xid =3286487458745343
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695