DCR Italy Video Browser SDK (6.0.1) - Revision history

ColinBrown at 01:41, 10 September 2020

2020-09-10T01:41:08Z

← Older revision		Revision as of 01:41, 10 September 2020
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|International}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|International DCR}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

Admin at 21:47, 29 May 2019

2019-05-29T21:47:00Z

← Older revision		Revision as of 21:47, 29 May 2019
Line 6:		Line 6:
	== Overview ==		== Overview ==
	The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.		The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
	The Browser SDK is the framework for browsers developers to integrate Nielsen Measurement into their media player pages. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR)~~, [[Digital Audio]]~~. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of pages like:		The Browser SDK is the framework for browsers developers to integrate Nielsen Measurement into their media player pages. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), and [[Digital Ad Ratings]] (DAR). Nielsen SDKs are also equipped to measure static content and can track key life cycle events of pages like:
	*Site launch events and how long page is viewed		*Site launch events and how long page is viewed
	*Time of viewing a sub section / page.		*Time of viewing a sub section / page.

YaminiKumawat: changed 86400 to 0 for live stream

2018-12-13T15:23:34Z

changed 86400 to 0 for live stream

← Older revision		Revision as of 15:23, 13 December 2018
Line 176:		Line 176:
	\| title \|\| Episode title (max. 254 characters) \|\| custom \|\| ✓		\| title \|\| Episode title (max. 254 characters) \|\| custom \|\| ✓
	\|-		\|-
	\| length \|\| Length of content in seconds for VOD. The estimated content length has to be passed for live content. \|\| <code>seconds</code> (~~86400~~ for live stream) \|\| ✓		\| length \|\| Length of content in seconds for VOD. The estimated content length has to be passed for live content. \|\| <code>seconds</code> (0 for live stream) \|\| ✓
	\|-		\|-
	\| airdate \|\| Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" \|\| <code>YYYYMMDD hh:mm:ss</code> \|\| ✓		\| airdate \|\| Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" \|\| <code>YYYYMMDD hh:mm:ss</code> \|\| ✓

Admin: Unix timestamp

2018-11-30T19:51:06Z

Unix timestamp

← Older revision		Revision as of 19:51, 30 November 2018
Line 257:		Line 257:
	\| <code>'5'</code> \|\| playhead position \|\| content play \|\| Call when content or ads start playing or resumes from pause.		\| <code>'5'</code> \|\| playhead position \|\| content play \|\| Call when content or ads start playing or resumes from pause.
	'''VOD''' (or ad): The playhead position must be passed.		'''VOD''' (or ad): The playhead position must be passed.
	'''Live''': current ~~UTC Timestamp~~ (seconds since ~~January 1st~~ 1970).		'''Live''': current Unix timestamp (seconds since Jan-1-1970 UTC).
	\|-		\|-
	\| <code>'6'</code> \|\| playhead position \|\| pause \|\| Call when content or ads is pausing. Use Event 5 to resume ...		\| <code>'6'</code> \|\| playhead position \|\| pause \|\| Call when content or ads is pausing. Use Event 5 to resume ...
	'''VOD''' (or ad): The playhead position must be passed.		'''VOD''' (or ad): The playhead position must be passed.
	'''Live''': current ~~UTC Timestamp~~ (seconds since ~~January 1st~~ 1970).		'''Live''': current Unix timestamp (seconds since Jan-1-1970 UTC).
	\|-		\|-
	\| <code>'7'</code> \|\| playhead position \|\| stop \|\| Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop		\| <code>'7'</code> \|\| playhead position \|\| stop \|\| Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop
Line 270:		Line 270:
	\|-		\|-
	\| <code>'49'</code> \|\| playhead position \|\| playhead position \|\| '''VOD''': current position in seconds.		\| <code>'49'</code> \|\| playhead position \|\| playhead position \|\| '''VOD''': current position in seconds.
	'''Live''': current ~~UTC Timestamp~~ (seconds since ~~January 1st~~ 1970).		'''Live''': current Unix timestamp (seconds since Jan-1-1970 UTC).
	Note: has to be called on a secondly basis.		Note: has to be called on a secondly basis.
	For each ad the playheads starts with 0 (no Live unix timestamp for ads)		For each ad the playheads starts with 0 (no Live unix timestamp for ads)

Admin3 at 22:07, 26 April 2018

2018-04-26T22:07:56Z

