Template:US Metadata

DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.

DCR

Digital Content Ratings

Parameter	Description	Supported values	Example
event	Event identifier	String: playhead, pause, complete, adStop	"event":"playhead"
type	Determines the metadata object that should be used for crediting.	String: content, ad, static	"type":"content"
metadata	Object that holds metadata values of specific types Detailed in tables below	Object	"metadata":{ "content": <content metadata object>, "ad": <ad metadata object>, "static": <static metadata object> },
playheadPosition	Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.	String	Position value is Unix timestamp (live): "playheadPosition":"1542797780" Position value is playhead: "playheadPosition":"10"

Content Metadata

Content metadata sent for every playheadPosition update.

Key	Description	Example	Required
assetName	name of program (100 character limit)	"MyTest789"	Yes
assetid	unique ID assigned to asset	"B66473"	Yes
length	length of content in seconds	"3600" (0 for live stream or unknown)	Yes
program	name of program (100 character limit)	"MyProgram"	Yes
segB	custom segment B ¹	"CustomSegmentValueB"	No
segC	custom segment C ¹	"segmentC"	No
title	name of program (100 character limit)	"S2,E3"	Yes
type	'content', 'ad', 'static'	'content'	Yes
section	Unique Value assigned to page/site section	"HomePage"	Yes
airdate	the airdate in the linear TV ²	"20180120 10:00:00"	Yes
isfullepisode	full episode flag	"y"- full episode, "n"- not a full episode	Yes
crossId1	standard episode ID	"Standard Episode ID"	Yes
crossId2	content originator (only required for distributors)	Provided by Nielsen	Yes (if distributor)
adloadtype	linear ("1") vs dynamic ("2") ad model	"1"	Yes

¹ Custom segments (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports.
² Acceptable Air Date Formats:

YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS 
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS

For USA all times should be EST, for all other countries Local Time. Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.

{ 
"event": "playhead",
"type": "content",
"metadata": { 
  "content":{
    "assetName":"Big Buck Bunny",
    "assetid":"B66473",
    "length":"3600",
    "program":"MyProgram",
    "segB":"CustomSegmentValueB",
    "segC":"segmentC",
    "title":"S2,E3",
    "type":"content",
    "section":"cloudApi_app",
    "airdate":"20180120 10:00:00",
    "isfullepisode":"y",
    "crossId1":"Standard Episode ID",
    "crossId2" :"Content Originator",
    "adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}

DTVR

Digital TV Ratings info

Parameter	Description	Supported values	Example
event	Event identifier	String: playhead,pause,complete, adStop	"event":"playhead"
type	Determines the metadata object that should be used for crediting.	String: content, ad, static	"type":"content"
metadata	Object that holds metadata values of specific types. Detailed in tables below	Object	"metadata":{ "content": <content metadata object>, "ad": <ad metadata object>, "static": <static metadata object> },
playheadPosition	Playhead value or Unix timestamp	String	Position value is Unix timestamp: "playheadPosition":"1501225191747" Position value is playhead: "playheadPosition":"10"
id3Data	Nielsen ID3 payload	String	"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg ==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60 kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W VJx2O4M=/33648/22847/00"

Content Metadata

Content metadata sent for every playheadPosition update.

Key	Description	Example	Required
channelName	name of program (32 character limit)	"MyTest789"	Yes
type	'content', 'ad', 'static'	"content"	Yes
adModel	linear ("1") vs dynamic ("2") ad model	"1"	Yes

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.

{ 
"event": "playhead",
"type": "content",
"metadata": { 
  "content":{
    "adModel":"1",
    "channelname":"channel1"
  },
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}

DCR & DTVR

Applies to DCR and DTVR

Parameter	Description	Supported values	Example
event	Event identifier	String: playhead, pause, complete, adStop	"event":"playhead"
type	Determines the metadata object that should be used for crediting.	String: content, ad, static	"type":"content"
metadata	Object that holds metadata values of specific types Detailed in tables below	Object	"metadata":{ "content": <content metadata object>, "ad": <ad metadata object>, "static": <static metadata object> },
playheadPosition	Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)	String	Position value is Unix timestamp: "playheadPosition":"1501225191747" Position value is playhead: "playheadPosition":"10"
id3Data	Nielsen ID3 payload	Object	"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg ==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60 kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W VJx2O4M=/33648/22847/00"
ottData	Object that holds OTT information	Object	"ottData": { "ottStatus": 1, "ottType": casting, "ottDevice": chromecast, "ottDeviceID": 1234 }

Content Metadata

Content metadata sent for every playheadposition update.

Keys	Description	Example	Required
length	length of content in seconds	seconds (0 for live stream)	Yes
type	"content", "ad", "static"	"content"	Yes
adModel	linear vs dynamic ad model	1=Linear 2=Dynamic Ads	custom
adloadtype	DCR Ad Model	1=Linear 2=Dynamic Ads	custom

+ Custom segments (segB and segC) can be used to aggregate video and/or static content within a single Brand to receive more granular reports within a brand.
++ Acceptable Air Date Formats:

YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS 
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS

Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.

{ 
"event": "playhead",
"type": "content",
"metadata": { 
  "content":{
    "type":"content",
    "length":"0",
    "adModel":"1",
    "adloadtype":"1"},
  "ad": {},
  "static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}