Engineering Client Portal - User contributions [en]

Digital Measurement SEI Audio Metadata

2024-07-03T15:55:50Z

AbbyArgue:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}The Nielsen “server-2-server” method of collecting DTVR data requires the distributor to make available to Nielsen audio file for each live-streaming channel and each VoD asset that is eligible to DTVR crediting. Please contact your Nielsen Technical contact for a full description of what content is eligible for DTVR crediting.

In addition, to the audio files themselves, the DTVR ingestion process needs to some additional metadata for each audio file; this document specifies the additional “out-of-band” metadata that need to be provided.

The specification is defined using a JSON schema.

=== File Naming Convention and Location ===
File should be named with following convention: FileType_MVPDId_AssetId_UTCStart_UTCEnd

File type: DTVRAssetMetaData

MVPDid: unique identifier provided by Nielsen for each MVPD

AssetId: in-house assetId

UTCStart (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

UTCEnd (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

Files should be placed in S3 buckets with the following folder structure:

[To be determined during design phase]

Nielsen will move files to another location as they are processed so processing status is apparent.

In the case of a stream that has one version with blackouts and one without, one with mobile and one non-mobile, each stream would have its own unique asset id.

Nielsen recommends for live-streams that the audio track associated with the live feed be segmented into 15min chunks for delivery to Nielsen.

For VoD, Nielsen recommends using a single audio file, unless the total duration is greater than 6 hours, in which case the file should be broken up into smaller chunks.

For live-streams, the audio file does not need to break on a show boundary. Nielsen recommends breaking on a convenient wall-clock time, such as on the hour, 15past, 30past, 45past etc

Please check with the Nielsen Technical support to confirm the proposed audio format is supported, and if any compression, encryption algorithms or frequency band filters are going to be used to transport the audio files to Nielsen.

=== SLA ===
The files must be delivered into the proper S3 bucket within 2 hours of the broadcast. For example, files from 1:00 AM to 1:15 AM must be delivered before 3:00 AM. The metadata file should be delivered to an S3 bucket after the audio files described in this reference file are delivered, and before any Viewing file that would use these audio files has been delivered. Please refer to the associated specifications for the SLA’s of these other files.

=== JSON Param Definition ===
'''Header Record'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|schemaversion
|Json Schema Version
|Yes
|Nielsen
|Example: S2SDTVRAssetMetaDataV2.0
|-
|apid
|Server App ID
|Yes
|Nielsen
|Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|creationtime
|File creation time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|assetid
|In-House Asset Id
|Yes
|Client
|Format: alphanumeric,

Example: VID123456789
|-
|assetname
|In-House video asset name,

used for troubleshooting
|Yes
|Client
|Format: alphanumeric, Example: "A&E High Def East" or GraceNote channel mnemonic or call station letters
|-
|webpageurl
|Website Identifier, used for diagnostics, can be turned off/on as needed
|No
|Client
|Format: alphanumeric (max 2k)

Example:<nowiki>http://www.myapp.com/video.html</nowiki>
|-
|recordcount
|# of records in body of file
|Yes
|Client
|Format: numeric
|}
'''Header JSON Schema:'''

<code>{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"schemaversion": { "type": "string" },

"apid": { "type": "string" },

"creationtime": { "type": "string" },

"assetid": { "type": "string" },

"assetname": { "type": "string" },

"webpageurl": { "type": "string" },

"recordcount": { "type": "string" }

},

"required": [ "schemaversion", "apid", "creationtime", "assetid", "assetname", "recordcount" ]

}</code>

'''Header Record - Example:'''

<code>{

"schemaversion":"S2SDTVRAssetMetaDataV2.0",

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

"creationtime":"1473781507",

"assetid":" VID123456789",

"assetname":"A&E High Def East",

"webpageurl":"<nowiki>http://www.myapp.com/video.html</nowiki>",

"recordcount":"100"

}</code>

'''Body'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|audiofilename
|Audio file name
|Yes
|Client
|Example: aacFile1.aac

Audio files are assumed to be uploaded to the same directory/folder as the associated Asset Metadata file
|-
|referencestart
|Starting in-house reference point for the audio file
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)

For VoD, this will be an offset from the start of the asset

For Live stream, this will be the in-house time
|-
|referenceend
|End in-house reference point for the audio file
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)

For VoD, this will be an offset from the start of the asset

For Live stream, this will be the in-house time
|}
Note: All parameters are case sensitive.

'''Body Message Schema:'''

<code>{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"audiofilename": { "type": "string" },

"referencestart": { "type": "string" },

"referenceend": { "type": "string" }

},

"required": [ "audiofilename", "referencestart", "referenceend" ]

}</code>

'''Body - Example:'''

<code>{"audiofilename":"aacFile1.aac","referencestart":"1489506887","referenceend":"1489506889"}</code>

Digital Measurement SEI Audio Metadata

2024-07-03T15:54:59Z

AbbyArgue:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}The Nielsen “server-2-server” method of collecting DTVR data requires the distributor to make available to Nielsen audio file for each live-streaming channel and each VoD asset that is eligible to DTVR crediting. Please contact your Nielsen Technical contact for a full description of what content is eligible for DTVR crediting.

In addition, to the audio files themselves, the DTVR ingestion process needs to some additional metadata for each audio file; this document specifies the additional “out-of-band” metadata that need to be provided.

The specification is defined using a JSON schema.

=== File Naming Convention and Location ===
File should be named with following convention: FileType_MVPDId_AssetId_UTCStart_UTCEnd

File type: DTVRAssetMetaData

MVPDid: unique identifier provided by Nielsen for each MVPD

AssetId: in-house assetId