← Older revision		Revision as of 22:07, 26 April 2018
Line 23:		Line 23:
	The vcid is your channel id		The vcid is your channel id
	vcid: <syntaxhighlight lang="console">"xXX"</syntaxhighlight> // eg. "c01"		vcid: <syntaxhighlight lang="console">"xXX"</syntaxhighlight> // eg. "c01"


			== Remove Nielsen JS Library Call ==
			* '''For clients currently using the legacy tagging system (Object Video)'''
			The Nielsen JS library call is no longer needed. You will need to remove:
			<syntaxhighlight lang="html">
			<script src='http://cdn-gl.imrworldwide.com/novms/js/2/ggcmb39X.js'></script>
			</syntaxhighlight>
			The initialization call in Step '''"Create SDK Instance"''' will handle the library download.


			* '''For clients not currently using the legacy tagging system (Object Video)'''
			If you are integrating for the first time our Video Browser SDK, you should use the SDK version 6.0.0.
			Please see the following guide [[DCR Italy Video Browser SDK (6.0.0)]]

			== Remove Nielsen SDK Plugins ==

			Nielsen SDK Plugins must be remove.

			* For existing '''Brightcove plugin''' clients. You Will need to remove:
			<syntaxhighlight lang="html">
			<script src='http://cdn-gl.imrworldwide.com/novms/bc/3/ggng510.js'></script>
			</syntaxhighlight>
			<br>
			* For existing '''JW Player plugin''' clients.You Will need to remove:
			<syntaxhighlight lang="html">
			<script src='http://cdn-gl.imrworldwide.com/novms/jw/ggjw510.js'></script>
			</syntaxhighlight>
			<br>
			* For existing '''The Platform/CTS plugin''' clients.You Will need to remove:
			<syntaxhighlight lang="html">
			<script src='http://cdn-gl.imrworldwide.com/novms/tp/3/ggtp510.js'></script>
			</syntaxhighlight>

	== Configure SDK ==		== Configure SDK ==
Line 137:		Line 170:
	\|\| <code>"content"</code> \|\| ✓		\|\| <code>"content"</code> \|\| ✓
	\|-		\|-
	\| assetid \|\| Unique ID assigned to content (max. 32 characters) \|\| custom ~~<br>(no [[Special Characters]])~~ \|\| ✓		\| assetid \|\| Unique ID assigned to content (max. 40 characters) \|\| custom \|\| ✓
	\|-		\|-
	\| program \|\| Program name (max. ~~100~~ characters) \|\| custom \|\| ✓		\| program \|\| Program name (max. 254 characters) \|\| custom \|\| ✓
	\|-		\|-
	\| title \|\| Episode title (max. ~~100~~ characters) \|\| custom \|\| ✓		\| title \|\| Episode title (max. 254 characters) \|\| custom \|\| ✓
	\|-		\|-
	\| length \|\| Length of content in seconds for VOD. The estimated content length has to be passed for live content. \|\| <code>seconds</code> (86400 for live stream) \|\| ✓		\| length \|\| Length of content in seconds for VOD. The estimated content length has to be passed for live content. \|\| <code>seconds</code> (86400 for live stream) \|\| ✓
Line 224:		Line 257:
	\| <code>'5'</code> \|\| playhead position \|\| content play \|\| Call when content or ads start playing or resumes from pause.		\| <code>'5'</code> \|\| playhead position \|\| content play \|\| Call when content or ads start playing or resumes from pause.
	'''VOD''' (or ad): The playhead position must be passed.		'''VOD''' (or ad): The playhead position must be passed.
	'''Live''': current ~~unix timestamp~~ (seconds since January 1st 1970).		'''Live''': current UTC Timestamp (seconds since January 1st 1970).
	\|-		\|-
	\| <code>'6'</code> \|\| playhead position \|\| pause \|\| Call when content or ads is pausing. Use Event 5 to resume ...		\| <code>'6'</code> \|\| playhead position \|\| pause \|\| Call when content or ads is pausing. Use Event 5 to resume ...
	'''VOD''' (or ad): The playhead position must be passed.		'''VOD''' (or ad): The playhead position must be passed.
	'''Live''': current ~~unix timestamp~~ (seconds since January 1st 1970).		'''Live''': current UTC Timestamp (seconds since January 1st 1970).
	\|-		\|-
	\| <code>'7'</code> \|\| playhead position \|\| stop \|\| Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop		\| <code>'7'</code> \|\| playhead position \|\| stop \|\| Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop
Line 237:		Line 270:
	\|-		\|-
	\| <code>'49'</code> \|\| playhead position \|\| playhead position \|\| '''VOD''': current position in seconds.		\| <code>'49'</code> \|\| playhead position \|\| playhead position \|\| '''VOD''': current position in seconds.
	'''Live''': current ~~unix timestamp~~ (seconds since January 1st 1970).		'''Live''': current UTC Timestamp (seconds since January 1st 1970).
	Note: has to be called on a secondly basis.		Note: has to be called on a secondly basis.
	For each ad the playheads starts with 0 (no Live unix timestamp for ads)		For each ad the playheads starts with 0 (no Live unix timestamp for ads)
