Engineering Client Portal - User contributions [en]

Digital Measurement SEI Streaming Content Viewing

2025-10-31T15:36:02Z

DarsanaDinesh:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

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

== Delivery Specifications ==
Files should be delivered at a fixed cadence in a dedicated S3 bucket the following 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 (.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" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501</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.

Digital Measurement SEI Audio File

2025-10-31T15:35:36Z

DarsanaDinesh:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

The Nielsen SEI server-to-server solution ([[Digital Measurement SEI Content Viewing]]) needs audio files for each watermarked source that requires crediting.

{| class="wikitable"
|-
! '''Audio Compression Type''' !! '''Tested ideal Compression Rate'''
|-
| AC3 Stereo || 192 Kbps or higher
|-
| AC3 5.1 || 384 Kbps or higher
|-
| Enhanced AC3 || 192 Kbps
|-
| MPEG2 audio || 192 Kbps or higher
|-
| AAC with ADTS headers ||
|}

* If source audio is stereo, include both Left and Right channels
* If source audio is 5.1, take L + .707C into Left and R + .707C into Right and deliver stereo
* Audio sampling rate should be 32kHz, 44.1kHz or 48kHz

=== S3 Bucket and Prefix Naming Convention ===
<code>DTVRAudio_<'''partnerid'''>_<'''AssetId'''>_<'''UTCStart'''>_<'''UTCEnd'''></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|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 in a mutually agreed upon folder structure.
*15 minutes of audio does not have to align with hour boundary. For example for broadcast from 1 AM to 2 AM, 4 audio files each with 15 minutes of audio from 1:00 AM to 1:15 AM, 1:15 AM until 1:30 AM, 1:30 AM until 1:45 AM and 1:45 AM until 2:00 AM, but if the encoder turns on at 1:07, deliver through 1:22, etc. The preference is hourly bound but not required.
*If difficult to achieve exactly 15m increments, err towards shorter. I.e. 10m instead of 20m
*Avoid small, fragmented audio files. Watermark decoding algorithms require runway. Too short of a file will result in lost audio codes
*If file times/audio overlap, ingestion will overwrite the portion of the older file
*Precision is important for UTC start/end file naming convention. Use UTC timestamp of Server time/encoder
*The file should not be encrypted.
*One copy per stream only.

=== Audio Asset Metadata ===
==== S3 Bucket and Prefix Naming Convention ====
<code>DTVRAssetMetaData_<'''partnerid'''>_<'''AssetId'''>_<'''UTCStart'''>_<'''UTCEnd'''></code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|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
|-
|}

==== Header Record ====
{| class="wikitable"
|-
! '''Parameter''' !! '''Description''' !! '''Mandatory''' !! '''Specified by''' !! '''Format'''
|-
| appid || Nielsen-provided server application identifier || Yes || Nielsen || Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| creationtime || File creation time || Yes || Client || Format: Unix timestamp in 32-bit unsigned int in seconds
Example:
<code>1577858505</code>
|-
| assetid || In-house id used for a video asset || Yes || Client || Format: alphanumeric

Example:
<code>VID123456789</code>
|-
| recordcount || # of records in body of file || Yes || Client || Format: numeric
|}

==== Body ====
{| class="wikitable"
|-
! '''Parameter''' !! '''Description''' !! '''Mandatory''' !! '''Specified by''' !! '''Format'''
|-
| audiofilename || Audio file name || Yes || Client || Example: <code>aacFile1.aac</code>
|-
| referencestart || Start of in-house reference time for the audio file || Yes || Client ||
Format: Unix timestamp in 32-bit unsigned int in seconds
*For VOD, parameter should reflect offset from the start of the asset
*For Livestream, parameter should reflect in-house time
|-
| referenceend || End pf in-house reference point for the audio file || Yes || Client ||
Format: Unix timestamp in 32-bit unsigned int in seconds
*For VOD, parameter should reflect offset from the start of the asset
*For Livestream, parameter should reflect in-house time
|}

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

Digital Measurement Content Audit Beacon

2025-10-31T15:35:10Z

DarsanaDinesh:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{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

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

Digital Measurement Content Asset Metadata

2025-10-31T15:34:33Z

DarsanaDinesh: Added DCR asset metadata page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}

