Template:US Metadata - Revision history

ColinBrown: Created page with "DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing. {{DCRDTVRTabs |DCR= === Digital Content Ratings=== ..."
2019-10-08T18:47:06Z
Created page with "DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing. {{DCRDTVRTabs |DCR= === Digital Content Ratings=== <table>..."
New page
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> <b>Description</b>
</th>
<th> <b>Supported values</b>
</th>
<th> <b>Example</b>
</th></tr>
<tr>
<td> <b>event</b>
</td>
<td> Event identifier
</td>
<td>
<p><code> String:
playhead, pause,
complete, adStop</code>
</p>
</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> <b>type</b>
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<p><code> String:<br />
content,
ad,
static</code>
</p>
</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> <b>metadata</b>
</td>
<td> Object that holds metadata values of specific types<br />
<p><span style="color:blue"> Detailed in tables below</span>
</p>
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> <b>playheadPosition</b>
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
<p>Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
</p><p>Position value is playhead:
<code>
"playheadPosition":"10"</code>
</p>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> <b>adloadtype</b>
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports.<br>
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
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
</syntaxhighlight>
<br>
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.
<syntaxhighlight lang="json">
{
"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": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> <b>Description</b>
</th>
<th> <b>Supported values</b>
</th>
<th> <b>Example</b>
</th></tr>
<tr>
<td> <b>event</b>
</td>
<td> Event identifier
</td>
<td>
<p><code> String:
playhead,pause,complete,
adStop</code>
</p>
</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> <b>type</b>
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<p><code> String:<br />
content,
ad,
static</code>
</p>
</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> <b>metadata</b>
</td>
<td> Object that holds metadata values of specific types. <br />
<p><span style="color:blue"> Detailed in tables below</span>
</p>
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> <b>playheadPosition</b>
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
<p>Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
</p><p>Position value is playhead:
<code>
"playheadPosition":"10"</code>
</p>
</td></tr>
<tr>
<td> <b>id3Data</b>
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<p><code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>
</p>
<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> <b>adModel</b>
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

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.
<syntaxhighlight lang="json">
{
"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"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> <b>Description</b>
</th>
<th> <b>Supported values</b>
</th>
<th> <b>Example</b>
</th></tr>
<tr>
<td> <b>event</b>
</td>
<td> Event identifier
</td>
<td>
<p><code> String:
playhead,
pause,
complete,
adStop</code>
</p>
</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> <b>type</b>
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<p><code> String:<br />
content,
ad,
static</code>
</p>
</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> <b>metadata</b>
</td>
<td> Object that holds metadata values of specific types<br />
<p><span style="color:blue"> Detailed in tables below</span>
</p>
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> <b>playheadPosition</b>
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
<p>Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
</p><p>Position value is playhead:
<code>
"playheadPosition":"10"</code>
</p>
</td></tr>
<tr>
<td> <b>id3Data</b>
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<p><code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>
</p>
</td></tr>
<tr>
<td> <b>ottData</b>
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> <b>adModel</b>
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> <b>adloadtype</b>
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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.<br>
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
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
</syntaxhighlight>
<br>
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"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"
}
</syntaxhighlight>
}}