thePlatform Plugin Browser - Revision history

YaminiKumawat: changed 86400 to 0 for live stream

2018-12-13T15:20:05Z

changed 86400 to 0 for live stream

← Older revision		Revision as of 15:20, 13 December 2018
Line 50:		Line 50:
	\| airdate \|\| The original airdate for linear TV \|\| <code>'20161013 20:00:00'</code> \|\| date \|\| No		\| airdate \|\| The original airdate for linear TV \|\| <code>'20161013 20:00:00'</code> \|\| date \|\| No
	\|-		\|-
	\| length \|\| Length of content in seconds \|\| <code>3600</code> (~~86400~~ for ~~lives tream~~)\|\| integer \|\| Yes		\| length \|\| Length of content in seconds \|\| <code>3600</code> (0 for live stream)\|\| integer \|\| Yes
	\|-		\|-
	\| segB \|\| Custom Reporting Segment \|\| <code>custom</code> \|\| string \|\| No		\| segB \|\| Custom Reporting Segment \|\| <code>custom</code> \|\| string \|\| No

Admin at 20:31, 14 March 2018

2018-03-14T20:31:12Z

← Older revision		Revision as of 20:31, 14 March 2018
Line 42:		Line 42:
	\| type \|\| Type of asset \|\| <code>'content'</code> \|\| string \|\| Yes		\| type \|\| Type of asset \|\| <code>'content'</code> \|\| string \|\| Yes
	\|-		\|-
	\| assetid \|\| Unique ID assigned to asset \|\| ~~<code>~~custom<~~/code~~> \|\| string \|\| Yes		\| assetid \|\| Unique ID assigned to asset \|\| custom<br>(no [[Special Characters]]) \|\| string \|\| Yes
	\|-		\|-
	\| program \|\| Program Name \|\| <code>custom</code> \|\| string \|\| Yes		\| program \|\| Program Name \|\| <code>custom</code> \|\| string \|\| Yes

Admin3 at 19:54, 19 December 2017

2017-12-19T19:54:29Z

← Older revision		Revision as of 19:54, 19 December 2017
Line 125:		Line 125:
	\| apn \|\| a user-defined string value for describing your player \|\| e.g, "Client Name PrimeTime" \|\| string \|\| No		\| apn \|\| a user-defined string value for describing your player \|\| e.g, "Client Name PrimeTime" \|\| string \|\| No
	\|-		\|-
	\| sfcode \|\| collections location setting. The SDK uses the sfcode value to manage traffic routing. Set sfcode to '~~cert~~'.		\| sfcode \|\| collections location setting. The SDK uses the sfcode value to manage traffic routing. Set sfcode to 'dcr'.
	\|\|'~~cert~~'		\|\|'dcr'
	\|\| string \|\| No		\|\| string \|\| No
	\|-		\|-

Admin3: Removed dcr-cert

2017-12-19T19:53:29Z

Removed dcr-cert

