DCR Static Domless SDK: Difference between revisions

From Engineering Client Portal

No edit summary
Line 7: Line 7:
The Digital Content Ratings (DCR) Static product provides content consumption measurement on client mobile apps or webpages. This measurement includes insight into the total time a user spent on a webpage, how they navigated through the page via links, and many other data points. This tutorial provides the steps to implement the DCR Static product in a sample NodeJS app. It includes:
The Digital Content Ratings (DCR) Static product provides content consumption measurement on client mobile apps or webpages. This measurement includes insight into the total time a user spent on a webpage, how they navigated through the page via links, and many other data points. This tutorial provides the steps to implement the DCR Static product in a sample NodeJS app. It includes:


== DOM-less SDK Initialization ==
DOM-less SDK Initialization
DCR Video Metadata: information about the content being tracked
DCR Video Metadata: information about the content being tracked
DCR Video Events/API calls
DCR Video Events/API calls

Revision as of 15:37, 24 October 2024

License

Nielsen SDK contains material that is protected by copyright laws, patent laws, trade secret laws, and by international treaty provisions and is Copyright © 2024 The Nielsen Company (US) LLC. All intellectual property rights and licenses therein are reserved by The Nielsen Company (US) LLC and its licensors. Please read the license agreement presented here, which must be accepted in order to download the Nielsen SDKs. For more information, reach out to your Nielsen Technical Account Manager(TAM).

DOM-less SDK DCR Static 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 apps for dom-less platforms like ReactNative, NodeJS etc. apps.

The Digital Content Ratings (DCR) Static product provides content consumption measurement on client mobile apps or webpages. This measurement includes insight into the total time a user spent on a webpage, how they navigated through the page via links, and many other data points. This tutorial provides the steps to implement the DCR Static 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 Static 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 Static 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.

Refer to the " DOM-less SDK initialization " section in the DOM-less SDK API Reference Guide.

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 Client provided Yes String eg. abcdefg
appName Application name Client provided Yes appName: 'BSDK RN Sample App'
deviceId Device ID Client provided Yes deviceId: '38400000-8cf0-11bd-b23e-10b96e40000d'
nol_sdkDebug Enables Nielsen console logging. Only required for testing Client-provided No nol_sdkDebug: 'debug'
domlessEnv Specify the domless environment.

"1" for ReactNative "2" for Amazon "3" for NodeJS "4" for Custom

Client-provided Yes domlessEnv: '1'
nol_debugServerUrl This is the IP Address and port of where the debug-node-server host is running. Client-provided No 'nol_debugServerUrl' : 'http://0.0.0.0:3000'
nol_debugSessionTracking Value of "true" or "false" which will either enable or disable the Session Manager in the SDK to send messages to the running debug node server. Client-provided No 'nol_debugSessionTracking' : 'true'

Nielsen Debug Node Server

The debug server is a Node.js server project that can be ran locally and will act as an api that uses web sockets to track messages and events that are fired from the Domless SDK when enabled in the initialization.

Nielsen Debug Node Server Repository

DOM-less SDK DCR Static Step 3 - Create DCR Static Metadata Object

DOM-less SDK DCR Video Step 4 - Basic Set of Events - Sample Playback

Sample Nielsen BSDK-Domless NodeJS Example

Sample DCR Static Integration