View source for Digital Measurement SEI Streaming Content Viewing

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

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

This document describes the log file exposures, to be used in conjunction with [[Digital Measurement Content Audit Beacon]]

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

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

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

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

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

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

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

* Example format: yyyymmddhh
|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[File:Phone_Playback.png]]

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

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


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

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

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

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

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

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

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

Example: 
Salted, hashed user ID: 

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

Example: Salted, hashed user ID: 

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

Example: 
<code>VID123456789</code>
|-
| colspan="2" |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==<wbr />/AAAB2Jz2_k74GXSzx4npHuI<wbr />_JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI<wbr />-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=<wbr />/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==/<wbr />AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3<wbr />_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_<wbr />J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=<wbr />/00000/46016/00</code>
|-
| colspan="2" |gracenote_id
|Gracenote TMS ID (If available) should be passed for all telecasted content.
|Required if id3 not provided
|
Format: 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers.

Example: 
<code>SH009311820022</code>
|-
| colspan="2" |station_id
|GraceNote station ID that identifies the station
|Required if id3 not provided
|
Format: alphanumeric
|-
| colspan="2" |program_name
|Name of program
|Required if id3 not provided
|
Format: alphanumeric, Max 25 characters; no special characters.

Example: 
<code>Nightly News</code>

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

Example: 
<code>xyz</code>
|-
| colspan="2" |channel_id
|ID of channel
|Required if id3 not provided
|
Format: integer
|-
| colspan="2" |channel_name
|Name of channel
|Required if id3 not provided
|
Format: alphanumeric
|-
| colspan="2" |callsign
| FCC assigned unique identifier for a transmitter station
|Required if id3 not provided
|
Format: alphanumeric
|-
| colspan="2" |dma
|Designated Market Area where viewing occurred
|Yes
|<code>501</code>
|-
| colspan="2" |ad_load_flag
|linear or dynamic ad load
|Yes
|
Format: integer;

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

*<code>0</code> = (no ads),
*<code>1</code> = (content is supported by ads)
*<code>2</code> = (not known)

Note: set to "<code>1</code>" if content ad support was intended but did not occur
|-
| colspan="2" |position
|Array of contiguous content viewing.

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

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

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

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

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

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

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

See below for additional details on position array parameters
|Yes
|
Format: 
<syntaxhighlight lang="JSON">
"viewedads": 
[
   {
      "adpod":"0",
      "adposition":"0",
      "adid":"0",
      "isdarid":"0",
      "adstart":"utc",
      "adend":"utc",
      "advisible":"0",
      "adfocus":"0",
      "adaudio":"0"
   }
]
</syntaxhighlight>
|-
|{
|adpod
|AdPod sequence number.</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</code> = is NOT DAR ID;
*<code>1</code> = is a DAR ID
|-
|
|adstart
|Wall clock reference start time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
|<nowiki>}</nowiki>
|adend
|Wall clock reference end time
|Yes
|
Format: Unix timestamp in 32-bit unsigned int in seconds
|-
| colspan="2" |device_id
|Mobile Ad ID (IDFA, ADID), Connected Device ID
|Yes,if 

available
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
| colspan="2" |hem_sha256
|SHA-256 hashed email

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

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