← Older revision		Revision as of 19:53, 19 December 2017
Line 184:		Line 184:
	"plplugin$visibility": "basic",		"plplugin$visibility": "basic",
	"plplugin$description": "sfcode",		"plplugin$description": "sfcode",
	"plplugin$defaultValue": "dcr~~-cert~~"		"plplugin$defaultValue": "dcr"
	},		},
	{		{
Line 218:		Line 218:
	=== SDK / GlobalParameter Plug-in Variables ===		=== SDK / GlobalParameter Plug-in Variables ===
	* '''apid''': This value is given to you by your Nielsen Technical Account Manager. Example value: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"		* '''apid''': This value is given to you by your Nielsen Technical Account Manager. Example value: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
	* '''sfcode''': ~~During testing and QA this value should be "dcr-cert". In production this~~ value should be "dcr".		* '''sfcode''': This value should be "dcr".
	* '''apn''': This is the name of the Player and is editable within the plug-in creation / update		* '''apn''': This is the name of the Player and is editable within the plug-in creation / update
	* '''nol_sdkDebug''': Used in test environment for console logging: 'DEBUG'.		* '''nol_sdkDebug''': Used in test environment for console logging: 'DEBUG'.

Admin3: updated

2017-12-19T19:51:53Z

updated

← Older revision		Revision as of 19:51, 19 December 2017
Line 248:		Line 248:
	* '''clip.contentCustomData''' object with the fields provided by the client while configuring custom fields in MPX console.		* '''clip.contentCustomData''' object with the fields provided by the client while configuring custom fields in MPX console.

	The plugin takes these fields in the order specified above and puts them to one single object that is passed to the ~~Browser~~ SDK with "loadmetadata" ~~events (3/15)~~.		The plugin takes these fields in the order specified above and puts them to one single object that is passed to the Nielsen SDK with "loadmetadata" event.
	Fields with the same name will be overwtitten.		Fields with the same name will be overwtitten.

Line 259:		Line 259:
	<code>clip.contentCustomData.mykey="val2"</code>.		<code>clip.contentCustomData.mykey="val2"</code>.

	As a result the value <code>"val2"</code> will be passed to the ~~Browser~~ SDK.		As a result the value <code>"val2"</code> will be passed to the Nielsen SDK.

	Data from '''setup.defaults''' will be used for '''all videos''' and for '''all ads''' played in the session, e.g. for all videos in the playlist.		Data from '''setup.defaults''' will be used for '''all videos''' and for '''all ads''' played in the session, e.g. for all videos in the playlist.
	Data from '''setup.custom_fields''' will be used for '''all videos''', but '''NOT for ads''' played in the session		Data from '''setup.custom_fields''' will be used for '''all videos''', but '''NOT for ads''' played in the session

	The plugin ~~doesn~~'~~t send events 3/15/49/7/57~~ to the ~~Browser~~ SDK if there is no custom field provided. In this case the plugin ~~sends~~ only ~~events 55 if~~ the ~~video is~~ ID3 ~~tagged.~~		The plugin will not send a 'loadmetadata', 'stop' or 'end' to the Nielsen SDK if there is no custom field provided. In this case the plugin will only send the playhead postion for ID3 tags.
	~~There is one exception. The field '''length''' provided in custom fields is '''NOT''' considered as a parameter allowing the Plugin to send events 3/15/49/7/57~~.

	If custom fields are passed through the setup object, it requires initializing the plugin and the ~~Browser~~ SDK for each video.		If custom fields are passed through the setup object, it requires initializing the plugin and the Nielsen SDK for each video.

Admin3 at 19:43, 19 December 2017

2017-12-19T19:43:31Z

← Older revision		Revision as of 19:43, 19 December 2017
Line 125:		Line 125:
	\| apn \|\| a user-defined string value for describing your player \|\| e.g, "Client Name PrimeTime" \|\| string \|\| No		\| apn \|\| a user-defined string value for describing your player \|\| e.g, "Client Name PrimeTime" \|\| string \|\| No
	\|-		\|-
	\| sfcode \|\| collections location setting. The SDK uses the sfcode value to manage traffic routing. ~~During the Nielsen Beta Period, set~~ sfcode to '~~dcr-~~cert' ~~for testing & 'cert' for production~~.		\| sfcode \|\| collections location setting. The SDK uses the sfcode value to manage traffic routing. Set sfcode to 'cert'.
	\|\|		\|\|'cert'
	'~~''Development''': set sfcode to 'dcr-~~cert'.

	~~'''Production''': set sfcode to 'dcr'.~~
	\|\| string \|\| No		\|\| string \|\| No
	\|-		\|-
Line 139:		Line 136:
	\| instanceName \|\| Name of SDK instance \|\| "any string" \|\| string \|\| No		\| instanceName \|\| Name of SDK instance \|\| "any string" \|\| string \|\| No
	\|}		\|}


	== Setup ==		== Setup ==

Admin3: Updated Note

2017-12-19T19:41:07Z

Updated Note

