DCR & DTVR Browser Static Adobe Launch Extension

From Engineering Client Portal

Revision as of 21:19, 21 February 2019 by Admin3 (talk | contribs)

Engineering Portal / Digital / DCR & DTVR / DCR & DTVR Browser Static Adobe Launch Extension

Adobe Launch Extensions

Adobe Launch Extensions are building blocks for mobile application development that reside on Adobe Servers for client utilization. Nielsen provides three Adobe Launch Extensions that can be integrated to an html page containing any number of video players. It allows clients to add the reporting functionality to their site by putting several lines of JavaScript code into the page. This guide focuses on Static Page Measurement only. For detailed information on how to use with Video, please select this link: BSDK Adobe Launch Extension for Video

Extension Installation and Configuration

Nielsen has developed Extensions to simplify adding Nielsen measurement into your video stream. The first step is to create and publish a property which is outlined in the Getting Started Guide.

Install the Extension

When you sign in to the Launch you’ll see the Properties screen first. A property is a container for the tags that you want to deploy and it can be used on one or many sites. Click New Property and enter a name. You will now be able to add an extension. icon

BSDK extension

BSDK extension integrates the Nielsen BSDK, initializes BSDK instances that can be used by any other extension or from the client’s page directly.

Build the Extension

After the Extension is configured, it can be “built” under the “library” on the Publishing page with other “libraries”.

Add a New library

Select to add a new library

icon

Set the name, chose Environment (Production, Staging, Development):

icon

Save and Build

Add all changed resources. When you get the Extension configured, it will appear in the list of changed resources. Select the Latest revision and press “Select & Create a New Revision” button: icon

Confirm

Once built, it will appear in the list of Development libraries:

icon

BDSK Adobe Launch Extension

The following events and API calls are supported:

Event API Function Description
"nls-sdk-init-instance" window.NSDKAPI.initInstance requests BSDK extension to initialize a new SDK instance
"nls-sdk-trackevent" window.NSDKAPI.trackEvent sends data for trackEvent function of the SDK

Event based API

The extension listens to the following custom events:

"nls-sdk-init-instance"

Format of input object is the following: 

window.NSDKAPI.initInstance({
  "ext_opt": {
    //Do something
  }
});

All parameters and supported values are described below.

Parameter Description Required Values Example
sdk_instance_name Name of the BSDK instance. It's used to bind
BSDK and other extensions. If it's not
provided, the extension generates the name.
It can be obtained in the callback function.		 No string 
"sdk_instance_name": "myPlayer1"
debug Debug flag. If set to "DEBUG", the extension prints
debug messages to the browser console.		 No string 
"debug": "DEBUG"
apid APID that is used in Browser SDK Yes string 
"apid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
opt_params Optional parameters that are passed to
initialization function of Browser SDK		 No object 
"opt_params":
   {
     "apn": "myApn",
     "sfcode": "code1",
     "nol_sdkDebug": "DEBUG"
   }
callback Function that is called by the extension
to provide output data		 No function 
"callback": function (ret) {
   var name = ret.sdk_instance_name;
}

Example

