DAR Browser SDK
From Engineering Client Portal
Prerequisites
To start using the Browser SDK, the following details are required:
- App ID (apid): Unique ID assigned to the player/site and configured by product.
- sfcode: Unique identifier for the environment that the SDK should point to. During testing, please use the sfcode as "dcr-cert".
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
Import Library
In the HTML head section of each page, call the Nielsen library using the script tag, as shown below.
<script type="javascript" src="http://secure-dcr-cert.imrworldwide.com/novms/js/2/ggcmb510.js"></script>
Define GlobalParams
<script type="javascript">
var _nolggGlobalParams =
{
sfcode: "dcr-cert",
apid: "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
apn: "test-setup",
nol_sdkdebug: "console"
};
</script>
Initialize SDK
Initialize Browser SDK 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 custom parameter data.
The Nielsen Browser SDK supports multiple processing instances. To create an instance, call the getInstance() function
var nSdkInstance=NOLCMB.getInstance(instanceName);
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
var nSdkInstance=NOLCMB.getInstance();
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. There are two IDs provided for
|
Nielsen assigned | Yes |
| apn | User-defined string value for describing the player/site | Client-specified | Yes |
| sfcode | Location of collection environment. During testing, all traffic should be directed to dcr-cert. |
"dcr-cert" – testing
"dcr" – production || Yes | |
| nsdkv | Nielsen SDK Version currently being used. | Nielsen assigned (‘511’ for Browser SDK 5.1.0, etc.) | Yes |
| nol_sdkdebug | Enables Debug Mode which allows output to be viewed in console. | "console" |
No |
var gg = window.NOLCMB.getInstance(instanceName /*optional*/);
gg.ggInitialize(window._nolggGlobalParams);
Configure and fire API calls
The syntax for firing events is
nSdkInstance.ggPM("event", parameterObject);
Event is passed in parameter 1 and the argument is passed in parameter 2.
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 http://secure-us.imrworldwide.com/nielsen_app_optout.html) 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 user’s current Opt-Out status.
Pre-Certification Checklists
After the website is ready to be sent for Nielsen Certification, please go through the Pre-Certification Checklist and ensure the webpage behaves as expected, before submitting to Nielsen.