Engineering Client Portal - User contributions [en]

Digital Measurement SEI Ad Exposure

2025-06-05T19:39:28Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Nielsen Media Impact (NMI), Add Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''<code>dar</code>'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Optional for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="2" |timestamp
|Time impression occurred
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-06-05T19:38:56Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Nielsen Media Impact (NMI), Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric

Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Optional for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|Example: <code>501</code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-06-04T17:44:20Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''<code>dar</code>'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Optional for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="2" |timestamp
|Time impression occurred
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-06-04T17:43:49Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric

Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Optional for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|Example: <code>501</code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-05-30T18:16:49Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''<code>dar</code>'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="2" |timestamp
|Time impression occurred
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-30T18:10:43Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric

Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|Example: <code>501</code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-05-29T20:38:50Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''<code>dar</code>'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="2" |timestamp
|Time impression occurred
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-05-22T17:21:46Z

Admin: /* S3 Bucket and Prefix Naming Convention */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''<code>dar</code>'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

DAR Tag Implementation Guide

2025-05-20T20:39:32Z

Admin:

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

= Introduction =

This document provides an overview of the Nielsen Digital Ad Ratings (DAR) Tags and the steps necessary to implement them as part of your digital advertising campaigns.
=== What is DAR ===
DAR is a measurement platform for digital advertising campaigns. The platform provides a clear view of the true audience of a campaign, including Reach, Frequency, and GRP statistics by audience demographic group.
=== What we measure===
All DAR tags allow you to measure campaign impressions and the DAR JavaScript tags measure ad viewability, GIVT (General Invalid Traffic), and SIVT (Sophisticated Invalid Traffic) across platforms including web, mobile, and in-app.
=== How we measure it===
Nielsen’s DAR suite of JavaScript tags together with a pixel tag fallback will be present in your ad placements. We utilize industry-standard APIs to perform measurement cross-browser and cross-platform. In most cases, you will only need to add a simple URL through your ad management interface to fully utilize DAR measurement in your campaigns.
=== Prerequisites ===
For steps outlined in this document, you should have access to Nielsen’s Campaign Management Interface (CMI) and a Nielsen Technical Account Manager (TAM) will be working with you during the implementation phase.
__TOC__
= DAR Measurement Types =

== DAR Display==

The DAR Display JavaScript tag reports ad impressions as well as measures ad viewability and SIVT. In standard web placements, it will find the ad unit in the surrounding DOM container and will then report viewability as a time series with a 1-second resolution.

The DAR tag will report the MRC-required minimum of 1 second on screen and a continuous viewability time series for the lifetime of the ad session to enable additional viewability qualifiers.

