loadMetadata (Browser) - Revision history

Admin: /* Input Parameters */

2019-05-29T23:50:05Z

Input Parameters

← Older revision		Revision as of 23:50, 29 May 2019
Line 22:		Line 22:
	! Parameter !! Description !! JSON Object		! Parameter !! Description !! JSON Object
	\|-		\|-
	\| rowspan=10 \| metadataObject		\| rowspan=9 \| metadataObject
	\| '''DTVR'''		\| '''DTVR'''
	\| <syntaxhighlight lang="javascript">		\| <syntaxhighlight lang="javascript">
Line 37:		Line 37:
	"type": "ad",		"type": "ad",
	"ocrtag": "http://secure-uat-cert.imrworldwide.com/cgi-bin/m?ci= ENTXX5&am=3&ep=1&at=view&rt=banner&st=image&ca=cmp97144&cr=1186239&pc=3739659&r=2011370876 "		"ocrtag": "http://secure-uat-cert.imrworldwide.com/cgi-bin/m?ci= ENTXX5&am=3&ep=1&at=view&rt=banner&st=image&ca=cmp97144&cr=1186239&pc=3739659&r=2011370876 "
	};
	~~</syntaxhighlight>~~
	\|-
	~~\|'''Digital Audio'''~~
	~~type should always be "radio".~~
	~~\| <syntaxhighlight lang="javascript">~~
	{
	~~"type": "radio",~~
	~~"assetid": "WXYZ-FM",~~
	~~"stationType": "3",~~
	~~"provider": "providerName",~~
	~~"dataSrc": "cms"~~
	};		};
	</syntaxhighlight>		</syntaxhighlight>

Admin3 at 20:50, 4 October 2017

2017-10-04T20:50:50Z

← Older revision		Revision as of 20:50, 4 October 2017
Line 93:		Line 93:
	"length": "30",		"length": "30",
	"assetid": "myMidrollAssetId",		"assetid": "myMidrollAssetId",
	"~~adModel~~": "2",		"adloadtype": "2",
	"tv": "true",		"tv": "true",
	"dataSrc": "cms"		"dataSrc": "cms"

Admin3: /* Input Parameters */

2017-10-04T20:49:52Z

Input Parameters

← Older revision		Revision as of 20:49, 4 October 2017
Line 26:		Line 26:
	\| <syntaxhighlight lang="javascript">		\| <syntaxhighlight lang="javascript">
	{		{
	"~~adModel~~": "~~link to the table~~"		"adloadtype": "1"
	};		};
	</syntaxhighlight>		</syntaxhighlight>

Admin at 23:54, 7 June 2017

2017-06-07T23:54:33Z

← Older revision		Revision as of 23:54, 7 June 2017
Line 2:		Line 2:
	[[Category:Digital]]		[[Category:Digital]]
	[[Category:Browser SDK API Reference]]		[[Category:Browser SDK API Reference]]
	This event loads the metadata from the stream, but does not inform SDK about playhead position. This API is only necessary for announcing main content before ~~‘preroll’~~ ads, so SDK can relate the ads with content.		This event loads the metadata from the stream, but does not inform SDK about playhead position. This API is only necessary for announcing main content before 'preroll' ads, so SDK can relate the ads with content.

	'''Example:''' If loadMetadata API is called for a video identified as ~~‘Video1’~~, then all subsequent [[setPlayheadPosition (Browser)\|setPlayheadPosition]] events will be related to ~~‘Video1’~~, until another loadMetadata is executed.		'''Example:''' If loadMetadata API is called for a video identified as 'Video1', then all subsequent [[setPlayheadPosition (Browser)\|setPlayheadPosition]] events will be related to 'Video1', until another loadMetadata is executed.

	== Syntax ==		== Syntax ==

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Browser SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Browser SDK API Reference This event lo..."

2017-05-21T21:48:33Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Browser SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Browser SDK API Reference This event lo..."

New page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Browser SDK API Reference}} {{CurrentBreadcrumb}}
[[Category:Digital]]
[[Category:Browser SDK API Reference]]
This event loads the metadata from the stream, but does not inform SDK about playhead position. This API is only necessary for announcing main content before ‘preroll’ ads, so SDK can relate the ads with content.

'''Example:''' If loadMetadata API is called for a video identified as ‘Video1’, then all subsequent [[setPlayheadPosition (Browser)|setPlayheadPosition]] events will be related to ‘Video1’, until another loadMetadata is executed.

== Syntax ==
'''International (Germany) implementation:'''
<syntaxhighlight lang="javascript">
ggPM("loadMetadata", metadataObject); //Except VA users
</syntaxhighlight>

<syntaxhighlight lang="javascript">
ggPM('3', metadataObject); //For VA users only
</syntaxhighlight>