Line 366:		Line 399:


	~~===~~Interruption Scenarios~~===~~		'''Interruption Scenarios'''
	The following possible browser interruption scenarios must be handled:		The following possible browser interruption scenarios must be handled:
	* Browser/Tab close		* Browser/Tab close
Line 373:		Line 406:
	There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).		There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	~~var stopped = false;~~
	function closePlayer() {		function closePlayer() {
	if (~~stopped~~) {~~return;}~~		if (insideMidroll) { // Only inside a midroll indicate 'stop' for the ad
	~~stopped = true;~~		nSdkInstance.ggPM('7', playheadPositionMidroll);
	~~if (inMidroll) {~~ // Only inside a midroll indicate <stop> for the ad		}
	nSdkInstance.ggPM(7, playheadPositionMidroll);
	}		// Indicate 'end' for the content and 'stop' for the stream
	nSdkInstance.ggPM(57, playheadPositionContent); ~~// Indicate <end> for the content~~		nSdkInstance.ggPM('57', playheadPositionContent);
	nSdkInstance.ggPM(7, playheadPositionContent); ~~// Indicate <stop> for the content~~		nSdkInstance.ggPM('7', playheadPositionContent);
	};		};
	window.addEventListener("~~beforeunload~~", function (e) {		if ('onpagehide' in window) {
	closePlayer(); // call nielsensdk with end/stop		window.addEventListener("pagehide", function (e) { // for iOS mobile recommended by apple
	});		closePlayer(); // call nielsensdk with end/stop
	window.addEventListener("~~pagehide~~", function (e) { ~~// for iOS mobile "pagehide" recommended by apple~~		});
	closePlayer(); // call nielsensdk with end/stop		} else {
	});		window.addEventListener("beforeunload", function (e) {
			closePlayer(); // call nielsensdk with end/stop
			});
			}
	</syntaxhighlight>		</syntaxhighlight>

Admin3 at 00:00, 24 April 2018

2018-04-24T00:00:55Z

← Older revision		Revision as of 00:00, 24 April 2018
Line 137:		Line 137:
	\|\| <code>"content"</code> \|\| ✓		\|\| <code>"content"</code> \|\| ✓
	\|-		\|-
	\| assetid \|\| Unique ID assigned to content (max. 40 characters) \|\| custom <br>(no [[Special Characters]]) \|\| ✓		\| assetid \|\| Unique ID assigned to content (max. 32 characters) \|\| custom <br>(no [[Special Characters]]) \|\| ✓
	\|-		\|-
	\| program \|\| Program name (max. ~~254~~ characters) \|\| custom \|\| ✓		\| program \|\| Program name (max. 100 characters) \|\| custom \|\| ✓
	\|-		\|-
	\| title \|\| Episode title (max. ~~254~~ characters) \|\| custom \|\| ✓		\| title \|\| Episode title (max. 100 characters) \|\| custom \|\| ✓
	\|-		\|-
	\| length \|\| Length of content in seconds for VOD. The estimated content length has to be passed for live content. \|\| <code>seconds</code> (86400 for live stream) \|\| ✓		\| length \|\| Length of content in seconds for VOD. The estimated content length has to be passed for live content. \|\| <code>seconds</code> (86400 for live stream) \|\| ✓

Admin at 22:04, 14 March 2018

2018-03-14T22:04:24Z

← Older revision		Revision as of 22:04, 14 March 2018
Line 137:		Line 137:
	\|\| <code>"content"</code> \|\| ✓		\|\| <code>"content"</code> \|\| ✓
	\|-		\|-
	\| assetid \|\| Unique ID assigned to content (max. 40 characters) \|\| custom \|\| ✓		\| assetid \|\| Unique ID assigned to content (max. 40 characters) \|\| custom <br>(no [[Special Characters]]) \|\| ✓
	\|-		\|-
	\| program \|\| Program name (max. 254 characters) \|\| custom \|\| ✓		\| program \|\| Program name (max. 254 characters) \|\| custom \|\| ✓

NielsSedat at 09:29, 13 March 2018

2018-03-13T09:29:34Z

← Older revision		Revision as of 09:29, 13 March 2018
Line 366:		Line 366:


	~~'''~~Interruption Scenarios~~'''~~		===Interruption Scenarios===
	The following possible browser interruption scenarios must be handled:		The following possible browser interruption scenarios must be handled:
	* Browser/Tab close		* Browser/Tab close
Line 373:		Line 373:
	There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).		There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
			var stopped = false;
	function closePlayer() {		function closePlayer() {
	if (~~insideMidroll~~) { // Only inside a midroll indicate 'stop' for the ad		if (stopped) {return;}
	nSdkInstance.ggPM('7', playheadPositionMidroll);		stopped = true;
	}		if (inMidroll) { // Only inside a midroll indicate <stop> for the ad
			nSdkInstance.ggPM(7, playheadPositionMidroll);
	~~// Indicate 'end' for the content and 'stop' for the stream~~		}
	nSdkInstance.ggPM('57', playheadPositionContent);		nSdkInstance.ggPM(57, playheadPositionContent); // Indicate <end> for the content
	nSdkInstance.ggPM('7', playheadPositionContent);		nSdkInstance.ggPM(7, playheadPositionContent); // Indicate <stop> for the content
	};		};
	~~if ('onpagehide' in window) {~~		window.addEventListener("beforeunload", function (e) {
	window.addEventListener("~~pagehide~~", function (e) { ~~// for iOS mobile recommended by apple~~		closePlayer(); // call nielsensdk with end/stop
	closePlayer(); // call nielsensdk with end/stop		});
	});		window.addEventListener("pagehide", function (e) { // for iOS mobile "pagehide" recommended by apple
	~~} else {~~		closePlayer(); // call nielsensdk with end/stop
	window.addEventListener("~~beforeunload~~", function (e) {		});
	closePlayer(); // call nielsensdk with end/stop
	});
	}
	</syntaxhighlight>		</syntaxhighlight>

NielsSedat at 15:03, 30 November 2017

2017-11-30T15:03:43Z

← Older revision		Revision as of 15:03, 30 November 2017
Line 341:		Line 341:
	nSdkInstance.ggPM('49', 62);		nSdkInstance.ggPM('49', 62);
	nSdkInstance.ggPM('6', 62); // now send nothing to SDK until player resumes (automatically because of buffering ends or user unpauses/resumes play		nSdkInstance.ggPM('6', 62); // now send nothing to SDK until player resumes (automatically because of buffering ends or user unpauses/resumes play
	nSdkInstance.ggPM('5', 62); // play/5 when resume occurs (when user click play or buffering ends)		nSdkInstance.ggPM('5', 62); // ONLY WHEN PLAYING CONTENT (not ads!) - play/5 when resume occurs (when user click play or buffering ends)
	nSdkInstance.ggPM('49', 63);		nSdkInstance.ggPM('49', 63);
	nSdkInstance.ggPM('49', 64);		nSdkInstance.ggPM('49', 64);
Line 358:		Line 358:
	nSdkInstance.ggPM('6', 62); // use pause, because buffering will occur (to be on safe side)		nSdkInstance.ggPM('6', 62); // use pause, because buffering will occur (to be on safe side)
	nSdkInstance.ggPM('8', 62,120);		nSdkInstance.ggPM('8', 62,120);
	nSdkInstance.ggPM('5', 120); // play/5 when resuming		nSdkInstance.ggPM('5', 120); // ONLY WHEN PLAYING CONTENT (not ads!) - play/5 when resuming
	nSdkInstance.ggPM('49', 120);		nSdkInstance.ggPM('49', 120);
	nSdkInstance.ggPM('49', 121);		nSdkInstance.ggPM('49', 121);

NielsSedat at 15:36, 15 November 2017

2017-11-15T15:36:30Z

← Older revision		Revision as of 15:36, 15 November 2017
Line 372:		Line 372:
	* Pressing the stop button		* Pressing the stop button
	There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).		There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
	<syntaxhighlight lang="javascript">~~window.addEventListener('beforeunload',~~ function(~~event~~)		<syntaxhighlight lang="javascript">
	{		function closePlayer() {
	// Only inside a midroll indicate 'stop' for the ad		if (insideMidroll) { // Only inside a midroll indicate 'stop' for the ad
	~~if (insideMidroll) {~~		nSdkInstance.ggPM('7', playheadPositionMidroll);
	nSdkInstance.ggPM('7', ~~playheadPosition~~);
	}		}

	// Indicate 'end' for the content and 'stop' for the stream		// Indicate 'end' for the content and 'stop' for the stream
	nSdkInstance.ggPM('57', ~~playheadPosition~~);		nSdkInstance.ggPM('57', playheadPositionContent);
	nSdkInstance.ggPM('7', ~~playheadPosition~~);		nSdkInstance.ggPM('7', playheadPositionContent);
	});</syntaxhighlight>		};
			if ('onpagehide' in window) {
			window.addEventListener("pagehide", function (e) { // for iOS mobile recommended by apple
			closePlayer(); // call nielsensdk with end/stop
			});
			} else {
			window.addEventListener("beforeunload", function (e) {
			closePlayer(); // call nielsensdk with end/stop
			});
			}
			</syntaxhighlight>

	<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer or covering Safari on mobile browsers ... you may use "onpagehide" event as well).</blockquote>		<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer or covering Safari on mobile browsers ... you may use "onpagehide" event as well).</blockquote>