The tag can utilize the IAB’s [https://iabtechlab.com/standards/open-measurement-sdk/ '''Open Measurement SDK'''] (OM SDK) including [https://iabtechlab.com/blog/open-measurement-for-web-video-arrives/ '''OM Web'''] integration if the OM Interface Definition (OMID) is available, or it will use industry-standard web APIs to measure viewability.

=== Requirements ===

The DAR Display tag requires a JavaScript-enabled browser for web environments or the OM SDK for in-app to operate and should be placed close to the corresponding measured ad unit. It should be on the same DOM level (e.g. directly under the same parent) or in a child node under the same parent node. The ad unit should be a content-bearing DOM element (e.g. img, canvas, SVG, iframe, div) with a minimum size of 30x30 pixels.

=== Parameters ===

The minimum required DAR parameters are '''ca, ci, cr, pc, ce''' and '''am'''. See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

=== Example Tag ===
<syntaxhighlight lang="javascript">
<script type="text/javascript"
src="https://dar.imrworldwide.com/js/dar.js?ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}&am={ad-server-code}">
</script>
</syntaxhighlight>

=== Example OMID Display Placement ===

DAR can be enabled through the OM SDK by passing the required Nielsen OM inputs listed in the table below during setup:

{| class="wikitable"
|-
! style="width: 20%" | OM Parameter
! style="width: 40%" | Description
! style="width: 40%" | Nielsen Value
! style="width: 5%" |Required
|-
| Verification Vendor
| Vendor key for measurement provider
| nielsen.com-omid
| ✔
|-
| JavaScriptResource
| URL for measurement provider’s verification script
|<syntaxhighlight lang="html">https://dar.imrworldwide.com/js/dar.js</syntaxhighlight>
| ✔
|-
| VerificationParameters
| Measurement provider’s verification tag parameters
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" |<syntaxhighlight lang="html">ca={campaign-id}&cr={creative-id}&ce={site-id}&ci=
{client-id}&pc={placement-id}&am={ad-server-id}</syntaxhighlight>
| ✔
|-
| Tracking Event verificationNotExecuted
| Error URL when the ad player denies measurement script execution
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" | <syntaxhighlight lang="html">https://events.imrworldwide.com/er?ercd=8800&erms=verificationNotExecuted-
{reason}&ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc
={placement-id}&am={ad-server-id}&c13={asid,app_id}</syntaxhighlight>
|

|}

<blockquote>
Note: The verificationNotExecuted Error URL is recommended for better troubleshooting during campaign setup. If your system can provide a macro for the reason of the interrupted measurement session, it can be added in place of the {reason} placeholder in the error URL. This can be an error code or a clear text error message.</blockquote>

=== Expected Display Ad Session Pings ===
{| class="wikitable"

! '''Description'''
! '''Timing'''
! '''Path'''
|-
| DAR Main Ping
| At initial load
| secure-gl.imrworldwide.com/cgi-bin/m
|-
| Nielsen Measure Ping
| Measurement start
| events.imrworldwide.com/nmp
|-
| Primary Standard Ping
| After 1 second of viewable duration (may not occur based on MRC rules)
| events.imrworldwide.com/psp
|-
| Timed Pings
| At 1, 5, 15 and 120 seconds of ad session time (may not occur based on ad session length)
| events.imrworldwide.com/1sp, 5sp, 15sp, 120sp
|-
| Final Ping
| At window/tab unloading event
| events.imrworldwide.com/fp
|-
| Error Ping
| Potential integration error - please contact your Nielsen representative
| events.imrworldwide.com/er
|}

=== Ping Flow ===

This flow illustrates the behavior of the DAR Display tag. 

[[File:Screenshot 2022-06-22 152646.png]]

{| class="wikitable"
|-
! colspan="2" | Ping Flow Legend
|-
| 1SP, 5SP, 15SP, 120SP
| Timed Measure Ping at 1, 5, 15 and 120 seconds
|-
| D0, D1, D2
| Dynamic SIVT Pings at 1, 15 & 30 seconds
|-
| FP
| Final Ping
|-
| IMPID
| Unique Impression ID
|-
| NMP
| Nielsen Main Measure Ping
|-
| PSP
| Primary Standard Ping
|-
| SIVT
| Sophisticated Invalid Traffic
|}

== DAR Video ==

The DAR Video tag will typically be trafficked as part of a Video Ad Serving Template (VAST) file. Nielsen provides its wrapped video tag (vWrap) to make this type of deployment easy and consistent across the various ad servers and trafficking options. Nielsen’s vWrap tag supports both automatic OMID and VPAID integration with existing VAST files. The two sections below, [[#Wrapped_Video_Tag_.28vWrap.29_Deployment|'''Wrapped Video Tag''']] and [[#Video_JS_Tag|'''Video JS Tag''']], describe these options and their expected outcomes.

In addition, Nielsen supports '''direct DAR Video tag deployments''' with manual integration in existing workflows. In this case, the section [[#video-js-tag|'''Video JS Tag''']] below describes the basic setup and expected results. In addition, it is recommended that you work closely with your Nielsen Technical Account Manager if you consider a manual tag integration with your campaigns.

=== Wrapped Video Tag (vWrap) Deployment ===

Nielsen’s wrapped DAR video tag, vWrap, is the preferred delivery method for VAST-controlled video ad placements.The vWrap tag is served by a Nielsen service that takes an original VAST with an inline ad (not a wrapper redirect) and dynamically adds the DAR Video tag with measurement solutions for VPAID and OMID. The '''apiframework''' parameter can be used to control which measurement solution will be inserted (see below).

=== Parameters ===

The minimum required DAR parameters are '''ca, ci, ce, cr, pc''', '''am, apiframework''' and '''vastURL'''. See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

The Open Real Time Bidding ([https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf '''OpenRTB''']) API framework values for identifying the ad inventory type should be passed in the Nielsen '''apiframework''' parameter. The values should be either 1 or 2 (VPAID) or 7 or 8 (OMID). The available API framework values are listed in the IAB’s [https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks- '''AdCOM specification 1.0''']. If the parameter is left blank or set to 0, Wrap will add the DAR Video tag as '''both''' an OMID verification client and VPAID wrapper. See more details in the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']].

The '''vastURL''' parameter must be the last parameter on the DAR tag with its value set as the full URL (including all original parameters) of the original VAST tag for the ad placement.

=== Example Wrapped Video Tag (vWrap) ===
{| class="wikitable" style="font-family:'Courier New', Courier, monospace !important;"
|-
! <syntaxhighlight lang="html"> https://vwrap.imrworldwide.com/v1/wrap?ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}
&am={ad-server-id}&c9={devid,Advertising_ID}&c13=asid,app_id}&apiframework={APIFRAMEWORK}&vastURL={ORIGINAL_VAST_URL}</syntaxhighlight>
|}
<blockquote>
To observe how vWrap operates, we have provided some example VAST URLs which you can load directly in your browser.
</blockquote>
==== VAST ad Unit, no Impression/Viewability ====
First, here is a VAST ad unit with a single video file and no impression tracking or viewability measurement:
{| class="wikitable"
|-
! https://dartag.info/vast-examples/example_video_only_nielsen_15s.xml
|}
==== VAST ad Unit, Nielsen vWrap for OMID measurement ====
This is the same VAST file loaded via Nielsen’s vWrap tag for '''OMID measurement''' (apiframework is set to 7):
{| class="wikitable"
|-
! https://vwrap.imrworldwide.com/v1/wrap?ca=nlsn305255&cr=nielsenomidtest&ce=nielsen&pc=vastomid&ci=nlsntest&am=4&apiframework=7&vastURL=http://dartag.info/vast-examples/example_video_only_nielsen_15s.xml
|}

==== VAST ad Unit, Nielsen vWrap for VPAID measurement ====
And here is the same VAST with the vWrap tag configured for '''VPAID measurement''' (apiframework is set to 2):
{| class="wikitable"
|-
!https://vwrap.imrworldwide.com/v1/wrap?ca=nlsn305255&cr=nielsenomidtest&ce=nielsen&pc=vastvpaid&ci=nlsntest&am=4&apiframework=2&vastURL=http://dartag.info/vast-examples/example_video_only_nielsen_15s.xml
|}

=== Video JS Tag ===

The DAR Video tag supports both OM SDK and VPAID video ad measurement and provides viewability time series, audio volume time series, GIVT, and SIVT data. The time series contains playhead events with corresponding measurements at a 1-second resolution. In addition to the time series, a dedicated ping will report on the MRC-required minimum of 2 seconds on screen.

With OM SDK, the DAR Video tag supports the following ad types:

* Native mobile in-app ad placements
* Mobile web ads
* OM Web placements
* OMID-enabled streaming video players with ad SDKs (for instance DAI IMA SDK)

With VPAID, it supports the following operating modes:
* As VPAID wrapper for an existing VPAID ad unit in the VAST
* As VPAID ad unit in a VAST with video files and AdParameters node
* In Custom Integrations with VPAID host players

In most cases, the DAR Video tag should not be manually implemented as a wrapper, instead consider utilizing Nielsen’s vWrap tag.

==== Requirements ====

The DAR Video tag needs a JavaScript environment to operate. The video unit to be measured needs to have a size of at least 30x30 pixels. The DAR Video tag requires access to the VPAID ad unit or to an OM SDK API present in the JavaScript context.

==== Parameters ====

The minimum required DAR parameters are '''ca, ci, ce, cr, pc''' and '''am'''. For VPAID wrapper placements, '''vpaidURL''' is also required.

To comply with MRC guidelines, you will be required to append '''autop''' to indicate click-to-play vs auto-play.

If the DAR Video tag will act as the VPAID wrapper, '''vpaidURL''' has to be the tag’s last parameter and its value set to the full URL (including parameters) of the original VPAID ad unit.

See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

==== Expected Video Ad Session Pings ====

{| class="wikitable"
! '''Description'''
! '''Timing'''
! '''Path'''
|-
| DAR Main Ping
| At initial load
| secure-gl.imrworldwide.com/cgi-bin/m
|-
| Nielsen Measure Ping
| Measurement start
| events.imrworldwide.com/nmp
|-
| Primary Standard Ping
| After 2 seconds of viewable duration (may not occur based on MRC rules)
| events.imrworldwide.com/psp
|-
| Quarterly Ping
| At 25%, 50%, 75% and 100% of video progress
| events.imrworldwide.com/qp
|-
| Final Ping
| At video stop or window/tab unloading event
| events.imrworldwide.com/fp
|-
| Error Ping
| Potential integration error - please contact your Nielsen representative
| events.imrworldwide.com/er
|}

==== Ping Flow ====

This flow illustrates the behavior of the DAR Video tag if the impression pixel is part of the VAST to be sent by the ad player and the JS tag has '''&darsup=1'''. The parameter, <code>darsup=1</code>, is used to suppress the DAR Main Ping from being sent from the JS tag since the DAR main ping will be sent from the DAR impression pixel. This is the default setup if Nielsen’s vWrap tag is being used to set up the video campaign.

[[File:Screenshot 2022-06-22 2.png]]
{| class="wikitable"
|-
! colspan="2" | Ping Flow Legend
|-
| D0, D1, D2
| Dynamic SIVT Pings at 1, 15 & 30 seconds
|-
| FP
| Final Ping
|-
| IMPID
| Unique Impression ID
|-
| NMP
| Nielsen Main Measure Ping
|-
| PSP
| Primary Standard Ping
|-
| QP
|Quarterly Media Pings at 25%, 50%, 75% and 100%
|-
| SIVT
| Sophisticated Invalid Traffic
|}

==== Example OMID Video Placement ====

DAR can be enabled through the OM SDK by passing the required Nielsen OM inputs listed in the table in the VAST <adVerifications> node:

{| class="wikitable"
! '''OM Parameter'''
! '''Description'''
! '''Nielsen Value'''
! '''Required'''
|-
| Verification Vendor
| Vendor key for measurement provider
| nielsen.com-omid
| ✔
|-
| JavaScriptResource
| URL for measurement provider’s verification script
| <syntaxhighlight lang="html">https://dar.imrworldwide.com/js/darvideo.js</syntaxhighlight>
| ✔
|-
| VerificationParameters
| Measurement provider’s verification tag parameters
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" |<syntaxhighlight lang="html">ca={campaign-id}&cr={creative-id}&ce={site-id}&ci=
{client-id}&pc={placement-id}&am={ad-server-id}</syntaxhighlight>
| ✔
|-
| Verification Not Executed URL
| Error URL when the ad player denies measurement script execution
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" | <syntaxhighlight lang="html">https://events.imrworldwide.com/er?ercd=8800&erms=verificationNotExecuted-
{reason}&ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}
&pc={placement-id}&am={ad-server-id}&c9={devid,Advertising_ID}&c13={asid,app_id}</syntaxhighlight>
|

|}
<blockquote>
Note: The verificationNotExecuted Error URL is recommended for better troubleshooting during campaign setup. If your system can provide a macro for the reason of the interrupted measurement session, it can be added in place of the {reason} placeholder in the error URL. This can be an error code or a clear text error message.
</blockquote>

==== Example VPAID Placement in VAST ====

A typical VAST placement with VPAID will contain an impression pixel, the DAR Video JS tag as MediaFile of type “VPAID”, and the video MediaFiles will be duplicated as AdParameters object. In the example below, there was no original VPAID ad unit (the original VAST only contained MP4 video files), so the &vpaidURL parameter on the DAR JS tag stays empty.

In this example, the DAR JavaScript tag will operate as the VPAID ad unit and will play an appropriate media file from the list contained in the AdParameters node.

<syntaxhighlight lang="json">
...
<Impression id="Nielsen Digital Ad Ratings">
<![CDATA[https://secure-enc.imrworldwide.com/cgi-bin/m?at=view&cy=2&rt=banner&src=njs&
st=image&tpv=vwrap&ca=nlsnXXXXXX&cr={AD.ID}&ce=publisherXXXX&ci=nlsnciXXXX&pc=placementID_XXXX1&am=3]]>
</Impression>
...
<MediaFiles>
<MediaFile apiFramework="VPAID" type="application/javascript">
<![CDATA[https://dar.imrworldwide.com/js/darvideo.js?darsup=1&ca=nlsnXXXXXX&cr={{AD.ID}}&
ce=publisherXXXX&ci=nlsnciXXXX&pc=placementID_XXXX1&am=3]]>
</MediaFile>
<MediaFile bitrate="720" delivery="progressive" height="480" id="XXXXXX"
maintainAspectRatio="true" scalable="true" type="video/mp4"
width="854"><![CDATA[https://XXXXX.net/XXXXXX.mp4]]>
</MediaFile>
</MediaFiles>
...
<AdParameters>
<![CDATA[{"mediaFiles":[{"bitrate":"720","uri":"https://XXXXX.net/XXXXXX.mp4","height":"480","scalable":"true",
"id":"XXXXXX","type":"video/mp4","maintainAspectRatio":"true","delivery":"progressive","width":"854"}]]>
</AdParameters>
</syntaxhighlight>

==== Server-Side Integration ====

If you are interested in implementing the DAR tags server-side, e.g. through SSAI, please contact your Nielsen TAM to provide you with the required guidelines.

==== Notes ====

Manual placement of the DAR Video tag is only recommended in situations where the DAR vWrap tag can not be utilized, like in certain mobile in-app ad placements or in scenarios where DAR Video needs to be configured as OMID viewability measurement solution.

== Pixel Tag==

The DAR Impression pixel provides basic campaign impression counts and allows to cover placements served in environments where the DAR JavaScript tag is not supported.

=== Environment ===

The DAR pixel tag should only be used in environments where the DAR JavaScript tag cannot be utilized such as restricted CTV environments, for SSAI Server-Side Beaconing, and other situations where an adequate JavaScript environment is not available.

=== Parameters ===

The minimum required DAR parameters are '''ca, ci, ce, cr, pc''', and '''am''' along with fixed valued params, '''at=view''', '''rt=banner''' and '''st=image''' . See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

=== Example Tag ===
<syntaxhighlight lang="html">
<img src="https://secure-gl.imrworldwide.com/cgi-bin/m?ca=nlsnXXXXXX&cr=crtve
&ce={PUBLISHER.ID}&pc=PLACEMENT.ID}&nlsnciXXXX&am=3&at=view&rt=banner&st=image
&cy=0&r=[timestamp]" style="display:none"/>
</syntaxhighlight>

= Tag Integration =
A successful tag integration will require you to go through the following 6 steps.
== Step 1: Determine Your Campaign Needs==
To receive optimal results from DAR measurement, it is good practice to consider the technical requirements of different sites and placements. Please share your media plan with your Technical Account Manager before launch.

Specifically, be on the lookout for placements that might span across web and mobile ad inventory and make sure if all of the in-app placements support OMID. Also, some placement types may need manual setup and cannot be automated or may need extra time for setup and testing.

Please reach out to your Nielsen Technical Account Manager (TAM) for advice if the technical requirements for your campaign are not clear.
== Step 2: Generate Tags==
Your Nielsen representative will walk you through the Campaign Management Interface (CMI) so that you can generate DAR tags for your campaigns at any time.

Nielsen supports macro-based tag generation for several major ad servers. Nielsen’s Technical Account Managers can assist you with any technical questions on tagging campaigns for DAR measurement.
== Step 3: Campaign Integration==
Your Nielsen tags created in CMI will need to be included when you traffic your ad campaigns. Please reach out to your Nielsen TAM for additional guidance and assistance.
== Step 4: Test the Tag Implementation==
Depending on the complexity of the integration, you may be working closely with a TAM at this point or are performing a self-guided tag implementation based on the CMI output.

If working with a TAM, they will coordinate a plan to test the tag implementation ahead of the campaign go-live date. Depending on your campaign needs, testing will involve either running a diagnostic campaign to validate tagging setup or reviewing test pages or apps.

In case of a self-guided tag implementation, we recommend to verify and compare the impression counts in the CMI with your planned campaign volume or ad server reports during the first hours of the campaign. If there are any unexpected impression counts, please reach out to your Nielsen TAM.
== Step 5: Share your Ad Server Report==

=== Why the Ad Server Report is Needed ===

Knowing the delivered impressions helps Nielsen run Discrepancy Checks ensuring overall quality and reduces errors in the tagging process.

Nielsen can provide the client with a template with the inputs required to complete the quality checks.

=== How to Share Your Delivered impressions ===

Set up an automated daily report from your ad server containing Site Name, Site ID, Placement Name, Placement ID, and data date.

A secondary method to share your media plan information is to grant Nielsen “Reporting access” to your campaign in the designated ad server (such as DCM). To do this, simply grant the login '''clientreporting@nielsen.com''' access. In doing so Nielsen can directly access your media plan information, which enables us to check for updates, and reconcile any discrepancies.

== Step 6: Monitoring Your Campaign==
Nielsen recommends all clients participate in Discrepancy Checks. Nielsen’s team will verify that the tags delivered have begun to receive data once the campaign goes live and will regularly (typically every 7-14 days) compare the Nielsen reporting to your 3rd party or publisher reporting to ensure we are capturing all data across all placements, as expected, and that the discrepancy gap between your reporting and the Nielsen reporting is kept to a minimum.

= Appendix =
== Tag Parameters==
All passthrough parameters will appear on the JavaScript-generated DAR impression ping.
{| class="wikitable" style="background-color:#FFF;"
|- style="font-weight:bold; background-color:#EAECF0; color:#222;"
! Query Parameter
! Description
! style="text-align:center;" | Required
! style="text-align:center;" | Pass-through
|- style="font-weight:bold; text-align:center; vertical-align:middle; background-color:#FFEBD3; color:#222;"
| colspan="4" | Group 1 - Required Parameters
|- style="vertical-align:middle; color:#222;"
| ca
| Campaign ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| pc
| Placement ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| ci
| Client ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| am
| Ad server ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="color:#222;"
| ce
| Site ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="background-color:#F4F5F7; color:#222;"
| cr
| Creative ID
| style="text-align:center; background-color:#EFEFEF;" | X
| style="text-align:center;" | X
|- style="font-weight:bold; text-align:center; vertical-align:middle; background-color:#FFEBD3; color:#222;"
| colspan="4" | Group 2 - Use Case Specific Parameters
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| at
| Fixed Value "view" (Nielsen value, JS tags add this to DAR and NMP pings)
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; color:#222;"
| st
| Fixed Value "image" (Nielsen value, JS tags add this to DAR and NMP pings)
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| rt
| Fixed Value "banner" (Nielsen value, JS tags add this to DAR and NMP pings)
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; color:#222;"
| r
| Cachebuster/Timestamp. It's required in the pixel tags with a hardcoded value as a default or a macro (r=timestamp/macro) .
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| cy
| Creative type (1: display/2: video) JS tags add this to DAR and NMP pings for In-House Viewability. When parameter is not present or value is missing on pixel tags, there will be no creative type breakout. 
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; color:#222;"
| '''[[DAR_Tag_Implementation_Guide#vWrap_apiframework_Values|apiframework]]'''
| IAB-defined value designating the measurement method See vWrap apiframework values
| style="text-align:center;" | vWrap only
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| autof
| Video only: Auto refresh (1 for auto refresh, leave empty otherwise)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| autop
| Video only: Autoplay (1 for auto-play, 2 for click-to-play, leave empty otherwise)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c7
| OS Grouping c7=osgrp,IOS c7=osgrp,DROID c7=osgrp,ANDROID
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c8
| Device Grouping c8=devgrp,DSK (computers) c8=devgrp,PHN (mobile phone devices) c8=devgrp,TAB (mobile tablet devices) c8=devgrp,PMP (portable media player) c8=devgrp,UNWN (unknown mobile devices)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c9
| Mobile Advertising ID c9=devid,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c10
| Platform c10=plt,DSK (Computer) c10=plt,MBL (Mobile) c10=plt,OTT (Connected Device)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c12
| App Version c12=apv,xxx
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c13
| Nielsen Assigned App ID Example: c13=asid,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c14
| OS Version c14=osver,xxx
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c68
| Mobile App Bundle ID c68=bndlid,xxxxxxxxxxxxxx References: https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids https://developer.android.com/studio/build/configure-app-module#set_the_application_id
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| C78
| Custom Integration Flag (please note: this is the only uppercase parameter name)
| style="text-align:center;" | some vendors
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| darsup
| If present suppress DAR main ping originating from JS tag (value can be 0 or 1, same effect)
|
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| forceid
| If present provides impid, can be overwritten by impid parameter
|
| style="text-align:center;" | X (as impid)
|- style="vertical-align:middle; color:#222;"
| impid
| Same as forceid, but higher priority in case both are present
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| frcd
| Video only: Forced duration (seconds/null)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| frcf
| Video only: Forced ad flag (yes/no/null)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| ptraf
| Video only: Purchased traffic
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| contplay
| Video only: Continuous play
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| gdpr
| GDPR flag to indicate whether GDPR is applicable: 0 - GDPR does not apply 1 - GDPR applies
| style="text-align:center;" | in some jurisdictions
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| gdpr_consent
| URL-safe base64-encoded Transparency & Consent (TC) string for identifying user's privacy preferences
| style="text-align:center;" | in some jurisdictions
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| hem_sha256
| Hashed email
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| hem_unknown
| Hashed email
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| mode
| VPAID video only, optional: Custom Direct Access mode ("w" wrapper / "c" custom; defaults to wrapper)
|
|
|- style="vertical-align:middle; color:#222;"
| onload
| VPAID video only, optional: JS callback for Custom Direct Access VPAID integration
|
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| pub
| Publisher Name
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| pubid
| Publisher ID
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| si
| Site identifier. Canonical URL of the content where the Ad creative is served. The parameter value has to be encoded with encodeURIComponent() method or equivalent.
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| uid2
| Unified ID 2.0
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| uid2_token
| Unified ID 2.0 token
|
| style="text-align:center;" | X
|-
|fp_id
|Publisher provided unique identifier for users
|
|
|- style="vertical-align:middle; color:#222;"
| uoo
| User opt out
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="font-weight:bold; text-align:center; vertical-align:middle; background-color:#FFEBD3; color:#222;"
| colspan="4" | Group 3 - Parameters With Required Position in URL
|- style="vertical-align:middle; background-color:#ffffff; color:#222;"
| vpaidURL
| VPAID Video only: Always the last parameter for video tags. Either VPAID ad unit URL to be wrapped or empty. If empty, DAR tag will use its own vpaidplayer.js
| style="text-align:center;" | VPAID video tag only
|
|- style="background-color:#f4f5f7;"
| style="vertical-align:middle; color:#222;" | vastURL
| style="vertical-align:middle; color:#222;" | vWrap Tag only: Always the last parameter for the vWrap tag. It must contain the URL of the original VAST for the placement.
| style="text-align:center; vertical-align:middle; color:#222;" | vWrap tag only
|
|}

== Additional Parameters ==
This section describes several important additional parameters that the DAR tag can support, specifically Hashed Email, UID2 values, along with Page URL and Bundle Identifier if available. 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=671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2
|}

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

=== First Party Identifier ===
{| class="wikitable"
!Name
!Description
!Available Tag Parameters
|-
|First Party Identifier
|A user unique identifier given by the Publisher
|&fp_id
|}

=== Page and Bundle ===
{| class="wikitable" style="background-color:#F8F9FA;"
|- style="font-weight:bold; background-color:#EAECF0;"
! Name
! Description
! Available Tag Parameters
|-
| Page URL
| Canonical URL of the content where the Ad creative is served. (e.g. https://example.com/news/tech/article.html) The parameter value has to be encoded with JavaScript’s encodeURIComponent() method or equivalent. Example: si=https%3A%2F%2Fexample.com%2Fnews%2Ftech%2Farticle.html
| &si
|-
| App Bundle ID
| The app’s unique bundle ID (e.g. com.example.myapp). The ID can be used to look up the App in Apple’s App Store or the Google Play Store. References: https://developer.android.com/studio/build/application-idhttps://developer.apple.com/documentation/appstoreconnectapi/bundle_ids
| &c68=bndlid
|}
{| class="wikitable" style="font-weight:bold;"
|- style="background-color:#32BBB9; color:#002041;"
! Example
|- style="font-weight:normal;"
| si=https%3A%2F%2Fexample.com%2Fnews%2Ftech%2Farticle.html c68=bndlid,com.tam.nielsen.com
|}

== vWrap apiframework Values==

Nielsen’s vWrap tag uses the existing definition of '''apiframework''' values defined in the IAB’s [https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks- '''AdCOM Specification''' '''1.0''']. This means that existing macros for this parameter in your system should work out of the box with vWrap.

The vWrap tag supports the numerical values in bold below. In case of '''8''' (SIMID), the DAR Video tag will be inserted as a standard OMID verification client for viewability measurement and it will not interfere with any SIMID components in the ad.

If a '''0''' or an empty value is given, the resulting VAST will include both OMID and VPAID measurement solutions. This leaves the decision of the measurement method to the video player, which might be advantageous for mixed campaigns that span mobile and web environments.

{| class="wikitable" style="font-weight:bold;"
|- style="background-color:#F4F5F7;"
! Value
! Definition
|-
| 1
| style="font-weight:normal;" | VPAID 1.0
|-
| 2
| style="font-weight:normal;" | VPAID 2.0
|- style="font-weight:normal; color:#666;"
| 3
| MRAID 1.0
|- style="font-weight:normal; color:#666;"
| 4
| ORMMA
|- style="font-weight:normal; color:#666;"
| 5
| MRAID 2.0
|- style="font-weight:normal; color:#666;"
| 6
| MRAID 3.0
|-
| 7
| style="font-weight:normal;" | OMID 1.0
|-
| 8
| style="font-weight:normal;" | SIMID 1.0
|}

== SERVER-SIDE TAG DISPATCH ==
The standard way of triggering a Digital Ad Ratings (DAR) tag on mobile in-app or connected devices is for the publisher to trigger the tag upon ad exposure to the user (either directly or via the ad server). This can be described as 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 (eg. publisher log file or similar) from the MRC/IAB to substantiate that the user was exposed to the ad on their device.

In addition to the tag parameters covered in the prior sections, S2S tagging requires the implementation of [[Digital Measurement Ads Audit Beacon]] and additional HTTP headers outlined below.

The following HTTP headers need to be modified in the DAR calls to support dispatch from a '''server-side''' publisher ad server:

{| class="wikitable"
|- style="text-align:center; background-color:#c0c0c0; color:#000000;"
! HTTP Headers
! Description of Modifications
|-
| User-Agent (UA)
| This is expected to be the originating client user-agent for the device where the user was exposed to the ad. The HTTP UA from the client device should be used to populate the HTTP UA in the server-side connection/ping. DAR leverages the type of device for platform derivation.
|-
| X-Forwarded-For (XFF) IP
| This is expected to be the originating client IP address for the device where the user was exposed to the ad. Note: When the tag is fired directly from the ad server, the X-Real-IP will be the ad server IP.
|}

=== Server Side Tag Notes ===

* The client’s server-side setup 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 be triggered upon receiving the 2nd and nth tag.

* The tag received by Nielsen must be TLS v1.2 compliant or greater.

== About Nielsen ==

Nielsen shapes the world’s media and content as a global leader in audience measurement, data and analytics. Through our understanding of people and their behaviors across all channels and platforms, we empower our clients with independent and actionable intelligence so they can connect and engage with their audiences—now and into the future.

A Nielsen operates around the world in more than 55 countries. Learn more at [http://www.nielsen.com '''www.nielsen.com'''] and connect with us on social media.

'''Audience Is Everything®'''

Digital Measurement Ads Audit Beacon

2025-05-20T04:47:16Z

Admin:

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

The Nielsen Server-to-Server (S2S) solution needs audit pings for audience validation. The audit pings are https requests that are fired at least once per session. It primarily contains URL parameters with a randomly generated Session Identifier, Integration Identifier, and a timestamp that is matched to the server-side traffic.

The end user device makes a request to Nielsen Collections servers at least once per Session. Sessions are defined as continuous interaction with the application, as defined by the Publisher. The Audit pings are executed ideally at the beginning of the Session or upon first ad exposure. Audit Pings may optionally fire more often, for example: fired upon each ad exposure if preferred.

Audit Pings are intended to be as light-weight, generic as possible, and contain no personal identifiers, campaign information, or advertisement metadata.

== Ping Structure ==
Requests should be executed with the following convention structure:
<syntaxhighlight>
https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&
</syntaxhighlight>
(Please note that this URL may require updates in response to changes in the market.)

The Audit Ping will carry all parameters in the matrix later in this document. Under normal operating circumstances, the Nielsen collection system will return the following response codes:

* 302: A redirect to another Nielsen domain, used for the purpose of generating a URL compatible with Nielsen streaming meters
* 200: The ping was successfully received, inspect traffic to ensure no CORS error

== Audit Ping Implementation Details ==

* SessionID is ideally generated when the application is initiated, optionally upon first ad exposure
* Audit Pings should be executed at least every time a SessionID is created
* It is permissible for Audit Pings to fire more frequently than once per session (for example, upon each ad exposure, or page change, etc.)
* It is permissible for SessionIDs to change within a session, so long as the Audit Ping is fired again ensuring that the ImpID parameter reflects the same new SessionID
* For security reasons, downstream servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked, which is the preferred behavior.

{| class="wikitable"
|-
! Parameter
! Description
! Mandatory?
! Specified By
! Format Example
|-
| intid
| Single ID assigned per integration for all audit pings across platforms
| Yes
| Nielsen
| a9ddf15ea054ea415718767ea6
|-
| apid
| Server App ID assigned by Nielsen
| Only required for content measurement
| Nielsen
| Alphanumeric application identifier assigned by Nielsen by platform
|-
| sessionid
| Unique id generated when video player is instantiated
| Yes
| Client
| Format: alphanumeric, Example: 16 char guid
|-
| product
| Indicates which product audit ping content corresponds to
| Yes
| Client
| Format: alphanumeric, Example: “dar”, “dcr”, “dtvr”
|-
| createtm
| Time the ping was fired
| Yes
| Client
| Format: UnixTime “1643858542”
|}

'''Generic Ping Format:'''
<syntaxhighlight>
https://audit.imrworldwide.com/cgi-bin/gn?prd=audit
&intid=<Integration id>&apid=<App id>&sessionid=<Session Id>&product=<dar>&createtm=<>
</syntaxhighlight>

'''Audit Ping Example:'''
<syntaxhighlight>
https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=a9ddf15ea054ea415718767ea6&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542
</syntaxhighlight>

== Nielsen One Ads Impression Implementation Details ==

A new Impression ID parameter specified as "&impid" that exactly matches the SessionID included in the Audit Pings.

'''Example Nielsen One Ads Ping:'''
<syntaxhighlight>
https://secure-us.imrworldwide.com/cgi-bin/m?ci=us-201234h&cg=0[...]&impid=2576459933726989&rnd=164403011
</syntaxhighlight>

Digital Measurement Ads Audit Beacon

2025-05-20T04:43:34Z

Admin:

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

The Nielsen Server-to-Server (S2S) solution needs audit pings for audience validation. The audit pings are https requests that are fired at least once per session. It primarily contains URL parameters with a randomly generated Session Identifier, Integration Identifier, and a timestamp that is matched to the server-side traffic.

The end user device makes a request to Nielsen Collections servers at least once per Session. Sessions are defined as continuous interaction with the application, with gaps that do not exceed contiguous content consumption of 30 minutes or greater. The Audit pings are required to fire only once per Session, ideally at the beginning of the Session or upon first ad exposure. Audit Pings may optionally fire more often, for example: fired upon each ad exposure if preferred.

Audit Pings are intended to be as light-weight, generic as possible, and contain no personal identifiers, campaign information, or advertisement metadata. The following two primary technical purposes of the audit ping are:

# to enable Nielsen to make a connection between metered Nielsen panelists and the Census data received via the Nielsen One Ads S2S integration. This ping provides a signal that Nielsen streaming meters and mobile meter devices can intercept the Session IDs
# as a secondary mechanism to monitor the health of the S2S Nielsen One Ads measurement. If Nielsen One Ads S2S measurement fails in some way, Nielsen can detect a disparity between the trends in volume from the Audit pings and Census data. Anomalous detected behavior will prompt Nielsen to investigate. For example: Audit Pings without corresponding Nielsen One Ads S2S measurement or the converse.

== Ping Structure ==
Requests should be executed with the following convention structure:
<syntaxhighlight>
https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&
</syntaxhighlight>
(Please note that this URL may require updates in response to changes in the market.)

The Audit Ping will carry all parameters in the matrix later in this document. Under normal operating circumstances, the Nielsen collection system will return the following response codes:

* 302: A redirect to another Nielsen domain, used for the purpose of generating a URL compatible with Nielsen streaming meters
* 200: The ping was successfully received, inspect traffic to ensure no CORS error

== Audit Ping Implementation Details ==

* SessionIDs Ideally when the application is initiated, a SessionID is also created, optionally upon first ad exposure
* Audit Pings will be fired at least every time a SessionID is created
* It is permissible for Audit Pings to fire more frequently than once per session (for example, upon each ad exposure, or page change, etc.)
* It is permissible for SessionIDs to change within a session, so long as the Audit Ping is fired again ensuring that the Nielsen One Ads S2S ImpID parameter reflects the same new SessionID
* For security reasons, downstream servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked, which is the preferred behavior.

{| class="wikitable"
|-
! Parameter
! Description
! Mandatory?
! Specified By
! Format Example
|-
| intid
| Single ID assigned per integration for all audit pings across platforms
| Yes
| Nielsen
| a9ddf15ea054ea415718767ea6
|-
| apid
| Server App ID assigned by Nielsen
| Only required for content measurement
| Nielsen
| Alphanumeric application identifier assigned by Nielsen by platform
|-
| sessionid
| Unique id generated when video player is instantiated
| Yes
| Client
| Format: alphanumeric, Example: 16 char guid
|-
| product
| Indicates which product audit ping content corresponds to
| Yes
| Client
| Format: alphanumeric, Example: “dar”, “dcr”, “dtvr”
|-
| createtm
| Time the ping was fired
| Yes
| Client
| Format: UnixTime “1643858542”
|}

'''Generic Ping Format:'''
<syntaxhighlight>
https://audit.imrworldwide.com/cgi-bin/gn?prd=audit
&intid=<Integration id>&apid=<App id>&sessionid=<Session Id>&product=<dar>&createtm=<>
</syntaxhighlight>

'''Audit Ping Example:'''
<syntaxhighlight>
https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=a9ddf15ea054ea415718767ea6&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542
</syntaxhighlight>

== Nielsen One Ads Ping Implementation Details ==

For S2S Nielsen One Ads Tags, a new Impression ID parameter specified as "&impid" that exactly matches the SessionID included in the Audit Pings.

'''Example Nielsen One Ads Ping:'''
<syntaxhighlight>
https://secure-us.imrworldwide.com/cgi-bin/m?ci=us-201234h&cg=0[...]&impid=2576459933726989&rnd=164403011
</syntaxhighlight>

Digital Measurement SEI Ad Exposure

2025-05-14T20:23:41Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T20:22:23Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Genre of content
|Required for CTV
|Format: Alphanumeric

Example: <code>CV (comedy variety)</code>
|-
| }
|original_airtime
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|Example: <code>501</code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T20:19:15Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|Example: <code>501</code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T20:18:21Z

Admin: /* SLA */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T20:17:31Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T20:16:57Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T20:13:23Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session. The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists, 3) retrieve 3p cookies where applicable

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|client_id
|Nielsen-defined identifier for publisher
|Yes
|Example:
<code>nlsnci123</code>
|-
|
|campaign_id
|Publisher-defined value to aggregate different campaigns under one advertiser
|Yes
|Example:
<code>1234567</code>
|-
|
|campaign_name
|Publisher-defined human-readable name that will surface as the "campaign name" in reporting interface
|Yes
|Example:
<code>Campaign 123</code>
|-
|
|advertiser_id
|Publisher-defined unique advertiser ID for each advertiser
|Yes
|Example:
<code>adv123</code>
|-
|
|advertiser_name
|Publisher-defined unique advertiser name for each advertiser
|Yes
|Example:
<code>Advertiser</code>
|-
|
|placement_id
|Publisher-defined placement ID for individual campaigns for an advertiser, removing the need to create cross campaigns
|Yes
|Example:
<code>plcmt1234</code>
|-
|
|placement_name
|Publisher-defined placement name for each placement. If no value are passed then placement ID will be displayed as placement name
|Preferred
|Example:
<code>Placement</code>|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure Tagless

2025-05-14T19:51:17Z

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}} This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately. The Single Endpoint..."

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Content Viewing CR

2025-05-14T18:59:14Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement S2S CR}} {{CurrentBreadcrumb}}

This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products. In addition to the below data points, a Nielsen panel match mechanism to be agreed upon, and is a necessary component of the methodology.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Apache Parquet format with snappy compression; (preferred)
** Text files with utf-8 encoding in JSON Lines format;
* All data files have extensions to indicate the file format (.parquet | .json)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific, non-interoperable user ID (must remain persistent indefinitely); should match value provided in panel matching mechanism
|Yes
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Optional
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address, or truncated IP with last octet zeroed ".000"
|Optional
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Streaming Measurement S2S CR

2025-05-14T18:53:21Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|Digital Streaming Measurement Specifications (custom)}}
__NOTOC__

