View source for DAR Paramater Reference

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}}  {{CurrentBreadcrumb}}
[[Category:Digital]]

The purpose of this document is to describe all necessary data inputs for Nielsen to conduct ad measurement on ''Computer Mobile'' and ''Connected TV'' platforms. 

== Mandatory campaign metadata From Nielsen CMI ==
{| class="wikitable sortable" style="table-layout: fixed; width:100%;"
|-
! style="width: 15%;" | Parameter Name
! style="width: 7%;" | Legacy Parameter Name
! style="width: 25%;" | Description
! style="width: 10%;" | Required for Computer / Mobile (C/M)
! style="width: 10%;" | Required for CTV
!| Example Value
|-
| Client ID || ci ||  || ✔ || ✔ || <code>nlsnci123</code>
|-
| Ad Server || am ||  || ✔ || ✔ || <code>3</code>
|-
| campaign_id || ca || Custom campaign hierarchy mapping to Campaign id || ✔ || ✔ || <code>1234567</code>
|-
| creative_id || cr || Custom campaign hierarchy mapping Creative id || ✔ || ✔ || <code>765432</code>
|-
| placement_id || pc || Custom campaign hierarchy  mapping to Placement id || ✔ || ✔ || <code>placement_plc0001</code>
|-
| campaign_id || ca || Custom campaign hierarchy mapping to Campaign id || ✔ || ✔ || <code>1234567</code>
|-
| at || at || Fixed value || ✔ || ✔ || <code>view</code>
|-
| rt || rt || Fixed value || ✔ || ✔ || <code>banner</code>
|-
| st || st || Fixed value || ✔ || ✔ || <code>image</code>
|}