The Nielsen "Server-To-Server" method of collecting DCR data requires the distributor to make available each Asset (Episode) referenced in the DCR Viewing file in a separate metadata file (a.k.a metadata catalog). 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.
==Delivery Specifications==
Consolidated list of asset metadata catalog that is up to date for a particular hour needs to be provided in a single file following the naming convention specified below. The metadata needs to be in a json lines format, including a header line. A reasonable effort needs to be made to remove expired/inactive asset ids, to avoid size creep.
===S3 Bucket and Prefix Naming Convention===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>'''/'''<filetype>'''/'''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
|dcrassetmetadata
|-
|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>'''<partner_id>_<file_type>_<int_id>[.gz]'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|filetype
|dcrassetmetadata
|-
|initid
|integration id: unique identifier provided by Nielsen
|-
|[.gz]
|Uncompressed json lines (no extension) - splittable, ideal for medium size files, less than 5 GB, preferred for metadata.
Optional compression formats supported:
*[.gz] - non splittable, requires multiple files, if data larger than 32 MB
|}
===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).
===Data delivery example for hour 10 (10:00:00 AM UTC to 10:59:59 PM UTC):===
<code>useast1-nlsn-w-dig-sei-acme-feeds-prod/dcrassetmetadata/2022/06/12/10/ acme_dcrassetmetadata_a9ddf15ea054ea415718767ea6

useast1-nlsn-w-dig-sei-acme-feeds-prod/dcrassetmetadata/2022/06/12/10/_SUCCESS</code>
==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 before any Viewing file has been delivered.
==Schema Parameter Definitions==
{| class="wikitable"
! colspan="2" |'''Parameter'''
!'''Description'''
!'''Required'''
!'''Format / Example'''
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric,

Example: VID123456789

AssetId needs to be unique at episode level
|-
| colspan="2" |assetname
|In-house video asset name,
for troubleshooting
|Yes
|Format: alphanumeric

Examples: TMS ID, EIDR ID or Episode title
|-
| colspan="2" |programname
|Name of the program
|Yes
|Format: alphanumeric, Max 25 char’s; no special characters

Example: Nightly News
|-
| colspan="2" |episodetitle
|Title of the episode
|Yes
|Format: alphanumeric
|-
| colspan="2" |episodelen
|Total episode length
|Yes
|Format: Integer (seconds)

Example: 3600

For continuous live stream or unknown duration use 24*60*60 (86400)

Can be updated with a replacement asset file when the live playout ends, and the exact duration becomes known
|-
| colspan="2" |isfullepisode
|Full episode Flag
(indicates full episode or a clip)
|Yes
|Format: integer – 0 (not full episode), 1 (full episode)
|-
| colspan="2" |genre
|Nielsen genre code
|No
|Format: alphanumeric

Example: CV (comedy variety), N (news)
|-
| colspan="2" |airdate
|The date the episode was first made available on Traditional TV
|No
|Format: US ET: YYYYMMDDHHMMSS

Example: 19970716231256

For the US, the time should be specified as Eastern Timezone. Other countries will use a local timezone.

This value can be updated with a replacement asset file if the original air date changes
|-
| colspan="2" |webpageurl
|Website Identifier, for diagnostics, can be turned off/on as needed
|Optional
|Format: alphanumeric (max 2k)

Example:<nowiki>https://www.myapp.com/video.html</nowiki>
|}Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2025-10-31T15:32:47Z

DarsanaDinesh:

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

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

== Delivery Specifications ==
Files should be delivered at a fixed cadence in a dedicated S3 bucket the following 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 (.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" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501</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.

Digital Measurement SEI Streaming Content Viewing

2025-10-30T12:59:28Z

DarsanaDinesh:

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

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

== Delivery Specifications ==
Files should be delivered at a fixed cadence in a dedicated S3 bucket the following 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 (.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.

== 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" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501</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.

Digital Measurement SEI Streaming Content Viewing

2025-10-30T12:57:55Z

DarsanaDinesh: /* Accuracy of Measurement */

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

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

== Delivery Specifications ==
Files should be delivered at a fixed cadence in a dedicated S3 bucket the following 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 (.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.

== 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" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|
Format: alphanumeric;

Example:

<code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</code>

Note: Only Data Tags should be included, INFO Tags should not.

INFO Tag is characterized by the following CID prefix: X100zdCIGeIlgZnkYj6UvQ==

Example INFO Tag (not desired):

<code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</code>
|-
| colspan="2" |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>
|-
| colspan="2" |station_id
|GraceNote station ID that identifies the station
|Required if id3 not provided
|
Format: alphanumeric
|-
| colspan="2" |program_name
|Name of program
|Required if id3 not provided
|
Format: alphanumeric, Max 25 characters; no special characters.

Example:
<code>Nightly News</code>

See below for more specific guidance on Program Name.
|-
| colspan="2" |network_affiliate
|Network affiliation of a station
|Required if id3 not provided
|
Format: alphanumeric

Example:
<code>xyz</code>
|-
| colspan="2" |channel_id
|ID of channel
|Required if id3 not provided
|
Format: integer
|-
| colspan="2" |channel_name
|Name of channel
|Required if id3 not provided
|
Format: alphanumeric
|-
| colspan="2" |callsign
| FCC assigned unique identifier for a transmitter station
|Required if id3 not provided
|
Format: alphanumeric
|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501</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.

US DCR & DTVR

2025-10-30T12:54:04Z

DarsanaDinesh:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SEI ==
{| class="wikitable"
| colspan="3" |Single Endpoint Integration (SEI) - log-file based data transaction mechanism
|-
!Type
!
!Implementation Guide
|-
| rowspan="5" |{{SmallIcon|DigitalIcon.png}}
|-
| rowspan="5" |{{OSIcon|VideoIcon.png|alt=Video}}
|'''[[Digital Measurement SEI Streaming Content Viewing]]'''
|-
|'''[[Digital Measurement Content Asset Metadata]]'''
|-
|'''[[Digital Measurement Content Audit Beacon]]'''
|-
|'''[[Digital Measurement SEI Audio File]](Only for DTVR)'''
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== AppSDK Flutter Plugin ==
{| class="wikitable"
| colspan="6" | Flutter Integration Guides (Flutter support is part of [[Special:Downloads|Nielsen's AppSDK V10.1.0]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Flutter_Integration|DCR & DTVR Flutter Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
 
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

Digital Measurement Content Audit Beacon

2025-10-28T11:48:15Z

DarsanaDinesh:

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

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

Digital Measurement Content Audit Beacon

2025-10-28T11:45:14Z

DarsanaDinesh: Added Content Audit page

Digital Measurement SEI Ad Exposure

2025-10-27T14:24:37Z

DarsanaDinesh:

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

This document outlines the required specification for facilitating Nielsen ONE advertising(N1Ad) measurement, Digital Ad Ratings (DAR) measurement, Nielsen Media Impact (NMI), Add Effectiveness (MTA, Lift, etc.), Nielsen Brand Effect (NBE) 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.

Refer to [[Digital Measurement SEI Data Delivery Specification]] for file delivery and access.

=== 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, after which the process will skip the missing file and continue processing subsequent files. 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" |session_id
|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.
|No
|
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>

where ci - Nielsen defined client identifier that will be unique per Nielsen client

am - Nielsen defined Ad Server value.

ca - Nielsen defined campaign ID which allows the overall campaign for the client to be tied together across publishers

ce - Site ID of where the campaign is being served.

pc - This is the individual placement value for different placements being served on the site.

The rest of the variable value pairs generally are static and do not change
|-
|
|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>
|-
|
|tms_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Optional
|
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
|Preferred for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
|
|program_type
|Type of the program
|Preferred for CTV
|Example: <code>television, movie</code>
|-
|
|program_name
|Name of program in which the ad was served
|Preferred for CTV
|Name Of TV Show
|-
| }
|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. If hashed, use SHA-256 hashing method while keeping hyphens in place and in all lower case
|Yes, if available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |is_device_id_hashed
|If device_id is SHA-256 hashed
|Yes
|
Format: boolean
*<code>True</code> = hashed
*<code>False</code> = else
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing

* remove all leading and trailing whitespace
* force lowercase
* for @gmail.com addresses only:
** remove dots
** remove + suffix, including sign

Example: “Art.Nielsen+JR@gmail.com” → “artnielsen@gmail.com”
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: string
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |device_useragent
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

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

Example: <code>172.217.22.14</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>
*DSK (Desktop)
*PHN (Mobile phone)
*TAB (Tablet)
*STV (Smart TVs)
*DVD (BluRay & DVD player devices)
*STB (Set-top boxes)
*XBX (Xbox devices)
*PSX (PlayStation devices)
*AMN (Amazon devices, excluding SmartTVs)
*APL (Apple devices)
*GGL (Google devices, excluding SmartTVs)
*RKU (Roku devices, excluding SmartTVs)
*UNWN (Unknown Device)
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |bot_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="5" |The following parameters are needed if dar_url is not available
|-
| colspan="2" |campaign_id
|Campaign Identifier which allows the overall campaign for the client to be tied together across publishers
|Required if no dar_url
|Example: nlsn1234
|-
| colspan="2" |client_id
|Nielsen defined client identifier that will be unique per Nielsen client
|Required if no dar_url
|Example: nlsnci1046
|-
| colspan="2" |creative_id
|Identifier for the Ad creative
|Optional
|Example: ad3ff462d24541339d6f67e1b2352465
|-
| colspan="2" |site_id
|Site ID of where the campaign is being served.
|Required if no dar_url
|Example: site1
|-
| colspan="2" |placement_id
|Identifier for different placements being served on the site.
|Required if no dar_url
|Example: 150DEB50A2ED2D
|-
| colspan="2" |adserver
|Nielsen defined Ad Server value
|Required if no dar_url
|Nielsen provided Ad Server value
|}
Note: All parameters are case sensitive.

'''Example in JSON format'''

{

"session_id": "R487421B-XXXX-YYYY-3343-E3BBB46E44F2",

"device_id": "A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"is_device_id_hashed": False,

"hem_sha256": "671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2",

"uoo": "0",

"timestamp": "1548395046744",

"ip_address": "86.100.256.000",

"device_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36",

"device_group": "PHN",

"device_platform": "MBL",

"dma": "501",

"zip_code": "10001",

"ad" : {

"publisher_user_id": "ed36968977606872e4312943c218568123786342",

"dar_url": "<nowiki>http://secure-gl.imrworldwide.com/cgi-bin/m</nowiki>? ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345",

"publisher_name": "Publisher 123",

"original_airtime": "1593633600",

}

}
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-10-27T14:20:10Z

DarsanaDinesh:

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

This document outlines the required specification for facilitating Nielsen ONE advertising(N1Ad) measurement, Digital Ad Ratings (DAR) measurement, Nielsen Media Impact (NMI), Add Effectiveness (MTA, Lift, etc.), Nielsen Brand Effect (NBE) 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.

Refer to [[Digital Measurement SEI Data Delivery Specification]] for file delivery and access.

=== 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, after which the process will skip the missing file and continue processing subsequent files. 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" |session_id
|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.
|No
|
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>

where ci - Nielsen defined client identifier that will be unique per Nielsen client

am - Nielsen defined Ad Server value.

ca - Nielsen defined campaign ID which allows the overall campaign for the client to be tied together across publishers

ce - Site ID of where the campaign is being served.

pc - This is the individual placement value for different placements being served on the site.

The rest of the variable value pairs generally are static and do not change
|-
|
|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>
|-
|
|tms_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Optional
|
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
|Preferred for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
|
|program_type
|Type of the program
|Preferred for CTV
|Example: <code>television, movie</code>
|-
|
|program_name
|Name of program in which the ad was served
|Preferred for CTV
|Name Of TV Show
|-
| }
|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. If hashed, use SHA-256 hashing method while keeping hyphens in place and in all lower case
|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

* remove all leading and trailing whitespace
* force lowercase
* for @gmail.com addresses only:
** remove dots
** remove + suffix, including sign

Example: “Art.Nielsen+JR@gmail.com” → “artnielsen@gmail.com”
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: boolean
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |device_useragent
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

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

Example: <code>172.217.22.14</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>
*DSK (Desktop)
*PHN (Mobile phone)
*TAB (Tablet)
*STV (Smart TVs)
*DVD (BluRay & DVD player devices)
*STB (Set-top boxes)
*XBX (Xbox devices)
*PSX (PlayStation devices)
*AMN (Amazon devices, excluding SmartTVs)
*APL (Apple devices)
*GGL (Google devices, excluding SmartTVs)
*RKU (Roku devices, excluding SmartTVs)
*UNWN (Unknown Device)
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |bot_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="5" |The following parameters are needed if dar_url is not available
|-
| colspan="2" |campaign_id
|Campaign Identifier which allows the overall campaign for the client to be tied together across publishers
|Required if no dar_url
|Example: nlsn1234
|-
| colspan="2" |client_id
|Nielsen defined client identifier that will be unique per Nielsen client
|Required if no dar_url
|Example: nlsnci1046
|-
| colspan="2" |creative_id
|Identifier for the Ad creative
|Optional
|Example: ad3ff462d24541339d6f67e1b2352465
|-
| colspan="2" |site_id
|Site ID of where the campaign is being served.
|Required if no dar_url
|Example: site1
|-
| colspan="2" |placement_id
|Identifier for different placements being served on the site.
|Required if no dar_url
|Example: 150DEB50A2ED2D
|-
| colspan="2" |adserver
|Nielsen defined Ad Server value
|Required if no dar_url
|Nielsen provided Ad Server value
|}
Note: All parameters are case sensitive.

'''Example in JSON format'''

{

"session_id": "R487421B-XXXX-YYYY-3343-E3BBB46E44F2",

"device_id": "A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"is_device_id_hashed": "0",

"hem_sha256": "671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2",

"uoo": "0",

"timestamp": "1548395046744",

"ip_address": "86.100.256.000",

"device_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36",

"device_group": "PHN",

"device_platform": "MBL",

"dma": "501",

"zip_code": "10001",

"ad" : {

"publisher_user_id": "ed36968977606872e4312943c218568123786342",

"dar_url": "<nowiki>http://secure-gl.imrworldwide.com/cgi-bin/m</nowiki>? ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345",

"publisher_name": "Publisher 123",

"original_airtime": "1593633600",

}

}
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-08-26T11:40:27Z

DarsanaDinesh:

{{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.), Nielsen Brand Effect (NBE) 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.

Refer to [[Digital Measurement SEI Data Delivery Specification]] for file delivery and access.

=== 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, after which the process will skip the missing file and continue processing subsequent files. 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" |session_id
|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.
|No
|
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>

where ci - Nielsen defined client identifier that will be unique per Nielsen client

am - Nielsen defined Ad Server value.

ca - Nielsen defined campaign ID which allows the overall campaign for the client to be tied together across publishers

ce - Site ID of where the campaign is being served.

pc - This is the individual placement value for different placements being served on the site.

The rest of the variable value pairs generally are static and do not change
|-
|
|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>
|-
|
|tms_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Optional
|
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
|Preferred for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
|
|program_type
|Type of the program
|Preferred for CTV
|Example: <code>television, movie</code>
|-
|
|program_name
|Name of program in which the ad was served
|Preferred for CTV
|Name Of TV Show
|-
| }
|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. If hashed, use SHA-256 hashing method while keeping hyphens in place and in all lower case
|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

* remove all leading and trailing whitespace
* force lowercase
* for @gmail.com addresses only:
** remove dots
** remove + suffix, including sign

Example: “Art.Nielsen+JR@gmail.com” → “artnielsen@gmail.com”
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: boolean
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |device_useragent
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

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

Example: <code>172.217.22.14</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>
*DSK (Desktop)
*PHN (Mobile phone)
*TAB (Tablet)
*STV (Smart TVs)
*DVD (BluRay & DVD player devices)
*STB (Set-top boxes)
*XBX (Xbox devices)
*PSX (PlayStation devices)
*AMN (Amazon devices, excluding SmartTVs)
*APL (Apple devices)
*GGL (Google devices, excluding SmartTVs)
*RKU (Roku devices, excluding SmartTVs)
*UNWN (Unknown Device)
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |bot_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="5" |The following parameters are needed if dar_url is not available
|-
| colspan="2" |campaign_id
|Campaign Identifier which allows the overall campaign for the client to be tied together across publishers
|Required if no dar_url
|Example: nlsn1234
|-
| colspan="2" |client_id
|Nielsen defined client identifier that will be unique per Nielsen client
|Required if no dar_url
|Example: nlsnci1046
|-
| colspan="2" |creative_id
|Identifier for the Ad creative
|Optional
|Example: ad3ff462d24541339d6f67e1b2352465
|-
| colspan="2" |site_id
|Site ID of where the campaign is being served.
|Required if no dar_url
|Example: site1
|-
| colspan="2" |placement_id
|Identifier for different placements being served on the site.
|Required if no dar_url
|Example: 150DEB50A2ED2D
|-
| colspan="2" |adserver
|Nielsen defined Ad Server value
|Required if no dar_url
|Nielsen provided Ad Server value
|}
Note: All parameters are case sensitive.

'''Example in JSON format'''

{

"session_id": "R487421B-XXXX-YYYY-3343-E3BBB46E44F2",

"device_id": "A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"is_device_id_hashed": "0",

"hem_sha256": "671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2",

"uoo": "0",

"timestamp": "1548395046744",

"ip_address": "86.100.256.000",

"device_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36",

"device_group": "PHN",

"device_platform": "MBL",

"dma": "501",

"zip_code": "10001",

"ad" : {

"publisher_user_id": "ed36968977606872e4312943c218568123786342",

"dar_url": "<nowiki>http://secure-gl.imrworldwide.com/cgi-bin/m</nowiki>? ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345",

"publisher_name": "Publisher 123",

"original_airtime": "1593633600",

}

}
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-08-26T11:39:47Z

DarsanaDinesh: /* 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, Nielsen Media Impact (NMI), Add Effectiveness (MTA, Lift, etc.), Nielsen Brand Effect (NBE) 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.

Refer to [[Digital Measurement SEI Data Delivery Specification]] for file delivery and access.

=== 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, after which the process will skip the missing file and continue processing subsequent files. 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" |session_id
|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.
|No
|
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>

where ci - Nielsen defined client identifier that will be unique per Nielsen client

am - Nielsen defined Ad Server value.

ca - Nielsen defined campaign ID which allows the overall campaign for the client to be tied together across publishers

ce - Site ID of where the campaign is being served.

pc - This is the individual placement value for different placements being served on the site.

The rest of the variable value pairs generally are static and do not change
|-
|
|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>
|-
|
|tms_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Optional
|
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
|Preferred for CTV
|Format: Alphanumeric
Example: <code>CV (comedy variety)</code>
|-
|
|program_type
|Type of the program
|Preferred for CTV
|television, movie
|-
|
|program_name
|Name of program in which the ad was served
|Preferred for CTV
|Name Of TV Show
|-
| }
|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. If hashed, use SHA-256 hashing method while keeping hyphens in place and in all lower case
|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

* remove all leading and trailing whitespace
* force lowercase
* for @gmail.com addresses only:
** remove dots
** remove + suffix, including sign

Example: “Art.Nielsen+JR@gmail.com” → “artnielsen@gmail.com”
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: boolean
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |device_useragent
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

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

Example: <code>172.217.22.14</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>
*DSK (Desktop)
*PHN (Mobile phone)
*TAB (Tablet)
*STV (Smart TVs)
*DVD (BluRay & DVD player devices)
*STB (Set-top boxes)
*XBX (Xbox devices)
*PSX (PlayStation devices)
*AMN (Amazon devices, excluding SmartTVs)
*APL (Apple devices)
*GGL (Google devices, excluding SmartTVs)
*RKU (Roku devices, excluding SmartTVs)
*UNWN (Unknown Device)
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |bot_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="5" |The following parameters are needed if dar_url is not available
|-
| colspan="2" |campaign_id
|Campaign Identifier which allows the overall campaign for the client to be tied together across publishers
|Required if no dar_url
|Example: nlsn1234
|-
| colspan="2" |client_id
|Nielsen defined client identifier that will be unique per Nielsen client
|Required if no dar_url
|Example: nlsnci1046
|-
| colspan="2" |creative_id
|Identifier for the Ad creative
|Optional
|Example: ad3ff462d24541339d6f67e1b2352465
|-
| colspan="2" |site_id
|Site ID of where the campaign is being served.
|Required if no dar_url
|Example: site1
|-
| colspan="2" |placement_id
|Identifier for different placements being served on the site.
|Required if no dar_url
|Example: 150DEB50A2ED2D
|-
| colspan="2" |adserver
|Nielsen defined Ad Server value
|Required if no dar_url
|Nielsen provided Ad Server value
|}
Note: All parameters are case sensitive.

'''Example in JSON format'''

{

"session_id": "R487421B-XXXX-YYYY-3343-E3BBB46E44F2",

"device_id": "A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"is_device_id_hashed": "0",

"hem_sha256": "671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2",

"uoo": "0",

"timestamp": "1548395046744",

"ip_address": "86.100.256.000",

"device_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36",

"device_group": "PHN",

"device_platform": "MBL",

"dma": "501",

"zip_code": "10001",

"ad" : {

"publisher_user_id": "ed36968977606872e4312943c218568123786342",

"dar_url": "<nowiki>http://secure-gl.imrworldwide.com/cgi-bin/m</nowiki>? ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345",

"publisher_name": "Publisher 123",

"original_airtime": "1593633600",

}

}
[[Category:Digital]]

Digital Measurement SEI Ad Exposure

2025-08-11T13:49:12Z

DarsanaDinesh: /* 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, Nielsen Media Impact (NMI), Add Effectiveness (MTA, Lift, etc.), Nielsen Brand Effect (NBE) 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.

Refer to [[Digital Measurement SEI Data Delivery Specification]] for file delivery and access.

=== 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, after which the process will skip the missing file and continue processing subsequent files. 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.
|No
|
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>

where ci - Nielsen defined client identifier that will be unique per Nielsen client

am - Nielsen defined Ad Server value.

ca - Nielsen defined campaign ID which allows the overall campaign for the client to be tied together across publishers

ce - Site ID of where the campaign is being served.

pc - This is the individual placement value for different placements being served on the site.

The rest of the variable value pairs generally are static and do not change
|-
|
|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.
|Optional
|
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. If hashed, use SHA-256 hashing method while keeping hyphens in place and in all lower case
|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

* remove all leading and trailing whitespace
* force lowercase
* for @gmail.com addresses only:
** remove dots
** remove + suffix, including sign

Example: “Art.Nielsen+JR@gmail.com” → “artnielsen@gmail.com”
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: boolean
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |device_useragent
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

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

Example: <code>172.217.22.14</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>
*DSK (Desktop)
*PHN (Mobile phone)
*TAB (Tablet)
*STV (Smart TVs)
*DVD (BluRay & DVD player devices)
*STB (Set-top boxes)
*XBX (Xbox devices)
*PSX (PlayStation devices)
*AMN (Amazon devices, excluding SmartTVs)
*APL (Apple devices)
*GGL (Google devices, excluding SmartTVs)
*RKU (Roku devices, excluding SmartTVs)
*UNWN (Unknown Device)
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |bot_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="5" |The following parameters are needed if dar_url is not available
|-
| colspan="2" |campaign_id
|Campaign Identifier which allows the overall campaign for the client to be tied together across publishers
|Required if no dar_url
|Example: nlsn1234
|-
| colspan="2" |client_id
|Nielsen defined client identifier that will be unique per Nielsen client
|Required if no dar_url
|Example: nlsnci1046
|-
| colspan="2" |creative_id
|Identifier for the Ad creative
|Optional
|Example: ad3ff462d24541339d6f67e1b2352465
|-
| colspan="2" |site_id
|Site ID of where the campaign is being served.
|Required if no dar_url
|Example: site1
|-
| colspan="2" |placement_id
|Identifier for different placements being served on the site.
|Required if no dar_url
|Example: 150DEB50A2ED2D
|-
| colspan="2" |adserver
|Nielsen defined Ad Server value
|Required if no dar_url
|Nielsen provided Ad Server value
|}
Note: All parameters are case sensitive.

'''Example in JSON format'''

{

"session_id": "R487421B-XXXX-YYYY-3343-E3BBB46E44F2",

"device_id": "A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"is_device_id_hashed": "0",

"hem_sha256": "671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2",

"uoo": "0",

"timestamp": "1548395046744",

"ip_address": "86.100.256.000",

"device_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36",

"device_group": "PHN",

"device_platform": "MBL",

"dma": "501",

"zip_code": "10001",

"ad" : {

"publisher_user_id": "ed36968977606872e4312943c218568123786342",

"dar_url": "<nowiki>http://secure-gl.imrworldwide.com/cgi-bin/m</nowiki>? ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345",

"publisher_name": "Publisher 123",

"original_airtime": "1593633600",

}

}
[[Category:Digital]]

Digital Measurement SEI Data Delivery Specification

2025-08-06T11:45:50Z

DarsanaDinesh:

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

= Introduction =
This document outlines the data delivery specification for Ad and Content Measurement products via SEI integration.

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 formats are:
** Uncompressed text files with utf-8 encoding in:
*** JSON format(.json);
*** PARQUET format(.parquet) --- Preferred;
* All files should have extensions to indicate the file format (.json or .parquet)
* Large data file can be partitioned into multiple parts with min size of 128MB - 256MB
* Data can be delivered separately in multiple splits(platforms), 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 S2S system;

== Prerequisites ==
To get started, you will need a Nielsen App ID. The App ID is a unique ID assigned to your app. This will be provided to you by your assigned Technical Account Manager upon starting the integration.
{| class="wikitable"
!Item
!Description
!Source
|-
|'''App ID (AppID)'''
|Unique ID assigned to the player/site and configured by product.
|Provided by Nielsen
|-
|'''Integration ID (IntID)'''
|Integration id provided by Nielsen. Used to link different integration inputs, ex. associate single audit ping integration with different viewership pipelines (dar, dtvr, dcr, etc.)
|Provided by Nielsen
|-
|'''Partner ID (PartnerID)'''
|Partner id provided by Nielsen. Used for the client specific S3 bucket .
Please note that the sample PartnerID 'acme' used in all examples is a placeholder to be replaced with your PartnerID.
|Provided by Nielsen
|}
The onboarding process varies depending on the client's cloud environment.

=== '''AWS to AWS Integration''' ===
'''Prerequisites'''

* The client's IAM Role ARN to grant access to Nielsen S3 bucket provided by client.
'''Onboarding steps to be performed by client'''

'''Onboarding steps to be performed by client'''

# Create an IAM user or role in client AWS account.
# Attach the following IAM policy to the user or role to grant necessary permissions. This policy allows the user or role to read, write, and manage object access control lists (ACLs) in the specified S3 bucket. <code>{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": "arn:aws:s3:::<AccountABucketName>/*" } ] }</code> '''Note:''' Replace <code><AccountABucketName></code> with the bucket name provided by Nielsen. You can also restrict access to a specific folder by modifying the <code>Resource</code> element (e.g., <code>"arn:aws:s3:::AccountABucketName/FolderName/*"</code>). Check <nowiki>https://repost.aws/knowledge-center/cross-account-access-s3</nowiki> for more details.
# '''Share''' the '''IAM Role ARN''' to us.
Once you received S3 bucket information from Nielsen, perform the following steps to test access.

Once you received S3 bucket information from Nielsen, perform the following steps to test access.

'''1. List Files (ls)'''

To see a list of the files in your designated folder: <code>aws s3 ls s3://<bucket-name>/<prefix>/</code> To list all the files in all the sub folders as well: <code>aws s3 ls s3://<bucket-name>/<prefix>/ --recursive</code> ''Example:'' <code>aws s3 ls s3://useast1-nlsn-w-dig-sei-partnera-feeds-prod/dar-exposure/ --recursive</code>

'''2. Copy a Single File (cp)'''

To upload a single file from your local machine to S3: <code>aws s3 cp yourfile.txt s3://<bucket-name>/<prefix>/</code>
<code>''This command copies filename.csv to your s3 bucket at prefix folder.''</code>
'''3. Sync a Directory (sync)'''

To upload all new or updated files from a local directory to your S3 folder: <code>aws s3 sync /path/to/your/local/directory s3://<bucket-name>/<prefix>/</code> ''This command uploads all the files in your directory to your s3 bucket folder.''

Digital Measurement SEI Data Delivery Specification

2025-08-06T11:44:09Z

DarsanaDinesh:

= Introduction =
This document outlines the data delivery specification for Ad and Content Measurement products via SEI integration.

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 formats are:
** Uncompressed text files with utf-8 encoding in:
*** JSON format(.json);
*** PARQUET format(.parquet) --- Preferred;
* All files should have extensions to indicate the file format (.json or .parquet)
* Large data file can be partitioned into multiple parts with min size of 128MB - 256MB
* Data can be delivered separately in multiple splits(platforms), 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 S2S system;

== Prerequisites ==
To get started, you will need a Nielsen App ID. The App ID is a unique ID assigned to your app. This will be provided to you by your assigned Technical Account Manager upon starting the integration.
{| class="wikitable"
!Item
!Description
!Source
|-
|'''App ID (AppID)'''
|Unique ID assigned to the player/site and configured by product.
|Provided by Nielsen
|-
|'''Integration ID (IntID)'''
|Integration id provided by Nielsen. Used to link different integration inputs, ex. associate single audit ping integration with different viewership pipelines (dar, dtvr, dcr, etc.)
|Provided by Nielsen
|-
|'''Partner ID (PartnerID)'''
|Partner id provided by Nielsen. Used for the client specific S3 bucket .
Please note that the sample PartnerID 'acme' used in all examples is a placeholder to be replaced with your PartnerID.
|Provided by Nielsen
|}
The onboarding process varies depending on the client's cloud environment.

=== '''AWS to AWS Integration''' ===
'''Prerequisites'''

* The client's IAM Role ARN to grant access to Nielsen S3 bucket provided by client.
'''Onboarding steps to be performed by client'''

'''Onboarding steps to be performed by client'''

# Create an IAM user or role in client AWS account.
# Attach the following IAM policy to the user or role to grant necessary permissions. This policy allows the user or role to read, write, and manage object access control lists (ACLs) in the specified S3 bucket. <code>{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": "arn:aws:s3:::<AccountABucketName>/*" } ] }</code> '''Note:''' Replace <code><AccountABucketName></code> with the bucket name provided by Nielsen. You can also restrict access to a specific folder by modifying the <code>Resource</code> element (e.g., <code>"arn:aws:s3:::AccountABucketName/FolderName/*"</code>). Check <nowiki>https://repost.aws/knowledge-center/cross-account-access-s3</nowiki> for more details.
# '''Share''' the '''IAM Role ARN''' to us.
Once you received S3 bucket information from Nielsen, perform the following steps to test access.

Once you received S3 bucket information from Nielsen, perform the following steps to test access.

'''1. List Files (ls)'''

To see a list of the files in your designated folder: <code>aws s3 ls s3://<bucket-name>/<prefix>/</code> To list all the files in all the sub folders as well: <code>aws s3 ls s3://<bucket-name>/<prefix>/ --recursive</code> ''Example:'' <code>aws s3 ls s3://useast1-nlsn-w-dig-sei-partnera-feeds-prod/dar-exposure/ --recursive</code>

'''2. Copy a Single File (cp)'''

To upload a single file from your local machine to S3: <code>aws s3 cp yourfile.txt s3://<bucket-name>/<prefix>/</code>
<code>''This command copies filename.csv to your s3 bucket at prefix folder.''</code>
'''3. Sync a Directory (sync)'''

To upload all new or updated files from a local directory to your S3 folder: <code>aws s3 sync /path/to/your/local/directory s3://<bucket-name>/<prefix>/</code> ''This command uploads all the files in your directory to your s3 bucket folder.''

Digital Measurement SEI Data Delivery Specification

2025-08-06T11:42:25Z

DarsanaDinesh: New page added to cover data delivery specification

= Introduction =
This document outlines the data delivery specification for Ad and Content Measurement products via SEI integration.

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 formats are:
** Uncompressed text files with utf-8 encoding in:
*** JSON format(.json);
*** PARQUET format(.parquet) --- Preferred;
* All files should have extensions to indicate the file format (.json or .parquet)
* Data file can be partitioned into multiple parts with min size of 128MB - 256MB
* Data can be delivered separately in multiple splits(platforms), 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 S2S system;

== Prerequisites ==
To get started, you will need a Nielsen App ID. The App ID is a unique ID assigned to your app. This will be provided to you by your assigned Technical Account Manager upon starting the integration.
{| class="wikitable"
!Item
!Description
!Source
|-
|'''App ID (AppID)'''
|Unique ID assigned to the player/site and configured by product.
|Provided by Nielsen
|-
|'''Integration ID (IntID)'''
|Integration id provided by Nielsen. Used to link different integration inputs, ex. associate single audit ping integration with different viewership pipelines (dar, dtvr, dcr, etc.)
|Provided by Nielsen
|-
|'''Partner ID (PartnerID)'''
|Partner id provided by Nielsen. Used for the client specific S3 bucket .
Please note that the sample PartnerID 'acme' used in all examples is a placeholder to be replaced with your PartnerID.
|Provided by Nielsen
|}
The onboarding process varies depending on the client's cloud environment.

=== '''AWS to AWS Integration''' ===
'''Prerequisites'''

* The client's IAM Role ARN to grant access to Nielsen S3 bucket provided by client.

'''Onboarding steps to be performed by client'''

# Create an IAM user or role in client AWS account.
# Attach the following IAM policy to the user or role to grant necessary permissions. This policy allows the user or role to read, write, and manage object access control lists (ACLs) in the specified S3 bucket. <code>{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": "arn:aws:s3:::<AccountABucketName>/*" } ] }</code> '''Note:''' Replace <code><AccountABucketName></code> with the bucket name provided by Nielsen. You can also restrict access to a specific folder by modifying the <code>Resource</code> element (e.g., <code>"arn:aws:s3:::AccountABucketName/FolderName/*"</code>). Check <nowiki>https://repost.aws/knowledge-center/cross-account-access-s3</nowiki> for more details.
# '''Share''' the '''IAM Role ARN''' to us.

Once you received S3 bucket information from Nielsen, perform the following steps to test access.

'''1. List Files (ls)'''

To see a list of the files in your designated folder: <code>aws s3 ls s3://<bucket-name>/<prefix>/</code> To list all the files in all the sub folders as well: <code>aws s3 ls s3://<bucket-name>/<prefix>/ --recursive</code> ''Example:'' <code>aws s3 ls s3://useast1-nlsn-w-dig-sei-partnera-feeds-prod/dar-exposure/ --recursive</code>

'''2. Copy a Single File (cp)'''

To upload a single file from your local machine to S3: <code>aws s3 cp yourfile.txt s3://<bucket-name>/<prefix>/</code>
<code>''This command copies filename.csv to your s3 bucket at prefix folder.''</code>
'''3. Sync a Directory (sync)'''

To upload all new or updated files from a local directory to your S3 folder: <code>aws s3 sync /path/to/your/local/directory s3://<bucket-name>/<prefix>/</code> ''This command uploads all the files in your directory to your s3 bucket folder.''

Digital Measurement SEI Ad Exposure

2025-08-06T11:25:46Z

DarsanaDinesh:

{{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.), Nielsen Brand Effect (NBE) 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.

Refer to [[Digital Measurement SEI Data Delivery Specification]] for file delivery and access.

=== 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, after which the process will skip the missing file and continue processing subsequent files. 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.
|No
|
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>

where ci - Nielsen defined client identifier that will be unique per Nielsen client

am - Nielsen defined Ad Server value.

ca - Nielsen defined campaign ID which allows the overall campaign for the client to be tied together across publishers

ce - Site ID of where the campaign is being served.

pc - This is the individual placement value for different placements being served on the site.

The rest of the variable value pairs generally are static and do not change
|-
|
|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. If hashed, use SHA-256 hashing method while keeping hyphens in place and in all lower case
|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

* remove all leading and trailing whitespace
* force lowercase
* for @gmail.com addresses only:
** remove dots
** remove + suffix, including sign

Example: “Art.Nielsen+JR@gmail.com” → “artnielsen@gmail.com”
|Strongly Preferred
|<code>671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2</code>
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|
Format: boolean
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
| colspan="2" |device_useragent
|Device HTTP User Agent string
|Yes, or alternatives below
|
Format: alphanumeric

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

Example: <code>172.217.22.14</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>
*DSK (Desktop)
*PHN (Mobile phone)
*TAB (Tablet)
*STV (Smart TVs)
*DVD (BluRay & DVD player devices)
*STB (Set-top boxes)
*XBX (Xbox devices)
*PSX (PlayStation devices)
*AMN (Amazon devices, excluding SmartTVs)
*APL (Apple devices)
*GGL (Google devices, excluding SmartTVs)
*RKU (Roku devices, excluding SmartTVs)
*UNWN (Unknown Device)
|-
| colspan="5" |The following 3 parameters become mandatory if IP Address is not available
|-
| colspan="2" |bot_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="5" |The following parameters are needed if dar_url is not available
|-
| colspan="2" |campaign_id
|Campaign Identifier which allows the overall campaign for the client to be tied together across publishers
|Required if no dar_url
|Example: nlsn1234
|-
| colspan="2" |client_id
|Nielsen defined client identifier that will be unique per Nielsen client
|Required if no dar_url
|Example: nlsnci1046
|-
| colspan="2" |creative_id
|Identifier for the Ad creative
|Optional
|Example: ad3ff462d24541339d6f67e1b2352465
|-
| colspan="2" |site_id
|Site ID of where the campaign is being served.
|Required if no dar_url
|Example: site1
|-
| colspan="2" |placement_id
|Identifier for different placements being served on the site.
|Required if no dar_url
|Example: 150DEB50A2ED2D
|-
| colspan="2" |adserver
|Nielsen defined Ad Server value
|Required if no dar_url
|Nielsen provided Ad Server value
|}
Note: All parameters are case sensitive.

'''Example in JSON format'''

{

"session_id": "R487421B-XXXX-YYYY-3343-E3BBB46E44F2",

"device_id": "A487421B-XXXX-YYYY-8343-E3BBB66E44F2",

"is_device_id_hashed": "0",

"hem_sha256": "671638d17df92ac6e46e3f00ad0e78f09116ca29128e93dcb53ff340abdeb2c2",

"uoo": "0",

"timestamp": "1548395046744",

"ip_address": "86.100.256.000",

"device_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36",

"device_group": "PHN",

"device_platform": "MBL",

"dma": "501",

"zip_code": "10001",

"ad" : {

"publisher_user_id": "ed36968977606872e4312943c218568123786342",

"dar_url": "<nowiki>http://secure-gl.imrworldwide.com/cgi-bin/m</nowiki>? ca=nlsn1234&cr=678&ce=abc&pc=12345&ci=nlsnci123&am=1&at=view&rt=banner&st=image&r=12345",

"publisher_name": "Publisher 123",

"original_airtime": "1593633600",

}

}
[[Category:Digital]]

Digital Ad Ratings

2025-08-06T10:27:45Z

DarsanaDinesh:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
{{CategoryIcon|Advertising.png|Digital Ad Ratings (DAR)}}

{| class="wikitable"
|-
! style="width: 90px;" |
! General Reference
|-
| rowspan="2" | {{SmallIcon|Cross_Platform.png}}
| '''[[DAR Mobile Attributes Requirements]]'''
|-
|'''[[iOS SDK App Privacy|App Privacy Details for App Store]]'''
|}

{| class="wikitable"
|-
! style="width: 90px;" | SDK / API
! style="width: 45px;" | OS
! Guide
|-
| rowspan="3" | {{SmallIcon|SDKIcon.png}}
| {{SmallIcon|BrowserIcon.png}}
| '''[[DAR Tag Implementation Guide]]'''
|}
{| class="wikitable"
|+
! style="width: 90px;" | SEI
!Guide
|-
| rowspan="2" | {{SmallIcon|DigitalIcon.png}}
|'''[[Digital Measurement SEI Ad Exposure|SEI Ad Exposure Guide]]'''
|-
|'''[[Digital Measurement Ads Audit Beacon|SEI Ad Audit Ping]]'''
|}

Digital Ad Ratings

2025-08-06T10:22:11Z

DarsanaDinesh: Added SEI section