{| class="wikitable"
| colspan="3" | Single Endpoint Integration (SEI) - log-file based data transaction mechanism
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
!| Implementation Guide
|-
| rowspan="5" style="text-align:right;" | {{SmallIcon|S2SIcon.png|alt=SDK}}
|-
| rowspan="5" | {{OSIcon|VideoIcon.png|alt=Video}}
| '''[[Digital Measurement SEI Content Viewing CR]]'''
|-
| '''[[Digital Measurement Content Relayed Audit Beacon]]'''
|-
| '''Panel Match Mechanism details to be mutually agreed upon'''
|-
|[[Nielsen Watermarking Introduction|'''Nielsen Watermarking Introduction''']]
|}

DAR Tag Implementation Guide

2025-04-28T20:50:06Z

Admin: /* Server Side Tag Notes */

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

= Introduction =

This document provides an overview of the Nielsen Digital Ad Ratings (DAR) Tags and the steps necessary to implement them as part of your digital advertising campaigns.
=== What is DAR ===
DAR is a measurement platform for digital advertising campaigns. The platform provides a clear view of the true audience of a campaign, including Reach, Frequency, and GRP statistics by audience demographic group.
=== What we measure===
All DAR tags allow you to measure campaign impressions and the DAR JavaScript tags measure ad viewability, GIVT (General Invalid Traffic), and SIVT (Sophisticated Invalid Traffic) across platforms including web, mobile, and in-app.
=== How we measure it===
Nielsen’s DAR suite of JavaScript tags together with a pixel tag fallback will be present in your ad placements. We utilize industry-standard APIs to perform measurement cross-browser and cross-platform. In most cases, you will only need to add a simple URL through your ad management interface to fully utilize DAR measurement in your campaigns.
=== Prerequisites ===
For steps outlined in this document, you should have access to Nielsen’s Campaign Management Interface (CMI) and a Nielsen Technical Account Manager (TAM) will be working with you during the implementation phase.
__TOC__
= DAR Measurement Types =

== DAR Display==

The DAR Display JavaScript tag reports ad impressions as well as measures ad viewability and SIVT. In standard web placements, it will find the ad unit in the surrounding DOM container and will then report viewability as a time series with a 1-second resolution.

The DAR tag will report the MRC-required minimum of 1 second on screen and a continuous viewability time series for the lifetime of the ad session to enable additional viewability qualifiers.

The tag can utilize the IAB’s [https://iabtechlab.com/standards/open-measurement-sdk/ '''Open Measurement SDK'''] (OM SDK) including [https://iabtechlab.com/blog/open-measurement-for-web-video-arrives/ '''OM Web'''] integration if the OM Interface Definition (OMID) is available, or it will use industry-standard web APIs to measure viewability.

=== Requirements ===

The DAR Display tag requires a JavaScript-enabled browser for web environments or the OM SDK for in-app to operate and should be placed close to the corresponding measured ad unit. It should be on the same DOM level (e.g. directly under the same parent) or in a child node under the same parent node. The ad unit should be a content-bearing DOM element (e.g. img, canvas, SVG, iframe, div) with a minimum size of 30x30 pixels.

=== Parameters ===

The minimum required DAR parameters are '''ca, ci, cr, pc, ce''' and '''am'''. See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

=== Example Tag ===
<syntaxhighlight lang="javascript">
<script type="text/javascript"
src="https://dar.imrworldwide.com/js/dar.js?ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}&am={ad-server-code}">
</script>
</syntaxhighlight>

=== Example OMID Display Placement ===

DAR can be enabled through the OM SDK by passing the required Nielsen OM inputs listed in the table below during setup:

{| class="wikitable"
|-
! style="width: 20%" | OM Parameter
! style="width: 40%" | Description
! style="width: 40%" | Nielsen Value
! style="width: 5%" |Required
|-
| Verification Vendor
| Vendor key for measurement provider
| nielsen.com-omid
| ✔
|-
| JavaScriptResource
| URL for measurement provider’s verification script
|<syntaxhighlight lang="html">https://dar.imrworldwide.com/js/dar.js</syntaxhighlight>
| ✔
|-
| VerificationParameters
| Measurement provider’s verification tag parameters
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" |<syntaxhighlight lang="html">ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}&am={ad-server-id}</syntaxhighlight>
| ✔
|-
| Tracking Event verificationNotExecuted
| Error URL when the ad player denies measurement script execution
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" | <syntaxhighlight lang="html">https://events.imrworldwide.com/er?ercd=8800&erms=verificationNotExecuted-
{reason}&ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}&am={ad-server-id}&c13={asid,app_id}</syntaxhighlight>
|

|}

<blockquote>
Note: The verificationNotExecuted Error URL is recommended for better troubleshooting during campaign setup. If your system can provide a macro for the reason of the interrupted measurement session, it can be added in place of the {reason} placeholder in the error URL. This can be an error code or a clear text error message.</blockquote>

=== Expected Display Ad Session Pings ===
{| class="wikitable"

! '''Description'''
! '''Timing'''
! '''Path'''
|-
| DAR Main Ping
| At initial load
| secure-gl.imrworldwide.com/cgi-bin/m
|-
| Nielsen Measure Ping
| Measurement start
| events.imrworldwide.com/nmp
|-
| Primary Standard Ping
| After 1 second of viewable duration (may not occur based on MRC rules)
| events.imrworldwide.com/psp
|-
| Timed Pings
| At 1, 5, 15 and 120 seconds of ad session time (may not occur based on ad session length)
| events.imrworldwide.com/1sp, 5sp, 15sp, 120sp
|-
| Final Ping
| At window/tab unloading event
| events.imrworldwide.com/fp
|-
| Error Ping
| Potential integration error - please contact your Nielsen representative
| events.imrworldwide.com/er
|}

=== Ping Flow ===

This flow illustrates the behavior of the DAR Display tag. 

[[File:Screenshot 2022-06-22 152646.png]]

{| class="wikitable"
|-
! colspan="2" | Ping Flow Legend
|-
| 1SP, 5SP, 15SP, 120SP
| Timed Measure Ping at 1, 5, 15 and 120 seconds
|-
| D0, D1, D2
| Dynamic SIVT Pings at 1, 15 & 30 seconds
|-
| FP
| Final Ping
|-
| IMPID
| Unique Impression ID
|-
| NMP
| Nielsen Main Measure Ping
|-
| PSP
| Primary Standard Ping
|-
| SIVT
| Sophisticated Invalid Traffic
|}

== DAR Video ==