UTCStart (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

UTCEnd (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

Files should be placed in S3 buckets with the following folder structure:

[To be determined during design phase]

Nielsen will move files to another location as they are processed so processing status is apparent.

In the case of a stream that has one version with blackouts and one without, one with mobile and one non-mobile, each stream would have its own unique asset id.

Nielsen recommends for live-streams that the audio track associated with the live feed be segmented into 15min chunks for delivery to Nielsen.

For VoD, Nielsen recommends using a single audio file, unless the total duration is greater than 6 hours, in which case the file should be broken up into smaller chunks.

For live-streams, the audio file does not need to break on a show boundary. Nielsen recommends breaking on a convenient wall-clock time, such as on the hour, 15past, 30past, 45past etc

Please check with the Nielsen Technical support to confirm the proposed audio format is supported, and if any compression, encryption algorithms or frequency band filters are going to be used to transport the audio files to Nielsen.

=== SLA ===
The files must be delivered into the proper S3 bucket within 2 hours of the broadcast. For example, files from 1:00 AM to 1:15 AM must be delivered before 3:00 AM. The metadata file should be delivered to an S3 bucket after the audio files described in this reference file are delivered, and before any Viewing file that would use these audio files has been delivered. Please refer to the associated specifications for the SLA’s of these other files.

=== JSON Param Definition ===
'''Header Record'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|schemaversion
|Json Schema Version
|Yes
|Nielsen
|Example: S2SDTVRAssetMetaDataV2.0
|-
|apid
|Server App ID
|Yes
|Nielsen
|Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|creationtime
|File creation time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|assetid
|In-House Asset Id
|Yes
|Client
|Format: alphanumeric,

Example: VID123456789
|-
|assetname
|In-House video asset name,

used for troubleshooting
|Yes
|Client
|Format: alphanumeric, Example: "A&E High Def East" or GraceNote channel mnemonic or call station letters
|-
|webpageurl
|Website Identifier, used for diagnostics, can be turned off/on as needed
|No
|Client
|Format: alphanumeric (max 2k)

Example:<nowiki>http://www.myapp.com/video.html</nowiki>
|-
|recordcount
|# of records in body of file
|Yes
|Client
|Format: numeric
|}
'''Header JSON Schema:'''

<code>{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"schemaversion": { "type": "string" },

"apid": { "type": "string" },

"creationtime": { "type": "string" },

"assetid": { "type": "string" },

"assetname": { "type": "string" },

"webpageurl": { "type": "string" },

"recordcount": { "type": "string" }

},

"required": [ "schemaversion", "apid", "creationtime", "assetid", "assetname", "recordcount" ]

}</code>

'''Header Record - Example:'''

<code>{

"schemaversion":"S2SDTVRAssetMetaDataV2.0",

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

"creationtime":"1473781507",

"assetid":" VID123456789",

"assetname":"A&E High Def East",

"webpageurl":"<nowiki>http://www.myapp.com/video.html</nowiki>",

"recordcount":"100"

}</code>

'''Body'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|audiofilename
|Audio file name
|Yes
|Client
|Example: aacFile1.aac

Audio files are assumed to be uploaded to the same directory/folder as the associated Asset Metadata file
|-
|referencestart
|Starting in-house reference point for the audio file
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)

For VoD, this will be an offset from the start of the asset

For Live stream, this will be the in-house time
|-
|referenceend
|End in-house reference point for the audio file
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)

For VoD, this will be an offset from the start of the asset

For Live stream, this will be the in-house time
|}
Note: All parameters are case sensitive.

'''Body Message Schema:'''

<code>{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"audiofilename": { "type": "string" },

"referencestart": { "type": "string" },

"referenceend": { "type": "string" }

},

"required": [ "audiofilename", "referencestart", "referenceend" ]

}</code>

'''Body - Example:'''

{"audiofilename":"aacFile1.aac","referencestart":"1489506887","referenceend":"1489506889"}

DTVR SEI Viewing

2024-07-03T15:39:52Z

AbbyArgue:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification describes the file format that needs to be used to supply Nielsen with end-user viewing data captured by a “server-to-server” method for the Nielsen Digital TV Ratings (DTVR) product.

* The specification is defined using a JSON schema, with each file ideally containing all the viewing that has been captured within an hour.
* 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 it’s own unique asset id.
* The audio file with related data should arrive before the viewing data file for the same hour.
[[File:S2S Diagram.png|thumb|700x700px]]

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

=== File Naming Convention ===
File should be named with following convention: FileType_AppID _UTCStart_UTCEnd

File Type: DTVRViewingFile

AppID: app identifier

