View source for thePlatform Plugin Browser

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}}  {{CurrentBreadcrumb}}
[[Category:Digital]]

The Nielsen Browser SDK (Software Development Kit) is the Nielsen framework for measuring media consumption in browser environments.
This SDK has the following features:
* Multiple product support: built-in capabilities to support Digital Content Ratings (DCR), VideoCensus (VC), IAG and Digital in TV Ratings (DTVR).

{{PluginInfobox
|pluginImage=thePlatformIcon
|osImage=BrowserIcon
|playerVersion=5.7.7
|SDKVersion=6.0.0.28
|supportedAdFrameworks=Google IMA
}}

<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 does not send the information in the ID3 tags in the correct sequence; therefore, these player versions should not be used. </blockquote>


== Plugin Implementation ==
Pre-requisites
* '''Nielsen App ID (apid)''': A Unique ID that Nielsen assigns to the site / player. The 'apid' will be provided by your Nielsen Technical Account Manager.
* '''thePlatform Plugin''': Plugin URLs are provided in below section
* '''Test Environment Validation''': Before moving the app into production, Nielsen must validate the Plugin's integration in a test environment.

== Initial Configuration ==
Before integrating the plugin, perform the following
* Configure metadata
* Obtain Nielsen APID's
* Review the Nielsen plugin URLs for thePlatform video players

=== Configure Metadata ===
You must configure your Metadata to send to the SDK. The required values are highlighted in the table below, and will need to be supplied through the "Nielsen Keys".
<blockquote>'''Note''': For more information on setting up your Nielsen Keys & Metadata, please reach out to your Nielsen Technical Account Manager.</blockquote>

=== Content Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Type !! Required
|-
| type || Type of asset || <code>'content'</code> || string || Yes
|-
| assetid || Unique ID assigned to asset || custom<br>(no [[Special Characters]]) || string || Yes
|-
| program || Program Name || <code>custom</code> || string || Yes
|-
| title || Episode title || <code>custom</code> || string || Yes
|-
| airdate || The original airdate for linear TV || <code>'20161013 20:00:00'</code> || date || No
|-
| length || Length of content in seconds || <code>3600</code> (0 for live stream)|| integer || Yes
|-
| segB || Custom Reporting Segment || <code>custom</code> || string || No
|-
| segC || Custom Reporting Segment || <code>custom</code> || string || No
|-
| isfullepisode || Full Episode Flag ||
<code>'y'</code> - Full Episode

<code>'n'</code> - Non Full Episode 
|| boolean || Yes
|-
| adloadtype || Distinguishes Dynamic vs Linear Ad Insertion ||
<code>'1'</code> - Linear

<code>'2'</code> - Dynamic
|| integer || Yes
|-
| crossId1 || Standard Episode ID || <code>custom</code> || string || Yes
|-
| crossId2 || Content Originator ID || <code>custom</code> || string || No
|-
| mediaURL || URL location of the content being streamed || <code>custom</code> || string || Yes
|-
| hasAds || Distinguishes when content includes Ads ||
<code>'0'</code> - No Ads

<code>'1'</code> - Includes Ads

<code>'2'</code> - Unknown
|| integer || Yes
|}

=== Ad Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Type !! Required
|-
| type || Type of ad ||
<code>'preroll'</code>

<code>'midroll'</code>

<code>'postroll'</code>
|| string || Yes
|-
| assetid || Unique ID assigned to ad || <code>custom</code> || string || Yes
|}
<blockquote>'''Note''':There is a URL character limit of 2000 characters imposed due to browser limitations. Exceeding this value can impair data delivery on particular browsers.</blockquote>

=== Obtain the Nielsen Application ID (apid) ===
The Nielsen apid is required to enable SDK functionality. Your Technical Account Manager will provide two apids for each player configuration
* '''Test apid''': use this apid during development and testing
* '''Production apid''': use this apid in your production environment after Nielsen has tested and qualified the player.

=== The Platform Plugin URLs ===
The URL to be used for thePlatform Plugin is as below

'''Javascript''': http://cdn-gl.imrworldwide.com/novms/tp/3/ggtp510.js
<blockquote>'''Note''': Supports flash version of thePlatform Plugin.</blockquote>

== Global Parameters ==
To initialize the Nielsen Browser SDK, you must pass one required global parameter, which will be created when configuring the plugin within thePlatform user interface.
You can also pass optional parameters as described below.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Type !! Required
|-
| apid || unique Nielsen-assigned identifier for the application. Nielsen provides you with the following two apid values:
'''Test apid''': used during development, test, and certification processes.
'''Production apid''': used only after Nielsen has certified the implementation.
|| 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' || string || Yes
|-
| 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 'dcr'.
||'dcr'
|| string || No
|-
| 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.
|| <code>debug</code> || string || No
|-
| instanceName || Name of SDK instance || "any string" || string || No
|}

