Overview and Mappings for Metadata Files

A metadata file links numeric IDs with names you can read and understand. The Audience Optimization reports display readable names in the various report options menus.

Contents:

Overview

A review of metadata and how it's used. A metadata file must be accompanied by a data file. The metadata file contents match data file information to related, human-readable labels in the report menus. For more information, see Data Files for Audience Optimization Reports.

Metadata Files Contain Data About Other Data

A metadata file contains information about other types of data. To help you understand how this works, let’s review how Audience Manager receives data. During an impression or click event, Audience Manager receives data in an URL string known as an event call. The event call organizes information into sets of defined key-value pairs. The values in a key-value pair contain of numeric data. The metadata file contains names and other readable information corresponding to the ID in each key-value pair.

Metadata Links IDs to Readable Names

The metadata file is required to tie a numeric ID to a readable name. As an example, say an event call contains a creative ID in a key-value pair like this: d_creative:1234. Without a metadata file, this creative would show up as 1234 in an options menu. However, a properly formatted metadata file can tie this creative to back to a real name like “Advertiser Creative A,” which is a name you can read and recognize in a report.

When Do You Need a Metadata File

First, a metadata file, and all of the parameters listed below, are required in an event call when you want to use the Audience Optimization Reports.

Second, you need a metadata file if you’re sending your own data to Audience Manager or if you want to see data in the reports from other providers we’re not integrated with. For example, Audience Manager has an integration with Google’s Double-click Campaign Manager (DCM). Because of this relationship, Audience Manager can associate IDs with names and descriptions used by the report options. Without an integration, we can still ingest data, but the report options will show numeric IDs instead of descriptive name.

File Mappings

The following table lists the key-value pairs that hold data used by the Audience Optimization reports. If you need to use a metadata file, it would contain human-readable information that corresponds to the values in these key-value pairs. The values for these keys accept integers only (data type INT). Note, italics indicates a variable placeholder. Other elements are constants or keys and do not change.

Important: If you're using the Audience Optimization reports, all of these values are required in the event call.
Report Option Metadata Key-Value Pairs

Advertiser

d_adsrc = data source ID or integration code

This is the advertiser's data source ID or integration code provided when creating a data source. See Create a Data Source.

Business Unit (BU)

d_bu = business unit ID

Campaign

d_campaign = campaign ID

Creative

d_creative = creative ID

Exchange

Accepts 2 different key-value pairs:

  • d_exchange = ID for the exchange that served the ad
  • d_site = ID for the site an ad served on

Insertion Order (IO)

d_io = insertion order ID

Platform

d_src = data source ID

This is the data source ID for the platform providing metadata information (e.g., DFA, Atlas, GBM, MediaMath, etc.).

Tactic

d_tactic = tactic ID

Vertical

d_vert = vertical ID

How Event Call IDs Shape File Names, Contents, and Delivery Paths

The IDs passed in by these key-value pairs help create the metadata file name and its contents. The following sections and illustrations demonstrate how this works. These examples build a file that contains the name of a creative in a campaign, but other combinations are possible.

Event Call

In this example we'll create a metadata file that brings creative names in to an Audience Optimization report. To do this, we need to extract creative, campaign, and data source IDs from an event call.

File Name

The file name is based on the creative, campaign, and data source IDs. In this case, compare the differences here between the key-value data in an event call and how it's used in a file name.

In a file name:

  • The data source key changes to dpid from d_src.
  • The creative and campaign IDs represent a category rather than an actual identifier.

See Naming Conventions for Metadata Files.

File Contents

In this example, the file contents reflect the creative and campaign IDs passed in on the event call. The new element here is a readable name. Once processed, the name in this file will appear as an option in the Creative menu of an Audience Optimization report.

See Content Format for Metadata Files.

File Delivery

After you name and add data to a file, you send it to an Amazon S3 storage directory provided by Audience Manager. See Delivery Methods for Metadata Files and Status Updates for Metadata Files.