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

The standard Nielsen Digital Ad Rating (DAR) tag only supports cookie based '''web browser''' viewing on PCs, MACs, and tablets/smartphone (web-browser). However, when ads are served to tablets/smartphones via native '''app-store applications''', the cookie based tag does not function correctly. Additional tag attributes are needed in order for audience reach measurement to function. Example tags are detailed later in this document.

One way Nielsen clients can accomplish this is by the use of Nielsen’s native iOS/Android App SDK. Nielsen’s App SDK automatically adds these additional tag attributes to the standard cookie based webbrowser tag before the tag is forwarded on to the Nielsen census collection system. However, there is a significant portion of the publisher mobile app universe where it is either not feasible, or desirable to integrate Nielsen’s native App SDK into 3rd party applications.

The purpose of this document is to detail the tag URL parameters required that are '''additional''' to the standard cookie based web-browser tag.

The most critical additional parameter required is the insertion of the Advertising ID (IFA / IDFA / AdID) from the users device that has been exposed to the Ad creative.

If you are reading this document as an Ad server representative then it is assumed that you have published a specification that mobile app publishers follow to pass the appropriate Advertising ID in the Ad request payload. Typically, your Ad server will then expand a macro or label with that value passed in the Ad request URL, insert into the DAR mobile app tag and redirect to Nielsen collections. See s. See [[#Appendix A: Example Implementation]], figure 2 for an example tag workflow.

The standard way of triggering a Digital Ad Ratings (DAR) tag on Mobile-App is for the publisher app to trigger (either directly or via Ad server) the tag upon Ad exposure to the user. i.e. a client-side initiated tag. If you wish to implement server-side dispatch of mobile in-app DAR tags then see additional section in this document titled '''server-side tag dispatch'''. Please read the rest of this document before reading the section on server-server.

Once you have completed your integration, you will be required to submit to a short certification. See [[#Appendix B: Implementation, Testing & Certification]]. Certification also grants inclusion to the approved publisher and certified Ad server vendor list.

'''Important Note:''' for 2018, the MRC has mandated a series of changes to audience measurement that will require additional tag events to be communicated to Nielsen so that we may compute duration weighting etc. You are strongly urged to contact your Nielsen client service representative to seek a briefing from Nielsen on the best technical methods for tagging in order to be compliant with these changes.

__TOC__

== Standard DAR Tag ==
The DAR tag is available as a 1x1 pixel. The following pixel/tag parameters must be specified for all DAR tags, 1x1, regardless of implementation type: browser, mobile browser, mobile app or connected device.

{| class="wikitable"
|-
! Tag Parameter
! Description
|-
| CI
| Client ID: the ID that is associated with the DAR account that processed tag data is associated with. Will always be hardcoded to a Nielsen generated value that comes from the Nielsen campaign management system
|- style="background-color:#eff8ef;"
| AM
| Ad Server: an ad server participating on the campaign media-plan. This is an internal Nielsen generated value when the ad server is indicated on the campaign during setup
|-
| CA
| Campaign Id: this is the ID associated with your DAR campaign. Unless you are creating and managing the Nielsen campaign via the DAR Tag API, then this parameter value will always be generated from the Nielsen campaign management system. Note: often maps to a media-plan I/O Id
|- style="background-color:#eff8ef;"
| CR
| Creative Id: DAR does not currently report at the creative level; can be hard coded ad server id or associated with a macro expansion
|-
| PC
| Placement Id: can be generated by the ad server via macro expansion or generated by the Nielsen campaign management system. Note: often maps to one of Ad Unit Id, Line Item Id or Video Ad Id
|- style="background-color:#eff8ef;"
| CE
| Site Id: the Id that identifies a publisher site that the placement needs to be mapped to. Maps into the Nielsen MarketView database. Note: can be hardcoded to a pre-registered ad server site id in the Nielsen system or a macro expansion where more than one pre-existing site ids have been made known to Nielsen
|-
| R
| Cachebuster (web): timestamp / random number. Generated by ad server
|- style="background-color:#eff8ef;"
| AT
| Fixed value: “view”
|-
| RT
| Fixed value: “banner”
|- style="background-color:#eff8ef;"
| ST
| Fixed value: “image”
|}
<blockquote> Do not URL encode the values</blockquote>

== Additional DAR Tag Parameters for Mobile App Audience Measurement ==
In this section, the additional URL parameters required beyond the standard cookie based web-browser tag are described in detail.

For each of the tag examples detailed below, we can support both non-secure (http) and secure (https) flavors. The standard cookie based web-browser tag is included below for reference purposes.

'''Important note:''' the values against each value-pair in the following tags are for illustrative purposes only. Values for CA, PC and CE will vary depending on the specific campaign being measured and capabilities of the Ad server for macro/value expansion. For more detail on the core DAR parameters, please see the '''Nielsen DAR Tag Implementation Guide.'''

'''Web Browser DAR tag (cookie based persons identification)'''
<code> //secure-gl.imrworldwide.com/cgi-bin/m?ci=nlsnci535&am=3&at=view&rt=banner&st=image&ca=nlsn12452&cr=crtve&pc=<creativeid>_plc0001&ce=<siteid>&r=<timestamp> </code>

'''Mobile-App DAR Tag Extension (IFA based persons identification)'''
<code> //secure-gl.imrworldwide.com/cgi-bin/m?ci=nlsnci535&am=3&at=view&rt=banner&st=image&ca=nlsn12452&cr=crtve&pc=<creativeid>_plc0001&ce=<siteid>&c7=osgrp,IOS&c8=devgrp,PHN&c9=devid,XXXX-XX-XXXXX-XXXX &c10=plt,MBL&c12=apv,<appVersion>&c13=asid,NIELSEN-PROVIDEDID&c14=osver,7.0.4&uoo=0&r=<timestamp> </code>

{| class="wikitable"
|- style="font-weight:bold; "
! style="vertical-align:middle;" | Additional DAR Tag Parameters for Mobile
! style="vertical-align:middle;" | Example
! style="vertical-align:middle;" | Description
! style="vertical-align:middle;" | Mandatory parameter for mDAR?
|-
| style="vertical-align:middle;" | &c7
| &c7=osgrp,IOS
| style="vertical-align:middle;" | OS Grouping
| style="vertical-align:middle;" |
|- style="background-color:#eff8ef;"
| &c8
| &c8=devgrp,PHN
| style="vertical-align:middle;" | Device Grouping
| ✔
|-
| style="vertical-align:middle;" | &c9
| &c9=devid,CB6E9220-EA64-440B-9456-33AD2294C658
| style="vertical-align:middle; " | Advertising ID
| ✔
|- style="background-color:#eff8ef;"
| &c10
| &c10=plt,MBL
| Platform
| ✔
|-
| &c12
| &c12=apv,1
| App Version
|
|- style="background-color:#eff8ef;"
| &c13
| c13=asid,DD8136-4F0B-470B-9ACA-231E818D95BC
| AppID (Nielsen assigned App ID)
| | ✔
|-
| &c14
| &c14=osver,15.1.3
| OS Version
|
|- style="background-color:#eff8ef;"
|&uoo
| &uoo=0
| Opt-out indicator
| ✔
|-
|&hem_sha256
|
| SHA256 Hashed Email
|
|- style="background-color:#eff8ef;"
| &hem_unknown
|
| Unknown Hashed Algorithm Email
|
|}

<blockquote>'''Note''': Clients are encouraged to make an effort to always fill-in optional parameters.

'''Note''': Do not URL encode the values.</blockquote>

== C7 - OS Grouping (Optional) ==
Valid device OS Grouping data values are the following literal values:
* osgrp,IOS
* osgrp,DROID
* osgrp,ANDROID
<blockquote>'''Note''': If one of the above values cannot be specific, then the parameter should not be included in the call.</blockquote>

== C8 - Device Grouping (Mandatory)==
Valid literal values for phone, tablet, portable media player (iPod) and unknown are as follows:
* devgrp,PHN - Phone
* devgrp,TAB - Tablet
* devgrp,PMP - Portable Media Player (iPod)
* devgrp,UNWN - Unknown/Unclassified
* devgrp,DSK - Desktop
* devgrp,STV ← CTV/OTT Device
==== Notes ====
* Mandatory for accurate measurement, and if unable to pass, Nielsen cannot guarantee the impression will be classified correctly.
* “UNWN” will result in Nielsen attempting an introspection of the User Agent in the HTTP request sent against Device Atlas for classification.
* “STV” is the default value for OTT when the specific device value isn’t passed.</blockquote>

== C9 - Advertising ID (Mandatory) ==
This is the advertiser ID for the client’s mobile device. IDFA for iOS, Google Advertising ID for Android:
* devid,<IDFA>
* devid,<IFA>
* devid,<Google Advertising ID>
 
{| class="wikitable"
|- style="background-color:#efefef;"
! colspan="2" | Below are the supported hash methods for the devid value:
|- style="vertical-align:bottom;"
| Clear Text
| c9=devid,CB6E9220-EA64-440B-9456-33AD2294C658
|- style="vertical-align:bottom;"
| sha256
| c9=devid,136844f58ab7f7e991ea4b5150ec767c9327e1391c839a3b3612d418ae875391
|- style="vertical-align:bottom;"
| Sha1
| c9=devid,a08039967f4817ada4a7f331369eea522ad415a7
|- style="vertical-align:bottom;"
| md5
| c9=devid,53d8c474c1e871bdd34f14785dbcfd94
|}

==== Notes ====
For Android devices, the Google Advertiser ID should be used as the default and the Android ID as the second option. 

* If C9 is <empty>, upon receiving the ping, the Nielsen collection server will attempt a 302 redirect to the data provider per the regular DAR pixel for browsers.</blockquote>
* As of August 1, 2014, Google is enforcing use of the Advertising ID for advertising and user analytics (http://play.google.com/about/developer-content-policy.html).
<blockquote>'' "Beginning August 1st 2014, all updates and new apps uploaded to the Play Store must use the advertising ID (when available on a device) in lieu of any other device identifiers for any advertising purposes."</blockquote>
* It is preferred that the IDFA or Google Advertising ID be sent as is from the mobile device (“cleartext”). However, if mandated, we will support SHA256 hashed values with no-salt. Passing a hashed value (and/or salting) using any other standard will result in a failed match by the data provider upon receiving the ping. In turn, this results in impressions surfacing in the DAR unmeasurable audience totals. Please contact Nielsen if you anticipate a large percentage of hashed values coming in from your publisher clients.

=== Privacy, Ad Tracking, and Ad Targeting ===
In newer iterations of the iOS and Android device operating systems, a facility exists allowing users to “opt-out” of “Ad Tracking”. It is Nielsen’s interpretation that this setting is primarily designed to allow users to specify opt-out of Ad Targeting rather than Ad Measurement. DAR
does not provide Ad Targeting data.

However, it is also Nielsen’s position that the publisher or Ad network should provide a mechanism to also allow a user to opt-out of Ad Measurement. The Nielsen SDK will honor the Nielsen Ad Measurement opt-out settings configurable @ http://www.nielsen.com/us/en/campaigns/privacy-policy-opt-out.html.

However if the integration approach described in this document is being used instead of the Nielsen SDK then '''YOU''' as the publisher or Ad network must provide a capability to opt-out of Ad Measurement as the configuration on www.nielsen.com will not be detectable. You may
elect to interpret the iOS / Android “Ad Tracking” setting for the purpose of limit Ad measurement or provide a separate discreet mechanism to allow a user to opt-out of Ad measurement.

Please see '''&uoo''' later in this document for implementation details of the optout indicator.

For additional clarification on privacy policy, please contact your Nielsen representative.

== C10 - Platform (Mandatory) ==
To determine this value, Nielsen suggests that the ad network leverage user agent information to determine if the client device is either a mobile or desktop device.

Valid literal values for mobile and desktop data values are as follows:
* plt,MBL
* plt,DSK
* plt,OTT
==== Notes ====
* Mandatory for accurate measurement, and if unable to pass, Nielsen cannot guarantee the impression will be classified correctly.
* Omitting c10, or a value in c10, will result in Nielsen attempting an introspection of the User Agent in the HTTP request sent against Device Atlas for classification.
* “OTT” (Connective Devices) is a valid value that is populated by participating vendors (Amazon, Hulu and Roku). Non-participating vendors will be unmeasurable volumetric metric only.

== C12 - App Version (Optional) ==
This is the version of the ad network system software or SDK that is implemented in this extension. Although this field is not required, this feature can be useful for troubleshooting purposes following deployment.
* apv,<N.N>

== C13 - AppID ==
This Nielsen provided ID is unique to the ad network and is required for certification.
* asid,<NNNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN>
An App ID will be provided for testing. A separate App ID will be provided for production use. Please request from your Nielsen representative.
<blockquote>'''Note''': If you are a publisher leveraging the non-SDK solution, you will be provided with a unique App ID for each combination of app and device OS type.</blockquote>

== C14 - OS Version (Optional) ==
Operating system version
* osver,<OS Version>
Example: for iOS -> 7.0.4

== UOO - Opt Out ==
Opt-out parameter
* <Boolean state>
<Boolean state> is a Boolean representation of whether the user is opting out or not.

The absence of uoo in the tag is interpreted as an implicit opt-in. i.e. not opting out.

The following pairings of opt-out are supported. '''Important:''' you must choose one set of paired values only and inform your Nielsen representative.
{| class="wikitable"
|-
! Opt-out !! Opt-in
|-
| uoo=true || uoo=false
|-
| uoo=1 || uoo=0
|-
| uoo=yes || uoo=no
|}
<blockquote>'''Note''': if your Ad server is not capable os supporting the discrete &uoo parameter then you can set the c9 value to <code>devid,optout</code> (for example <code>…&c8=PHN&c9=devid,optout&c10=MBL…</code>)</blockquote>
== Additional Parameters ==
This section describes several important additional parameters that the DAR tag can support, specifically Hashed Email, and UID2 values. Please note that all parameters are case-sensitive.

Please work with your Nielsen Technical Account Manager to decide which of the following parameters to append to the standard DAR tag.
=== HEM Support (Hashed Email) ===
Please use the parameter that matches your hashing algorithm. For example, if you are using sha256 to encode the email address, then use hem_sha256={encrypted_value_here}
{| class="wikitable" style="font-weight:bold; background-color:#EAECF0;"
|-
! Name
! Description
! Available Tag Parameters
|- style="font-weight:normal; background-color:#F8F9FA;"
| Hashed Email
| User’s email address that has been run through the sha256 hashing algorithm to create a unique hexadecimal string. If a client is unable to determine hashing type, they should pass using &hem_unknown parameter.
| &hem_unknown &hem_sha256 
|}
{| class="wikitable" style="font-weight:bold;"
|- style="background-color:#dae8fc; color:#002041;"
! Example
|- style="font-weight:normal;"
| hem_sha256=tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=
|}

=== Unified ID ===
{| class="wikitable" style="background-color:#F8F9FA;"
|- style="font-weight:bold; background-color:#EAECF0;"
! Name
! Description
! Available Tag Parameters
|-
| Unified ID 2.0
| An identifier based on a user’s verifiable PII (e.g. hashed email). UID2.0 was initially created by The Trade Desk (TTD) and is now managed by Prebid.
| &uid2
|-
| Unified ID 2.0 Token
| Encrypted Unified ID 2.0
| &uid_token
|}
{| class="wikitable" style="font-weight:bold;"
|- style="background-color:#32BBB9; color:#002041;"
! Example
|- style="font-weight:normal;"
| uid2=MTKVpUAzwYAPnHrtfE0wlINOMzhU7UUEjjVdCdRu63k= uid_token=AgAAAAPFR0zA5ogv/yaAPiUsAdZPsfqS8QlDSGxAB+rr8yekFs3AjLYVk5qqqiyV2XHbSuwzHmxSlLeQeKQI1mp015jsNnpX5 /xGgXldcgVz+gFnyh3T8/3agMwRmyrhCxG4oH2C7fc48AQk2eotE7FW0ZDEYM8fD9ZxDaxFUC/OV3OuZA&
|}

== Server-Side Tag Dispatch ==
The standard way of triggering a Digital Ad Ratings (DAR) tag on Mobile-App is for the publisher app to trigger (either directly or via Ad server) the tag upon Ad exposure to the user. i.e. a client-side initiated tag.

It is important to note that MRC/IAB measurement standards stipulate that the Ad exposure event still be initiated and recorded from the client-side, even if the Ad measurement tag (in this case a DAR tag) is physically initiated from the server-side. Evidence may be required (publisher log file or similar) from the MRC/IAB that the user was exposed to the Ad creative on their device.

The following additional changes to the standard mobile-app DAR tag are required to support dispatch the DAR tag from a '''server-side''' publisher ad server:

#'''X-Forwarded-For (XFF) IP:''' The original client IP address must be passed in the X-Forwarded-For (XFF) HTTP header field. When the impression is fired directly from the Ad Server, the XReal-IP will be the Ad Server IP.
#'''Cachebuster:''' Already present in the DAR tag, this now becomes mandatory. A cachebuster or random number ensures a new call is made to the Ad Server. By including a cachebuster ('r' parameter), the tag will not be cached. The timestamp of when the Ad was served can be used.
#'''User Agent (UA):''' The HTTP UA from the client device should be used to populate the HTTP UA in the server-server connection/ping.
#'''TLS:''' the tag received by Nielsen must be TLS v1.2 compliant or greater.

==== Important notes ====
* the current iteration of server-server tag collection only supports mobile-app (IFA and AAID) and will NOT support cookie based audience measurement.
* The client’s server-server setup that is going to trigger/send the DAR tag should suppress any Nielsen cookie returned by the Nielsen collection server as a result of the first DAR tag received. If the Nielsen cookie (returned upon receiving the first DAR tag into secure.imrworldwide.com) is not suppressed then invalid traffic (IVT) filtration will quickly be triggered upon receiving the 2nd and nth tag.

== Appendix A: Example Implementation ==
In the below examples, you will see the overall DAR flow (Figure 1) and a detailed illustrative Ad Request / Response model (Figure 2).

<div align="center">'''Figure 1 – End to End Data Flow'''</div>

[[File:mDAR_Dataflow.png|center|link=]]

Nielsen certified publishers and platforms will append the new parameters (below) with the appropriate URL safe values passed to Nielsen’s current DAR tag. The current DAR tag should be acquired using the existing processes for each campaign/placement.

<blockquote><code>'''&c7'''=osgrp,IOS'''&c8'''=devgrp,PHN'''&c9'''=devid,XXXX-XX-XXXXXXXXX'''&c10'''=plt,MBL'''&c12'''=apv,AppVersion'''&c13'''=asid,XXXX-XX-XXXX-XXXX</code></blockquote>

<div align="center">'''Figure 2 – Illustrative Ad Request / Ad Response'''</div>

[[File:ad_response.png|center|link=]]

The above is an example of how an Ad server is supporting the build of mobile DAR tags for its publisher clients.
*Step 2 in Figure 1 is a summary of steps 1 and 2 in Figure 2 above.
*Steps 3 and 4 in Figure 1 is a summary of steps 3 through 9 in Figure 2 above.

== Appendix B: Implementation, Testing & Certification ==
Once you have integrated the ping per the above specs, Nielsen requires you to pass through a one-time certification before traffic can be accepted into the production environment.

The overall process is:
* Valid DAR contract or NDA is in place.
* Kick-off meeting with Nielsen onboarding team.
* Confirm meet minimums testing requirements:
** Host Ad/Tag for in-app delivery
** Can pass opt-out back to Nielsen
** Can pass Device ID in cleartext or SHA-256
* Nielsen provides the mDAR testing form that includes the test App ID and the test tag
* Identify the live campaigns for initial testing and run the test tag; suggest 5,000-10,000 impressions.
* Nielsen validates the data received from the test and confirms the initial test successful and provides the production App ID.
* Ensure contracts are in place for external test campaign with Nielsen Client Service team.
* Identify another live campaigns for production testing with production tag and app ID.
* Nielsen validates the data received from the final test and confirms certification for any DAR countries tested.
==== Goals ====
* To test in full DAR E2E environment, receive matches from data provider for demographics and correct identification of mobile impressions.
* To test that all minimum requirements in step 3 are passed to Nielsen with no issues.
* To test in a full DAR end-to-end environment, receive matches from data providers for demographics and correct identification of mobile impressions.

2023-05-26T23:32:40Z

Admin: /* Parameter listing */

{{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: 11%;" | Param Name
! style="width: 9%;" | Legacy Parameter Name
! style="width: 30%;" | 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>


|-
| 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. || ✔ required for publishers || ✔ required for publishers || <code>ed36968977606872e4312943c218568123786342</code>



|-
| publisher_name || pub || This is a Nielsen-supplied value representing the publisher of the content where the ad was served. || ✔ || ✔ 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). || || ✔ required for providers || <code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
| provider_name || prov || Name of the provider supplying the data to Nielsen. || || ✔ 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>
|-


| 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>

|-
| 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

DAR Paramater Reference

2023-05-26T23:32:22Z

Admin: /* Parameter listing */

{{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: 11%;" | Param Name
! style="width: 7%;" | Legacy Parameter Name
! style="width: 30%;" | 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>


|-
| 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. || ✔ required for publishers || ✔ required for publishers || <code>ed36968977606872e4312943c218568123786342</code>



|-
| publisher_name || pub || This is a Nielsen-supplied value representing the publisher of the content where the ad was served. || ✔ || ✔ 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). || || ✔ required for providers || <code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
| provider_name || prov || Name of the provider supplying the data to Nielsen. || || ✔ 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>
|-


| 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>

|-
| 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