UTCStart (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

UTCEnd (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

Files should be placed in S3 buckets with the following folder structure:

[To be determined during design phase]

Nielsen will move files to another location as they are processed so processing status is apparent. Accuracy of measurement

These thresholds are currently under review during the Beta program period, and may change before data collected in this manner flows into Nielsen currency products.

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

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 is no more than 20 seconds).

=== JSON Param Definition ===
'''Header Record'''
{| class="wikitable"
!'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
|schemaversion
|Json Schema Version
|Yes
|Nielsen
|Example: S2SDTVRViewingV1.3
|-
|apid
|Server App ID
|Yes
|Nielsen
|Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|type
|Type of data
|Yes
|Client
|Value: "content"
|-
|producttype
|Product Type
|Yes
|Client
|Value: "DTVR"
|-
|starttime
|File Start Time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|endtime
|File End Time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|recordcount
|# of records in body of file
|Yes
|Client
|Format: integer

Note: Multiple entries in position array still only count as a single record for the purposes of the file record count
|}
'''Header Record - Example:'''
<code>{"schemaversion":"S2SDTVRViewingV1.3","apid":"A487421B-XXXX-YYYY-8343-E3BBB66E44F2","type":"content","producttype":"DTVR","starttime":"1473781507","endtime":"1473791507","recordcount":"14"}</code>

'''Body'''
{| class="wikitable"
| colspan="2" |'''Parameter'''
!'''Description'''
!'''Mandatory'''
!'''Specified by'''
!'''Format or Example'''
|-
| colspan="2" |apn
|Client side App name
|Yes
|Client
|Format: alphanumeric, Example: BestAppIOS
|-
| colspan="2" |apv
|Client side App version
|No
|Client
|Format: alphanumeric, Example: 1.3
|-
| colspan="2" |sessionid
|Unique id generated when player is instantiated
|Yes
|Client
|Format: alphanumeric, Example: 16 char guid
|-
| colspan="2" |streamid
|id for every new instance of an asset
|Required if no sessionid
|Client
|Format: alphanumeric, Example: UTC or other random #
|-
| colspan="2" |sessionended
|Session is known to have ended in this file
|Yes
|Client
|Format: numeric,

Example: 1 (session will continue in next file), 2 (session closed)
|-
| colspan="2" |assetid
|id for an asset

(could be TMS id)
|Yes
|Client
|Format: alphanumeric, Example: VID123456789
|-
| colspan="2" |assetname
|Video asset name

used for troubleshooting
|Yes
|Client
|Format: alphanumeric, Example: “A&E High Def East” or GraceNote channel mnemonic or call station letters
|-
| colspan="2" |origcontent
|The origin of the content that is being played out
|No
|Client
|Format : integer

0 – (assumed default if no value provided); content is being streamed from source other than user's device e.g. Cloud DVR, MVPD VoD Library, or Publisher live-feed

1 – content is being played out directly from user device e.g. local DVR
|-
| colspan="2" |picturemode
|Picture in Picture Mode
|No
|Client
|Format: integer – 0 (no PnP), 1 (PnP being used)
|-
| colspan="2" |secondscr
|Second Screen Indicator. For Mirroring & Extended Screen via OTT device scenarios
|No
|Client
|Format: alphanumeric, Example: MIR or OTT
|-
| colspan="2" |position
|Array of contiguous content viewing
|Yes
|Client
|Format:

[{ "referencestart":"utc",

"referenceend":"utc",

"playheadstart":"utc",

"playheadend":"utc" "}]

Additional Notes:

<nowiki>*</nowiki> For viewing gaps less than 1 second, the gap can be smoothed over

<nowiki>*</nowiki> For playouts that are abandoned before the first whole second of viewing is rendered, a position record of zero duration should be created IF an audit ping has already been fired
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|
|referenceend
|Wall clock reference end time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|
|playheadstart
|Content position start time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID. Should not be the user ID.

If hashing required, SHA-256 is preferred
|Yes, for opted-in mobile devices where available
|Client
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|Client
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC4335C
|-
| colspan="2" |hem_md5
|MD5 hashed email

Note: email normalization rules applied before hashing
|Preferred
|Client
|3E168605F46DFB596EB717b7C83ACBC0
|-
| colspan="2" |hem_sha1
|SHA-1 hashed email

Note: email normalization rules applied before hashing
|Preferred
|Client
|37B7410CD605DB6294318CDB174014F062F0E9C6
|-
| colspan="2" |hem_other
|Hashed email if hashing algorithm is unknown or not sha256, md5, or sha1
|Preferred
|Client
|3E168605F46DFB596EB717b7C83ACBC0
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV where available, or audit ping
|Client
|B0EOFEDgD
|-
| colspan="2" |xff
|IP address
|Yes
|Client
|Format: xxx.xxx.xxx.xxx or xxx.xxx.xxx.000

or 000.000.000.000 for opt-out
|-
| colspan="2" |xdua
|Device User Agent
|Desired
|Client
|Format: alphanumeric, Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |device_platform
|Device Platform
|Required if UA not shared
|Client
|Format: alphanumeric, Example DSK, MBL, OTT
|-
| colspan="2" |device_group
|Device Group
|Required if UA not shared
|Client
|Format: alphanumeric, Example PHN = phone, TAB = tablet, DSK = desktop, STV = Smart TV, UNWN = unknown
|-
| colspan="2" |os_group
|OS Group
|Required if UA not shared
|Client
|Format: alphanumeric, Example DROID, IOS, UNWN
|}
Note: All parameters are case sensitive.

'''Body - Example:'''
<code>{"apn":"BestAppiOS","apv":"1.1","sessionid":"123456789", "streamid":"123465435","sessionended":"1", "assetid":"vid345-67483","assetname":"ABC HD EAST","origcontent":"0","picturemode":"0","secondscr":"MIR","xff":"205.114.192.12","device_platform":"MBL","device_group":"PHN","os_group":"ios","xdua":"Apple-iPhone1C2/801.293","position":[{"referencestart":"utc","referenceend":"utc","playheadstart":"utc","playheadend":"utc"}</code>

DTVR SEI Viewing

2024-07-03T15:29:06Z

AbbyArgue:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification describes the file format that needs to be used to supply Nielsen with end-user viewing data captured by a “server-to-server” method for the Nielsen Digital TV Ratings (DTVR) product.

* The specification is defined using a JSON schema, with each file ideally containing all the viewing that has been captured within an hour.
* 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 it’s own unique asset id.
* The audio file with related data should arrive before the viewing data file for the same hour.
[[File:S2S Diagram.png|thumb|700x700px]]

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

=== File Naming Convention ===
File should be named with following convention: FileType_AppID _UTCStart_UTCEnd

File Type: DTVRViewingFile

AppID: app identifier

UTCStart (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

UTCEnd (time in 32-bit unsigned int UTC in seconds from first second of audio captured)

Files should be placed in S3 buckets with the following folder structure:

[To be determined during design phase]

Nielsen will move files to another location as they are processed so processing status is apparent. Accuracy of measurement

These thresholds are currently under review during the Beta program period, and may change before data collected in this manner flows into Nielsen currency products.

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

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 is no more than 20 seconds).

=== JSON Param Definition ===
'''Header Record'''
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Mandatory'''
|'''Specified by'''
|'''Format or Example'''
|-
|schemaversion
|Json Schema Version
|Yes
|Nielsen
|Example: S2SDTVRViewingV1.3
|-
|apid
|Server App ID
|Yes
|Nielsen
|Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|type
|Type of data
|Yes
|Client
|Value: "content"
|-
|producttype
|Product Type
|Yes
|Client
|Value: "DTVR"
|-
|starttime
|File Start Time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|endtime
|File End Time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|recordcount
|# of records in body of file
|Yes
|Client
|Format: integer

Note: Multiple entries in position array still only count as a single record for the purposes of the file record count
|}
'''Header Record - Example:'''
{"schemaversion":"S2SDTVRViewingV1.3","apid":"A487421B-XXXX-YYYY-8343-E3BBB66E44F2","type":"content","producttype":"DTVR","starttime":"1473781507","endtime":"1473791507","recordcount":"14"}

'''Body'''
{| class="wikitable"
| colspan="2" |'''Parameter'''
|'''Description'''
|'''Mandatory'''
|'''Specified by'''
|'''Format or Example'''
|-
| colspan="2" |apn
|Client side App name
|Yes
|Client
|Format: alphanumeric, Example: BestAppIOS
|-
| colspan="2" |apv
|Client side App version
|No
|Client
|Format: alphanumeric, Example: 1.3
|-
| colspan="2" |sessionid
|Unique id generated when player is instantiated
|Yes
|Client
|Format: alphanumeric, Example: 16 char guid
|-
| colspan="2" |streamid
|id for every new instance of an asset
|Required if no sessionid
|Client
|Format: alphanumeric, Example: UTC or other random #
|-
| colspan="2" |sessionended
|Session is known to have ended in this file
|Yes
|Client
|Format: numeric,

Example: 1 (session will continue in next file), 2 (session closed)
|-
| colspan="2" |assetid
|id for an asset

(could be TMS id)
|Yes
|Client
|Format: alphanumeric, Example: VID123456789
|-
| colspan="2" |assetname
|Video asset name

used for troubleshooting
|Yes
|Client
|Format: alphanumeric, Example: “A&E High Def East” or GraceNote channel mnemonic or call station letters
|-
| colspan="2" |origcontent
|The origin of the content that is being played out
|No
|Client
|Format : integer

0 – (assumed default if no value provided); content is being streamed from source other than user's device e.g. Cloud DVR, MVPD VoD Library, or Publisher live-feed

1 – content is being played out directly from user device e.g. local DVR
|-
| colspan="2" |picturemode
|Picture in Picture Mode
|No
|Client
|Format: integer – 0 (no PnP), 1 (PnP being used)
|-
| colspan="2" |secondscr
|Second Screen Indicator. For Mirroring & Extended Screen via OTT device scenarios
|No
|Client
|Format: alphanumeric, Example: MIR or OTT
|-
| colspan="2" |position
|Array of contiguous content viewing
|Yes
|Client
|Format:

[{ "referencestart":"utc",

"referenceend":"utc",

"playheadstart":"utc",

"playheadend":"utc" "}]

Additional Notes:

<nowiki>*</nowiki> For viewing gaps less than 1 second, the gap can be smoothed over

<nowiki>*</nowiki> For playouts that are abandoned before the first whole second of viewing is rendered, a position record of zero duration should be created IF an audit ping has already been fired
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|
|referenceend
|Wall clock reference end time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|
|playheadstart
|Content position start time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|<nowiki>}</nowiki>
|playheadend
|Content position end time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID. Should not be the user ID.

If hashing required, SHA-256 is preferred
|Yes, for opted-in mobile devices where available
|Client
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|Client
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC4335C
|-
| colspan="2" |hem_md5
|MD5 hashed email

Note: email normalization rules applied before hashing
|Preferred
|Client
|3E168605F46DFB596EB717b7C83ACBC0
|-
| colspan="2" |hem_sha1
|SHA-1 hashed email

Note: email normalization rules applied before hashing
|Preferred
|Client
|37B7410CD605DB6294318CDB174014F062F0E9C6
|-
| colspan="2" |hem_other
|Hashed email if hashing algorithm is unknown or not sha256, md5, or sha1
|Preferred
|Client
|3E168605F46DFB596EB717b7C83ACBC0
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV where available, or audit ping
|Client
|B0EOFEDgD
|-
| colspan="2" |xff
|IP address
|Yes
|Client
|Format: xxx.xxx.xxx.xxx or xxx.xxx.xxx.000

or 000.000.000.000 for opt-out
|-
| colspan="2" |xdua
|Device User Agent
|Desired
|Client
|Format: alphanumeric, Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |device_platform
|Device Platform
|Required if UA not shared
|Client
|Format: alphanumeric, Example DSK, MBL, OTT
|-
| colspan="2" |device_group
|Device Group
|Required if UA not shared
|Client
|Format: alphanumeric, Example PHN = phone, TAB = tablet, DSK = desktop, STV = Smart TV, UNWN = unknown
|-
| colspan="2" |os_group
|OS Group
|Required if UA not shared
|Client
|Format: alphanumeric, Example DROID, IOS, UNWN
|}
Note: All parameters are case sensitive.

'''Body - Example:'''
{"apn":"BestAppiOS","apv":"1.1","sessionid":"123456789", "streamid":"123465435","sessionended":"1", "assetid":"vid345-67483","assetname":"ABC HD EAST","origcontent":"0","picturemode":"0","secondscr":"MIR","xff":"205.114.192.12","device_platform":"MBL","device_group":"PHN","os_group":"ios","xdua":"Apple-iPhone1C2/801.293","position":[{"referencestart":"utc","referenceend":"utc","playheadstart":"utc","playheadend":"utc"}

DTVR SEI Viewing

2024-07-03T15:24:19Z

AbbyArgue:

File:S2S Diagram.png

2024-07-03T15:22:59Z

AbbyArgue:

S2S

DTVR SEI Viewing

2024-07-03T15:21:29Z

AbbyArgue:

Digital Measurement SEI Audio Metadata

2024-07-03T15:04:45Z

AbbyArgue: Created page with "Placeholder"

Placeholder

DTVR SEI Viewing

2024-06-26T17:27:33Z

AbbyArgue: Created page with "Placeholder"

Placeholder

Digital Measurement SEI Ad Exposure

2024-06-06T19:58:16Z

AbbyArgue: /* Manifest File */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}

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

The Single Endpoint integration contains two components:

# '''Exposure File''' 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 Ping''' (not required for ad effectiveness) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

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

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

The Audit Ping is required for facilitating MRC Accredited measurement.

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

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|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 '''_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 '''_manifest''' 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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|501
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

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

Digital Measurement SEI Ad Exposure

2024-06-06T19:57:41Z

AbbyArgue: /* Manifest File */

Digital Measurement SEI Ad Exposure

2024-06-06T19:55:09Z

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

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}

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

The Single Endpoint integration contains two components:

# '''Exposure File''' 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 Ping''' (not required for ad effectiveness) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

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

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

The Audit Ping is required for facilitating MRC Accredited measurement.

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

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|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 '''_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 '''_manifest''' suffix.

'''Example:'''
{

"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

}

}
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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''
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

= 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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|501
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

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

Digital Measurement SEI Ad Exposure

2024-06-06T19:54:42Z

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

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}

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

The Single Endpoint integration contains two components:

# '''Exposure File''' 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 Ping''' (not required for ad effectiveness) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

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

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

The Audit Ping is required for facilitating MRC Accredited measurement.

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

* '''exposure''' is reserved for multi-product files
* '''<product>-exposure''' is for single product files, where '''<product>''' is '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 '''_manifest''' suffix.

'''Example:'''
{

"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

}

}
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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''
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

= 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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|501
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

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

Digital Measurement SEI Streaming Content Viewing

2024-06-06T19:45:51Z

AbbyArgue: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|"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 [dar|dcr|dtvr|ctvc|audio]
|-
|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": 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|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: "secondscr":"MIR" 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 (stream continues in subsequent file), 2 (stream closed)</code>
|-
| 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_<wbr />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_<wbr />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 = Default / Unknown

1 = linear ad load

2 = dynamic ad load</code>
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|
Format: integer;

<code>0 = (no ads),

1 = (content is supported by ads),

2 = (not known)</code>

Note: set to "1" 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:

<code>"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{</code>
|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:

<code>"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|adpod
|AdPod sequence number.</code>

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 = is NOT DAR ID; 1 = is a DAR ID</code>
|-
|
|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 = not opt-out, 1 = opt-out</code>
|-
| 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, MBL, OTT</code>
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|<code>AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX</code>
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|<code>IOS, DROID, 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, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, 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 = not bot, 1 = bot</code>
|-
| 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, CA, etc.</code>
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T19:06:35Z

AbbyArgue: /* Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|"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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|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: "secondscr":"MIR" 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: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T19:05:13Z

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

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|"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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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: "secondscr":"MIR" 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: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T19:04:39Z

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

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
<code>useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''</code>
{| class="wikitable"
!'''Name'''
!'''Description'''
|-
|partnerid
|Abbreviation provided by Nielsen for each provider or publisher
|-
|env
|"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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
'''<partnerid>'''_'''<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]'''
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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: "secondscr":"MIR" 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: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T19:02:34Z

AbbyArgue: /* Schema Parameter Definitions */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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: "secondscr":"MIR" 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: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T19:01:51Z

AbbyArgue: /* CTV, Mirroring, and Casting */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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: "secondscr":"MIR" 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: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T18:53:30Z

AbbyArgue: /* Manifest File */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
!'''Required'''
!'''Specified'''
!'''Format / Example'''
!'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-06T18:52:34Z

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

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' 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'''
|'''Required'''
|'''Specified'''
|'''Format / Example'''
|'''Type'''
|-
|schema_version
|Schema Version
|Yes
|Nielsen
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
| ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
| US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement Content Audit Beacon

2024-06-06T18:44:17Z

AbbyArgue: Update to v1.8.8

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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:

https://[to_be_provided].imrworldwide.com/cgi-bin/gn?prd=audit&+[query parameters]

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: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|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: ce6c1c95-de3e-431e-b11e-77…
|-
|pingtype
|Indicator for ping type: “start” or “end” audit ping
|Yes
|Client
|Format: integer,

1 = Start Stream

0 = Start Session

3 = End Stream

2 = End Session
|-
|product
|Indicates which product audit ping corresponds to
|Yes
|Client
|Format: alphanumeric,

Example: dcr, dtvr, dar, ctv
|-
|uoo
|User opt out flag for demographic measurement
|Yes, if devid/LUID provided
|Client
|Format: integer

0 = not opt-out, 1 = opt-out
|-
|devid
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Optional, or in S2S file
|Client
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
|luid
|Living Unit ID - Experian Household ID
|Optional, or in S2S file
|Client
|B0EOFEDgD
|-
|createtm
|Time ping is initiated
|Yes
|Client
|Format: Unix timestamp in 32-bit unsigned int in seconds

Example: 1577858505
|}
'''Audit Ping Start Example:'''
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
[[Category:Digital]]

Digital Measurement Content Audit Beacon

2024-06-06T18:42:08Z

AbbyArgue: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital"

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

Digital Measurement SEI Content Viewing

2024-06-06T18:41:02Z

AbbyArgue: Update to v1.7.1

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<partnerid>-feeds-<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 _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 AWS unload manifest file format. It has the same name as the data file, but has the _manifest suffix.

Example:
{

"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

}

}
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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''
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

= 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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

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

Digital Measurement SEI Content Viewing

2024-06-06T18:30:39Z

AbbyArgue: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital"

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

Digital Measurement SEI Content Asset Metadata

2024-06-05T17:30:30Z

AbbyArgue: Update to new version

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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).

== Naming Convention and Delivery Specification ==
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.

Nielsen will move files to indicate they are being processed.

'''S3 bucket naming convention:'''
useast1-nlsn-w-dig-sei-<partner_id>-feeds-<env>/<s3_prefix>/<s3_object>
'''S3 prefix naming convention:'''
<file_type>/yyyy/mm/dd/hh
'''S3 object naming convention:'''
<partner_id>_<file_type>_<int_id>[.gz|.bz2]
{| class="wikitable"
|'''partner_id'''
|'''Partner id provided by Nielsen (4 letter code or TICK symbol, a.k.a. publisher id) in human readable format.'''
|-
|env
|<nowiki>[ test | prod ]</nowiki>
|-
|int_id
|Integration id provided by Nielsen. Used to link different integration inputs, ex. associate single audit ping integration with different viewsership pipelines (dar, dtvr, dcr, etc.)
|-
|file_type
|[ dcrassetmetadata ]
|-
|/yyyy/mm/dd/hh/
|year/month/day/hour (including leading zeros, starting from 00 hour )

ex.: 2023/02/12/05
|-
|<nowiki>[.gz|.bz2]</nowiki>
|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
* [.bz2]- splittable, preferred for larger files, above 256 MB (block size 256MB) (in development)
|}
'''Example of a file for 10:00 EST to 11:00 AM EST:'''
useast1-nlsn-w-dig-sei-acme-feeds-prod/dcrassetmetadata/2022/06/12/10/

acme_dcrassetmetadata_a9ddf15ea054ea415718767ea6

= 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. Please refer to the associated specifications for the SLAs of these other files.

= JSON Param Definition =
'''Header Record:'''
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Mandatory'''
|'''Specified by'''
|'''Format or Example'''
|-
|schemaversion
|Json Schema Version
|Yes
|Nielsen
|Example: S2SAssetMetaDataDCRV2.0
|-
|mvpdid
|Server App ID
|Yes
|Nielsen
|Example: NLSN
|-
|creationtime
|File creation time
|Yes
|Client
|Format: utc (time in 32-bit unsigned int UTC in seconds)
|-
|recordcount
|# of records in body of file
|Yes
|Client
|Format: numeric

In this schema implementation this value is set to "1", as each file will only contain the metadata associated to a single asset
|}
'''Header JSON Schema:'''
{

"$schema": "<nowiki>http://json-schema.org/draft-04/schema#</nowiki>",

"type": "object",

"properties": {

"schemaversion": { "type": "string" },

"mvpdid": { "type": "string" },

"creationtime": { "type": "string" },

"recordcount": { "type": "string" }

},

"required": [ "schemaversion", "appid", "creationtime", "recordcount" ]

}
'''Header Record - Example:'''
{"schemaversion":"S2SAssetMetaDataDCRV2.0","mvpdid":"NLSN","creationtime":"1473781507","recordcount":"1"}

'''Body Record:'''
{| class="wikitable"
|'''Parameter'''
|'''Description'''
|'''Mandatory'''
|'''Specified by'''
|'''Format or Example'''
|-
|assetid
|In-house asset id
|Yes
|Client
|Format: alphanumeric,

Example: VID123456789

AssetId needs to be unique at episode level
|-
|assetname
|In-house video asset name,

for troubleshooting
|Yes
|Client
|Format: alphanumeric

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

Example: Nightly News

See below for more specific guidance on Program Name
|-
|episodetitle
|Title of the episode
|Yes
|Client
|Format: alphanumeric,

Examples: News: “Prime Time News YYYY-MM-DD”

TV Show: “The Greatest American Hero S2E23”

Movie: “Movie Title”

See below for more specific guidance on Episode Title
|-
|episodelen
|Total episode length
|Yes
|Client
|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
|-
|isfullepisode
|Full episode Flag

(indicates full episode or a clip)
|Yes
|Client
|Format: integer – 0 (not full episode), 1 (full episode)
|-
|genre
|Nielsen genre code
|No
|Client
|Format: alphanumeric

Example: CV (comedy variety), N (news)

Contact Nielsen Technical support for a list of current Genre codes
|-
|airdate
|The date the episode was first made available on Traditional TV
|No
|Client
|Format: US ET: YYYYMMDDHHMMSS

Example: 19970716231256

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

Used as default episode name if metadata not available

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

Example:<nowiki>https://www.myapp.com/video.html</nowiki>
|-
|crossrefId1
|Content owner’s episode asset id. Used for secondary crediting
|No
|Client
|Format: alphanumeric

Example: TMS ID, EIDR ID or Episode title

Note: this field only needs to be populated by Distributors
|-
|crossrefId2
|Content owner. Used for secondary crediting
|Yes
|Client
|Format: alphabetical - Gracenote, channel mnemonic or Nielsen channel mnemonic

Example: AMC

Contact Nielsen for a list of current Nielsen channel codes

Note: this field only needs to be populated by Distributors
|}
Note: All parameters are case sensitive.
'''Body - Example:'''
{"assetid":"VID123456789", "assetname":"myassetname", "programname":"Nightly News","episodetitle":"Prime Time News S2E23", "episodelen":"2000", "isfullepisode":"true", "genre":"N", "airdate":"19970716231256", "webpageurl":"<nowiki>http://www.myapp.com/video.html</nowiki>", "crossrefId1":"myepisodeid", "crossrefId2":"networkxyz"}

=== Additional Guidance on Program & Episode Metadata ===
If the intention is that the DCR metadata also be used for TCR (Total Content Ratings). Then the DCR Program & Episode name should be identical to the Program & Episode name that is used in Traditional TV Ratings. It is recommended to use the metadata registered in Nielsen TV Names systems (myEVNTS/myVOD). If a Nielsen TV Names systems is not used, then you may use the Program & Episode name registered with a 3rd party television listing service such as GraceNote.

Nielsen recommends the following format for Episode name:

Format: Episode Title + Season # + Episode # (e.g. Title S3E1).

Values: A minimum of one of the values below should be provided:

* Episode Title: must be first value if provided
* Season #: must follow Episode Title if provided
* Episode #: must follow Season # if provided

NOTE: It is recommended to pass all three values if available.

Identifiers:

* Season: 'Season', 'S'
* Episode: 'Episode', 'E', 'Ep'
* Not case sensitive

Delimiters:

* Supported delimiters: ' ' (space), ':', '.'
* Delimiters are optional

Characters:

* 40 character limit
* No special characters

You may reference the examples below to determine if you are passing a valid episode name:

* Valid: 'Title S2E9', 'Title S.2 EP.9', 'Title Episode:9'
* Invalid (with reason):
** 'Title S-2 E-9' '-' is not a supported delimiter
** 'Title Episode9 Season2' Season # must precede Episode #
** 'Title SE2 EP9' 'SE' is not a valid identifier

[[Category:Digital]]

Digital Measurement SEI Content Asset Metadata

2024-06-05T17:15:26Z

AbbyArgue: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital"

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

Digital Measurement SEI Ad Exposure

2024-06-05T17:14:42Z

AbbyArgue: Update to V 1.0.0

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}

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

The Single Endpoint integration contains two components:

# '''Exposure File''' 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 Ping''' (not required for ad effectiveness) are HTTPS requests that emanate from the end-user device at a minimum of once per Session (uninterrupted user experience with gaps shorter than 30 minutes, or as mutually agreed upon). The Audit Ping provides Nielsen the ability to 1) validate traffic volume 2) provide a signal that Nielsen meters can detect for participating Nielsen panelists.

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

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

