Digital Measurement Metadata: Difference between revisions
From Engineering Client Portal
ColinBrown (talk | contribs) No edit summary |
MarkTufano (talk | contribs) No edit summary |
||
Line 2: | Line 2: | ||
[[Category:Digital]] | [[Category:Digital]] | ||
The | = 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 == | ||
Content | === Video Metadata === | ||
{{DCR Content Metadata}} | |||
==== Example Video Metadata Object ==== | |||
<syntaxhighlight lang="javascript"> | |||
var contentMetadataObject = | |||
{ | |||
type: 'content', | |||
assetid: 'VID-123456', | |||
program: 'program name', | |||
title: 'episode title', | |||
length: 'length in seconds', | |||
airdate: '20210321 09:00:00', | |||
isfullepisode: 'y', | |||
adloadtype: '2', | |||
segB: 'custom segment B', // optional | |||
segC: 'custom segment C', // optional | |||
crossId1: 'Standard Episode ID', // optional | |||
crossId2: 'Content Originator' //optional | |||
}; | |||
</syntaxhighlight> | |||
=== Ad Metadata === | |||
The Ad Metadata (if applicable) should be passed for each individual ad. | |||
{| class="wikitable" | |||
|- | |||
! Keys !! Description !! Values !! Required | |||
|- | |||
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓ | |||
|- | |||
| assetid || unique ID assigned to Ad || custom || ✓ | |||
|} | |||
==== Example Ad Object ==== | |||
<syntaxhighlight lang="javascript"> | |||
var adMetadataObject = | |||
{ | |||
type: 'preroll', | |||
assetid: 'AD-1' | |||
}; | |||
</syntaxhighlight> | |||
=== Static Metadata === | |||
{| class="wikitable" | |||
|- | |||
! Key !! Description !! Data Type !! Value !! Required? | |||
|- | |||
| type || asset type || fixed || <code>'static'</code> || Yes | |||
|- | |||
| assetid || Unique ID for each article || dynamic || custom <br>(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 || 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 ==== | |||
<syntaxhighlight lang="javascript"> | |||
var contentMetadataObject = | |||
{ | |||
type: 'static', | |||
assetid: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED** | |||
section: '', // *DYNAMIC METADATA*: section of site **REQUIRED** | |||
segA: '', // *DYNAMIC METADATA*: custom segment | |||
segB: '', // *DYNAMIC METADATA*: custom segment | |||
segC: '' // *DYNAMIC METADATA*: custom segment | |||
}; | |||
</syntaxhighlight> | |||
== Digital TV Ratings (DTVR) Metadata == | |||
=== Content Metadata === | |||
{| class="wikitable" | |||
|- | |||
! 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==== | |||
<syntaxhighlight lang="javascript"> var contentMetadataObject = | |||
{ | |||
type: 'content', | |||
adModel: '1' | |||
}; | |||
</syntaxhighlight> | |||
==== 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. | |||
<!-- | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 155: | Line 252: | ||
The object can then be passed when calling [[loadMetadata]]. | The object can then be passed when calling [[loadMetadata]]. | ||
<syntaxhighlight lang="java"> loadMetadata(jsonMetadataObject);</syntaxhighlight> | <syntaxhighlight lang="java"> loadMetadata(jsonMetadataObject);</syntaxhighlight> | ||
--> |
Revision as of 17:04, 23 June 2020
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 | Provider |
---|---|---|---|---|
type | Type of asset | For Video use: content For Static or text static |
Yes | Nielsen |
assetid | Unique ID assigned to asset Note: Refrain from using the following special characters (Special Characters). |
Examples: BBT345a234 CBSs5e234F2021 |
Yes | Client |
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 | Client |
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 | Client |
crossId1 | Gracenote TMS ID (If available) should be passed for all telecasted content for clients using the Gracenote solution for proper matching purposes. Note: The TMS ID will be a 14 character string. Normally leading with 2 alpha characters ('EP', 'MV', 'SH' or 'SP'), followed by 12 numbers. |
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 |
Optional | Nielsen |
crossId2 | Populated by content distributor to contribute viewing from that distributor to the given content originator. | Custom For a full list of acceptable values, please contact your Nielsen reprentative. |
Yes, for distributors | Nielsen |
length | Length of content in seconds Note: Integers and decimal values are acceptable for the length parameter. |
Examples:
For standard VOD content - |
Yes | Client |
airdate | Original broadcast or release date for the program For USA, date should be EST Outside USA, date should be local time. If not applicable or available, original broadcast or release date for the Program. |
Acceptable Formats:YYYY-MM-DDTHH:MI:SS YYYY-MM-DDHH:MI:SS YYYY-MM-DDTHH:MI:SS+xx:xx YYYY-MM-DDTHH:MI:SS-xx:xx YYYYMMDDHH:MI:SS YYYYMMDD HH:MI:SS MM-DD-YYYY MM/DD/YYYY YYYYMMDD |
Yes | Client |
isfullepisode | Full episode flag to identify differences between long form content. | y - full episode, n - non full episode(clip,teaser,promo,etc.)
Also accept:
|
Yes | Nielsen |
adloadtype | Type of ad load:
|
2 - DCR measures content with dynamic ads |
Yes | Nielsen |
segB | One of two custom segment for the clients granular reporting within a brand. | Examples: Genre - horror , comedy , etc.Timeslot - primetime , daytime , etc.News type - breakingnews , weather , etc. |
Optional | Client |
segC | One of two custom segment for the clients granular reporting within a brand. | Examples: Genre - horror , comedy , etc.Timeslot - primetime , daytime , etc.News type - breakingnews , weather , etc. |
Optional | Client |
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: 'program name',
title: 'episode title',
length: 'length in seconds',
airdate: '20210321 09:00:00',
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 | ✓ |
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 | 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: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: '', // *DYNAMIC METADATA*: section of site **REQUIRED**
segA: '', // *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.