DCR Video Domless SDK
From Engineering Client Portal
DOM-less SDK DCR Video Introduction
The Nielsen DOM-less SDK is a Javascript based cross-platform library that clients can use to integrate the Nielsen Digital Content Rating or Digital TV Rating measurement in ReactNative or NodeJS apps.
The Digital Content Ratings (DCR) Video product provides content consumption measurement on client mobile apps or webpages. This measurement includes insight into the total time a user spent watching the tracked content, video player events, and much more. This example provides the steps to implement the DCR Video product in a sample NodeJS app. It includes:
- DOM-less SDK Initialization
- DCR Video Metadata: information about the content being tracked
- DCR Video Events/API calls
By the end of this guide you will have the needed steps to integrate Nielsen's DOM-less SDK in your app.
DOM-less SDK DCR Video Step 1 - Obtain AppID
To begin using the DOM-less SDK you will need to obtain an Application ID (AppId)
| Item | Description | Source | |
|---|---|---|---|
| ✅ | App ID (appid) | Unique ID assigned to the player/site and configured by product | Contact your Nielsen TAM |
The appid is a 37 character unique ID assigned to the player/site and configured by product and is required when creating a new instance of the DOM-less SDK on the app.
Example: PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX
DOM-less SDK DCR Video Step 2 - SDK Initialization
This project is an API that allows clients to integrate the Nielsen SDK in DOM-less environments like React Native, NodeJS, etc.
Installation
Install with npm install https://github.com/NielsenDigitalSDK??????????????? and import the BsdkInstance into video player component
`import { BsdkInstance } from 'bsdk-domless'
Exposed Interface
The exposed interface is as follows:
1. `ggPM` - method to send messages to the Nielsen SDK
2. `processEvent` - method to send app state to the Nielsen SDK, e.g., Focus, Blur, AppClose
SDK Initialization
The following table contains the list of arguments that can be passed
| Parameter / Argument | Description | Source | Required? | Example |
|---|---|---|---|---|
| appid | Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. | Nielsen-specified | Yes | PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
| instanceName | DOM-less SDK instance name | Yes | String eg. abcdefg | |
| metadataObject | Object containing the metadata for SDK initialization. The parameters are:
|
Yes |