The Audit Ping is required for facilitating MRC Accredited measurement.

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<partnerid>-feeds-<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>
{| 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 '''[dar|dcr|dtvr|ctvc|audio]'''
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 '''_manifest''' suffix.

'''Example:'''
{

"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

}

}
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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}
'''Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC):'''
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

= 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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|501
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

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

Digital Measurement SEI Ad Exposure

2024-06-05T17:04:41Z

AbbyArgue: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital"

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

Digital Measurement SEI Streaming Content Viewing

2024-06-03T17:32:32Z

AbbyArgue:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{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.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' suffix.

Example:
{

"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

}

}
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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
|US, CA, etc.
|}
Note: All parameters are case sensitive.

Digital Measurement SEI Streaming Content Viewing

2024-06-03T17:30:58Z

AbbyArgue: Upload of v. 1.7.1

This interface specification depicts the file schema required to supply Nielsen with response-level Viewing data in a “Server-to-Server” relationship for incorporation into the Nielsen One Content and/or Nielsen One Ads products.

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

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

=== S3 Bucket and Prefix Naming Convention ===
useast1-nlsn-w-dig-sei-<'''partnerid'''>-feeds-'''<env>/<filetype>/<split>/yyyy/mm/dd/hh/<object>'''
{| 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 [dar|dcr|dtvr|ctvc|audio]
|-
|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 ===
<partnerid>_<filetype>_<intid>_<appid>_<starttime>_<endtime>.[json|parquet]
{| 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 '''_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 AWS unload manifest file format. It has the same name as the data file, but has the '''_manifest''' suffix.

Example:
{

"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

}

}
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
|S2SV1.7.0
|String
|-
|accreditation_status
|Accreditation Status
|No
|Client
|MRC = 1
|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: 31337
|Number
|}

=== Data delivery example for hour 11 (11:00:00 AM UTC to 11:59:59 PM UTC): ===
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

== 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|thumb]]
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: "secondscr":"MIR" 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.
{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx123","referenceend":"xxxxxxx183","playheadstart":"0","playheadend":"60"},{"referencestart":"xxxxxxx243","referenceend":"xxxxxxx303","playheadstart":"120","playheadend":"180"}]}

{ ... "sessionid":"ABC","streamid":"DEF","position":[{"referencestart":"xxxxxxx183","referenceend":"xxxxxxx243","playheadstart":"60","playheadend":"120"}],"secondscr":"OTT"}

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

Example: BestAppIOS
|-
| colspan="2" |apv
|Application version
|Yes
|Format: alphanumeric

Example: 21.5
|-
| 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: ce6c1c95-de3e-431e-b11e-77…
|-
| colspan="2" |streamid
|ID for every new instance of exposure to a different asset
|Yes, if no sessionid
|Format: alphanumeric

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

Example: 1 (stream continues in subsequent file), 2 (stream closed)
|-
| colspan="2" |publisher_user_id
|Publisher-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

8f434346648f6b96d9dda901c5…
|-
| colspan="2" |provider_user_id
|Provider-specific user ID (must remain persistent indefinitely)
|No
|Format: alphanumeric

Example: Salted, hashed user ID:

2cf24dba5fb0a30e26e83b2ab9…
|-
| colspan="2" |assetid
|In-house id used for a video asset (TMS ID if available)
|Yes
|Format: alphanumeric

Example: VID123456789
|-
| colspan="2" |nielsen_id3_tag
|Encrypted Nielsen ID3 Tag. Contains SID (Source Identifier) codes (PC - Program Content & FD - Final Distributor).
|Optional
|Format: alphanumeric;

Example:

www.nielsen.com/0UQ1mB-DRZMCTQ3Fr9zLjw==/EnVp4bRmgPx7KDNctoTVpQ==/AAcCEP7hk_DDqQuocAM3JRHB7raS8j8yKAM2b3Na2F9Po4yWm87KA6Ubefb3Hb6Fj_GOijXnlXw1yzgKzpc0J-cCEFEQqjGD2HHpSj5upGJyz6V0lx5j64rfFd4jyv3cxHGz_UKb-yJdHKTHKB11Iv_LJls1P1xbNT9iOo8=/29100/36900/00

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

www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
|-
| 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: SH009311820022
|-
| 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: Nightly News

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: xyz
|-
| 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
|501
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|Format: integer;

0 = Default / Unknown

1 = linear ad load

2 = dynamic ad load
|-
| colspan="2" |ad_support_flag
|Intended method of monetizing the content
|Yes
|Format: integer;

0 = (no ad's),

1 = (content is supported by ad’s),

2 = (not known)

Note: set to "1" 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:

"position": [{

"referencestart":"[timestamp]",

"referenceend":"[timestamp]",

"playheadstart":"[playhead position]",

"playheadend":"[playhead position]"

}]
|-
|{
|referencestart
|Wall clock reference start time
|Yes
|Format: Unix timestamp in 32-bit unsigned int in seconds

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

Example: 1577858775
|-
|
|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: 1577858515
|-
|<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: 1577858785
|-
| colspan="2" |viewedads
|Array of ads viewed by client.

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

"viewedads": [{"adpod":"0","adposition":"0","adid":"0","isdarid":"0","adstart":"utc","adend":"utc","advisible":"0","adfocus":"0","adaudio":"0"}]
|-
|{
|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: 2
|-
|
|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: 1
|-
|
|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

0 = is NOT DAR ID; 1 = 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
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

Note: email normalization rules applied before hashing
|Strongly Preferred
|55C06A30DAA5D5F382FDEB8C702EC57875CC9D91A7C78BB620053FD81DC…
|-
| colspan="2" |luid
|Living Unit ID - Experian Household ID
|Yes, for CTV if available
|B0EOFEDgD
|-
| colspan="2" |uoo
|User opt out flag for demographic measurement
|Yes
|Format: integer

0 = not opt-out, 1 = opt-out
|-
| colspan="2" |xdua
|Device HTTP User Agent string
|Yes
|Format: alphanumeric,

Example: Apple-iPhone1C2/801.293
|-
| colspan="2" |xff
|IP address
|Yes
|Format: xxx.xxx.xxx.xxx
|-
| colspan="2" |psudo_id_sha256
|Hashed Device User Agent string + IP address
|No
|421c76d77563afa1914846b010bd164f395bd34c2102e5e99e0cb9cf173…
|-
| 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
|DSK, MBL, OTT
|-
| colspan="2" |device_type
|Device type for connected devices
|Required if no UAS
|AMN, APL, DVD, GGL, PSX, RKU, STB, STV, XBX
|-
| colspan="2" |os_group
|Operating system of mobile devices. All other device should be NA
|Required if no UAS
|IOS, DROID, NA
|-
| colspan="2" |device_group
|Type of device: phone, tablet, desktop, set top box (CTV or OTT), unknown
|Required if no UAS
|DSK, PHN, TAB, STV, DVD, PMP, OTHER, STB, XBX, PSX, AMN, APL, GGL, RKU, UNWN
|-
| 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

0 = not bot, 1 = bot
|-
| colspan="2" |zip_code
|ZIP code where viewing occurred
|Required if no IP
|10001
|-
| colspan="2" |country
|Country ISO 3166 ALPHA-2
|Required if no IP
|US, CA, etc.
|}
Note: All parameters are case sensitive.

File:Phone Playback.png

2024-06-03T17:27:15Z

AbbyArgue:

Phone Playback

Digital Measurement SEI Streaming Content Viewing

2024-06-03T17:23:12Z

AbbyArgue:

Digital Measurement SEI Streaming Content Viewing

2024-06-03T17:16:34Z

AbbyArgue: Created page with "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."

Digital Measurement Ads Audit Beacon

2024-06-03T15:15:29Z

AbbyArgue: Update to newer version of spec

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

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

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

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

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

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

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

== Audit Ping Implementation Details ==

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

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

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

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

== DAR Ping Implementation Details ==

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

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