date | version |
---|---|
2018-08-17 14:37 |
0.3 |
The objective of the specification is to make digital advertising exposure data from the Open Internet available so that advertisers can properly and transparently measure the effectiveness of campaigns and ensure engagement with consumers is relevant and valuable. The specification is open to any media company that adheres to its standards and its commitment to enabling transparent and open measurement.
- Human Readable - Prefer semantic names and identifiers that can be interpreted without system-specific knowledge. For example,
Sacramento-Stockton-Modesto
versus65
. - Commonality - The type information contained within standardized measurement logs needs to be shared across participants. Therefore, maintaining only useful fields and being purposeful about additions is crucial to the success of a unified format.
- Privacy - User privacy is core to a successful and sustainable specification. Care must be taken to preserve user privacy and comply with applicable regulation.
- Openness - As much as possible, decisions about the exposure specification should be made in the open, with feedback from the Advertising ID Consortium, advertisers and the broader ecosystem.
Measurement log files are provided in a tab-separated, gzipped format. The files are broken up into 500 megabyte chunks, if necessary. If the file is chunked, the parts will be numbered with an integer.
Values of the variables in the filename may contain letters, integers and ASCII special characters (except for underscores, periods and whitespace).
SourcePlatform_Consumer_Version_CreationTimestamp_Part.tsv.gz
Name | Definition | Example |
---|---|---|
SourcePlatform | The DSP or SSP that produced the log. | The-Trade-Desk |
Consumer | A description of the consumer to which the measurement data relates. | Recreation-Equipment-Inc |
Version | The Coalition measurement format version | 0-1 |
CreationTimestamp | The RFC 3339 date-time, in UTC time. | 2018-07-05T20:43:52Z |
Part | The "chunk" of a split, 500MB+ file. | 2 |
All events types should be written to a single feed, if possible. Both OpenAdIds and IDLs are required in the feed if either existed at the time of the bid request.
Name | Description | Example | Valid Values | Required - DSP | Required - SSP |
---|---|---|---|---|---|
Cross_Device_ID | The cross-device identifier. | Xi1377... |
No* | No* | |
Cross_Device_ID_Type | The type of cross-device ID. | IDL |
IDL |
No* | No* |
Open_AdID | A supported Open_AdID device identifier, including IDFA or AAID if relevant. | 098d35af-fa02-4677-ba50-eb6a62e565e5 |
No* | No* | |
Open_AdID_Type | The type of OpenAdId. | The Trade Desk |
The Trade Desk , AppNexus , Digitrust |
No* | No* |
Timestamp | A timestamp given in RFC 3339 date-time, in UTC. | 2018-07-05T20:43:52Z |
Yes | Yes | |
Country | The country the event originated in, in ISO 3166 ALPHA2 format. | US |
Yes* | Yes* | |
Region | The subdivision of the country, also found in ISO 3166. | US-CA |
Yes* | Yes* | |
DMA | The DMA name where the event originated. If outside of the US, the city name. | Sacramento-Stockton-Modesto |
Yes* | Yes* | |
Device_Type | The device type as interpreted by parsing the User Agent with a ua-parser-compatible library. | iPad |
Any value of device.family . |
Yes | Yes |
OS_Type | The operating system as interpreted by parsing the User Agent with a ua-parser-compatible library. | iOS 5.1 |
Value of os.family + ' ' + os.major+'.'os.minor+'.'os.patch . "None" values should be excluded. |
Yes | Yes |
Browser_Type | The browser name as interpreted by parsing the User Agent with a ua-parser-compatible library. | UC Browser |
Value of user_agent.family . |
Yes | Yes |
Browser_Version | The specific release of the browser, as interpreted by parsing the User Agent. Major, minor and patch versions should be concatenated. | 3.4.3 |
Value of user_agent.major+'.'+user_agent.minor+'.'+user_agent.patch "None" values should be excluded. |
Yes | Yes |
Browser Language | The browser language defined in the Accept-Language header. | en-US,en;q=0.5 |
Any string passed in the HTTP header. | Yes | Yes |
Advertiser | The advertiser buying media. | Gap Inc. |
Platform-Defined | Yes | No* |
Agency | The agency (potentially) acting on behalf of the advertiser. | Publicis |
Platform-Defined | No | No |
Campaign | The specific campaign in play. | FALL_MARKET_PROMO |
Platform-Defined | Yes | No* |
Domain | The publisher domain on which the inventory existed. | eventbrite.com |
Any publisher hostname, without protocol or path. | Yes | Yes |
Event Type | The action / event that took place. | View |
View ,Click ,Bid ,Conversion |
Yes | Yes |
Inventory Type | The ad unit. | Banner |
Any valid RTB2.0 impression object type. | Yes | Yes |
Inventory Specs | The attributes of the inventory. | {"w":300,"h":200} |
Attributes specified in RTB2.0, described in JSON format | Yes | Yes |
Creative | The name of the creative asset that was served | OrganicNoGMO_FY19 |
Platform-Defined | Yes | No |
Exchange | The exchange that provided the inventory. | AppNexus |
Platform-Defined | No | No |
ID | An ID to refer to the specific impression or click record. | 5465465468463 |
Platform-Defined | Yes | Yes |
DealID | The PMP identified used in the auction. | abc001 |
Platform-Defined | No | No |
Winning Bid | The bid that won the auction, passed to the DSP via a macro. | $0.17 | Must contain currency, zero-padded dollars and cents. | No | No |
Extension | An optional field to add additional information. | {"viewability_score":80} |
Any valid JSON object. | No | No |
- required when available. A cross-device ID or device ID must be present in each record.
TBD.
Files will be delivered hourly to an Amazon S3 bucket. While the bucket may be owned by a platform or directly by an consumer, the consumer is responsible for all storage costs incurred from usage of the bucket. Expiration policies must be set to not sooner than seven days from data delivery.
See a sample file.