== Input Parameters ==
{| class="wikitable"
|-
! Parameter !! Description !! JSON Object
|-
| rowspan=10 | metadataObject
| '''DTVR'''
| <syntaxhighlight lang="javascript">
{
"adModel": "link to the table"
};
</syntaxhighlight>
|-
|'''DAR'''
type should always be "ad" for DAR
|
<syntaxhighlight lang="javascript">
{
"type": "ad",
"ocrtag": "http://secure-uat-cert.imrworldwide.com/cgi-bin/m?ci= ENTXX5&am=3&ep=1&at=view&rt=banner&st=image&ca=cmp97144&cr=1186239&pc=3739659&r=2011370876 "
};
</syntaxhighlight>
|-
|'''Digital Audio'''
type should always be "radio".
| <syntaxhighlight lang="javascript">
{
"type": "radio",
"assetid": "WXYZ-FM",
"stationType": "3",
"provider": "providerName",
"dataSrc": "cms"
};
</syntaxhighlight>
|-
|'''DCR'''
type should be "content"
|
<syntaxhighlight lang="javascript">
{
"type": "content",
"assetName": "myassetName",
"length": "300",
"title": "myTitle",
"program": "myProgram",
"censuscategory": "myCensusCategory",
"assetid": "myAssetId",
"channelName": "myChannel",
"segB": "segmentB",
"segC": "segmentC",
"isfullepisode":"Y",
"crossId1": "Reference11",
"crossId2": "Reference22",
"airdate": "20161013 20:00:00",
"adloadtype": "2",
"hasAds": "0"
};
</syntaxhighlight>
<syntaxhighlight lang="javascript">
// Static Measurement:
{
"type": "static",
"assetid": "static123",
"assetName": "Page-Asset",
"section": "siteSection",
"segA": "segmentA",
"segB": "segmentB",
"segC": "segmentC"
};
</syntaxhighlight>
<syntaxhighlight lang="java">
// Ad Measurement:
{
"type": "midroll",
"length": "30",
"assetid": "myMidrollAssetId",
"adModel": "2",
"tv": "true",
"dataSrc": "cms"
};
</syntaxhighlight>

|-
|'''DCR Germany'''
| <syntaxhighlight lang="javascript">
// type should be "content"
{
// SDK
"assetid": "VID123-123456",
// SDK and VA Beacon
"type": "content",
"program": "programName",
"title": "title",
"length": "length",
// VA Beacon
"censuscategory": "censuscategory",
"livestream": "no",
"subcategory": "subcategory",
"uurl":"uurl",
"vidtype": "vidtype",
// Custom Properties
"nol_c2": "p2, nol_c2",
"nol_c5": "p5, nol_c5",
"nol_c7": "p7, nol_c7",
"nol_c8": "p8, nol_c8",
"nol_c9": "p9, nol_c9",
"nol_c10": "p10, nol_c10",
"nol_c12": "p12, nol_c12",
"nol_c14": "p14, nol_c14",
"nol_c15": "p15, nol_c15",
"nol_c16": "p16, nol_c16",
"nol_c18": "p18, nol_c18",
"nol_c19": "p19, nol_c19",
}

//Ad Measurement - type should be "preroll", "midroll" or "postroll".:
{
// SDK
"type": "preroll"
"assetid": "AD-1",
"length": "123",
"title": "title",
// VA Beacon Metadata
"censuscategory": "censuscategory",
"vidtype": "vidtype",
"subcategory": "subcategory",
"uurl":"http://nielsen.com",
// Custom Properties
"nol_c2": "p2, nol_c2",
"nol_c4": "p4, nol_c4",
"nol_c5": "p5, nol_c5",
"nol_c7": "p7, nol_c7",
"nol_c8": "p8, nol_c8",
"nol_c9": "p9, nol_c9",
"nol_c10": "p10, nol_c10",
"nol_c11": "p11, nol_c11",
"nol_c12": "p12, nol_c12",
"nol_c16": "p16, nol_c16",
"nol_c17": "p17, nol_c17",
"nol_c18": "p18, nol_c18",
},
</syntaxhighlight>
|}

== Notes ==
The actual parameter names and possible values passed in <code>metadataObject</code> depend on application. These are defined between the client and Nielsen before integration starts. Contact the Nielsen Technical Account Manager (TAM) for exact details.

=== Custom Variables Setup ===
Nielsen SDK supports collection of custom format and variables. This feature allows the App to pass additional data to the SDK. Contact Nielsen Technical Account Manager (TAM) to configure any custom variables, as needed for implementing the audio / video player.

==== Samples for passing values to Segment parameters A, B and C ====
<syntaxhighlight lang="json">
{
"type": "content",
"length": 300,
"title": "%Program Title%",
"assetid": "%Asset ID",
"assetName": "%Asset Name%",
"segmentA": "%Segment A%",
"segmentB": "%Segment B%",
"segmentC": "%Segment C%"
}
</syntaxhighlight>