The DAR Video tag will typically be trafficked as part of a Video Ad Serving Template (VAST) file. Nielsen provides its wrapped video tag (vWrap) to make this type of deployment easy and consistent across the various ad servers and trafficking options. Nielsen’s vWrap tag supports both automatic OMID and VPAID integration with existing VAST files. The two sections below, [[#Wrapped_Video_Tag_.28vWrap.29_Deployment|'''Wrapped Video Tag''']] and [[#Video_JS_Tag|'''Video JS Tag''']], describe these options and their expected outcomes.

In addition, Nielsen supports '''direct DAR Video tag deployments''' with manual integration in existing workflows. In this case, the section [[#video-js-tag|'''Video JS Tag''']] below describes the basic setup and expected results. In addition, it is recommended that you work closely with your Nielsen Technical Account Manager if you consider a manual tag integration with your campaigns.

=== Wrapped Video Tag (vWrap) Deployment ===

Nielsen’s wrapped DAR video tag, vWrap, is the preferred delivery method for VAST-controlled video ad placements.The vWrap tag is served by a Nielsen service that takes an original VAST with an inline ad (not a wrapper redirect) and dynamically adds the DAR Video tag with measurement solutions for VPAID and OMID. The '''apiframework''' parameter can be used to control which measurement solution will be inserted (see below).

=== Parameters ===

The minimum required DAR parameters are '''ca, ci, ce, cr, pc''', '''am, apiframework''' and '''vastURL'''. See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

The Open Real Time Bidding ([https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf '''OpenRTB''']) API framework values for identifying the ad inventory type should be passed in the Nielsen '''apiframework''' parameter. The values should be either 1 or 2 (VPAID) or 7 or 8 (OMID). The available API framework values are listed in the IAB’s [https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks- '''AdCOM specification 1.0''']. If the parameter is left blank or set to 0, Wrap will add the DAR Video tag as '''both''' an OMID verification client and VPAID wrapper. See more details in the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']].

The '''vastURL''' parameter must be the last parameter on the DAR tag with its value set as the full URL (including all original parameters) of the original VAST tag for the ad placement.

=== Example Wrapped Video Tag (vWrap) ===
{| class="wikitable" style="font-family:'Courier New', Courier, monospace !important;"
|-
! <syntaxhighlight lang="html"> https://vwrap.imrworldwide.com/v1/wrap?ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}
&am={ad-server-id}&c9={devid,Advertising_ID}&c13=asid,app_id}&apiframework={APIFRAMEWORK}&vastURL={ORIGINAL_VAST_URL}</syntaxhighlight>
|}
<blockquote>
To observe how vWrap operates, we have provided some example VAST URLs which you can load directly in your browser.
</blockquote>
==== VAST ad Unit, no Impression/Viewability ====
First, here is a VAST ad unit with a single video file and no impression tracking or viewability measurement:
{| class="wikitable"
|-
! https://dartag.info/vast-examples/example_video_only_nielsen_15s.xml
|}
==== VAST ad Unit, Nielsen vWrap for OMID measurement ====
This is the same VAST file loaded via Nielsen’s vWrap tag for '''OMID measurement''' (apiframework is set to 7):
{| class="wikitable"
|-
! https://vwrap.imrworldwide.com/v1/wrap?ca=nlsn305255&cr=nielsenomidtest&ce=nielsen&pc=vastomid&ci=nlsntest&am=4&apiframework=7&vastURL=http://dartag.info/vast-examples/example_video_only_nielsen_15s.xml
|}

==== VAST ad Unit, Nielsen vWrap for VPAID measurement ====
And here is the same VAST with the vWrap tag configured for '''VPAID measurement''' (apiframework is set to 2):
{| class="wikitable"
|-
!https://vwrap.imrworldwide.com/v1/wrap?ca=nlsn305255&cr=nielsenomidtest&ce=nielsen&pc=vastvpaid&ci=nlsntest&am=4&apiframework=2&vastURL=http://dartag.info/vast-examples/example_video_only_nielsen_15s.xml
|}

=== Video JS Tag ===

The DAR Video tag supports both OM SDK and VPAID video ad measurement and provides viewability time series, audio volume time series, GIVT, and SIVT data. The time series contains playhead events with corresponding measurements at a 1-second resolution. In addition to the time series, a dedicated ping will report on the MRC-required minimum of 2 seconds on screen.

With OM SDK, the DAR Video tag supports the following ad types:

* Native mobile in-app ad placements
* Mobile web ads
* OM Web placements
* OMID-enabled streaming video players with ad SDKs (for instance DAI IMA SDK)

With VPAID, it supports the following operating modes:
* As VPAID wrapper for an existing VPAID ad unit in the VAST
* As VPAID ad unit in a VAST with video files and AdParameters node
* In Custom Integrations with VPAID host players

In most cases, the DAR Video tag should not be manually implemented as a wrapper, instead consider utilizing Nielsen’s vWrap tag.

==== Requirements ====

The DAR Video tag needs a JavaScript environment to operate. The video unit to be measured needs to have a size of at least 30x30 pixels. The DAR Video tag requires access to the VPAID ad unit or to an OM SDK API present in the JavaScript context.

==== Parameters ====

The minimum required DAR parameters are '''ca, ci, ce, cr, pc''' and '''am'''. For VPAID wrapper placements, '''vpaidURL''' is also required.

To comply with MRC guidelines, you will be required to append '''autop''' to indicate click-to-play vs auto-play.

If the DAR Video tag will act as the VPAID wrapper, '''vpaidURL''' has to be the tag’s last parameter and its value set to the full URL (including parameters) of the original VPAID ad unit.

See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

==== Expected Video Ad Session Pings ====

{| class="wikitable"
! '''Description'''
! '''Timing'''
! '''Path'''
|-
| DAR Main Ping
| At initial load
| secure-gl.imrworldwide.com/cgi-bin/m
|-
| Nielsen Measure Ping
| Measurement start
| events.imrworldwide.com/nmp
|-
| Primary Standard Ping
| After 2 seconds of viewable duration (may not occur based on MRC rules)
| events.imrworldwide.com/psp
|-
| Quarterly Ping
| At 25%, 50%, 75% and 100% of video progress
| events.imrworldwide.com/qp
|-
| Final Ping
| At video stop or window/tab unloading event
| events.imrworldwide.com/fp
|-
| Error Ping
| Potential integration error - please contact your Nielsen representative
| events.imrworldwide.com/er
|}

==== Ping Flow ====

This flow illustrates the behavior of the DAR Video tag if the impression pixel is part of the VAST to be sent by the ad player and the JS tag has '''&darsup=1'''. The parameter, <code>darsup=1</code>, is used to suppress the DAR Main Ping from being sent from the JS tag since the DAR main ping will be sent from the DAR impression pixel. This is the default setup if Nielsen’s vWrap tag is being used to set up the video campaign.

[[File:Screenshot 2022-06-22 2.png]]
{| class="wikitable"
|-
! colspan="2" | Ping Flow Legend
|-
| D0, D1, D2
| Dynamic SIVT Pings at 1, 15 & 30 seconds
|-
| FP
| Final Ping
|-
| IMPID
| Unique Impression ID
|-
| NMP
| Nielsen Main Measure Ping
|-
| PSP
| Primary Standard Ping
|-
| QP
|Quarterly Media Pings at 25%, 50%, 75% and 100%
|-
| SIVT
| Sophisticated Invalid Traffic
|}

==== Example OMID Video Placement ====

DAR can be enabled through the OM SDK by passing the required Nielsen OM inputs listed in the table in the VAST <adVerifications> node:

{| class="wikitable"
! '''OM Parameter'''
! '''Description'''
! '''Nielsen Value'''
! '''Required'''
|-
| Verification Vendor
| Vendor key for measurement provider
| nielsen.com-omid
| ✔
|-
| JavaScriptResource
| URL for measurement provider’s verification script
| <syntaxhighlight lang="html">https://dar.imrworldwide.com/js/darvideo.js</syntaxhighlight>
| ✔
|-
| VerificationParameters
| Measurement provider’s verification tag parameters
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" |<syntaxhighlight lang="html">ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}&pc={placement-id}&am={ad-server-id}</syntaxhighlight>
| ✔
|-
| Verification Not Executed URL
| Error URL when the ad player denies measurement script execution
| style="font-family:'Courier New', Courier, monospace !important; color:#222222;" | <syntaxhighlight lang="html">https://events.imrworldwide.com/er?ercd=8800&erms=verificationNotExecuted-
{reason}&ca={campaign-id}&cr={creative-id}&ce={site-id}&ci={client-id}
&pc={placement-id}&am={ad-server-id}&c9={devid,Advertising_ID}&c13={asid,app_id}</syntaxhighlight>
|

|}
<blockquote>
Note: The verificationNotExecuted Error URL is recommended for better troubleshooting during campaign setup. If your system can provide a macro for the reason of the interrupted measurement session, it can be added in place of the {reason} placeholder in the error URL. This can be an error code or a clear text error message.
</blockquote>

==== Example VPAID Placement in VAST ====

A typical VAST placement with VPAID will contain an impression pixel, the DAR Video JS tag as MediaFile of type “VPAID”, and the video MediaFiles will be duplicated as AdParameters object. In the example below, there was no original VPAID ad unit (the original VAST only contained MP4 video files), so the &vpaidURL parameter on the DAR JS tag stays empty.

In this example, the DAR JavaScript tag will operate as the VPAID ad unit and will play an appropriate media file from the list contained in the AdParameters node.

<syntaxhighlight lang="json">
...
<Impression id="Nielsen Digital Ad Ratings">
<![CDATA[https://secure-enc.imrworldwide.com/cgi-bin/m?at=view&cy=2&rt=banner&src=njs&
st=image&tpv=vwrap&ca=nlsnXXXXXX&cr={AD.ID}&ce=publisherXXXX&ci=nlsnciXXXX&pc=placementID_XXXX1&am=3]]>
</Impression>
...
<MediaFiles>
<MediaFile apiFramework="VPAID" type="application/javascript">
<![CDATA[https://dar.imrworldwide.com/js/darvideo.js?darsup=1&ca=nlsnXXXXXX&cr={{AD.ID}}&
ce=publisherXXXX&ci=nlsnciXXXX&pc=placementID_XXXX1&am=3]]>
</MediaFile>
<MediaFile bitrate="720" delivery="progressive" height="480" id="XXXXXX"
maintainAspectRatio="true" scalable="true" type="video/mp4"
width="854"><![CDATA[https://XXXXX.net/XXXXXX.mp4]]>
</MediaFile>
</MediaFiles>
...
<AdParameters>
<![CDATA[{"mediaFiles":[{"bitrate":"720","uri":"https://XXXXX.net/XXXXXX.mp4","height":"480","scalable":"true",
"id":"XXXXXX","type":"video/mp4","maintainAspectRatio":"true","delivery":"progressive","width":"854"}]]>
</AdParameters>
</syntaxhighlight>

==== Server-Side Integration ====

If you are interested in implementing the DAR tags server-side, e.g. through SSAI, please contact your Nielsen TAM to provide you with the required guidelines.

==== Notes ====

Manual placement of the DAR Video tag is only recommended in situations where the DAR vWrap tag can not be utilized, like in certain mobile in-app ad placements or in scenarios where DAR Video needs to be configured as OMID viewability measurement solution.

== Pixel Tag==

The DAR Impression pixel provides basic campaign impression counts and allows to cover placements served in environments where the DAR JavaScript tag is not supported.

=== Environment ===

The DAR pixel tag should only be used in environments where the DAR JavaScript tag cannot be utilized such as restricted CTV environments, for SSAI Server-Side Beaconing, and other situations where an adequate JavaScript environment is not available.

=== Parameters ===

The minimum required DAR parameters are '''ca, ci, ce, cr, pc''', and '''am''' along with fixed valued params, '''at=view''', '''rt=banner''' and '''st=image''' . See the [[DAR_Tag_Implementation_Guide#Appendix|'''Appendix''']] for a full list of parameters.

=== Example Tag ===
<syntaxhighlight lang="html">
<img src="https://secure-gl.imrworldwide.com/cgi-bin/m?ca=nlsnXXXXXX&cr=crtve
&ce={PUBLISHER.ID}&pc=PLACEMENT.ID}&nlsnciXXXX&am=3&at=view&rt=banner&st=image
&cy=0&r=[timestamp]" style="display:none"/>
</syntaxhighlight>

= Tag Integration =
A successful tag integration will require you to go through the following 6 steps.
== Step 1: Determine Your Campaign Needs==
To receive optimal results from DAR measurement, it is good practice to consider the technical requirements of different sites and placements. Please share your media plan with your Technical Account Manager before launch.

Specifically, be on the lookout for placements that might span across web and mobile ad inventory and make sure if all of the in-app placements support OMID. Also, some placement types may need manual setup and cannot be automated or may need extra time for setup and testing.

Please reach out to your Nielsen Technical Account Manager (TAM) for advice if the technical requirements for your campaign are not clear.
== Step 2: Generate Tags==
Your Nielsen representative will walk you through the Campaign Management Interface (CMI) so that you can generate DAR tags for your campaigns at any time.

Nielsen supports macro-based tag generation for several major ad servers. Nielsen’s Technical Account Managers can assist you with any technical questions on tagging campaigns for DAR measurement.
== Step 3: Campaign Integration==
Your Nielsen tags created in CMI will need to be included when you traffic your ad campaigns. Please reach out to your Nielsen TAM for additional guidance and assistance.
== Step 4: Test the Tag Implementation==
Depending on the complexity of the integration, you may be working closely with a TAM at this point or are performing a self-guided tag implementation based on the CMI output.

If working with a TAM, they will coordinate a plan to test the tag implementation ahead of the campaign go-live date. Depending on your campaign needs, testing will involve either running a diagnostic campaign to validate tagging setup or reviewing test pages or apps.

In case of a self-guided tag implementation, we recommend to verify and compare the impression counts in the CMI with your planned campaign volume or ad server reports during the first hours of the campaign. If there are any unexpected impression counts, please reach out to your Nielsen TAM.
== Step 5: Share your Ad Server Report==

=== Why the Ad Server Report is Needed ===

Knowing the delivered impressions helps Nielsen run Discrepancy Checks ensuring overall quality and reduces errors in the tagging process.

Nielsen can provide the client with a template with the inputs required to complete the quality checks.

=== How to Share Your Delivered impressions ===

Set up an automated daily report from your ad server containing Site Name, Site ID, Placement Name, Placement ID, and data date.

A secondary method to share your media plan information is to grant Nielsen “Reporting access” to your campaign in the designated ad server (such as DCM). To do this, simply grant the login '''clientreporting@nielsen.com''' access. In doing so Nielsen can directly access your media plan information, which enables us to check for updates, and reconcile any discrepancies.

== Step 6: Monitoring Your Campaign==
Nielsen recommends all clients participate in Discrepancy Checks. Nielsen’s team will verify that the tags delivered have begun to receive data once the campaign goes live and will regularly (typically every 7-14 days) compare the Nielsen reporting to your 3rd party or publisher reporting to ensure we are capturing all data across all placements, as expected, and that the discrepancy gap between your reporting and the Nielsen reporting is kept to a minimum.

= Appendix =
== Tag Parameters==
All passthrough parameters will appear on the JavaScript-generated DAR impression ping.
{| class="wikitable" style="background-color:#FFF;"
|- style="font-weight:bold; background-color:#EAECF0; color:#222;"
! Query Parameter
! Description
! style="text-align:center;" | Required
! style="text-align:center;" | Pass-through
|- style="font-weight:bold; text-align:center; vertical-align:middle; background-color:#FFEBD3; color:#222;"
| colspan="4" | Group 1 - Required Parameters
|- style="vertical-align:middle; color:#222;"
| ca
| Campaign ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| pc
| Placement ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| ci
| Client ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| am
| Ad server ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="color:#222;"
| ce
| Site ID
| style="text-align:center;" | X
| style="text-align:center;" | X
|- style="background-color:#F4F5F7; color:#222;"
| cr
| Creative ID
| style="text-align:center; background-color:#EFEFEF;" | X
| style="text-align:center;" | X
|- style="font-weight:bold; text-align:center; vertical-align:middle; background-color:#FFEBD3; color:#222;"
| colspan="4" | Group 2 - Use Case Specific Parameters
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| at
| Fixed Value "view" (Nielsen value, JS tags add this to DAR and NMP pings)
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; color:#222;"
| st
| Fixed Value "image" (Nielsen value, JS tags add this to DAR and NMP pings)
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| rt
| Fixed Value "banner" (Nielsen value, JS tags add this to DAR and NMP pings)
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; color:#222;"
| r
| Cachebuster/Timestamp. It's required in the pixel tags with a hardcoded value as a default or a macro (r=timestamp/macro) .
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| cy
| Creative type (1: display/2: video) JS tags add this to DAR and NMP pings for In-House Viewability. When parameter is not present or value is missing on pixel tags, there will be no creative type breakout. 
| style="text-align:center;" | Pixel only
|
|- style="vertical-align:middle; color:#222;"
| '''[[DAR_Tag_Implementation_Guide#vWrap_apiframework_Values|apiframework]]'''
| IAB-defined value designating the measurement method See vWrap apiframework values
| style="text-align:center;" | vWrap only
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| autof
| Video only: Auto refresh (1 for auto refresh, leave empty otherwise)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| autop
| Video only: Autoplay (1 for auto-play, 2 for click-to-play, leave empty otherwise)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c7
| OS Grouping c7=osgrp,IOS c7=osgrp,DROID c7=osgrp,ANDROID
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c8
| Device Grouping c8=devgrp,DSK (computers) c8=devgrp,PHN (mobile phone devices) c8=devgrp,TAB (mobile tablet devices) c8=devgrp,PMP (portable media player) c8=devgrp,UNWN (unknown mobile devices)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c9
| Mobile Advertising ID c9=devid,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c10
| Platform c10=plt,DSK (Computer) c10=plt,MBL (Mobile) c10=plt,OTT (Connected Device)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c12
| App Version c12=apv,xxx
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c13
| Nielsen Assigned App ID Example: c13=asid,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| c14
| OS Version c14=osver,xxx
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| c68
| Mobile App Bundle ID c68=bndlid,xxxxxxxxxxxxxx References: https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids https://developer.android.com/studio/build/configure-app-module#set_the_application_id
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| C78
| Custom Integration Flag (please note: this is the only uppercase parameter name)
| style="text-align:center;" | some vendors
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| darsup
| If present suppress DAR main ping originating from JS tag (value can be 0 or 1, same effect)
|
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| forceid
| If present provides impid, can be overwritten by impid parameter
|
| style="text-align:center;" | X (as impid)
|- style="vertical-align:middle; color:#222;"
| impid
| Same as forceid, but higher priority in case both are present
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| frcd
| Video only: Forced duration (seconds/null)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| frcf
| Video only: Forced ad flag (yes/no/null)
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| ptraf
| Video only: Purchased traffic
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| contplay
| Video only: Continuous play
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| gdpr
| GDPR flag to indicate whether GDPR is applicable: 0 - GDPR does not apply 1 - GDPR applies
| style="text-align:center;" | in some jurisdictions
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| gdpr_consent
| URL-safe base64-encoded Transparency & Consent (TC) string for identifying user's privacy preferences
| style="text-align:center;" | in some jurisdictions
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| hem_sha256
| Hashed email
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| hem_unknown
| Hashed email
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| mode
| VPAID video only, optional: Custom Direct Access mode ("w" wrapper / "c" custom; defaults to wrapper)
|
|
|- style="vertical-align:middle; color:#222;"
| onload
| VPAID video only, optional: JS callback for Custom Direct Access VPAID integration
|
|
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| pub
| Publisher Name
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| pubid
| Publisher ID
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| si
| Site identifier. Canonical URL of the content where the Ad creative is served. The parameter value has to be encoded with encodeURIComponent() method or equivalent.
|
| style="text-align:center;" | X
|- style="vertical-align:middle; color:#222;"
| uid2
| Unified ID 2.0
|
| style="text-align:center;" | X
|- style="vertical-align:middle; background-color:#EFEFEF; color:#222;"
| uid2_token
| Unified ID 2.0 token
|
| style="text-align:center;" | X
|-
|fp_id
|Publisher provided unique identifier for users
|
|
|- style="vertical-align:middle; color:#222;"
| uoo
| User opt out
| style="text-align:center;" | Mobile
| style="text-align:center;" | X
|- style="font-weight:bold; text-align:center; vertical-align:middle; background-color:#FFEBD3; color:#222;"
| colspan="4" | Group 3 - Parameters With Required Position in URL
|- style="vertical-align:middle; background-color:#ffffff; color:#222;"
| vpaidURL
| VPAID Video only: Always the last parameter for video tags. Either VPAID ad unit URL to be wrapped or empty. If empty, DAR tag will use its own vpaidplayer.js
| style="text-align:center;" | VPAID video tag only
|
|- style="background-color:#f4f5f7;"
| style="vertical-align:middle; color:#222;" | vastURL
| style="vertical-align:middle; color:#222;" | vWrap Tag only: Always the last parameter for the vWrap tag. It must contain the URL of the original VAST for the placement.
| style="text-align:center; vertical-align:middle; color:#222;" | vWrap tag only
|
|}

== Additional Parameters ==
This section describes several important additional parameters that the DAR tag can support, specifically Hashed Email, UID2 values, along with Page URL and Bundle Identifier if available. 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=671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2
|}

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

=== First Party Identifier ===
{| class="wikitable"
!Name
!Description
!Available Tag Parameters
|-
|First Party Identifier
|A user unique identifier given by the Publisher
|&fp_id
|}

=== Page and Bundle ===
{| class="wikitable" style="background-color:#F8F9FA;"
|- style="font-weight:bold; background-color:#EAECF0;"
! Name
! Description
! Available Tag Parameters
|-
| Page URL
| Canonical URL of the content where the Ad creative is served. (e.g. https://example.com/news/tech/article.html) The parameter value has to be encoded with JavaScript’s encodeURIComponent() method or equivalent. Example: si=https%3A%2F%2Fexample.com%2Fnews%2Ftech%2Farticle.html
| &si
|-
| App Bundle ID
| The app’s unique bundle ID (e.g. com.example.myapp). The ID can be used to look up the App in Apple’s App Store or the Google Play Store. References: https://developer.android.com/studio/build/application-idhttps://developer.apple.com/documentation/appstoreconnectapi/bundle_ids
| &c68=bndlid
|}
{| class="wikitable" style="font-weight:bold;"
|- style="background-color:#32BBB9; color:#002041;"
! Example
|- style="font-weight:normal;"
| si=https%3A%2F%2Fexample.com%2Fnews%2Ftech%2Farticle.html c68=bndlid,com.tam.nielsen.com
|}

== vWrap apiframework Values==

Nielsen’s vWrap tag uses the existing definition of '''apiframework''' values defined in the IAB’s [https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks- '''AdCOM Specification''' '''1.0''']. This means that existing macros for this parameter in your system should work out of the box with vWrap.

The vWrap tag supports the numerical values in bold below. In case of '''8''' (SIMID), the DAR Video tag will be inserted as a standard OMID verification client for viewability measurement and it will not interfere with any SIMID components in the ad.

If a '''0''' or an empty value is given, the resulting VAST will include both OMID and VPAID measurement solutions. This leaves the decision of the measurement method to the video player, which might be advantageous for mixed campaigns that span mobile and web environments.

{| class="wikitable" style="font-weight:bold;"
|- style="background-color:#F4F5F7;"
! Value
! Definition
|-
| 1
| style="font-weight:normal;" | VPAID 1.0
|-
| 2
| style="font-weight:normal;" | VPAID 2.0
|- style="font-weight:normal; color:#666;"
| 3
| MRAID 1.0
|- style="font-weight:normal; color:#666;"
| 4
| ORMMA
|- style="font-weight:normal; color:#666;"
| 5
| MRAID 2.0
|- style="font-weight:normal; color:#666;"
| 6
| MRAID 3.0
|-
| 7
| style="font-weight:normal;" | OMID 1.0
|-
| 8
| style="font-weight:normal;" | SIMID 1.0
|}

== SERVER-SIDE TAG DISPATCH ==
The standard way of triggering a Digital Ad Ratings (DAR) tag on mobile in-app or connected devices is for the publisher to trigger the tag upon ad exposure to the user (either directly or via the ad server). This can be described as 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 (eg. publisher log file or similar) from the MRC/IAB to substantiate that the user was exposed to the ad on their device.

In addition to the tag parameters covered in the prior sections, the following HTTP headers need to be modified in the DAR calls to support dispatch from a '''server-side''' publisher ad server:

{| class="wikitable"
|- style="text-align:center; background-color:#c0c0c0; color:#000000;"
! HTTP Headers
! Description of Modifications
|-
| User-Agent (UA)
| This is expected to be the originating client user-agent for the device where the user was exposed to the ad. The HTTP UA from the client device should be used to populate the HTTP UA in the server-side connection/ping. DAR leverages the type of device for platform derivation.
|-
| X-Forwarded-For (XFF) IP
| This is expected to be the originating client IP address for the device where the user was exposed to the ad. Note: When the tag is fired directly from the ad server, the X-Real-IP will be the ad server IP.
|}

=== Server Side Tag Notes ===

* The client’s server-side setup 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 be triggered upon receiving the 2nd and nth tag.

* The tag received by Nielsen must be TLS v1.2 compliant or greater.

== About Nielsen ==

Nielsen shapes the world’s media and content as a global leader in audience measurement, data and analytics. Through our understanding of people and their behaviors across all channels and platforms, we empower our clients with independent and actionable intelligence so they can connect and engage with their audiences—now and into the future.

A Nielsen operates around the world in more than 55 countries. Learn more at [http://www.nielsen.com '''www.nielsen.com'''] and connect with us on social media.

'''Audience Is Everything®'''

Digital Measurement SEI Ad Exposure

2025-03-25T20:03:35Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Optional
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-03-19T19:06:23Z

Admin: + timestamp for NBE

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|-
| colspan="2" |timestamp
|Time impression occurred
|Preferred; Yes for NBE
|Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Static Content Viewing

2024-12-13T22:44:28Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

This document describes the log file exposures, to be used in conjunction with:
*[[Digital Measurement Content Audit Beacon]]
*[[Digital Measurement SEI Content Asset Metadata]]

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for an asset
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |section
|section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values
|Yes
|Format: alphanumeric (no [[Special Characters]])

Example:
<code>Home Page</code>
|-
| colspan="2" |cln
|Cumulative time spent viewing in seconds
|Yes if no position array
|Format: int in seconds

Example:
<code>300</code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Measurement SEI Static Content Viewing

2024-12-13T22:40:37Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

This document describes the log file exposures, to be used in conjunction with:
*[[Digital Measurement Content Audit Beacon]]
*[[Digital Measurement SEI Content Asset Metadata]]

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for an asset
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |section
|section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values
|Yes
|Format: alphanumeric (no [[Special Characters]])

Example:
<code>Home Page</code>
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |cln
|Cumulative time spent viewing in seconds
|Yes if no position array
|
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Measurement SEI Content Viewing

2024-12-13T18:28:46Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content measurement products.

This document describes the log file exposures, to be used in conjunction with [[Digital Measurement SEI Content Asset Metadata]] and [[Digital Measurement Content Audit Beacon]] to enable measurement.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example: Salted, hashed user ID:

<code>2cf24dba5fb0a30e26e83b2ab9…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|
Format: integer;

*<code>0</code> = Default / Unknown
*<code>1</code> = linear ad load
*<code>2</code> = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|
Format: integer;

*<code>0</code> = (no ads),
*<code>1</code> = (content is supported by ads)
*<code>2</code> = (not known)

Note: set to "<code>1</code>" if content ad support was intended but did not occur
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
|{
|adpod
|AdPod sequence number.

Increment for each AdPod. If the same AdPod is played out twice (due to rewind), still increment the AdPod sequence to reflect the sequence the AdPods are played.
|Yes
|
Format: Integer

Example:
<code>2</code>
|-
|
|adposition
|Ad sequence number.

Increment each time a new Ad is encountered. If the same Ad is played out twice (due to rewind), still increment the Ad sequence to reflect the sequence the Ads are played
|Yes
|
Format: Integer

Example:
<code>1</code>
|-
|
|adid
| The unique identifier for this Ad
|No
|
Format: alphanumeric

In-house AdId, Industry AdID, AdNetwork ID or DAR placement ID
|-
|
|isdarid
|Is the AdId being passed a Nielsen DAR placement ID
|Required if AdID
|
Format: integer
*<code>0</code> = is NOT DAR ID;
*<code>1</code> = is a DAR ID
|-
|
|adstart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
|<nowiki>}</nowiki>
|adend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDgD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Measurement SEI Content Viewing

2024-12-13T18:28:27Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

This document describes the log file exposures, to be used in conjunction with [[Digital Measurement SEI Content Asset Metadata]] and [[Digital Measurement Content Audit Beacon]] to enable measurement.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example: Salted, hashed user ID:

<code>2cf24dba5fb0a30e26e83b2ab9…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|
Format: integer;

*<code>0</code> = Default / Unknown
*<code>1</code> = linear ad load
*<code>2</code> = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|
Format: integer;

*<code>0</code> = (no ads),
*<code>1</code> = (content is supported by ads)
*<code>2</code> = (not known)

Note: set to "<code>1</code>" if content ad support was intended but did not occur
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
|{
|adpod
|AdPod sequence number.

Increment for each AdPod. If the same AdPod is played out twice (due to rewind), still increment the AdPod sequence to reflect the sequence the AdPods are played.
|Yes
|
Format: Integer

Example:
<code>2</code>
|-
|
|adposition
|Ad sequence number.

Increment each time a new Ad is encountered. If the same Ad is played out twice (due to rewind), still increment the Ad sequence to reflect the sequence the Ads are played
|Yes
|
Format: Integer

Example:
<code>1</code>
|-
|
|adid
| The unique identifier for this Ad
|No
|
Format: alphanumeric

In-house AdId, Industry AdID, AdNetwork ID or DAR placement ID
|-
|
|isdarid
|Is the AdId being passed a Nielsen DAR placement ID
|Required if AdID
|
Format: integer
*<code>0</code> = is NOT DAR ID;
*<code>1</code> = is a DAR ID
|-
|
|adstart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
|<nowiki>}</nowiki>
|adend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDgD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2024-11-20T16:59:25Z

Admin: /* Manifest File */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Ad Ratings}} {{CurrentBreadcrumb}}

This document outlines the required specification for facilitating Nielsen ONE advertising measurement, Digital Ad Ratings (DAR) measurement, Ad Effectiveness (MTA, Lift, etc.), and Activation products leveraging the Single Endpoint integration (SEI). Integration specifications for other Nielsen products (DCR, DTVR, etc.) via SEI are available separately.

The Single Endpoint integration contains two components:

# '''Exposure File'''- the specifications of which are described in this document for the transmission to Nielsen with event level data shared via a Server-to-Server (S2S) method. This S2S file transfer supplies event data and related campaign, study, and user metadata required for facilitating measurement.
# '''Audit Beacon'''- (implementation details available here: [[Digital Measurement Ads Audit Beacon]]) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

=== Ad Measurement Considerations ===
Nielsen ad campaign setup is required using the '''Campaign Management Interface (CMI)''' tool or '''Tagging API''' for each campaign where Nielsen reporting is expected - this applies to new or current Nielsen clients transitioning from standard client-device-fired pixel tags to Single Endpoint style.

Nielsen ad pixel tags should not directly fire for any exposures already included in the Exposure File after the testing period. Third-party Nielsen pixel tags should be intercepted, suppressed, and included in a server file transfer with all associated information.

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-<'''env'''>/<'''filetype'''>/<'''split'''>/'''yyyy'''/'''mm'''/'''dd'''/'''hh'''/<object></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|“test” or “prod”
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.[parquet|json]</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty '''_SUCCESS''' file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in json format that implements the [https://docs.aws.amazon.com/redshift/latest/dg/r_UNLOAD_command_examples.html#unload-examples-manifest-verbose AWS unload manifest file] format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

'''Example:'''
<syntaxhighlight lang="JSON">
{

"entries": [

{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true},

{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}

],

"meta": {

"schema_version": "S2SV1.7.0",

"accreditation_status": "0",

"start_time": "1710154800",

"end_time": "1710158399",

"record_count": 55

}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Require'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code> MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest</code>

<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval.For example files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

== Schema Parameter Definitions ==
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Required'''
|'''Format / Example'''
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID: <code>70fa265f-5d49-4af7-ba9e-5e9da416bf78</code>
|-
| colspan="2" |ad
|Array that contains advertisement-related parameters indented below
|Required
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"dar_url":"http://secure-gl.imr...",
"publisher_name":"Publisher 123",
...
}
]
</syntaxhighlight>
|-
|{
|dar_url
|The DAR url for the specific Nielsen campaign to be tracked. In cases of 3rd party DAR urls, this url should be intercepted and unaltered by the publisher/provider
|Yes
|
Example:
<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>
|-
|
|publisher_name
|Name of the publisher where the ad or content is being served.
|Yes
|
Example:
<code>Publisher 123</code>
|-
|
|publisher_user_id
|Publisher-specific (first party) user ID (should remain persistent).
|Yes
|
Example:
<code>ed36968977606872e4312943c218568123786342</code>
|-
|
|provider_name
|Name of the provider supplying the data to Nielsen.
|For CTV (only for provider onboarding)
|
Example:
<code>Provider 123</code>
|-
|
|provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|For CTV (only for provider onboarding)
|
Example:
<code>A769C2B-3CBD-5784-852F-C57875CC9D91A</code>
|-
|
|gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: <code>SH009311820022</code>
|-
|
|program_genre
|Original broadcast time of content (if applicable) in Unix epoch timestamp format
|Required for CTV
|
|-
| }
|original_airtime
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required for CTV
|Example: <code>1531337551</code>

|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501<code>
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
*<code>1</code> = hashed
*<code>0</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDGD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

Example: <code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes, or alternatives below
|
Format: xxx.xxx.xxx.xxx

Example: <code>172.217.22.14</code>
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173</code>
|-
| colspan="5" |The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" |The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|
Format: integer

*<code>0</code> = not bot
*<code>1</code> = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Preferred; required if no IP
|<code>US</code>, <code>CA</code>, etc.
|}
Note: All parameters are case sensitive.
[[Category:Digital]]

Digital Measurement SEI Content Viewing

2024-11-18T15:27:29Z

Admin: {

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example: Salted, hashed user ID:

<code>2cf24dba5fb0a30e26e83b2ab9…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|
Format: integer;

*<code>0</code> = Default / Unknown
*<code>1</code> = linear ad load
*<code>2</code> = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|
Format: integer;

*<code>0</code> = (no ads),
*<code>1</code> = (content is supported by ads)
*<code>2</code> = (not known)

Note: set to "<code>1</code>" if content ad support was intended but did not occur
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
|{
|adpod
|AdPod sequence number.

Increment for each AdPod. If the same AdPod is played out twice (due to rewind), still increment the AdPod sequence to reflect the sequence the AdPods are played.
|Yes
|
Format: Integer

Example:
<code>2</code>
|-
|
|adposition
|Ad sequence number.

Increment each time a new Ad is encountered. If the same Ad is played out twice (due to rewind), still increment the Ad sequence to reflect the sequence the Ads are played
|Yes
|
Format: Integer

Example:
<code>1</code>
|-
|
|adid
| The unique identifier for this Ad
|No
|
Format: alphanumeric

In-house AdId, Industry AdID, AdNetwork ID or DAR placement ID
|-
|
|isdarid
|Is the AdId being passed a Nielsen DAR placement ID
|Required if AdID
|
Format: integer
*<code>0</code> = is NOT DAR ID;
*<code>1</code> = is a DAR ID
|-
|
|adstart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
|<nowiki>}</nowiki>
|adend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDgD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

MediaWiki:Common.css

2024-11-18T15:18:15Z

Admin:

/* CSS placed here will be applied to all skins */
#footer-right-icons {
visibility: hidden;
}

@font-face {
font-family: 'Inter';
src: url(https://eng-client-portal-npd.nonprod.digitalengsdk.com/w/skins/foreground/assets/fonts/Inter-VariableFont_slnt,wght.ttf) format("opentype"),
url(https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&display=swap);
font-feature-settings: "zero";
font-variant-numeric: slashed-zero;
font-display: swap;
}

@font-face {
font-family: 'Fira Code';
src: url(https://eng-client-portal-npd.nonprod.digitalengsdk.com/w/skins/foreground/assets/fonts/FiraCode-VariableFont_wght.ttf) format("opentype"),
url(https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;500;600&display=swap);
font-variant-numeric: slashed-zero;
font-feature-settings: "zero";
font-display: swap;
}

html {
background: #FFFFFF;
font-family: 'Inter', sans-serif;
-webkit-text-size-adjust: 100%;
-ms-text-size-adjust: 100%;
line-height: 1.5;
tab-size: 4;
}

body {
height: auto !important;
font-family: 'Inter', sans-serif !important;
color: #111218;
line-height: 1.5;
}

/* Fix so <tt>, <code>, and <pre> display in a suitable size in firefox, chrome, etc */
tt, code, pre {
font-size: 0.85rem;
}

code {
/*display: block;*/
margin: 2px 4px;
white-space: normal;
overflow-wrap: anywhere;
/*padding: 8px 12px;*/
}

blockquote {
margin: 1rem;
}

em, i {
font-family: 'Inter', sans-serif;
font-style: oblique 14deg;
}

p+p {
margin-top: 10px;
}

div.center {
text-align: center !important;
}

div.row {
display: flex;
flex-direction: row;
justify-content: center;
align-items: center;
}

.row {
width: 100%;
}

@media only screen and (max-width: 40.0625em) /* small screens (up to 641px) */ {
div.row .row {
flex-wrap: wrap;
}

div.large-6.columns {
flex-wrap: wrap;
width: auto;
}

#breadcrumb {
font-size: 1rem !important;
}

#bannertext {
font-size: 1.2rem !important;
margin: 1rem !important;
line-height: 1.2065em;
}
}

@media only screen and (min-width: 40.0625em) and (max-width: 64.0625em) /* large mobile devices & tablets (640px) to laptops (1025px) */ {
.row {
max-width: 80%; }

div.large-6.columns {
max-width: 23%;
margin: 5px !important;
}

.large-6.columns .iconText, .large-6.columns .iconText a {
font-size: 0.85em !important;
height: 30px !important;
line-height: 0.875rem; }

.iconImage {
padding: 1em !important; }

#breadcrumb {
font-size: 1rem !important; }

#bannertext {
font-size: 1.3rem !important;
margin: 1rem 2rem 1rem 2rem !important; }
}

@media only screen and (min-width: 64.0625em) and (max-width: 90.0625em) /* laptop (1024px) to large monitor (1441px) */ {
.row {
max-width: 70%; }

div.large-6.columns {
font-size: smaller; }

#bannertext {
font-size: 1.3rem !important;
margin: 1rem 3rem 1rem 3rem !important; }

#breadcrumb {
font-size: 1rem !important; }
}

@media only screen and (min-width: 64.0625em) /* screens wider than 1440px */ {
div.large-6.columns {
width: 23%; }
}

@media only screen and (min-width: 90.0625em) and (max-width: 160.0625em) /* large monitor (1441px) to 4K screen (2561px) */ {
.row {
max-width: 65%; }
}

@media only screen and (min-width: 160.0625em) /* screens wider than 2560px */ {
.row {
max-width: 50%; }
}

/* Main landing page */

div.small-4.large-4.columns {
text-align: center;
background: #F1F2F3;
border-radius: 12px;
display: flex;
flex-direction: column;
align-items: center;
padding: 32px;
margin: 10px;
width: auto;
height: auto;
}

.small-4.large-4.columns .iconText, .small-4.large-4.columns .iconText a {
width: 150px;
}

/* separate LOB landing pages */

div.large-6.columns {
text-align: center;
display: flex;
flex-direction: column;
flex-wrap: wrap;
justify-content: center;
align-items: stretch;
align-content: center;
background: #F1F2F3;
border-radius: 12px;
padding: 10px 20px 30px 20px;
margin: 10px;
}

.iconImage {
margin: auto;
padding: 2em;
}

.iconText, .iconText a {
font-size: 1rem;
font-family: 'Inter', sans-serif !important;
font-weight: 600;
text-transform: capitalize;
background: #6A46FE;
border: 2px solid #6A46FE;
border-radius: 32px;
color: #ffffff;
position: relative;
display: flex;
flex-direction: row;
justify-content: center;
align-items: center;
padding: 0.3em;
gap: 4px;
width: auto;
height: 48px;
}

/* TABLE OF CONTENTS */

#toc.toc {
position: fixed;
height: auto;
width: auto;
max-width: 280px;
max-height: 100dvh;
padding: 0;
margin: 0;
left: 0;
top: 55px;
z-index: 1000;
background-color: rgba(249, 249, 249, 0.95);
border: none;
display: flex;
flex-direction: column;
}

#toc > ul {
height: 90dvh;
overflow-y: auto;
scrollbar-gutter: stable;
}

.toc .toctitle {
display: flex;
flex-direction: row-reverse;
justify-content: flex-end;
align-items: center;
height: 35px;
width: auto;
flex-wrap: nowrap;
}

.toctogglespan .toctogglelabel {
margin: 6px;
float: left;
display: block;
height: auto;
width: auto;
content: url(https://mywikis-wiki-media.s3.us-central-1.wasabisys.com/nielsen/hamburgersmall.png);
}

.toc .toctitle h2 {
visibility: hidden;
width: 0;
height: 0;
}

#toc ul, .toc ul {
font-size: 0.75rem;
line-height: 1rem;
margin-right: 0;
margin-left: 2px;
padding-block: 6px;
padding-inline-start: 10px;
padding-inline-end: 2px;
}

#toc li, .toc li > a {
font-size: 0.75rem;
line-height: 0.9rem;
padding-block:3px;
color: #111218;
}

.toc li:hover > a:hover {
color: #6A46FE;
}

.tocnumber {
display: none; }

#toctogglecheckbox {
display: none !important;
}

.toctogglecheckbox,
:not(:checked) > .toctogglecheckbox {
display: none !important;
margin: 0 !important;
}

/*
:default(.toctogglecheckbox:checked) ~ ul {
visibility: hidden;
}

:where(.toctogglecheckbox:checked) ~ ul {
visibility: hidden;
}
*/

.toctogglecheckbox:not(:checked) + .toctitle .toctogglelabel:after {
content: none !important;
}

.toctogglecheckbox:checked + .toctitle .toctogglelabel:after {
content: none !important;
}

:not(:checked) > .toctogglespan:before {
content: none !important; }

:not(:checked) > .toctogglespan:after {
content: none !important; }

/* TABLE FORMATTING */

.smallIcon {
margin-right: 0.5em;
}

table tr th {
padding: 0.5625em 0.5625em;
font-size: 0.875em !important;
font-weight: 700;
}

table tr td {
padding: 0.5625em 0.5625em;
font-size: 0.875em !important;
}

/* Use the name altertable as the class when you want to alternate row colors - La Mar */
table.altertable tr:nth-child(even) {
background-color: #d0f6f8;
}

/* LIST FORMATTING */

.mw-content-ltr ul {
margin: 0.25em 0.5em 0.25em 2em;
font-size: inherit; /* so that lists within a table are the correct font size */
}

/* TOP BAR FORMATTING */

#navwrapper {
top: 0;
background: rgb(0,33,66,0.9) !important;
/* background-color: #002142; */
margin-top: 0;
margin-bottom: -6px;
width: 100%;
display: flex;
flex-direction: row;
align-content: center;
justify-content: center;
align-items: center;
flex-wrap: nowrap;
position: sticky;
z-index: 900;
}

nav.top-bar, .top-bar {
background: transparent;
height: 55px;
width: 100%;
display: flex;
flex-direction: row;
justify-content: space-around;
flex-wrap: wrap;
align-items: center;
}

div.title-name {
font-family: 'Inter', sans-serif !important;
font-weight: 500;
text-transform: capitalize !important;
color: #ffffff !important;
font-size: 1.0875rem !important;
display: inline-block;
position: relative;
z-index: 901;
margin: 0 0.5rem;
}

@media only screen and (min-width: 40em) /* top bar adjustments for screens 640px and up */ {
.top-bar:before, .top-bar:after {
content: none;
display: table;
margin-inline-start: auto;
margin-inline-end: auto;
}

.top-bar .title-area {
width: 18rem !important;
}

.top-bar-section .dropdown {
top: 45px;
}

.top-bar-section .has-dropdown.moved > .dropdown a, .top-bar-section .has-dropdown.moved > .dropdown {
top: 45px;
}
}

@media only screen and (max-width: 40em) /* top bar, top bar expanded, search form, and personal tools dropdown adjustments for screens up to 640px */ {
.top-bar .title-area {
width: inherit; }

.top-bar-section {
right: 0 !important;
width: inherit;
position: static;
transition: none;
}

.top-bar.expanded {
overflow: visible; }

.top-bar.expanded .top-bar-section .has-dropdown:not(.moved) > ul {
height: 0;
width: 0;
padding: 0;
margin: 0;
position: absolute !important;
}

.top-bar-section .dropdown li a.parent-link,
.top-bar-section .has-dropdown li a.parent-link {
height: 0px;
margin: 0;
padding: 0;
width: 0;
}

.top-bar.expanded .top-bar-section .dropdown,
.top-bar.expanded .top-bar-section .has-dropdown.moved > .dropdown,
.top-bar.expanded .top-bar-section .has-dropdown.moved > .dropdown a {
color: #ffffff;
width: 18em;
font-family: 'Inter',sans-serif;
line-height: 1.5rem;
background: inherit;
margin: auto;
float: right;
clear: both;
position: static !important;
}

.top-bar-section ul li.active > a a:not(.button), .top-bar-section ul li ul.dropdown li > a {
background: rgb(0, 33, 66, 0.9) !important; }

#personal-tools-dropdown li.title.back.js-generated {
background: url(https://eng-client-portal-npd.nonprod.digitalengsdk.com/w/images/4/43/action-icondark_mode_.png) no-repeat !important;
background-size: contain !important;
background-position: center;
width: fit-content;
float: right;
z-index: 1000;
position: relative;
top: -20px;
}

.top-bar-section .dropdown li.title h5 a {
display: inline-block;
font-size: 0.75rem;
color: transparent;
background: transparent;
width: fit-content !important;
float: right;
padding: 0;
z-index: 999;
}

.top-bar.expanded .top-bar-section .dropdown li.title h5,
.top-bar.expanded .top-bar-section .dropdown li.title h5 a {
background: transparent !important;
color: transparent !important;
}

ul#actions.f-dropdown.open {
max-width: fit-content !important;
right: 50px !important;
left: auto !important;
}

#toc {
visibility: hidden;
}
}

.top-bar .title-area {
display: flex;
flex-direction: row;
align-items: center;
flex-wrap: nowrap;
position: relative;
height: auto;
}

nav.top-bar.expanded {
height: auto !important;
}

.top-bar.expanded .title-area {
background: inherit;
width: inherit;
}

.top-bar .name, .top-bar .name a {
color: #ffffff !important;
width: inherit;
height: auto;
font-size: inherit;
}

img.top-bar-logo {
height: auto;
max-height: 20px;
max-width: 100%;
display: inline-block;
padding: 0 0 0 0.5rem;
}

.top-bar .toggle-topbar.menu-icon {
margin: 0 0.5rem;
top: auto;
right: auto;
position: relative;
}

.top-bar .toggle-topbar.menu-icon a {
color: transparent;
padding: 0 0.5rem;
line-height: normal;
position: relative;
height: 55px;
}

div.small-12.columns /* top bar search form section */ {
display: flex;
flex-direction: row;
align-items: center;
flex-wrap: nowrap;
}

#top-bar-right.right, #top-bar-right.right .has-form li {
display: flex;
flex-direction: row;
flex-wrap: nowrap;
justify-content: center;
max-width: none;
width: 100%;
max-height: 40px;
}

li#personal-tools-dropdown {
visibility: visible !important;
width: inherit;
max-width: 50px;
}

li#personal-tools-dropdown .drop-icon {
margin-right: 15px;
font-size: 14px;
}

#p-cactions #actions {
z-index: 600;
}

a#actions-button {
z-index: 599;
}

.top-bar-section .has-dropdown {
visibility: hidden;
width: 0;
}

.top-bar-section .dropdown {
z-index: 601;
}

.top-bar-section ul {
background: inherit;
width: inherit;
margin: auto;
}

.top-bar-section ul li {
background: inherit;
}

.top-bar-section .has-form, .top-bar-section li a:not(.button) {
background: inherit;
font-family: 'Inter', sans-serif;
max-height: inherit;
height: auto;
width: inherit;
padding: 0.25rem 0.5rem 0.25rem 0.5rem;
}

.top-bar-section ul li:hover:not(.has-form) > a, .top-bar-section li.active:not(.has-form) a:not(.button){
background: inherit;
color: transparent;
}

.top-bar-section ul li.active > a a:not(.button), .top-bar-section ul li ul.dropdown li > a {
background: rgb(0, 33, 66, 0.9) !important;
border-bottom: 0px solid;
}

.top-bar-section ul li.hover>a, .top-bar-section ul li ul.dropdown li.hover>a {
background: inherit;
color: transparent;
border-bottom: 0px;
}

.top-bar-section>ul>.divider, .top-bar-section>ul>[role="separator"] {
border-color: -moz-use-text-color #fff;
border-right: solid 0px #fff;
border-left: solid 0px #fff;
max-width: 5%;
}

.top-bar-section .divider, .top-bar-section [role="separator"] {
border-bottom: solid 0px;
border-top: solid 0px;
}

/* SEARCH - TOP BAR */

.top-bar .button.search {
margin: 4px;
background: url(https://mywikis-wiki-media.s3.us-central-1.wasabisys.com/nielsen/searchwhite.png) no-repeat;
color: transparent;
width: 21px;
border: none;
background-size: contain;
background-position: center;
}

input#searchInput {
background: #F1F2F3;
border-radius: 8px !important;
border-width: 2px !important;
border-color: #DDDEE4 !important;
font-size: 0.75rem;
width: 100%;
height: 25px;
}

input#searchInput::placeholder {
visibility: hidden;
}

.oo-ui-iconElement-icon { opacity: 50%; }

#searchInput::-webkit-input-placeholder { color: #FFFFFF; }

#searchInput:-moz-placeholder { color: #FFFFFF; }

#searchInput::-moz-placeholder { color: #FFFFFF; }

#searchInput:-ms-input-placeholder { color: #FFFFFF; }

/* Create page in Search */
.mw-search-createlink { display: none; }

/* SEARCH - PAGE */

div.oo-ui-fieldLayout-field {
display: flex !important;
flex-direction: row;
align-items: center;
justify-content: space-between;
margin: 18px;
}

.oo-ui-actionFieldLayout-input, .oo-ui-actionFieldLayout-button {
display: inline-block;
margin: 10px;
max-height: 38px;
}

.oo-ui-actionFieldLayout .oo-ui-actionFieldLayout-input .oo-ui-widget.oo-ui-textInputWidget > .oo-ui-inputWidget-input {
background: #F1F2F3;
border: 2px solid #DDDEE4;
border-radius: 8px;
margin-right: 10px;
position: relative;
}

.oo-ui-actionFieldLayout-input {
width: 100%;
}

.oo-ui-actionFieldLayout-button {
width: 20%;
}

.oo-ui-textInputWidget {
max-width: 100%;
}

.mw-widget-searchInputWidget {
display: inherit;
}

#mw-search-top-table div.oo-ui-actionFieldLayout {
width: 100%;
max-width: 100%;
}

/* BUTTONS */

button,
.button,
.multipleTemplateAdder {
background-color: #6A46FE;
border: 2px solid #6A46FE;
border-radius: 32px;
}

button:hover,
button:focus,
.button:hover,
.button:focus {
background-color: #4B31AF;
border: 2px solid #4B31AF;
border-radius: 32px;
}

button:disabled,
.button:disabled {
background-color: #6A46FE;
border: 2px solid #6A46FE;
border-radius: 32px;
opacity: 0.32;
}

.oo-ui-buttonElement-framed.oo-ui-widget-enabled.oo-ui-flaggedElement-primary.oo-ui-flaggedElement-progressive > .oo-ui-buttonElement-button,
.oo-ui-buttonElement-framed.oo-ui-widget-enabled.oo-ui-flaggedElement-primary.oo-ui-flaggedElement-progressive > .oo-ui-buttonElement-button:active {
border: 2px solid #6A46FE;
border-radius: 32px;
background-color: #6A46FE;
color: #ffffff;
}

.oo-ui-buttonElement-framed.oo-ui-widget-enabled.oo-ui-flaggedElement-primary.oo-ui-flaggedElement-progressive > .oo-ui-buttonElement-button:hover {
background-color: #4B31AF;
border: 2px solid #4B31AF;
border-radius: 32px;
color: #ffffff;
}

.oo-ui-buttonElement-framed.oo-ui-widget-enabled.oo-ui-flaggedElement-primary.oo-ui-flaggedElement-progressive > .oo-ui-buttonElement-button:focus {
background-color: #4B31AF;
border: 2px solid #4B31AF;
border-radius: 32px;
box-shadow: 0px 0px 0px 6px rgba(149, 140, 248, 0.16);
color: #ffffff;
}

input#wpPreview {
border: 2px solid #6A46FE;
border-radius: 32px;
background-color: #6A46FE;
color: #ffffff;
}

input#wpDiff {
border: 2px solid #DDDEE4;
border-radius: 32px;
background-color: #F1F2F3;
color: #111218;
}

button.secondary,
button.secondary:hover,
button.secondary:focus,
.button.secondary,
.button.secondary:hover,
.button.secondary:focus {
background: #363945;
border: 2px solid #363945;
border-radius: 32px;
color: #ffffff;
}

/* Back to Top button - use TopButton template */

span#Topbutton, #Topbutton a {
display: inline-block;
background-color: #6a46fec4;
width: auto;
height: auto;
max-width: 50px;
max-height: 50px;
text-align: center;
/* padding: 10px; */
border-radius: 8px;
position: fixed;
bottom: 40px;
right: 30px;
/* transition: background-color .3s,opacity .5s,visibility .5s; */
opacity: 1;
visibility: visible;
z-index: 1000;
}

#Topbutton a {
content: url(https://eng-client-portal-npd.nonprod.digitalengsdk.com/w/images/6/67/caretwhite.png);
padding: 10px;
}

#Topbutton a:hover {
cursor: pointer;
background-color: #4B31AF
}

#Topbutton:active {
background-color: #6A46FEc4
}

/* LINK FORMATTING */

a {
color: #6A46FE;
}

a:hover,
a:focus {
color: #4B31AF;
}

/* a.new { color: #ba0000; } */

.label {
background-color: transparent;
font-size: 0.75rem;
}

/* "Special" label */
h4.namespace.label {
display: none !important;
}

#bannertext a {
color: #FFFFFF !important;
}

/* TEXT FORMATTING */

.mw-headline {
font-family: 'Inter', sans-serif !important;
color: #111218; /* removed !important ... need to check how it behaves */
}

h1 {
font-family: 'Inter', sans-serif;
font-weight: 800;
font-size: 2rem;
letter-spacing: -0.25px;
margin-top: 1em;
margin-bottom: 0.5em;
}

h2 {
font-family: 'Inter', sans-serif !important;
color: #111218;
font-weight: 800;
font-size: 1.8rem;
letter-spacing: -0.25px;
margin-top: 1.5em;
margin-bottom: 0.83em;
}

h3 {
font-family: 'Inter', sans-serif;
font-size: 1.65rem;
font-weight: 800;
color: #002142 !important;
letter-spacing: -0.33px;
line-height: 1.6em;
margin-top: 1.5em;
margin-bottom: 0.5em;
}

h4 {
font-family: 'Inter', sans-serif;
font-size: 1.33rem;
font-weight: 600;
letter-spacing: -0.25px;
margin-top: 1.75em;
margin-bottom: 0.4em;
}

h5 {
font-family: 'Inter', sans-serif;
font-size: 1.33rem;
font-weight: 500;
line-height: 1.6em;
margin-top: 1.75em;
margin-bottom: 0.3em;
}

h6 {
font-family: 'Inter', sans-serif;
font-size: 1.15rem;
font-weight: 600;
line-height: 1.6em;
margin-top: 1.5em;
margin-bottom: 0.3em;
}

h1#firstHeading {
visibility: hidden;
height: 0px;
margin: 0 !important;
}

/* what is this for? */
h2#firstHeading.title {
font-family: 'Inter', sans-serif;
font-weight: 700;
font-size: 1rem;
letter-spacing: -0.25px;
text-transform: capitalize;
margin-bottom: 1em;
}

h2#filehistory {
visibility: hidden;
height: 0px;
}

h2#metadata {
visibility: hidden;
height: 0px;
}

h3#tagline {
visibility: hidden;
height: 0px;
margin: 0 !important;
}

h5#siteSub {
visibility: hidden;
height: 0;
}

/* Category links */

div #catlinks.catlinks {
margin-top: 2.5em !important;
}

#catlinks {
visibility: hidden;
}

ul#filetoc {
visibility: hidden;
height: 0px;
}

div#mw-imagepage-section-filehistory {
visibility: hidden;
height: 0px;
}

span.mw-redirectedfrom {
visibility: hidden;
height: 0px;
}

div.mw-imagepage-section-metadata {
visibility: hidden;
height: 0;
}

.mw-ui-vform {
margin-left: auto;
margin-right: auto;
}

#footer-left, ul#footer-left {
display: inline-block;
font-size: 80%;
}

li#footer-about {
display: none;
}

#footer-lastmod {
display: none;
}

footer.row {
margin-top: 2.5em;
margin-bottom: 1.5em;
}

/*
div#mw-customtoggle-myDivision.mw-customtoggle-myDivision {
display: flex !important;
}

.mw-collapsible-toggle.mw-collapsible-toggle-default.mw-collapsible-toggle-expanded {
background: url(https://eng-client-portal-npd.nonprod.digitalengsdk.com/w/images/9/9c/collapse.png) no-repeat;
background-size: contain;
width: 35px;
height: 35px;
float: none !important;
display: inline-flex;
float: none !important;

}

.mw-collapsible-toggle.mw-collapsible-toggle-collapsed {
display: inline-flex;
margin: 4px;
background: url(https://eng-client-portal-npd.nonprod.digitalengsdk.com/w/images/3/32/expand.png) no-repeat;
background-size: contain;
width: 35px;
height: 35px;
float: none !important;
flex-wrap: nowrap;
}

a.mw-collapsible-text {
color: transparent;
width: inherit;
}

span.mw-collapsible-toggle-default:before {
content: none !important;
}

span.mw-collapsible-toggle-default:after {
content: none !important;
}
*/

Digital Measurement SEI Static Content Viewing

2024-10-21T21:29:34Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

This document describes the log file exposures, to be used in conjunction with:
*[[Digital Measurement Content Audit Beacon]]
*[[Digital Measurement SEI Content Asset Metadata]]

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for an asset
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |cln
|Cumulative time spent viewing in seconds
|Yes if no position array
|
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Measurement SEI Static Content Viewing

2024-10-21T20:18:23Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for an asset
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes if no "cln"
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |cln
|Cumulative time spent viewing in seconds
|Yes if no position array
|
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Measurement SEI Static Content Viewing

2024-10-21T20:11:13Z

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products. = Delivery Specifications = Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data..."

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression;
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|
Format: alphanumeric

Example: Salted, hashed user ID:

<code>2cf24dba5fb0a30e26e83b2ab9…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|
Format: integer;

*<code>0</code> = Default / Unknown
*<code>1</code> = linear ad load
*<code>2</code> = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|
Format: integer;

*<code>0</code> = (no ads),
*<code>1</code> = (content is supported by ads)
*<code>2</code> = (not known)

Note: set to "<code>1</code>" if content ad support was intended but did not occur
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
|{
|adpod
|AdPod sequence number.

Increment for each AdPod. If the same AdPod is played out twice (due to rewind), still increment the AdPod sequence to reflect the sequence the AdPods are played.
|Yes
|
Format: Integer

Example:
<code>2</code>
|-
|
|adposition
|Ad sequence number.

Increment each time a new Ad is encountered. If the same Ad is played out twice (due to rewind), still increment the Ad sequence to reflect the sequence the Ads are played
|Yes
|
Format: Integer

Example:
<code>1</code>
|-
|
|adid
| The unique identifier for this Ad
|No
|
Format: alphanumeric

In-house AdId, Industry AdID, AdNetwork ID or DAR placement ID
|-
|
|isdarid
|Is the AdId being passed a Nielsen DAR placement ID
|Required if AdID
|
Format: integer
*<code>0</code> = is NOT DAR ID;
*<code>1</code> = is a DAR ID
|-
|
|adstart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
|<nowiki>}</nowiki>
|adend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|<code>55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…</code>
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|<code>B0EOFEDgD</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address
|Yes
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|<code>421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…</code>
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Nielsen Watermarking Introduction

2024-09-11T13:08:02Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement S2S CR}} {{CurrentBreadcrumb}}

[[File:Netflix_Encoding_and_ID3_Tagging.pdf|972x972px]]

Digital Measurement Content Relayed Audit Beacon

2024-09-11T13:07:42Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement S2S CR}} {{CurrentBreadcrumb}}

The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.

== Ping Structure ==
Ping is executed with following convention:

<code>https://'''[to_be_provided]'''.imrworldwide.com/cgi-bin/gn?prd=audit&+'''[query parameters]'''</code>

The Start Audit Ping carries all parameters in the table below. The End Audit Ping carries a subset of the parameters in the matrix below as denoted in the mandatory column.

Under normal operating circumstances, the audit ping server returns the following codes:

* Audit ping servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked
* 200: Ping successfully received, inspect traffic to ensure no CORS errors

= Session & Stream =

# Sessions
## Optionally, a new Session ID may be created when a new player is created
## If more than one video player exists within the same App (e.g. picture in picture) a different Session ID is required for each
# Streams
## New Stream ID is generated for each new video stream.
## If stream playback continues after 24 hours, then a new Stream ID should be created and a new Audit ping should be executed (Session ID may remain)
## Stream ID remains the same independent of fast-forward, rewind, pause, events assuming the asset remains the same
## If playback is suspended for greater than 30mins (paused or otherwise suspended), a new Stream ID should be assigned upon return
## Audit pings should be fired at the beginning and end of a stream

= Two-part Audit Ping design requires: =

#'''End-user-device-initiated ping''' with client-owned root domain and SessionID included in subdomain. Nielsen meters are trained to regex for a unique domain format. Example: <code><nowiki>https://2576459933726989.darnuid.[publisher-domain].com</nowiki></code>
#'''S2S Audit Ping relay from client-server to Nielsen server''' with furnished URL parameters outlined below. Example: <code><nowiki>https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=xp3clqou0dzb1u4jq2jecoyvza&appid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542</nowiki></code>

[[File:stdvss2saudit.png]]

= Furnished S2S Audit Ping Proxy Parameters =
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
|-
|apid
|Server App ID assigned by Nielsen
|Yes
|Nielsen
|
Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|Client
|
Format: alphanumeric
Example: Random GUID: <code>ce6c1c95-de3e-431e-b11e-77…</code>
|-
|pingtype
|Indicator for ping type: "start" or "end" audit ping
|Yes
|Client
|
Format: integer,
*<code>1</code> = Start Stream
*<code>0</code> = Start Session
*<code>3</code> = End Stream
*<code>2</code> = End Session
|-
|product
|Indicates which product audit ping corresponds to
|Yes
|Client
|
Format: alphanumeric,
Example: <code>dcr</code>, <code>dtvr</code>, <code>dar</code>, <code>ctv</code>
|-
|createtm
|Time ping is initiated
|Yes
|Client
|
Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
'''Audit Ping Start Example:'''

<code><nowiki>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB</nowiki></code>

'''Audit Ping End Example:'''

<code><nowiki>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637</nowiki></code>
[[Category:Digital]]

Digital Measurement SEI Content Viewing CR

2024-09-11T13:07:27Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement S2S CR}} {{CurrentBreadcrumb}}

This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression; (preferred)
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific, non-interoperable user ID (must remain persistent indefinitely); should match value provided in panel matching mechanism
|Yes
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Optional
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address, or truncated IP with last octet zeroed ".000"
|Optional
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Nielsen Watermarking Introduction

2024-09-10T20:54:23Z

Admin:

[[File:Netflix_Encoding_and_ID3_Tagging.pdf|972x972px]]

Digital Measurement SEI Content Viewing CR

2024-09-04T22:33:15Z

Admin: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

= Delivery Specifications =
Files should be delivered at a fixed cadence in a dedicated S3 bucket following the outlined in this spec prefix and object naming conventions and data formats.

* All prefix labels and file names should be lowercase except for app ids.
* Supported format are:
** Text files with utf-8 encoding in JSON Lines format;
** Apache Parquet format with snappy compression; (preferred)
* All data files have extensions to indicate the file format (.json | .parquet)
* Data file can be partitioned into multiple parts with min size of 256MB
* Data can be delivered separately in multiple splits, if needed due to organizational, technical or privacy requirements. This allows to permission s3 access separately, to process data independently and to persist data partitioned, within the limits of the SEI system;

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''<split>'''/'''yyyy/mm/dd/hh'''/'''<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|<code>test</code> or <code>prod</code>
|-
|filetype
|<code>exposure</code>, <code>dcr-exposure</code>, <code>dar-exposure</code>, <code>audio-exposure</code>, etc., where:

* exposure is reserved for multi-product files
* <product>-exposure is for single product files, where <product> is [<code>dar</code>|<code>dcr</code>|<code>dtvr</code>|<code>ctvc</code>|<code>audio</code>]
|-
|split
|a separate data split, can be by platform (ex.: ios, browser, android, ctv), by country (us, ca, jp, etc.), by publisher, by team, etc. or “all” (if data is provided in one split).
|-
|yyyy/mm/dd/hh
|
* yyyy - year
* mm - month
* dd - date padded with 0 example 01, 02,..., 31
* hh - hour padded with 0 example 00, 02,..., 23
|}

=== S3 Bucket and Prefix Naming Convention ===
<code><'''partnerid'''>_<'''filetype'''>_<'''intid'''>_<'''appid'''>_<'''starttime'''>_<'''endtime'''>.['''json'''|'''parquet''']</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|exposure, dcr-exposure, dar-exposure, audio-exposure, etc., where:

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|appid
|Nielsen-provided server application identifier
|-
|starttime
|start date and hour of the data in the file in UTC

* Example format: yyyymmddhh
|-
|endtime
|end date and hour (not inclusive) of the data in the file in UTC

* Example format: yyyymmddhh
|}

=== Success File ===
Empty <code>'''_SUCCESS'''</code> file should be provided to indicate that data delivery for a particular hour and split is completed (even if there is no data for that particular hour and split).

=== Manifest File ===
A manifest should be provided which contains metadata related to the uploaded file(s). The manifest is a text file in .json format that implements the AWS unload manifest file format. It has the same name as the data file, but has the <code>'''_manifest'''</code> suffix.

Example:
<syntaxhighlight lang="JSON">
{
"entries": [
{"url":"s3://bucket/prefix/0000_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0001_object_00.snappy.parquet", "mandatory":true},
{"url":"s3://bucket/prefix/0002_object_00.snappy.parquet", "mandatory":true}
{"url":"s3://bucket/prefix/0003_object_00.snappy.parquet", "mandatory":true}
],

"meta": {
"schema_version": "S2SV1.7.0",
"accreditation_status": "0",
"start_time": "1710154800",
"end_time": "1710158399",
"record_count": 31337
}
}
</syntaxhighlight>

The manifest contains a complete list of all files provided for a given period and split, as well as a meta data (a.k.a. header) which should include the following attributes:
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|<code>S2SV1.7.0</code>
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|<code>MRC = 1</code>
|String
|-
|data_start_time
|Data Start Time (min)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710154800</code>
|String
|-
|data_end_time
|Data Start Time (max)
|Yes
|Client
|Format:32-bit unsigned int Unix time in seconds
Example: <code>1710158399</code>
|String
|-
|record_count
|Number of records in data file
|Yes
|Client
|Example: <code>31337</code>
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0000.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0001.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0002.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_0003.json

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/acme_dtvr-exposure_a9ddf15ea054ea415718767ea6_P47C2495B-BBBA-56DE-BE99-14758F92F034_2024031111_2024031112_manifest

useast1-nlsn-w-dig-sei-acme-feeds-prod/dar-exposure/ios/2022/05/25/11/_SUCCESS</code>

= SLA =
The files must be delivered into the proper S3 bucket within 3 hours of the start of that hourly viewing file interval. For example, files from 1:00 AM to 2:00 AM must be delivered before 4 AM.

= Accuracy of Measurement =
The reported “wall clock” time of viewing needs to be within 25 seconds of the actual viewing time.

The reported content “reference” time needs to match the actual content that was played out with plus/minus 10 seconds (for clarity: start and end times can each be off by up to 10 seconds, so the combined under/over reporting for each individual viewing segment should be no greater than 20 seconds)

== CTV, Mirroring, and Casting ==
For apps native to the OTT device ''(i.e. downloading and viewing a streaming app to an Apple TV)'', audit ping should fire from the OTT device, and Viewing data should reside in OTT Viewing file.

[[File:Phone_Playback.png]]

For mirroring, where video playback occurs on the mobile device and OTT device, only one Viewing file row is necessary where, if possible to determine, set: <code>"secondscr":"MIR"</code> and include in respective mobile platform Viewing file.

For a casting scenario where content is controlled via the mobile device, but displayed only on the OTT device such as an AppleTV or Chromecast, an audit ping must fire from the mobile device before the casting occurs and at the end of playback from the mobile device only. Viewing data resides in the respective mobile platform Viewing file.
<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx123",
"referenceend":"xxxxxxx183",
"playheadstart":"0",
"playheadend":"60"
},
{
"referencestart":"xxxxxxx243",
"referenceend":"xxxxxxx303",
"playheadstart":"120",
"playheadend":"180"
}
]
}
</syntaxhighlight>

<syntaxhighlight lang="JSON">
{...
"sessionid":"ABC",
"streamid":"DEF",
"position":[
{
"referencestart":"xxxxxxx183",
"referenceend":"xxxxxxx243",
"playheadstart":"60",
"playheadend":"120"
}
],
"secondscr":"OTT"
}
</syntaxhighlight>

==Schema Parameter Definitions ==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |apn
|Application name
|Yes
|
Format: alphanumeric

Example:
<code>BestAppIOS</code>
|-
| colspan="2" |apv
|Application version
|Yes
|
Format: alphanumeric

Example:
<code>21.5</code>
|-
| colspan="2" |sessionid
|Unique, client generated value that represents the start of a user session. "Session" is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|
Format: alphanumeric

Example: Random GUID:
<code>cdcde33c-b62f-4f17-a9c8-0db4f78e09d6</code>
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|
Format: alphanumeric

Example: Random GUID:
<code>d7a909f1-5e77-4af7-8a9b-f2…</code>
|-
| colspan="2" |streamended
|Stream is known to have ended in this file
|Yes
|
Format: integer

Example:
*<code>1</code> (stream continues in subsequent file),
*<code>2</code> (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific, non-interoperable user ID (must remain persistent indefinitely); should match value provided in panel matching mechanism
|Yes
|
Format: alphanumeric

Example:
Salted, hashed user ID:

<code>8f434346648f6b96d9dda901c5…</code>
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|
Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|
Format: integer;

*<code>0</code> = Default / Unknown
*<code>1</code> = linear ad load
*<code>2</code> = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|
Format: integer;

*<code>0</code> = (no ads),
*<code>1</code> = (content is supported by ads)
*<code>2</code> = (not known)

Note: set to "<code>1</code>" if content ad support was intended but did not occur
|-
| colspan="2" |position
|Array of contiguous content viewing.

For viewing gaps < than 1 second, the gap can be smoothed over

See below for additional details on position array parameters
|Yes
|
Format:

<syntaxhighlight lang="JSON">
"position": [{
"referencestart":"[timestamp]",
"referenceend":"[timestamp]"
"playheadstart":"[playhead position]",
"playheadend":"[playhead position]"
}]
</syntaxhighlight>
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858505</code>
|-
|
|referenceend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds

Example:
<code>1577858775</code>
|-
|
|playheadstart
|Content position start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858515</code>
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds or integer indexed from 0 (typical for VOD)

Example:
<code>1577858785</code>
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

See below for additional details on position array parameters
|Yes
|
Format:
<syntaxhighlight lang="JSON">
"viewedads":
[
{
"adpod":"0",
"adposition":"0",
"adid":"0",
"isdarid":"0",
"adstart":"utc",
"adend":"utc",
"advisible":"0",
"adfocus":"0",
"adaudio":"0"
}
]
</syntaxhighlight>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Optional
|
Format: alphanumeric,

Example:
<code>Apple-iPhone1C2/801.293</code>
|-
| colspan="2" |xff
|IP address, or truncated IP with last octet zeroed ".000"
|Optional
|
Format: xxx.xxx.xxx.xxx
|-
| colspan="5" | The following 4 parameters become mandatory if Device User Agent String (UAS) is not available
|-
| colspan="2" |device_platform
|Device platform(mobile, desktop, connected device)
|Required if no UAS
|<code>DSK</code>, <code>MBL</code>, <code>OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN</code>, <code>APL</code>, <code>DVD</code>, <code>GGL</code>, <code>PSX</code>, <code>RKU</code>, <code>STB</code>, <code>STV</code>, <code>XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS</code>, <code>DROID</code>, <code>NA</code>
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|<code>DSK</code>, <code>PHN</code>, <code>TAB</code>, <code>STV</code>, <code>DVD</code>, <code>PMP</code>, <code>OTHER</code>, <code>STB</code>, <code>XBX</code>, <code>PSX</code>, <code>AMN</code>, <code>APL</code>, <code>GGL</code>, <code>RKU</code>, <code>UNWN</code>
|-
| colspan="5" | The following 4 parameters become mandatory if IP Address is not available
|-
| colspan="2" |robotic_flag
|Flag indicating IAB bot rule if IP address present in IAB bot list
|Required if no IP
|Format: integer
*<code>0</code> = not bot,
*<code>1</code> = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|<code>10001</code>
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| <code>US</code>, <code> CA</code>, etc.
|}
Note: All parameters are case sensitive.

[[Category:Digital]]

Digital Streaming Measurement S2S CR

2024-09-04T22:26:57Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|Digital Streaming Measurement Specifications (custom)}}
__NOTOC__

{| class="wikitable"
| colspan="3" | Single Endpoint Integration (SEI) - log-file based data transaction mechanism
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
!| Implementation Guide
|-
| rowspan="6" style="text-align:right;" | {{SmallIcon|S2SIcon.png|alt=SDK}}
|-
| rowspan="6" | {{OSIcon|VideoIcon.png|alt=Video}}
| '''[[Digital Measurement SEI Content Viewing CR]]'''
|-
| '''[[Digital Measurement Content Relayed Audit Beacon]]'''
|-
| '''[[Digital Measurement SEI Audio File]]''' (possibly optional if audio watermark monitoring feed can be repurposed)
|-
| '''[[Digital Measurement SEI Audio Metadata]]''' (possibly optional if audio watermark monitoring feed can be repurposed)
|-
| '''Panel Match Mechanism details to be mutually agreed upon'''
|}

Digital Streaming Measurement S2S CR

2024-09-04T22:09:44Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|Digital Streaming Measurement Specifications (custom)}}
__NOTOC__

{| class="wikitable"
| colspan="3" | Single Endpoint Integration (SEI) - log-file based data transaction mechanism
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
!| Implementation Guide
|-
| rowspan="5" style="text-align:right;" | {{SmallIcon|S2SIcon.png|alt=SDK}}
|-
| rowspan="5" | {{OSIcon|VideoIcon.png|alt=Video}}
| '''[[Digital Measurement SEI Content Viewing CR]]'''
|-
| '''[[Digital Measurement Content Relayed Audit Beacon]]'''
|-
| '''[[Digital Measurement SEI Audio File]]''' (possibly optional if audio watermark monitoring feed can be repurposed)
|-
| '''[[Digital Measurement SEI Audio Metadata]]''' (possibly optional if audio watermark monitoring feed can be repurposed)
|}

Digital Streaming Measurement S2S CR

2024-09-04T22:09:20Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|Digital Streaming Measurement Specifications (custom)}}
__NOTOC__

{| class="wikitable"
| colspan="3" | Single Endpoint Integration (SEI) - log-file based data transaction mechanism
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
!| Implementation Guide
|-
| rowspan="5" style="text-align:right;" | {{SmallIcon|S2SIcon.png|alt=SDK}}
|-
| rowspan="5" | {{OSIcon|VideoIcon.png|alt=Video}}
| '''[[Digital Measurement SEI Content Viewing CR]]'''
|-
| '''[[Digital Measurement Content Relayed Audit Beacon]]'''
|-
| '''[[Digital Measurement SEI Audio File]]''' (possibly optional if audio monitoring feed can be repurposed)
|-
| '''[[Digital Measurement SEI Audio Metadata]]''' (possibly optional if audio monitoring feed can be repurposed)
|}

Digital Streaming Measurement S2S CR

2024-09-04T22:07:51Z

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital {{CategoryIcon|DCR.png|Digital Streaming Measurement Specifications for Clean Room}} __NOTOC__ {| class="wikitable" | colspan="3" | Single Endpoint Integration (SEI) - log-file based data transaction mechanism |- ! style="width: 90px;" | Type ! style="width: 45px;" | !| Implementation Guide |- | rowspan="5" style="text-align:right;" | {{SmallIcon|S2SIcon.png|alt=SDK}} |- | rowspan="5" | {..."

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|Digital Streaming Measurement Specifications for Clean Room}}
__NOTOC__

{| class="wikitable"
| colspan="3" | Single Endpoint Integration (SEI) - log-file based data transaction mechanism
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
!| Implementation Guide
|-
| rowspan="5" style="text-align:right;" | {{SmallIcon|S2SIcon.png|alt=SDK}}
|-
| rowspan="5" | {{OSIcon|VideoIcon.png|alt=Video}}
| '''[[Digital Measurement SEI Content Viewing CR]]'''
|-
| '''[[Digital Measurement Content Relayed Audit Beacon]]'''
|-
| '''[[Digital Measurement SEI Audio File]]''' (possibly optional if audio monitoring feed can be repurposed)
|-
| '''[[Digital Measurement SEI Audio Metadata]]''' (possibly optional if audio monitoring feed can be repurposed)
|}

DTVR SEI Asset Metadata

2024-09-04T21:49:05Z

Admin: Admin moved page DTVR SEI Asset Metadata to Digital Measurement SEI Audio Metadata

#REDIRECT [[Digital Measurement SEI Audio Metadata]]

Digital Measurement SEI Audio Metadata

2024-09-04T21:49:04Z

Admin: Admin moved page DTVR SEI Asset Metadata to Digital Measurement SEI Audio Metadata

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}The Nielsen “server-2-server” method of collecting DTVR data requires the distributor to make available to Nielsen audio file for each live-streaming channel and each VoD asset that is eligible to DTVR crediting. Please contact your Nielsen Technical contact for a full description of what content is eligible for DTVR crediting.

In addition, to the audio files themselves, the DTVR ingestion process needs to some additional metadata for each audio file; this document specifies the additional “out-of-band” metadata that need to be provided.

The specification is defined using a JSON schema.

=== File Naming Convention and Location ===
File should be named with following convention: FileType_MVPDId_AssetId_UTCStart_UTCEnd

File type: DTVRAssetMetaData

MVPDid: unique identifier provided by Nielsen for each MVPD

AssetId: in-house assetId

UTCStart (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

UTCEnd (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

Files should be placed in S3 buckets with the following folder structure:

[To be determined during design phase]

Nielsen will move files to another location as they are processed so processing status is apparent.

In the case of a stream that has one version with blackouts and one without, one with mobile and one non-mobile, each stream would have its own unique asset id.

Nielsen recommends for live-streams that the audio track associated with the live feed be segmented into 15min chunks for delivery to Nielsen.

For VoD, Nielsen recommends using a single audio file, unless the total duration is greater than 6 hours, in which case the file should be broken up into smaller chunks.

For live-streams, the audio file does not need to break on a show boundary. Nielsen recommends breaking on a convenient wall-clock time, such as on the hour, 15past, 30past, 45past etc

Please check with the Nielsen Technical support to confirm the proposed audio format is supported, and if any compression, encryption algorithms or frequency band filters are going to be used to transport the audio files to Nielsen.

=== SLA ===
The files must be delivered into the proper S3 bucket within 2 hours of the broadcast. For example, files from 1:00 AM to 1:15 AM must be delivered before 3:00 AM. The metadata file should be delivered to an S3 bucket after the audio files described in this reference file are delivered, and before any Viewing file that would use these audio files has been delivered. Please refer to the associated specifications for the SLA’s of these other files.

=== JSON Param Definition ===
'''Header Record'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|schemaversion
|Json Schema Version
|Yes
|Nielsen
|Example: S2SDTVRAssetMetaDataV2.0
|-
|apid
|Server App ID
|Yes
|Nielsen
|Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|creationtime
|File creation time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|assetid
|In-House Asset Id
|Yes
|Client
|Format: alphanumeric,

Example: VID123456789
|-
|assetname
|In-House video asset name,

used for troubleshooting
|Yes
|Client
|Format: alphanumeric, Example: "A&E High Def East" or GraceNote channel mnemonic or call station letters
|-
|webpageurl
|Website Identifier, used for diagnostics, can be turned off/on as needed
|No
|Client
|Format: alphanumeric (max 2k)

Example:<nowiki>http://www.myapp.com/video.html</nowiki>
|-
|recordcount
|# of records in body of file
|Yes
|Client
|Format: numeric
|}
'''Header JSON Schema:'''

<code>{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"schemaversion": { "type": "string" },

"apid": { "type": "string" },

"creationtime": { "type": "string" },

"assetid": { "type": "string" },

"assetname": { "type": "string" },

"webpageurl": { "type": "string" },

"recordcount": { "type": "string" }

},

"required": [ "schemaversion", "apid", "creationtime", "assetid", "assetname", "recordcount" ]

}</code>

'''Header Record - Example:'''

<code>{

"schemaversion":"S2SDTVRAssetMetaDataV2.0",

"apid":"A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"creationtime":"1473781507",

"assetid":" VID123456789",

"assetname":"A&E High Def East",

"webpageurl":"<nowiki>http://www.myapp.com/video.html</nowiki>",

"recordcount":"100"

}</code>

'''Body'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|audiofilename
|Audio file name
|Yes
|Client
|Example: aacFile1.aac

Audio files are assumed to be uploaded to the same directory/folder as the associated Asset Metadata file
|-
|referencestart
|Starting in-house reference point for the audio file
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)

For VoD, this will be an offset from the start of the asset

For Live stream, this will be the in-house time
|-
|referenceend
|End in-house reference point for the audio file
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)

For VoD, this will be an offset from the start of the asset

For Live stream, this will be the in-house time
|}
Note: All parameters are case sensitive.

'''Body Message Schema:'''

<code>{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"audiofilename": { "type": "string" },

"referencestart": { "type": "string" },

"referenceend": { "type": "string" }

},

"required": [ "audiofilename", "referencestart", "referenceend" ]

}</code>

'''Body - Example:'''

<code>{"audiofilename":"aacFile1.aac","referencestart":"1489506887","referenceend":"1489506889"}</code>

Digital Measurement Content Relayed Audit Beacon

2024-09-04T21:38:43Z

Admin: /* Furnished S2S Audit Pint Proxy Parameters */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement}} {{CurrentBreadcrumb}}

The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.

== Ping Structure ==
Ping is executed with following convention:

<code>https://'''[to_be_provided]'''.imrworldwide.com/cgi-bin/gn?prd=audit&+'''[query parameters]'''</code>

The Start Audit Ping carries all parameters in the table below. The End Audit Ping carries a subset of the parameters in the matrix below as denoted in the mandatory column.

Under normal operating circumstances, the audit ping server returns the following codes:

* Audit ping servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked
* 200: Ping successfully received, inspect traffic to ensure no CORS errors

= Session & Stream =

# Sessions
## Optionally, a new Session ID may be created when a new player is created
## If more than one video player exists within the same App (e.g. picture in picture) a different Session ID is required for each
# Streams
## New Stream ID is generated for each new video stream.
## If stream playback continues after 24 hours, then a new Stream ID should be created and a new Audit ping should be executed (Session ID may remain)
## Stream ID remains the same independent of fast-forward, rewind, pause, events assuming the asset remains the same
## If playback is suspended for greater than 30mins (paused or otherwise suspended), a new Stream ID should be assigned upon return
## Audit pings should be fired at the beginning and end of a stream

= Two-part Audit Ping design requires: =

#'''End-user-device-initiated ping''' with client-owned root domain and SessionID included in subdomain. Nielsen meters are trained to regex for a unique domain format. Example: <code><nowiki>https://2576459933726989.darnuid.[publisher-domain].com</nowiki></code>
#'''S2S Audit Ping relay from client-server to Nielsen server''' with furnished URL parameters outlined below. Example: <code><nowiki>https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=xp3clqou0dzb1u4jq2jecoyvza&appid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542</nowiki></code>

[[File:stdvss2saudit.png]]

= Furnished S2S Audit Ping Proxy Parameters =
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
|-
|apid
|Server App ID assigned by Nielsen
|Yes
|Nielsen
|
Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|Client
|
Format: alphanumeric
Example: Random GUID: <code>ce6c1c95-de3e-431e-b11e-77…</code>
|-
|pingtype
|Indicator for ping type: "start" or "end" audit ping
|Yes
|Client
|
Format: integer,
*<code>1</code> = Start Stream
*<code>0</code> = Start Session
*<code>3</code> = End Stream
*<code>2</code> = End Session
|-
|product
|Indicates which product audit ping corresponds to
|Yes
|Client
|
Format: alphanumeric,
Example: <code>dcr</code>, <code>dtvr</code>, <code>dar</code>, <code>ctv</code>
|-
|createtm
|Time ping is initiated
|Yes
|Client
|
Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
'''Audit Ping Start Example:'''

<code><nowiki>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB</nowiki></code>

'''Audit Ping End Example:'''

<code><nowiki>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637</nowiki></code>
[[Category:Digital]]

Digital Measurement Content Relayed Audit Beacon

2024-09-04T21:38:12Z

Admin: /* Furnished S2S Audit Pint Proxy Parameters */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement}} {{CurrentBreadcrumb}}

The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.

== Ping Structure ==
Ping is executed with following convention:

<code>https://'''[to_be_provided]'''.imrworldwide.com/cgi-bin/gn?prd=audit&+'''[query parameters]'''</code>

The Start Audit Ping carries all parameters in the table below. The End Audit Ping carries a subset of the parameters in the matrix below as denoted in the mandatory column.

Under normal operating circumstances, the audit ping server returns the following codes:

* Audit ping servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked
* 200: Ping successfully received, inspect traffic to ensure no CORS errors

= Session & Stream =

# Sessions
## Optionally, a new Session ID may be created when a new player is created
## If more than one video player exists within the same App (e.g. picture in picture) a different Session ID is required for each
# Streams
## New Stream ID is generated for each new video stream.
## If stream playback continues after 24 hours, then a new Stream ID should be created and a new Audit ping should be executed (Session ID may remain)
## Stream ID remains the same independent of fast-forward, rewind, pause, events assuming the asset remains the same
## If playback is suspended for greater than 30mins (paused or otherwise suspended), a new Stream ID should be assigned upon return
## Audit pings should be fired at the beginning and end of a stream

= Two-part Audit Ping design requires: =

#'''End-user-device-initiated ping''' with client-owned root domain and SessionID included in subdomain. Nielsen meters are trained to regex for a unique domain format. Example: <code><nowiki>https://2576459933726989.darnuid.[publisher-domain].com</nowiki></code>
#'''S2S Audit Ping relay from client-server to Nielsen server''' with furnished URL parameters outlined below. Example: <code><nowiki>https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=xp3clqou0dzb1u4jq2jecoyvza&appid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542</nowiki></code>

[[File:stdvss2saudit.png]]

= Furnished S2S Audit Pint Proxy Parameters =
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
|-
|apid
|Server App ID assigned by Nielsen
|Yes
|Nielsen
|
Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|Client
|
Format: alphanumeric
Example: Random GUID: <code>ce6c1c95-de3e-431e-b11e-77…</code>
|-
|pingtype
|Indicator for ping type: "start" or "end" audit ping
|Yes
|Client
|
Format: integer,
*<code>1</code> = Start Stream
*<code>0</code> = Start Session
*<code>3</code> = End Stream
*<code>2</code> = End Session
|-
|product
|Indicates which product audit ping corresponds to
|Yes
|Client
|
Format: alphanumeric,
Example: <code>dcr</code>, <code>dtvr</code>, <code>dar</code>, <code>ctv</code>
|-
|createtm
|Time ping is initiated
|Yes
|Client
|
Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
'''Audit Ping Start Example:'''

<code><nowiki>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB</nowiki></code>

'''Audit Ping End Example:'''

<code><nowiki>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637</nowiki></code>
[[Category:Digital]]

Digital Measurement Content Relayed Audit Beacon

2024-09-04T21:37:17Z

Admin: /* Query Parameters */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement}} {{CurrentBreadcrumb}}

The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.

== Ping Structure ==
Ping is executed with following convention:

<code>https://'''[to_be_provided]'''.imrworldwide.com/cgi-bin/gn?prd=audit&+'''[query parameters]'''</code>

The Start Audit Ping carries all parameters in the table below. The End Audit Ping carries a subset of the parameters in the matrix below as denoted in the mandatory column.

Under normal operating circumstances, the audit ping server returns the following codes:

* Audit ping servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked
* 200: Ping successfully received, inspect traffic to ensure no CORS errors

= Session & Stream =

# Sessions
## Optionally, a new Session ID may be created when a new player is created
## If more than one video player exists within the same App (e.g. picture in picture) a different Session ID is required for each
# Streams
## New Stream ID is generated for each new video stream.
## If stream playback continues after 24 hours, then a new Stream ID should be created and a new Audit ping should be executed (Session ID may remain)
## Stream ID remains the same independent of fast-forward, rewind, pause, events assuming the asset remains the same
## If playback is suspended for greater than 30mins (paused or otherwise suspended), a new Stream ID should be assigned upon return
## Audit pings should be fired at the beginning and end of a stream

= Two-part Audit Ping design requires: =

#'''End-user-device-initiated ping''' with client-owned root domain and SessionID included in subdomain. Nielsen meters are trained to regex for a unique domain format. Example: <code><nowiki>https://2576459933726989.darnuid.[publisher-domain].com</nowiki></code>
#'''S2S Audit Ping relay from client-server to Nielsen server''' with furnished URL parameters outlined below. Example: <code><nowiki>https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=xp3clqou0dzb1u4jq2jecoyvza&appid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542</nowiki></code>

[[File:stdvss2saudit.png]]

= Furnished S2S Audit Pint Proxy Parameters =
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
|-
|apid
|Server App ID assigned by Nielsen
|Yes
|Nielsen
|
Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|Client
|
Format: alphanumeric
Example: Random GUID: <code>ce6c1c95-de3e-431e-b11e-77…</code>
|-
|pingtype
|Indicator for ping type: "start" or "end" audit ping
|Yes
|Client
|
Format: integer,
*<code>1</code> = Start Stream
*<code>0</code> = Start Session
*<code>3</code> = End Stream
*<code>2</code> = End Session
|-
|product
|Indicates which product audit ping corresponds to
|Yes
|Client
|
Format: alphanumeric,
Example: <code>dcr</code>, <code>dtvr</code>, <code>dar</code>, <code>ctv</code>
|-
|createtm
|Time ping is initiated
|Yes
|Client
|
Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
'''Audit Ping Start Example:'''

<code>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB</code>

'''Audit Ping End Example:'''

<code>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637</code>
[[Category:Digital]]

Digital Measurement Content Relayed Audit Beacon

2024-09-04T21:32:27Z

Admin:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement}} {{CurrentBreadcrumb}}

The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.

== Ping Structure ==
Ping is executed with following convention:

<code>https://'''[to_be_provided]'''.imrworldwide.com/cgi-bin/gn?prd=audit&+'''[query parameters]'''</code>

The Start Audit Ping carries all parameters in the table below. The End Audit Ping carries a subset of the parameters in the matrix below as denoted in the mandatory column.

Under normal operating circumstances, the audit ping server returns the following codes:

* Audit ping servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked
* 200: Ping successfully received, inspect traffic to ensure no CORS errors

= Session & Stream =

# Sessions
## Optionally, a new Session ID may be created when a new player is created
## If more than one video player exists within the same App (e.g. picture in picture) a different Session ID is required for each
# Streams
## New Stream ID is generated for each new video stream.
## If stream playback continues after 24 hours, then a new Stream ID should be created and a new Audit ping should be executed (Session ID may remain)
## Stream ID remains the same independent of fast-forward, rewind, pause, events assuming the asset remains the same
## If playback is suspended for greater than 30mins (paused or otherwise suspended), a new Stream ID should be assigned upon return
## Audit pings should be fired at the beginning and end of a stream

= Two-part Audit Ping design requires: =

#'''End-user-device-initiated ping''' with client-owned root domain and SessionID included in subdomain. Nielsen meters are trained to regex for a unique domain format. Example: <code><nowiki>https://2576459933726989.darnuid.[publisher-domain].com</nowiki></code>
#'''S2S Audit Ping relay from client-server to Nielsen server''' with furnished URL parameters outlined below. Example: <code><nowiki>https://audit.imrworldwide.com/cgi-bin/gn?prd=audit&intid=xp3clqou0dzb1u4jq2jecoyvza&appid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&product=dar&createtm=1643858542</nowiki></code>

[[File:stdvss2saudit.png]]

= Query Parameters =
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
|-
|apid
|Server App ID assigned by Nielsen
|Yes
|Nielsen
|
Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|sessionid
|Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams.
|Yes
|Client
|
Format: alphanumeric
Example: Random GUID: <code>ce6c1c95-de3e-431e-b11e-77…</code>
|-
|pingtype
|Indicator for ping type: "start" or "end" audit ping
|Yes
|Client
|
Format: integer,
*<code>1</code> = Start Stream
*<code>0</code> = Start Session
*<code>3</code> = End Stream
*<code>2</code> = End Session
|-
|product
|Indicates which product audit ping corresponds to
|Yes
|Client
|
Format: alphanumeric,
Example: <code>dcr</code>, <code>dtvr</code>, <code>dar</code>, <code>ctv</code>
|-
|uoo
|User opt out flag for demographic measurement
|Yes, if devid/HHID provided
|Client
|
Format: integer
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
|devid
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Optional, or in S2S file
|Client
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|hhid
|House Hold ID. Used as a primary match key to external data sources.
|Optional, or in S2S file.
|Client
|<code>B0EOFEDgD</code>
|-
|createtm
|Time ping is initiated
|Yes
|Client
|
Format: Unix timestamp in 32-bit unsigned int in seconds
Example: <code>1577858505</code>
|}
'''Audit Ping Start Example:'''

<code>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB</code>

'''Audit Ping End Example:'''

<code>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637</code>
[[Category:Digital]]

File:stdvss2saudit.png

2024-09-04T21:31:56Z

Admin:

stdvss2saudit