← Older revision		Revision as of 19:41, 19 December 2017
Line 14:		Line 14:
	}}		}}

	<blockquote>'''Note''': The Plugin 5.1.0.10 is compatible with ~~the~~ thePlatform player ~~version~~ 5.7.7.		<blockquote>'''Note''': The Plugin 5.1.0.10 is compatible with thePlatform player versions 5.7.7 and 5.7.16.
	ThePlatform player 5.7.8 through 5.7.15 ~~handles~~ ID3 tags ~~incorrectly, which results~~ in ~~incorrect order of ID3 tags sent to~~ the ~~Plugin.~~
	~~ThePlatform~~ player ~~of these~~ versions should not be used ~~with the version 5.1.0.10 of the plugin due to the player issue~~.		ThePlatform player 5.7.8 through 5.7.15 does not send the information in the ID3 tags in the correct sequence; therefore, these player versions should not be used. </blockquote>
	~~This issue is fixed in thePlatform player 5.7.16, but the same ID3 tags are being sent by the player multiple times, which impacts data traffic between the player and the plugin.~~

	== Plugin Implementation ==		== Plugin Implementation ==

MichaelSpivakbaranov: Description of setup object. Notes added.

2017-12-07T16:09:47Z

Description of setup object. Notes added.

Show changes

MichaelSpivakbaranov: Plugin 5.1.0.10. Ways to pass custom data.

2017-12-05T09:46:06Z

Plugin 5.1.0.10. Ways to pass custom data.

@@ Line 9: / Line 9: @@
 |pluginImage=thePlatformIcon
 |osImage=BrowserIcon
-|playerVersion=
+|playerVersion=5.7.7
-|SDKVersion=5.1.1
+|SDKVersion=6.0.0.28
 |supportedAdFrameworks=Google IMA
 }}
@@ Line 111: / Line 111: @@
 ** '''Test apid''': used during development, test, and certification processes
 ** '''Production apid''': used only after Nielsen has certified the implementation.
-* '''apn''': a user-defined string value for describing your player (for example, "Client Name PrimeTime", or "Channel Name Player")
+* '''nol_sdkDebug''': Nielsen SDK console logging that should be used while testing. Make sure to disable before moving the implementation to production.
 ** Set 'DEBUG' for all levels of logging enabled. 'INFO', 'WARN', & 'ERROR' can also be used for specific levels of debugging.
 ** Leave blank to disable.
@@ Line 151: / Line 145: @@
      "plplugin$jsUrl": "http://cdn-gl.imrworldwide.com/novms/tp/3/ggtp510.js",
      "plplugin$type": "plugin",
-     "plplugin$iconUrl": "http://engtestsite.com/nikita/nielsen.png",
+     "plplugin$iconUrl": "http://yoursite/folder/nielsen.png",
      "plplugin$componentType": "tpPlayer",
      "plplugin$parameters": [
@@ Line 161: / Line 155: @@
          "plplugin$description": "apid",
          "plplugin$defaultValue": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        },
+       {
@@ Line 185: / Line 163: @@
          "plplugin$description": "nol_sdkDebug",
          "plplugin$defaultValue": "DEBUG"
-       },
+   ]
 }</syntaxhighlight>
@@ Line 210: / Line 180: @@
 === SDK / GlobalParameter Plug-in Variables ===
 * '''apid''': This value is given to you by your Nielsen Technical Account Manager. Example value: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
 * '''nol_sdkDebug''': Used in test environment for console logging: 'DEBUG'.
 <blockquote>'''Note''': Make sure to disable before moving to production by leaving blank.</blockquote>

Admin at 16:11, 30 November 2017

2017-11-30T16:11:15Z

← Older revision		Revision as of 16:11, 30 November 2017
Line 9:		Line 9:
	\|pluginImage=thePlatformIcon		\|pluginImage=thePlatformIcon
	\|osImage=BrowserIcon		\|osImage=BrowserIcon
	\|playerVersion=~~5.7.7~~		\|playerVersion=
	\|SDKVersion=6.0.0		\|SDKVersion=5.1.1
	\|supportedAdFrameworks=Google IMA		\|supportedAdFrameworks=Google IMA
	~~\|downloadLink=https://engineeringportal.nielsen.com/w/downloads/digital/plugins/theplatform/browser/Nielsen-App-SDK-thePlatform-Plugin-Browser-5.1.0.10.zip~~
	}}		}}