== Parameter listing ==
{| class="wikitable sortable" style="table-layout: fixed; width:100%;"
|-
! style="width: 15%;" | Parameter Name
! style="width: 7%;" | Legacy Parameter Name
! style="width: 25%;" | Description
! style="width: 10%;" | Required for Computer / Mobile (C/M)
! style="width: 10%;" | Required for CTV
!| Example Value
|-
| session_id || impid || Unique, client-generated value that represents uninterrupted app interaction by no greater than 30 minutes. Must match session_id in other files || ✔ || ✔ || <code>R487421B-XXXX-YYYY-3343-E3BBB46E44F2</code>
|-
| device_id || c9 || Mobile Ad ID (IDFA, ADID), Connected Device ID. Should not be the user ID. || ✔ || Preferred if available || <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| provider_id || provid || This is a unique and persistent identifier supplied by the provider of the connected device content, which represents the device that is exposed to the ad. This is equivalent to the advertiser ID on mobile devices. Note: This ID must match across all data and reference assets sent to Nielsen (Experian match, viewing data, etc.) ||  || ✔ || <code>ab1cdef2-gh34-56ij-kl78-opq</code>

<!--
|-
| is_device_id_hashed || || If device_id is SHA-256: hashed = 1, else = 0 || ✔ || ✔ || <code>0</code>, <code>1</code>
|-
| uid2 || || Trade Desk Unified ID 2.0 This should be the unencrypted, non-tokenized UID2.0 in the clear || Preferred || Preferred || <code>MTKVpUAzwYAPnHrtfE0wlINOMzhU7UUEjjVdCdRu63k=</code>
|-
| uid2_token || || Encrypted Unified ID 2.0 || Preferred || Preferred || <code>AgAAAAPFR0zA5ogv/yaAPiUsAdZPsfqS8QlDSGxAB+rr8yekFs3AjLYVk5qqqiyV2XHbSuwz<br>HmxSlLeQeKQI1mp015jsNnpX5/xGgXldcgVz+gFnyh3T8/3agMwRmyrhCxG4oH2C7fc48AQk2<br>eotE7FW0ZDEYM8fD9ZxDaxFUC/OV3OuZA&</code>
|-
| first_name_sha256 || || SHA256 hashed First name Note: [[#Email Normalization]] rules applied before hashing ||  || ✔<br>if HEM unavailable || arthur → <code>befa156f0283eb0062beb9b86e16a413e1cf8c5135e5518d5c4fa321ce0c7b6b</code>
|-
| last_name_sha256 || || SHA256 hashed Last name Note: [[#Email Normalization]] rules applied before hashing* ||  || ✔<br>if HEM unavailable|| nielsen → <code>eae8e3404182477f008479b38a6629ee86b23cefe2c418c5dc5c2f0d02af5475</code>
|-
| suffix_sha256 || || SHA256 hashed suffix Note: [[#Email Normalization]] rules applied before hashing ||  || ✔<br>if HEM unavailable || jr → <code>f04a21f9e1c244d59df2255328fb2684c83f51c09e3c53108ed766681b5f4c84</code>
|-
| address || || Registration address ||  || ✔<br>if HEM unavailable || <code>625 6th Ave, New York, NY 10011</code>
|-
| hem_sha256 || hem_sha256 || SHA-256 hashed email Note: [[#Email Normalization]] rules applied before hashing || ✔ || ✔ || <code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC4335C</code>
|-
| country ||  || Country of delivery ISO 3166 ALPHA-2 (US, CA, etc.)  || Preferred, else derived from IP || Preferred, else derived from IP || <code>US</code>
-->
|-
| uoo || uoo || User opt out flag (demographic measurement – based on OS “Limit Ad Tracking” or “Opt out of Ads Personalization” setting): 0 = not-opted-out, 1 = opt-out || ✔ || ✔ || <code>0</code>, <code>1</code>
|-
| timestamp || || Server Unix time in milliseconds (UTC) when exposure occurs
 || ✔ || ✔ || <code>1548395046744</code>
|-
| publisher_user_id || || Publisher-specific (first party) user ID (must remain persistent indefinitely. || ✔<br>required for publishers || ✔<br>required for publishers || <code>ed36968977606872e4312943c218568123786342</code>

<!--
|-
| dar_url || || The DAR URL for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR RULs, this URL should be intercepted and unaltered by the publisher/provider. || ✔ || ✔ || <code>http://secure-gl.imrworldcwide.com/cgi-bin/m?ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345</code>
|-
| advertiser_id || || Publisher Advertiser ID/Account ID (if necessary via API from ad server) || Preferred || Preferred || <code>001C000001MEebYIAT</code>
|-
| advertiser_name || || Publisher Advertiser Name/Account Name || Preferred || Preferred || <code>Account ABC</code>
-->

|-
| publisher_name || pub || This is a Nielsen-supplied value representing the publisher of the content where the ad was served. || ✔ || ✔<br>required for publishers || <code>HOO</code>
|-
| provider_user_id ||  || Provider-specific device ID (must remain persistent indefinitely, must match ID in user mapping file, no collisions). ||  || ✔<br>required for providers || <code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
| provider_name || prov || Name of the provider supplying the data to Nielsen. ||  || ✔<br>required for providers || <code>Provider 123</code>
|-
| tms_id || c36 || Gracenote program ID ||  || ✔ || <code>EP019890770017</code>
|-
| gracenote_ch_id || gc_id || Gracenote channel ID ||  || ✔ || <code>123456</code>
|-
| program_name || c43 || This is a publisher supplied value, passed either directly or via the provider, which represents the program name of the content where the user was exposed to the ad. It is critical that these values are formatted and passed consistently. These values should be URL encoded. ||  || ✔ if tms_id not provided || <code>Name Of TV Show S06+<S06:E13></code>
|-
| channel_name || ch_name || This is a publisher-supplied value, passed either directly or via the provider, which represents the name of the channel where the user was exposed to the ad. This value should be URL encoded.  ||  || ✔ if tms_id not provided|| <code>abc</code>
|-
| publisher_genre || c44=provcg || This is a publisher-supplied value which represents the genre of the content where the user was exposed to the ad. In case multiple genre values are present, delimited values can be passed string in order of relevance. It is critical that these values are formatted and passed consistently. These values should be URL encoded. ||  || ✔ if tms_id not provided|| <code><drama>+<comedy></code>
|-
| program_type || c45=provgencls || TThis is a publisher-supplied value which distinguishes between television and movie content. One of the following two fixed string values (“television” or “movie”) should be passed, depending on the combination being represented. ||  || ✔ if tms_id not provided|| <code>television</code>, <code>movie</code>
|-

<!--
| original_airtime ||  || Original broadcast time of content (if applicable) in Unix epoch timestamp format ||  || ✔ if tms_id not provided || <code>1593633600</code>
|-
| campaign_name || || Custom campaign hierarchy mapping to Campaign name || Preferred || Preferred || <code>Campaign 1</code>
|-
| creative_name || || Custom campaign hierarchy mapping Creative name || Preferred || Preferred || <code>Creative 1</code>
|-
| placement_name || || Custom campaign hierarchy  mapping to Placement name || Preferred || Preferred || <code>Placement 1</code>
|-
| publisher_deal_id || || ID made available to bid stream for programmatic ad buying || Preferred || Preferred || <code>246810</code>
|-
| transaction_id || || ID confirming the purchase of an impression placement in programmatic bid stream || Preferred || Preferred || <code>112358132134</code>
|-
| creative_type || || Ad format: 0=other, 1=display, 2=video || Preferred || Preferred || <code>0</code>, <code>1</code>, <code>3</code>
|-
| is_business || || Indicator for business vs residential account: 1 = business, 0 = residential || Preferred || Preferred || <code>0, 1</code>
|-
| url || || URL the ad ran on || Preferred || Preferred || <code>example.com/v/video</code>
|-
| advertiser_brand || || advertiser defined brand || Preferred || Preferred || <code>Brand ABC</code>
|-
| advertiser_sub_brand || || advertiser define sub-brand || Preferred || Preferred || <code>Sub-brand ABC</code>
|-
| gdpr_consent || || TC string. Required if Publisher is using TCF framework || Preferred / Required in some markets || Preferred / Required in some markets || <code>CLcVDxRMWfGmWAVAHCENAXCkAKDAADnAABRgA5mdfCKZuYJez-NQm0TBMYA4oCAAGQYIAAAAAAEAIAEgAA.argAC0gAAAAAAAAAAAA</code>
-->
| ip_address || || Plain-text IP address || ✔ || ✔ || <code>86.100.256.123</code>
|-
| device_useragent || || Client-device user agent string || ✔ || ✔ || <code>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) hrome/84.0.4147.125 Safari/537.36</code>
|-
| os_group || c7 || Operating system of device || Preferred || Preferred || <code>IOS</code>, <code>ANDROID</code>, <code>NA</code>
|-
| device_group || c8=devgrp || desc || ✔ ||✔ || See [[#Device Group]]
|-
| device_platform || c10=plt || Platform name || ✔ || ✔ || <code>OTT/code>, <code>MBL/code>, <code>DSK</code>
<!--
|-
| dma || || DMA where ad was served || Preferred || Preferred || <code>501</code>
|-
| zip_code || || ZIP code where ad was served || Preferred || Preferred || <code>10001</code>
-->
|-
| intid || || Single ID assigned per integration provided by Nielsen || Preferred || Preferred || <code>abc123abc123abc123abc123</code>
|-
| app_id || c13=asid || Server App ID provided by Nielsen || ✔ || ✔ || <code>AB57421Z-XXXX-YYYY-8343-FJQBJ26E44NT</code>
|}



==== Email Normalization ====
The below procedures should be performed before hashing emails:
*remove all leading and trailing whitespace
*force lowercase
*for <code>@gmail.com</code> addresses only:
*remove dots
*remove + suffix, including sign

'''Example:''' <code>Art.Nielsen+JR@gmail.com</code> → <code>artnielsen@gmail.com</code>



==== Device Group ====
This is the device type where the user was exposed to the ad. Nielsen relies on both the c8 and c10 values to make platform determination; these values must be consistently populated. If c8 or c10 are not present in the tag, then Nielsen collections will infer the device and platform based on the user agent present in the tag. If one of the below values cannot be determined, then the parameter should not be included in the call or should be left empty.

Valid values for '''connected devices''' are as follows:
* STV 		''(Smart TVs)''
* STB 		''(Set-top boxes)''
* RKU 		''(Roku devices, excluding SmartTVs)''
* APL 		''(Apple devices)''
* AMN 		''(Amazon devices, excluding SmartTVs)''
* GGL 		''(Google devices, excluding SmartTVs)''
* XBX 		''(Xbox devices)''
* PSX		''(PlayStation devices)''
* DVD 		''(BluRay & DVD player devices)''
* PHN		''(Mobile phone)''
* UNWN		''(Unknown Device)''


{| class="wikitable"
|-
! Device Group !! Include !! Exclude
|-
| "APL" (Apple devices) || Apple TV || Desktop (use DSK), Tablet (TAB), Mobile (PHN)
|-
| "AMN"  || STB || Smart TV (STV), Tablet (TAB), Mobile (PHN), Desktop (DSK)
|-
| Example || STB || Smart TV (STV), Tablet (TAB), Desktop (DSK)
|-
| Example || STB || Smart TV (STV)
|}

Note: For OS, “Android” and “iOS” only applicable for Mobile and Tablet devices