Nielsen SDK Documentation

DCR Implementation Guide – Browser SDK

API Version 5.1.0
   

For static <Page Measurement>, in order to integrate Browser SDK into the player application, perform the following steps.

Prerequisites

Before starting the integration with Browser SDK, secure the following details from your (point of contact) Nielsen TAM.

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

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

Step 1: Import Library

In the HTML head section of each page, call the Nielsen library using the script tag, as shown below. (Include ggcmb510.js in the <head>)

Step 2: Define GlobalParams

In order to initialize the SDK, parameters must be passed when calling the initialization function (ggInitialize). The available parameters are listed in the table below.

Parameters Description Value Required? (Y/N)
apid UniqueID assigned to player/site. Nielsen assigned Yes
apn User-defined string value for describing the player/site. Client specified Yes
sfcode Location of collection environment. “dcr” Yes
nol_sdkDebug Enables Debug Mode which allows output to be viewed in console. “console” No

Step 3: Initialize SDK

Initialize Browser SDK (in the <body> section) as soon as the Parent / Main Page is loaded. During the initialization, custom parameters can be appended to the global parameter object. These custom (extended) parameters are optional. Use them only if the player application can handle the data requirement.

The Nielsen Browser SDK supports multiple processing instances. To create an instance, call the getInstance() function.

All subsequent calls to getInstance with the same instanceName will return an already created SDK instance with that name. This will allow accessing the same object from different parts of the code.

The “instanceName” parameter is optional and will be set to “default” if missing. To use a single default SDK instance call

Step 4: Fire Event: staticstart

Use staticstart to pass details about content section. The CMS data must be passed as a JSON string (before closing <body>).

Trigger staticstart, as below, for the static content when the page is loaded.

# Key Description Values Reported for Static <Page Measurement>?

1.

type Type of audio / video Measurement content (content, etc.). “static”

2.

assetid Unique ID assigned to content custom

3.

assetName Unique name for the asset custom

4.

section Section of site custom

5.

segA Segment A custom

6.

segB Segment B custom

7.

segC Segment C custom

Dynamic Metadata

An alternative method for passing in assetid, section, segA-segC (if used), is to pass these values dynamically instead of hardcoding these values per site section. The code below provides an example of how this can be achieved.

Tagging a Page

Refer to the sample code for Tagging a page with static <Page Measurement> content.

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 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 http://www.nielsen.com/digitalprivacy) should be displayed.
  • For more details, refer to Opt-Out Implementation and Nielsen Digital Privacy.
  • Use getOptOutStatus to retrieve the user’s current Opt-Out status.

Pre-Certification Checklists

  • After the application is ready to be sent for Nielsen Certification, please go through the Pre-Certification Checklist and ensure that it behaves as expected, before submitting to Nielsen.

Testing an Implementation – Browser

Click here for information on Testing the Browser Implementation.