View source for DCR Video Browser SDK

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

== Prerequisites ==
<br />
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" 

</syntaxhighlight>

== Configure SDK ==
<br />
There are two steps required for configuring the SDK:
<br/>
*Add Static Queue Snippet
*Create SDK Instance
<br/>
'''Static Queue Snippet'''
<br/>
Add the following script tag to the website:
<br/>
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
  t[n]=t[n]||
  {
    nlsQ:function(e,o,c,r,s,i)
    {
     return s=t.document,
     r=s.createElement("script"),
     r.async=1,
     r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
     i=s.getElementsByTagName("script")[0],
     i.parentNode.insertBefore(r,i),
     t[n][o]=t[n][o]||{g:c||{},
     ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
    }
  }
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
<br />
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
<br/>
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
<br />
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter	!! Description	!! Values
|-
| apid	|| Unique ID assigned to player/site ||	'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName ||	Name of SDK instance ||	"any string value"
|-
| nol_sdkDebug	|| Enables Nielsen console logging. Only required for testing	|| "{nol_sdkDebug: "debug"})"
|}
<br/>
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript">   var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
<br/>
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
<br/>
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
<br/>
'''Example SDK Configuration'''
<br/>
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript"> 

<script type="text/javascript">
  // Add Static Queue Snippet
 !function(t,n)
 {
   t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
   {
    return s=t.document,
    r=s.createElement("script"),
    r.async=1,
    r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
    i=s.getElementsByTagName("script")[0],
    i.parentNode.insertBefore(r,i),
    t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
    t[o]
   }
 }
} 
(window,"NOLBUNDLE");

  // Created SDK Instance
  var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
<br/>
There are two types of asset metadata:
<br/>
*content: identify video
*ad: identify each ad
<br/>
The metadata received for each asset is used for classification and reporting.
<br/>
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
<br/>
''Content Metadata''
<br/>
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
<br/>
{| class="wikitable"
|-
! Key !! Description !!	Values	 !! Required
|-
| clientid	|| 
parent ID – value is automatically populated through provided App ID.<br/>
In order to override the brand configured to the App ID, pass parent <br/>
value here and the sub-brand ID associated to that brand in the subbrand <br/>
key (e.g. multiple brands in App)	
||
Nielsen provided	
||
|-
| vcid	|| sub-brand ID – value is automatically populated through provided<br/>
App ID. In order to override the sub-brand configured to the App ID, value can <br/>
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided	
||
|-
| type ||	type of asset	|| "content"	|| ✓
|-
| assetid	|| unique ID assigned to asset	|| custom	|| ✓
|-
| program	|| name of program (25 character limit)	|| custom	|| ✓
|-
| title	|| episode title (40 character limit)	|| custom	|| ✓
|-
| length	|| length of content in seconds	|| seconds 86400 for live stream)||	✓
|-
| mediaURL	|| URL location of the content being streamed	|| custom	|| ✓
|-
| segB	|| custom segment B	|| custom	||
|-
| segC	|| custom segment C	|| custom	 ||
|-
| airdate	|| the airdate in the linear TV ||	YYYYMMDD HH:MI:SS	|| ✓
|-
| isfullepisode	|| full episode flag ||	
*"y"– full episode
*"n"– non full episode	
||
✓
|-
| crossId1	|| standard episode ID	|| custom	|| ✓
|-
| crossId2	|| content originator (only required for distributors)	|| Nielsen provided	||
|-
|adloadtype	|| type of ad load:
* 1) - Linear – matches TV ad load 
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads 
*"2" – content with dynamic ads	
||
✓
|-
| hasAds	|| identify if content includes Ads ||
*“0” – no ads 
“1” – includes Ads 
“2” – unknown (default)	
|| ✓
|}
<br/>
'''Example Content Object'''
<syntaxhighlight lang="javascript"> 
var contentMetadataObject =
{  
  type:           'content',
  assetid:        'VID123-123456',
  program:        'program name',
  title:          'episode title',
  length:         'length in seconds',
  mediaURL:       'http://www.site.com/videoAsset',
  segB:           'custom segment B',
  segC:           'custom segment C',
  airdate:        'YYYYMMDD HH:MI:SS',
  isfullepisode:  'y',
  crossId1:       'Standard Episode ID',
  crossId2:       'Content Originator',
  adloadtype:     '2',
  hasAds:         '1'
};
</syntaxhighlight>

=== Ad Metadata Object ===
<br/>
The ad metadata should be passed for each individual ad.
<br/>
{| class="wikitable"
|-
! Keys	!! Description	!! Values	!! Required
|-
| type	|| type of ad	|| 'preroll', 'midroll', or 'postroll' ||	✓
|-
| assetid ||	unique ID assigned to ad	|| custom	|| ✓
|}
<br/>
'''Example Ad Object'''
<br/>
<syntaxhighlight lang="javascript">  
var adMetadataObject = 
{  
  assetid: 'AD-1',
  type:    'preroll'
};
</syntaxhighlight>
<br/>
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
<br/>
'''Call Nielsen APIs'''
<br/>
The method for calling events is ggPM().
<br/>
<syntaxhighlight lang="javascript">  
 
nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>
== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
<br/>
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) 
{
  // Only inside a midroll indicate <stop> for the ad
  nSdkInstance.ggPM('stop', playheadPosition);
  
  // Indicate <end> and <stop> for the content
  nSdkInstance.ggPM('end', playheadPosition);
  nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
<br/>
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
<br/>

<br/>
'''SDK Events'''
<br/>
{| class="wikitable"
|-
! Event !!	Parameter	!! Description
|-
| 'loadMetadata'	|| content/ad metadata object	|| Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition'	|| playhead position as integer<br/>
VOD: || current position in seconds <br/>
Live: current UTC timestamp <br/>
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' ||	playhead position	|| Call when content or ads complete playing and pass playhead position
|-
| 'end'	|| playhead position in seconds	|| Call when the current video asset completes playback and pass the playhead position. <br/>
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
<br/>
== SDK Playhead Event Sequence ==
<br/>
The sample event lifecycle can be used as a reference for identifying the order for calling events.
<br/>
<syntaxhighlight lang="javascript">  
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject); 
 
// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//  
//   pass playhead every second
//   
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
 
// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//  
//   pass playhead every second
//   
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
 
// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//  
//   pass playhead every second
//   
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
 
// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//  
//   pass playhead every second
//   
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);
 
// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//  
//   pass playhead every second
//   
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>


== Nielsen Opt-Out ==
<br/>
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
<br/>
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
<br/>
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
<br/>
The following paragraph is a template for an opt-out statement.
<Br/>
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
<br/>
'''Opt Back In'''
<br/>
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
<br/>
'''Going Live'''
<br/>
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
<br/>
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript"> 

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>