== Setup ==
In order to integrate the Nielsen plugin, you must create the plugin from thePlatform user interface, then integrate with your thePlatform video player.

=== The Platform Player Plugin Creation ===
* In order to create a plugin, go to the URL http://data.player.theplatform.com/player/client and login with valid credentials.
* Select the object as a 'Plugin' from the dropdown and check the option POST and type of FORM as 'json'.

[[File:ThePlatform_json.jpg|link=]]

* Create the body code similarly to the example body code provided below. You may refer the link for more help http://help.theplatform.com/display/plds/Updating+PlugIn+objects
==== Example in JSON form ====
** title : Title for plugin
** plplugin$jsUrl : URL for .js file which loads the plugin in
** plplugin$iconUrl : URL for showing icon of plugin
** plplugin$parameters: Parameters need to add with the Plugin
'''Integration file references'''

The URL for integration file references is as below

'''JavaScript''': http://cdn-gl.imrworldwide.com/novms/tp/3/ggtp510.js
<blockquote>'''Note''': The below body code uses the JavaScript Plugin reference</blockquote>

<syntaxhighlight lang="json">{
  "$xmlns":
    {
      "plplugin": "http://xml.theplatform.com/player/data/PlugIn"
    },
    "title": "NielsenDCRJS510Plugin",
    "plplugin$jsUrl": "http://cdn-gl.imrworldwide.com/novms/tp/3/ggtp510.js",
    "plplugin$type": "plugin",
    "plplugin$iconUrl": "http://yoursite/folder/nielsen.png",
    "plplugin$componentType": "tpPlayer",
    "plplugin$parameters": [
      {
        "plplugin$name": "apid",
        "plplugin$type": "string",
        "plplugin$label": "apid",
        "plplugin$visibility": "basic",
        "plplugin$description": "apid",
        "plplugin$defaultValue": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      },
      {
        "plplugin$name": "sfcode",
        "plplugin$type": "string",
        "plplugin$label": "sfcode",
        "plplugin$visibility": "basic",
        "plplugin$description": "sfcode",
        "plplugin$defaultValue": "dcr"
      },
      {
        "plplugin$name": "nol_sdkDebug",
        "plplugin$type": "string",
        "plplugin$label": "nol_sdkDebug",
        "plplugin$visibility": "basic",
        "plplugin$description": "nol_sdkDebug",
        "plplugin$defaultValue": "DEBUG"
      },
      {
        "plplugin$name": "apn",
        "plplugin$type": "string",
        "plplugin$label": "apn",
        "plplugin$visibility": "basic",
        "plplugin$description": "apn",
        "plplugin$defaultValue": "defaultClientPlayerName"
    }
  ]
}</syntaxhighlight>

== Plugin Integration with Player ==
* Select the player and click on the plug-ins tab on the right hand side of the MPX UI
* Select the required plug-in from the drop-down 
** For example, the created plug-in 'NielsenDCRJSPlugin' should now be available under the plugin drop-down.

[[File:ThePlatform_NielsenDCRJSPlugin.jpg|link=]]

The variables associated with the plug-in are shown as below, and the user needs to enter the correct values. Refer to your Nielsen Technical Account Manager if you have questions.

[[File:ThePlatform_basic-settings.jpg|link=]]

=== 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" 
* '''sfcode''': This value should be "dcr". 
* '''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'. 
<blockquote>'''Note''': Make sure to disable before moving to production by leaving blank.</blockquote>

=== Notes ===
When creating a plugin instance, the setup object is passed to the initialization function called by the player.
Example of the setup object that is passed to the Plugin: <syntaxhighlight lang="json">{
  "apid": "PXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "defaults": {
     "tv": true
   },
  "custom_fields": {
     "assetid": "123456",
     "program": "myProgram"
   },
  "nol_sdkDebug": "DEBUG"
}
</syntaxhighlight>

The plugin obtains CMS data like assetid, program, length from the following sources:
* '''setup.defaults'''
* '''clip''' object with standard fields provided by the player:
** title = the value returned in clip.title
** nielsen_mediaid = the value returned in clip.contentID
** mediaURL = the value returned in clip.URL
** length = the value returned in timeObject.duration
* '''setup.custom_fields'''
* '''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 Nielsen SDK with "loadmetadata" event.
Fields with the same name will be overwtitten.

For example, parameter "mykey" is set in two objects:

<code>setup.custom_fields.mykey="val1"</code>

and

<code>clip.contentCustomData.mykey="val2"</code>.

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.custom_fields''' will be used for '''all videos''', but '''NOT for ads''' played in the session

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.

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