Engineering Portal Digital US DCR & DTVR Digital Measurement Metadata

Digital Metadata

Digital Metadata can passed through key-values using the Nielsen reserved keys. The keys and values are listed by product below.

Digital Content Ratings (DCR) Metadata

Video Metadata

Keys	Description	Values	Required
type	type of asset	For Video use: `"content"` For Static or text `"static"`	Yes
assetid	unique ID assigned to asset Note: Refrain from using the following special characters (Special Characters)	Examples: `BBT345a234` `CBSs5e234F2021`	Yes
program	Complete program or movie title. (no abbreviations or shorthand) Note: there is a 25 character limit.	`The Big Bang Theory` `TheBigBangTheory` `The Dark Knight` `TheDarkKnight`	Yes
title	episode title with season and episode number (40 character limit) (Formats accepted: S01E03, S1E3, S1 E3)	Examples: `The Pants Alternative S03E18` `The Pants Alternative S3E18` `The Pants Alternative S3 E18` Can also accept: `S3E18` Not Valid: `318` or `0318`	Yes
crossId1	The Gracenote TMS ID (If available)	The TMS ID will be a 14 character string. Normally being with 'EV,' 'EP', 'SH', 'SP', or 'MV' Followed by 12 numbers after the initial two letter prefix. The Giant Morning Show: `SH009311820022` The Pants Alternative Episode : `EP009311820061`
crossId2	content originator (only required for distributors)	custom
length	length of content in seconds	If continuous (24 x 7) stream, pass the value of 86400. If live stream of a discrete program (Live Event/Sporting Event), pass length of content. If unknown, pass a value of 0.	Yes
airdate	Original broadcast or release date for the program For USA, date should be EST Outside USA, date should be local time.	Acceptable 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`	Yes
isfullepisode	full episode flag	`"y"`- full episode, `"n"`- non full episode	Yes
adloadtype	type of ad load: `"1"` Linear – matches TV ad load `"2"` Dynamic – Dynamic Ad Insertion (DAI)	`"2"` - DCR measures content with dynamic ads	Yes
segB	custom segment B	custom
segC	custom segment C	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.

Examples regarding usage of segments within SDK:

All comedy clips and stories for a Brand rolled into a "Comedy" segment
genre grouping content by Comedy vs. Drama
group related Text + Video content - i.e. for a show that has a lot of - static pages associated with it
packaging based on how clients sell inventory
grouping related types of content either by genre, category or platform.

Example Video Metadata Object

var contentMetadataObject =
{  
  type:           'content',
  assetid:        'VID-123456',
  program:        'The Big Bang Theory',
  title:          'The Pants Alternative S03E18',  //no abbreviations or shorthand
  length:         '1320',   //lengths in seconds
  airdate:        '2021-03-21T12:00:00Z',
  isfullepisode:  'y',
  adloadtype:     '2',
  segB:           'custom segment B', // optional
  segC:           'custom segment C', // optional
  crossId1:       'Standard Episode ID', // optional
  crossId2:       'Content Originator' //optional
};

Ad Metadata

The Ad Metadata (if applicable) should be passed for each individual ad.

Keys	Description	Values	Required
type	type of Ad	`'preroll'`, `'midroll'`, `'postroll'` `'ad'` - If specific type can not be identified.	✓
assetid	unique ID assigned to Ad	custom (no Special Characters)	✓

Example Ad Object

var adMetadataObject = 
{  
  type:    'preroll',
  assetid: 'AD-1'
};

Static Metadata

Key	Description	Data Type	Value	Required?
type	asset type	fixed	`'static'`	Yes
assetid	Unique ID for each article	dynamic	custom (no Special Characters)	Yes
section	section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values	dynamic	custom (no Special Characters)	Yes
segA	custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC)	dynamic	custom	No
segB	custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC)	dynamic	custom	No
segC	custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC)	dynamic	custom	No

The values passed through the Nielsen keys will determine the breakouts that are seen in reporting. The custom segments (A, B & C) will roll into the sub-brand. To not use custom segments A, B and C, do not pass any value in these keys.

Example Static Metadata Object

var contentMetadataObject =
{  
  type: 'static', 
  assetid: 'HHF887465-9486', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
  section: 'SPORTS', // *DYNAMIC METADATA*: section of site **REQUIRED**
  segA: 'HD Videos', // *DYNAMIC METADATA*: custom segment
  segB: '', // *DYNAMIC METADATA*: custom segment
  segC: ''  // *DYNAMIC METADATA*: custom segment
};

Digital TV Ratings (DTVR) Metadata

Content Metadata

Key	Description	Values	Required
type	type of asset	"content"	✓
adModel	linear vs dynamic ad model	* 1) - Linear – matches TV ad load * 2) Dynamic – Dynamic Ad Insertion (DAI)	✓

Example Content Object

 var contentMetadataObject =
{  
  type: 'content',
  adModel: '1'
};

Custom Variables Extension

If you are looking for additional reporting options, reach out to us. We have a Custom Variables Extension and can work with you to obtain your desired reporting.

Digital Measurement Metadata

From Engineering Client Portal