function createStatic(playerId) {
  var sdk_instance_name = playerId;

  window.NSDKAPI.initInstance({
    "ext_opt": {
      "debug": "DEBUG",
      "sdk_instance_name": sdk_instance_name,
      "apid": sdkPluginParams.apid,
      "fnMessage": fnMessage,
      "opt_params": {
        "containerID": playerId,
        "apn": sdkPluginParams.apn,
        "sfcode": sdkPluginParams.sfcode,
        "nol_sdkDebug": sdkPluginParams.nol_sdkDebug
      }

    }
  });

"nls-sdk-trackevent"

Format of input object is the following: 

{ detail:
    {
        sdk_instance_name: <name>,
                obj: { /* data */ }
    }
}

All parameters and supported values are described below.

Parameter Description Required Values Example
sdk_instance_name Name of the BSDK instance that should
receive the data.		 Yes string 
"sdk_instance_name": "myPlayer1"
obj Object containing data that is passed
to trackEvent function of Browser SDK		 Yes string 
"obj": {
 "event": 'playhead',
 "type": 'static',
 "playheadPosition": '1',
 "metadata": {
 "static": {
 "type": 'static',
 "assetid": 'AID885-9984'
 }
}}
callback Function that is called by the extension
to provide the result value. It's true if success.		 function 
"callback": function (ret) {
   var result = ret.result;
}

Example

var obj = {
  "event": 'playhead', // playhead,pause,complete,adstop
  "type": 'static',
  "playheadPosition": '1',
  "metadata": {
    "content": {},
    "ad": {},
    "static": {
      type: 'static',
      section: 'TrackEvent Homepage',
      assetid: 'AID885-9984',
      segA: 'NielsenEnt',
      segB: 'CustomSegB',
      segC: 'CustomSegC',
      crossId1 : 'Reference'
    }
  }
};
window.NSDKAPI.trackEvent({
  sdk_instance_name: sdk_instance_name,
  obj: obj
});

Tracking the SDK Event

Event Types

The following event types are supported:

Key Description
playhead

It is used to pass content, ad or static metadata, the current playhead value,
Unix timestamp or id3 payload, OTT information to the SDK.

pause

This event should be used when content playback is paused.
(Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)

complete

It is called when session is completed or ends.

adStop

This event should be called at the end of each ad and is required when advertisements have the same assetId.


Handling JSON Metadata

Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following: 

{ 
 "event": <event identifier>,
 "type": <type of metadata>,
 "metadata":{ 
   "content": <content metadata object>,
   "ad": <ad metadata object>,
   "static": <static metadata object>
 },
 "playheadPosition":<playhead value | Unix Timestamp>,
 "id3Data": <id3 payload>,
}


DCR

Digital Content Ratings

Parameter Description Supported values Example
event Event identifier

String: playhead,pause,complete, adStop 

"event":"playhead"
type Determines the metadata object

that should be used for crediting.

String:
content, ad, static 

"type":"content"
metadata Object that holds metadata values of specific types

Detailed in tables below

Object 
"metadata":{ 
   "content": <content metadata object>,
   "ad": <ad metadata object>,
   "static": <static metadata object>
 },
playheadPosition Playhead value as reported by video player.
Unix timestamp (seconds since Jan-01-1970 UTC) for live video. 		String

Position value is Unix timestamp (live): "playheadPosition":"1542797780"

Position value is playhead:

"playheadPosition":"10"

Content Metadata

Content metadata sent for every playheadposition update.

Keys Description Example Required
assetName name of program (100 character limit) "MyTest789" Yes
assetid unique ID assigned to asset custom Yes
length length of content in seconds seconds (0 for live stream or unknown) Yes
program name of program (100 character limit) custom Yes
segB custom segment B ¹ custom
segC custom segment C ¹ custom
title name of program (100 character limit) custom Yes
type 'content', 'ad', 'static' 'content' Yes
section Unique Value assigned to page/site section HomePage Yes
airdate the airdate in the linear TV ² YYYYMMDD HH24:MI:SS Yes
isfullepisode full episode flag "y"- full episode, "n"- non full episode Yes
crossId1 standard episode ID custom ✓
crossId2 content originator (only required for distributors) Nielsen provided
adloadtype linear vs dynamic ad model 1=Linear

2=Dynamic Ads

custom

¹ Custom segments (segB and segC) can be used to aggregate video and/or static content within a single Brand to receive more granular reports within a brand.
² Acceptable Air Date Formats: 

YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS 
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS


For USA all times should be EST, for all other countries Local Time. Below is a sample event for DCR. If no ad or static values, these can be left as blank/null. 

{ 
"event": "playhead",
"type": "content",
"metadata": { 
  "content":{
    "assetName":"Big Buck Bunny",
    "assetid":"B66473",
    "length":"3600",
    "program":"MyProgram",
    "segB":"CustomSegmentValueB",
    "segC":"segmentC",
    "title":"S2,E3",
    "type":"content",
    "section":"cloudApi_app",
    "airdate":"20180120 10:00:00",
    "isfullepisode":"y",
    "crossId1":"Standard Episode ID",
    "crossId2" :"Content Originator",
    "adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}

DTVR

Digital TV Ratings info

Parameter Description Supported values Example
event Event identifier

String: playhead,pause,complete, adStop 

"event":"playhead"
type Determines the metadata object that should be used for crediting.

String:
content, ad, static 

"type":"content"
adModel linear vs dynamic ad model 1=Linear

2=Dynamic Ads

custom
channelName Any string representing the.channel/stream Object custom
playheadPosition Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC) String

Position value is Unix timestamp: "playheadPosition":"1542797780"

Position value is playhead:

"playheadPosition":"10"

id3Data Nielsen ID3 payload String

"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg ==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60 kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W VJx2O4M=/33648/22847/00"

Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null. 

{ 
"event": "playhead",
"type": "content",
"metadata": { 
  "content":{
    "adModel":"1",
    "channelname":"channel1"
  },
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}

DCR & DTVR

Applies to DCR and DTVR

Parameter Description Supported values Example
event Event identifier

String: playhead, pause, complete, adStop 

"event":"playhead"
type Determines the metadata object that should be used for crediting.

String:
content, ad, static 

"type":"content"
metadata Object that holds metadata values of specific types

Detailed in tables below

Object 
"metadata":{ 
   "content": <content metadata object>,
   "ad": <ad metadata object>,
   "static": <static metadata object>
 },
playheadPosition Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC) String

Position value is Unix timestamp: "playheadPosition":"1501225191747"

Position value is playhead:

"playheadPosition":"10"

id3Data Nielsen ID3 payload Object

"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg ==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60 kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W VJx2O4M=/33648/22847/00"

ottData Object that holds OTT information Object 
"ottData": {
   "ottStatus": 1,
   "ottType": casting,
   "ottDevice": chromecast,
   "ottDeviceID": 1234
}

Content Metadata

Content metadata sent for every playheadposition update.

Keys Description Example Required
length length of content in seconds seconds (0 for live stream) Yes
type "content", "ad", "static" "content" Yes
adModel linear vs dynamic ad model 1=Linear

2=Dynamic Ads

custom
adloadtype DCR Ad Model 1=Linear

2=Dynamic Ads

custom

+ Custom segments (segB and segC) can be used to aggregate video and/or static content within a single Brand to receive more granular reports within a brand.
++ Acceptable Air Date Formats: 

YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS 
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS


Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null. 

{ 
"event": "playhead",
"type": "content",
"metadata": { 
  "content":{
    "type":"content",
    "length":"0",
    "adModel":"1",
    "adloadtype":"1"},
  "ad": {},
  "static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}

IMA Adobe Launch Extension

IMA extension subscribes to ad related events fired by IMA plugin, processes data provided by the user and taken from IMA, and calls BSDK API (trackevent).

Events that are used in IMA extension: 

google.ima.AdEvent.Type.ALL_ADS_COMPLETED,
 google.ima.AdEvent.Type.COMPLETE,
 google.ima.AdEvent.Type.FIRST_QUARTILE,
 google.ima.AdEvent.Type.MIDPOINT,
 google.ima.AdEvent.Type.PAUSED,
 google.ima.AdEvent.Type.STARTED,
 google.ima.AdEvent.Type.THIRD_QUARTILE,
 google.ima.AdEvent.Type.SKIPPED,
 google.ima.AdEvent.Type.DURATION_CHANGE

Users can communicate with the extension in two ways – either by calling functions exposed by the extension or by using events.

The following events and API calls are supported:

Event API Function Sender/Caller Description 
"nls-ima-get-info"
window.NIMAAPI.getInfo. User requests IMA extension to provide the extension version information 
"nls-ima-init-instance"
window.NIMAAPI.initInstance. User requests IMA extension to initialize a new
IMA extension instance for the player		 
"nls-ima-get-data"
Extension requests IMA extension to provide the extension version information 
"nls-ima-set-data"
User requests IMA extension to provide the extension version information 
"nls-msg"
Extension requests IMA extension to provide the extension version information


"nls-ima-get-info"

Format of input object is the following: 

{ detail:
    {
        callback: function(obj) { /* Do something */}
    }
}

All parameters and supported values are described below.

Parameter Description Required Values Example
callback Function that is called by the
extension to provide output data		 Yes Function 
 "callback": function (ret) {
    var name = ret.ima_instance_name;
}

"nls-ima-init-instance"

Format of input object is the following: 

{ detail:
    {
        sdk_instance_name: <name>,
        // other parameters,
        callback: function(obj) { /* Do something */}
    }
}

All parameters and supported values are described below.

Parameter Description Required Values Example 
sdk_instance_name
Name of the BSDK instance that should
receive the data.		 Yes string 
"sdk_instance_name": "myPlayer1"

debug
Debug flag. If set to "DEBUG", the extension prints
debug messages to the browser console.		 string 
"debug": "DEBUG"

playerId
Id of the video element Yes string 
"playerId": "myPlayer1"

callback
Function that is called by the extension
to provide output data.		 function 
"callback": function (ret) {
   var result = ret.ima_instance_name;
}

"nls-ima-set-data"

Format of input object is the following: 

{ detail:
    {
        playerId: <player element id>,
        custom_fields: { /* data */ }
    }
}

All parameters and supported values are described below.

Parameter Description Required Values Example 
playerId
Id of the video element provided
in event "nls-ima-get-data"		 Yes string 
"playerId": "playerid"
custom_fields Custom fields like Custom fields like assetid Yes string 
 "custom_fields": {
 "assetid": 'myAssetId1'
}

"nls-ima-get-data"

Format of input object is the following: 

eventObject.detail.playerId


All parameters and supported values are described below.

Parameter Description Required Values Example
playerId Id of the video element playing the video.
This id must be copied to the object that will be
provided in event "nls-ima-set-data"		 Yes string 
 eventObject.detail.playerId

Examples

How to get version information of IMA extension 

var ev = new CustomEvent("nls-ima-get-info", {"detail":
 {
     callback: function (obj) {
         var imaInfo = obj.extinfo;
     }
 }
});
document.dispatchEvent(ev);


How to create an instance of IMA extension 

var ev = new CustomEvent("nls-ima-init-instance", {"detail":
  {
    "sdk_instance_name": "myPlayer1",
    "debug": "DEBUG",
    "playerId": "myPlayer1",
    "callback": function (ret) {
       console.log("IMA is ready");
    }
  }
});
document.dispatchEvent(ev);


How to provide custom fields 

function fnCustomDataAdRequest(detail) {
  var adId = detail.id;
  // id - is an identifier of the ad that is currently playing.
  var custom_fields = {};
  //  search for the info of the ad (currently playing ad)
  custom_fields.assetid = "myAssetId";
  return custom_fields;
}
document.addEventListener("nls-ima-get-data", function (event) {
 var customData = null;
 if (event) {
   var detail = event.detail;
   var plId = detail.playerId;
 // We must provide playerId as the event originator
 // Instead, we can copy the whole detail object back to the extension
   customData = fnCustomDataAdRequest(detail);
 }
 if (customData) {
    var ev = new CustomEvent("nls-ima-set-data", {
     "detail":
       {
          playerId: plId,
          custom_fields: customData
       }
    });
    document.dispatchEvent(ev);
 }
 });

VJS Adobe Launch Extension

VideoJS (VJS) extension subscribes to standard media events fired by VideoJS player, processes data provided by the user and taken from player, and calls BSDK API (trackevent).

Standard media events that are used in VJS extension: 

loadstart
timeupdate
ended
loadeddata
play
playing
stop
durationchange

The extension handles id3 tag related events as well.

Users can communicate with the extension in two ways – either by calling functions exposed by the extension or by using events. The following events and API calls are supported:

Event API Function Sender/Caller Description 
"nls-vjs-get-info"
window.NVJSAPI.getInfo User requests JVS extension to provide the
extension version information		 
"nls-vjs-init-instance"
window.NVJSAPI.initInstance User requests JVS extension to initialize a new
IMA extension instance for the player		 
"nls-vjs-get-data"
Extension requests the user to provide custom data for the video 
"nls-vjs-set-data"
User provides custom data to the extension 
"nls-msg"
Extension sends error or any other message

"nls-vjs-get-info"

Format of input object is the following: 

{ detail:
    {
        callback: function(obj) { /* Do something */}
    }
}


All parameters and supported values are described below.

Parameter Description Required Values Example
callback Function that is called by the
extension to provide output data		 Yes Function 
 "callback": function (ret) {
    var name = ret.vjs_instance_name;
}

"nls-vjs-init-instance"

Format of input object is the following: 

{ detail:
    {
        sdk_instance_name: <name>,
        // other parameters,
        callback: function(obj) { /* Do something */}
    }
}

All parameters and supported values are described below.


Parameter Description Required Values Example 
sdk_instance_name
Name of the BSDK instance that should
receive the data.		 Yes string 
"sdk_instance_name": "myPlayer1"

debug
Debug flag. If set to "DEBUG", the extension prints
debug messages to the browser console.		 string 
"debug": "DEBUG"
}}

playerId
Id of the video element Yes string 
"playerId": "myPlayer1"

callback
Function that is called by the extension
to provide output data.		 function 
"callback": function (ret) {
   var result = ret.vjs_instance_name;
}

"nls-vjs-set-data"

Format of input object is the following: 

{ detail:
    {
        playerId: <player element id>,
        custom_fields: { /* data */ }
    }
}

All parameters and supported values are described below.


Parameter Description Required Values Example 
playerId
Id of the video element provided
in event "nls-vjs-get-data"		 Yes string 
"playerId": "playerid"
custom_fields Custom fields like assetid Yes string 
 "custom_fields": {
 "assetid": 'myAssetId1',
"segA": 'NNh777'
}

"nls-vjs-get-data"

Format of input object is the following: 

eventObject.detail.playerId


All parameters and supported values are described below.

Parameter Description Required Values Example
playerId Id of the video element playing the video.
This id must be copied to the object that will be
provided in event "nls-vjs-set-data"		 Yes string 
 eventObject.detail.playerId

Examples

How to get version information of VJS extension 

var ev = new CustomEvent("nls-vjs-get-info", {"detail":
 {
     callback: function (obj) {
         var vjsInfo = obj.extinfo;
     }
 }
});
document.dispatchEvent(ev);


How to create an instance of VJS extension 

var ev = new CustomEvent("nls-vjs-init-instance", {"detail":
  {
    "sdk_instance_name": "myPlayer1",
    "debug": "DEBUG",
    "playerId": "myPlayer1",
    "callback": function (ret) {
       console.log("VJS is ready");
       // Init Player here...
    }
  }
});
document.dispatchEvent(ev);


How to provide custom fields 

function fnCustomDataContentRequest(detail) {
  var currentSrc = detail.currentSrc;
  // currentSrc - is the path to the stream that is currently playing
  var custom_fields = {};
  //  search for the info of the currentSrc (currently playing stream)
  custom_fields.assetid = "myAssetId";
  return custom_fields;
}
document.addEventListener("nls-vjs-get-data", function (event) {
 var customData = null;
 if (event) {
   var detail = event.detail;
   var plId = detail.playerId;
 // We must provide playerId as the event originator
 // Instead, we can copy the whole detail object back to the extension
   customData = fnCustomDataContentRequest(detail);
 }
 if (customData) {
    var ev = new CustomEvent("nls-vjs-set-data", {
     "detail":
       {
          playerId: plId,
          custom_fields: customData
       }
    });
    document.dispatchEvent(ev);
 }
 });

Implementation Methods

There are two ways to communicate with extensions. Users can use events or call the extension methods directly.

Event Implementation Method

The first step is to include the following Inside the <head> tag: 

<script src="//assets.adobedtm.com/launch-XXXXXX-development.min.js"></script>

Initialize Instance

Inside <body> tag: 

// create player with id specified in video tag
// ….
// Add listener. You can use the following code as a template.
document.addEventListener("nls-vjs-get-data", function (event) {
  var customData = {};
  var detail = event.detail;
  var plId = detail.playerId;
  // We must provide playerId field back to the event originator in "nls-vjs-set-data"
  var currentSrc = detail.currentSrc;
  if (currentSrc === “/path/file.mp4”)
      customData.assetid = "SeaHorseID";
  var ev = new CustomEvent("nls-vjs-set-data", {"detail":   {
     playerId: plId, custom_fields: customData }
  });
  document.dispatchEvent(ev);
});
//
// Initialize BSDK and VJS extensions. You can use the following code as a template.
var ev = new CustomEvent("nls-sdk-init-instance", {"detail":
   {
      "sdk_instance_name": "inst_" + playerId,                                                   
      "apid": APID,                                
      "opt_params":                                                                              
          {                                                                                  
              "apn": APN,                  
              "sfcode": SFCODE,            
              "nol_sdkDebug": "DEBUG"
          },
       callback: function (ret) {
           var sdk_instance_name = ret. sdk_instance_name;
           var ev = new CustomEvent("nls-vjs-init-instance", {"detail":
                 {
                     "playerId": playerId,
                     "sdk_instance_name": sdk_instance_name,
                     "callback": function (ret) {
                         console.log("USER: VJS is ready");
                         // initialize player (set playlist, ads);
                       }
                   }
               });
         console.log("USER: Sending nls-vjs-init-instance");
         document.dispatchEvent(ev);
         }
      }
 });
console.log("USER: Sending nls-sdk-init-instance");
document.dispatchEvent(ev);
 
// Add the following before </body
<script>_satellite.pageBottom();</script>
Retrieved from "https://engineeringportal.nielsen.com/w/index.php?title=DCR_%26_DTVR_Browser_Static_Adobe_Launch_Extension&oldid=3467"