DTVR Browser SDK

Engineering Portal / Digital / Digital in TV Ratings / DTVR Browser SDK

Prerequisites

To start using the App SDK, the following details are required:

• App ID (apid): Unique ID assigned to the player/site and configured by product.
• sfcode: Location of collection environment. Please set the sfcode to “dcr“.

If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.

Configure SDK

There are two steps required for configuring your SDK: 1. Add Static Queue Snippet and 2. Create SDK Instance.

Add Static Queue Snippet

Add the following script tag to your website:

<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");
</script>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. Since the queue is able to 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

To initialize the SDK, you will need to create an SDK instance by making the initialization call:

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})

When creating your instance, you will need to pass three parameter values. The available parameters are listed in the table below:

Parameters	Description	Value	Required? (Y/N)
apid	UniqueID assigned to player/site.	"XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX"	Yes
instanceName	User-defined string value for describing the player/site.	Client specified	Yes
sfcode	Location of collection environment. All traffic should be directed to "dcr".	Yes
nol_sdkDebug:"debug"	Enables Debug Mode which allows output to be viewed in console.	"{nol_sdkDebug: "debug"}"	No

Example SDK Initialization

var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});

When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on your apid and cached on the user's browser.

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".

Example SDK Initialization

Your configuration should include the Static Queue Snippet and an SDK Instance for your unique App ID as shown in the example:

//Add Static Queue Snippet
<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");

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

Create Metadata Objects

There are two types of asset metadata:

• content: identify video
• ad: identify each ad

The metadata received for each asset is used for classification and reporting.
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.

Content Metadata

Content metadata should remain constant throughout the completion of an episode or live stream.

Key	Description	Values	Required
type	type of asset	"content"	✓
channelName	Any string representing the channel/stream	custom	✓
adModel	linear vs dynamic ad model	* 1) - Linear – matches TV ad load * 2) Dynamic – Dynamic Ad Insertion (DAI)	✓

Example Content Object

 
var contentMetadataObject =
{  
  type: 'content',
  channelName: 'Live Player',
  adModel: '1'
};

Ad Metadata Object

The ad metadata should be passed for each individual ad, if ads are available during or before the stream begins.

Keys	Description	Values	Required
type	type of ad	'preroll', 'midroll', or 'postroll'	✓
assetid	unique ID assigned to ad	custom	✓

Example Ad Object

  
var adMetadataObject = 
{  
  assetid: 'AD-1',
  type:    'preroll'
};

SDK Events

Event	Parameter	Description
'loadMetadata'	content/ad metadata object	Needs to be called at the beginning of each asset
'setPlayheadPosition'	playhead position as integer VOD: || current position in seconds Live: current UTC timestamp 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. Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.

Configure and fire API calls

The syntax for firing events is

    nSdkInstance.ggPM("event", parameter object);

Event is passed in parameter 1 and the argument is passed in parameter 2.

Configure API calls - loadMetadata

Use loadMetadata (Browser) to pass the metadata object. The data must be passed as a JSON string.

nSdkInstance.ggPM("loadMetadata", metadataObject);

Configure API calls - sendID3

Use sendID3 (Browser) to send ID3 payload of the HLS content being played. This will allow the ID3 payload to be sent every time an ID3 packet is received (approximately, once in every 10 seconds).

nSdkInstance.ggPM("sendID3", ID3_Object);

ID3_Object is the container to pass the retrieved ID3 tag from the streaming. The player should look for 'PRIV' ID3 tags and send 'owner' field (which typically starts from "www.nielsen.com") through this API. Refer to Browser SDK API Reference - Retrieving ID3 Tags for more information.

Sample ID3 tags

• www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00
• www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00

Note: ID3 tags are not applicable for International (Germany)

Refer to Browser SDK API Reference - Retrieving ID3 Tags section to know more details.

Configure API calls - end

Call end (Browser) only at the end of playback, or if the stream is interrupted.

 
nSdkInstance.ggPM("end", UTC_Timestamp);

Nielsen Measurement Opt-Out Implementation

• As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. Our digital measurement products are not used to identify the consumer in any way, but they help us and our clients measure and analyze how consumers engage with media across online, mobile and emerging technologies, and offer insights into consumer behavior.
• When the user wants to opt in or opt out of Nielsen measurement, a new dynamic page (with content similar to [1]) should be displayed.
• For more details, refer to Browser SDK API Reference - Browser Opt-Out Implementation and Nielsen Digital Privacy.
  • Use getOptOutStatus (Browser) to retrieve the device’s Opt-Out status.

Testing an Implementation - App

See Digital Measurement Testing.