Engineering Client Portal - User contributions [en]

US DCR & DTVR

2024-12-09T17:58:59Z

DanielKrotov: Added a reference to the "Dual Instances" page.

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
<br><br>
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

Dual Instances of SDK

2024-12-09T17:55:33Z

DanielKrotov: /* Parent Page (index.html */ Added forgotten parenthesis

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Multiple SDK Instances ==

=== SDK Initialization ===

==== App SDK ====
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issue. The sharedInstance API that creates a singleton object was deprecated prior to version 5.1.1. (Version 4.0 for Android)

A maximum of four SDK instances per appid are supported.
When four SDK instances exist, you must destroy an old instance before creating a new one.

==== Browser SDK ====
The Browser SDK allows instantiating multiple instances of the object, which can be used simultaneously without any problems, however they must be instantiated with their own unique instance names. There is no maximum number of instances that is enforced in the browser.

=== App SDK Examples ===

==== Example using Swift ====
<br><br>In this example we create a swift file called NielsenInit where I store our SDK Initialization code. The example uses 2 APPIDS to keep everything organized.
<p>
<syntaxhighlight lang="swift">
self.nielsenStaticApi = NielsenInit.createStaticNielsenApi(delegate: self)
self.nielsenApi = NielsenInit.createNielsenApi(delegate: self)
</syntaxhighlight>
<br>Here are the methods in the NielsenInit class.

<syntaxhighlight lang="swift">
class NielsenInit : NSObject {

class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788BC65XXX",
"appname": "Standard SDK Swift Sample",
"appversion": "1.0",
"sfcode": "dcr",
"nol_devDebug": "INFO"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}

class func createStaticNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [

"appid": "PE4A57F64-878D-4D69-8EFB-4E87C27BXXXX",
"appname": "Standard SDK Swift Sample",
"appversion": "1.0",
"sfcode": "dcr",
"nol_devDebug": "INFO"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>
<br>We then load up the Static and Content metadata in our sample:

<syntaxhighlight lang="swift">
func loadStatic() -> [String : Any] {
//Loading Static data
let staticData =
[
"type": "static",
"section": "siteSection",
"segA": "segmentA",
"segB": "segmentB",
"segC": "segmentC"
]
return staticData
}

func loadContent() -> [String : Any] {
//Loading Content data
url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")
let content = [
"type":"content",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"section":"cloudApi_app",
"airdate":"20180221 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ] as [String : Any]

return content
}
</syntaxhighlight>

<br>In AppDelegate, we initialize the 1st instance of the SDK for Static Measurement when the App launches.
<br>
<syntaxhighlight lang="swift">
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
// Override point for customization after application launch.

//Getting the instance of NielsenApi
self.nielsenStaticApi = NielsenInit.createStaticNielsenApi(delegate: self)
sdkMethods = SDKMethods()
self.data = sdkMethods.loadStatic()
self.nielsenStaticApi.loadMetadata(self.data)
return true
}
</syntaxhighlight>
<br>Now for the Player Instance, we initialize in the ViewController, but only after the View has loaded:<br>
<syntaxhighlight lang="swift">
override func viewDidLoad() {
super.viewDidLoad()
self.view.backgroundColor = UIColor(patternImage: UIImage(named: "new_ios_bg.png")!)
//In NielsenInit class we are initialising the NielsenApi.

//Getting the instance of NielsenApi
self.nielsencontentApi = NielsenInit.createNielsenApi(delegate: self)
</syntaxhighlight>

Now you can just call them separately:

For example, App goes into the background:
<syntaxhighlight lang="swift">
func applicationDidEnterBackground(_ application: UIApplication) {

// Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later.

// If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
self.nielsenStaticApi.loadMetadata(self.data)
}
</syntaxhighlight>
<br>Or sending the playhead position to the second instance:<br>
<syntaxhighlight lang="swift">
nielsencontentApi.play(sdkMethods.loadChannelInfo())
self.nielsencontentApi?.playheadPosition(pos);
</syntaxhighlight>

==== Example using Android Studio ====
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/SimplePlayerStandardWithStaticAndroidSDK.zip Download Project Files]<br><br>The below is an example of Initializing two instances of the Nielsen SDK. One for Static Measurement, and the other for Video Measurement.
<br>

<syntaxhighlight lang=java>
public class NielsenInit {

private AppSdk mAppSdk = null;
private AppSdk mStaticAppSdk = null;

public AppSdk initAppSdk(Context mContext, IAppNotifier appNotifier){
try {
//Initialising the NielsenAppSDK class by passing app information which returns the instance of AppSdk.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC65XXX")
.put("appversion", "1.0")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO");

mAppSdk = new AppSdk(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}
return mAppSdk;
}

public AppSdk initStaticAppSdk(Context mContext, IAppNotifier appNotifier){
try {
//Initialising the NielsenAppSDK class by passing app information which returns the instance of AppSdk.

JSONObject appInformation = new JSONObject()

.put("appid", "PE4A57F64-878D-4D69-8EFB-4E87C27BAXXX")
.put("appversion", "1.0")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO");

mStaticAppSdk = new AppSdk(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}
return mStaticAppSdk;
}
}
</syntaxhighlight>
<br><br>
<syntaxhighlight lang=java>
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenSDK.
staticAppSdk = nielsenInit.initStaticAppSdk(MyApplication.getContext(), this);
data = sdkMethods.loadStaticData();

if(this.b == 0) {
AppLaunchMeasurementManager.appInBackground(app.getApplicationContext());
staticAppSdk.loadMetadata(data);
Log.d("SdkBgFgDetectionUtility", "App going to background");
}

</syntaxhighlight>
<br><br>
<syntaxhighlight lang=java>
//Getting the instance of NielsenSDK.
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenSDK.
appSdk = nielsenInit.initAppSdk(getApplicationContext(), this);

</syntaxhighlight>

=== Browser SDK Examples ===
The below examples will make use of the same AppId, however using different AppIds will work as well. The principles below follow the same initialization rules as a single instance and simply require a unique instance name and variable name with which the returned instance is assigned.

For more information around the possible parameters that can be passed as well as deeper descriptions for the API calls, please refer to our API documentation here: [[Browser SDK API Reference]]

==== Example of 2 instances on the same page ====
<syntaxhighlight lang="javascript">
//Add Static Queue Snippet
<script>
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

//Create SDK Instance(s)
// Notice the unique instance name given to each instance below and the unique variable name for each instance
var nSdkInstanceLive = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "instanceLive", {
nol_sdkDebug: 'debug',
optout: 'false'
});

var nSdkInstanceVod = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "instanceVod", {
nol_sdkDebug: 'debug',
optout: 'false'
});

</script>
</syntaxhighlight>

==== Example of 2 instances using a parent page and iFrame ====

===== Parent Page (index.html) =====
<syntaxhighlight lang="html">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>DCR Static/DCR Video</title>
<script>
/* NLSQUEUE build v*/
!function(e,n){
function t(e){
return"object"==typeof e?JSON.parse(JSON.stringify(e)):e
}
e[n]=e[n]||
{
nlsQ:function(o,r,c){
var s=e.document,
a=s.createElement("script");
a.async=1,
a.src=("http:"===e.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+o+".js#name="+r+"&ns="+n;
var i=s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a,i),
e[n][r]=e[n][r]||{g:c||{},
ggPM:function(o,c,s,a,i){e[n][r].q=e[n][r].q||[];try{var l=t([o,c,s,a,i]);e[n][r].q.push(l)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}},
trackEvent:function(o){e[n][r].te=e[n][r].te||[];try{var c=t(o);e[n][r].te.push(c)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}}},
e[n][r]
}
}
}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "staticPage", {
nol_sdkDebug: 'debug',
});

// Static Metadata
var staticMetadata = {
assetid: 'staticTestPage',
type: 'static'
};

// Event 'staticstart' call
nSdkInstance.ggPM(14, staticMetadata);
</script>
</head>

<body>
<h1>DCR Static on Parent/DCR Video in iFrame</h1>
<p>Static measurement is current on parent page when window is in focus</p>
<iframe src="./dcr-video.html" frameborder="0" width="650" height="500" style="background-color: rgb(42, 217, 248);" id="video-iframe"></iframe>
</body>

</html>
</syntaxhighlight>

===== Nested iFrame Referenced on Parent Page (dcr-video.html) =====
<syntaxhighlight lang="html">
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
<title>iFrame Same Source</title>
<script>
/* NLSQUEUE build v*/
!function(e,n){
function t(e){
return"object"==typeof e?JSON.parse(JSON.stringify(e)):e
}
e[n]=e[n]||
{
nlsQ:function(o,r,c){
var s=e.document,
a=s.createElement("script");
a.async=1,
a.src=("http:"===e.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+o+".js#name="+r+"&ns="+n;
var i=s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a,i),
e[n][r]=e[n][r]||{g:c||{},
ggPM:function(o,c,s,a,i){e[n][r].q=e[n][r].q||[];try{var l=t([o,c,s,a,i]);e[n][r].q.push(l)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}},
trackEvent:function(o){e[n][r].te=e[n][r].te||[];try{var c=t(o);e[n][r].te.push(c)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}}},
e[n][r]
}
}
}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "videoPlayer", {
nol_sdkDebug: 'debug',
});

var contentMetadata = {
type: "content",
length: "300",
title: "Skydiving Across Europe",
program: "latacg",
censuscategory: "Enlisted",
assetid: "204558915992",
section: "ProgramAsset8",
tv: "true",
adModel: "0",
dataSrc: "cms",
segA: "S07E04:NBC",
segB: "teams",
segC:"AtlanataFalcons",
}
</script>
</head>
<body>
<p>I'm iframe SDK DCR Video measurement, DCR static measurement should continue when clicking "play" on video</p>
<main>
<video
controls
src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217"
width="620">
Sorry, your browser doesn't support embedded videos, but don't worry, you can
<a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</main>
<script src="../player.js"></script>
</body>
</html>
</syntaxhighlight>

Dual Instances of SDK

2024-12-09T17:54:05Z

DanielKrotov: Added examples to reference for Browser SDK multi-instance implementations.

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Multiple SDK Instances ==

=== SDK Initialization ===

==== App SDK ====
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issue. The sharedInstance API that creates a singleton object was deprecated prior to version 5.1.1. (Version 4.0 for Android)

A maximum of four SDK instances per appid are supported.
When four SDK instances exist, you must destroy an old instance before creating a new one.

==== Browser SDK ====
The Browser SDK allows instantiating multiple instances of the object, which can be used simultaneously without any problems, however they must be instantiated with their own unique instance names. There is no maximum number of instances that is enforced in the browser.

=== App SDK Examples ===

==== Example using Swift ====
<br><br>In this example we create a swift file called NielsenInit where I store our SDK Initialization code. The example uses 2 APPIDS to keep everything organized.
<p>
<syntaxhighlight lang="swift">
self.nielsenStaticApi = NielsenInit.createStaticNielsenApi(delegate: self)
self.nielsenApi = NielsenInit.createNielsenApi(delegate: self)
</syntaxhighlight>
<br>Here are the methods in the NielsenInit class.

<syntaxhighlight lang="swift">
class NielsenInit : NSObject {

class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788BC65XXX",
"appname": "Standard SDK Swift Sample",
"appversion": "1.0",
"sfcode": "dcr",
"nol_devDebug": "INFO"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}

class func createStaticNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [

"appid": "PE4A57F64-878D-4D69-8EFB-4E87C27BXXXX",
"appname": "Standard SDK Swift Sample",
"appversion": "1.0",
"sfcode": "dcr",
"nol_devDebug": "INFO"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>
<br>We then load up the Static and Content metadata in our sample:

<syntaxhighlight lang="swift">
func loadStatic() -> [String : Any] {
//Loading Static data
let staticData =
[
"type": "static",
"section": "siteSection",
"segA": "segmentA",
"segB": "segmentB",
"segC": "segmentC"
]
return staticData
}

func loadContent() -> [String : Any] {
//Loading Content data
url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")
let content = [
"type":"content",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"section":"cloudApi_app",
"airdate":"20180221 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ] as [String : Any]

return content
}
</syntaxhighlight>

<br>In AppDelegate, we initialize the 1st instance of the SDK for Static Measurement when the App launches.
<br>
<syntaxhighlight lang="swift">
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
// Override point for customization after application launch.

//Getting the instance of NielsenApi
self.nielsenStaticApi = NielsenInit.createStaticNielsenApi(delegate: self)
sdkMethods = SDKMethods()
self.data = sdkMethods.loadStatic()
self.nielsenStaticApi.loadMetadata(self.data)
return true
}
</syntaxhighlight>
<br>Now for the Player Instance, we initialize in the ViewController, but only after the View has loaded:<br>
<syntaxhighlight lang="swift">
override func viewDidLoad() {
super.viewDidLoad()
self.view.backgroundColor = UIColor(patternImage: UIImage(named: "new_ios_bg.png")!)
//In NielsenInit class we are initialising the NielsenApi.

//Getting the instance of NielsenApi
self.nielsencontentApi = NielsenInit.createNielsenApi(delegate: self)
</syntaxhighlight>

Now you can just call them separately:

For example, App goes into the background:
<syntaxhighlight lang="swift">
func applicationDidEnterBackground(_ application: UIApplication) {

// Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later.

// If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
self.nielsenStaticApi.loadMetadata(self.data)
}
</syntaxhighlight>
<br>Or sending the playhead position to the second instance:<br>
<syntaxhighlight lang="swift">
nielsencontentApi.play(sdkMethods.loadChannelInfo())
self.nielsencontentApi?.playheadPosition(pos);
</syntaxhighlight>

==== Example using Android Studio ====
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/SimplePlayerStandardWithStaticAndroidSDK.zip Download Project Files]<br><br>The below is an example of Initializing two instances of the Nielsen SDK. One for Static Measurement, and the other for Video Measurement.
<br>

<syntaxhighlight lang=java>
public class NielsenInit {

private AppSdk mAppSdk = null;
private AppSdk mStaticAppSdk = null;

public AppSdk initAppSdk(Context mContext, IAppNotifier appNotifier){
try {
//Initialising the NielsenAppSDK class by passing app information which returns the instance of AppSdk.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC65XXX")
.put("appversion", "1.0")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO");

mAppSdk = new AppSdk(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}
return mAppSdk;
}

public AppSdk initStaticAppSdk(Context mContext, IAppNotifier appNotifier){
try {
//Initialising the NielsenAppSDK class by passing app information which returns the instance of AppSdk.

JSONObject appInformation = new JSONObject()

.put("appid", "PE4A57F64-878D-4D69-8EFB-4E87C27BAXXX")
.put("appversion", "1.0")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO");

mStaticAppSdk = new AppSdk(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}
return mStaticAppSdk;
}
}
</syntaxhighlight>
<br><br>
<syntaxhighlight lang=java>
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenSDK.
staticAppSdk = nielsenInit.initStaticAppSdk(MyApplication.getContext(), this);
data = sdkMethods.loadStaticData();

if(this.b == 0) {
AppLaunchMeasurementManager.appInBackground(app.getApplicationContext());
staticAppSdk.loadMetadata(data);
Log.d("SdkBgFgDetectionUtility", "App going to background");
}

</syntaxhighlight>
<br><br>
<syntaxhighlight lang=java>
//Getting the instance of NielsenSDK.
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenSDK.
appSdk = nielsenInit.initAppSdk(getApplicationContext(), this);

</syntaxhighlight>

=== Browser SDK Examples ===
The below examples will make use of the same AppId, however using different AppIds will work as well. The principles below follow the same initialization rules as a single instance and simply require a unique instance name and variable name with which the returned instance is assigned.

For more information around the possible parameters that can be passed as well as deeper descriptions for the API calls, please refer to our API documentation here: [[Browser SDK API Reference]]

==== Example of 2 instances on the same page ====
<syntaxhighlight lang="javascript">
//Add Static Queue Snippet
<script>
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

//Create SDK Instance(s)
// Notice the unique instance name given to each instance below and the unique variable name for each instance
var nSdkInstanceLive = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "instanceLive", {
nol_sdkDebug: 'debug',
optout: 'false'
});

var nSdkInstanceVod = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "instanceVod", {
nol_sdkDebug: 'debug',
optout: 'false'
});

</script>
</syntaxhighlight>

==== Example of 2 instances using a parent page and iFrame ====

===== Parent Page (index.html =====
<syntaxhighlight lang="html">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>DCR Static/DCR Video</title>
<script>
/* NLSQUEUE build v*/
!function(e,n){
function t(e){
return"object"==typeof e?JSON.parse(JSON.stringify(e)):e
}
e[n]=e[n]||
{
nlsQ:function(o,r,c){
var s=e.document,
a=s.createElement("script");
a.async=1,
a.src=("http:"===e.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+o+".js#name="+r+"&ns="+n;
var i=s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a,i),
e[n][r]=e[n][r]||{g:c||{},
ggPM:function(o,c,s,a,i){e[n][r].q=e[n][r].q||[];try{var l=t([o,c,s,a,i]);e[n][r].q.push(l)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}},
trackEvent:function(o){e[n][r].te=e[n][r].te||[];try{var c=t(o);e[n][r].te.push(c)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}}},
e[n][r]
}
}
}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "staticPage", {
nol_sdkDebug: 'debug',
});

// Static Metadata
var staticMetadata = {
assetid: 'staticTestPage',
type: 'static'
};

// Event 'staticstart' call
nSdkInstance.ggPM(14, staticMetadata);
</script>
</head>

<body>
<h1>DCR Static on Parent/DCR Video in iFrame</h1>
<p>Static measurement is current on parent page when window is in focus</p>
<iframe src="./dcr-video.html" frameborder="0" width="650" height="500" style="background-color: rgb(42, 217, 248);" id="video-iframe"></iframe>
</body>

</html>
</syntaxhighlight>

===== Nested iFrame Referenced on Parent Page (dcr-video.html) =====
<syntaxhighlight lang="html">
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
<title>iFrame Same Source</title>
<script>
/* NLSQUEUE build v*/
!function(e,n){
function t(e){
return"object"==typeof e?JSON.parse(JSON.stringify(e)):e
}
e[n]=e[n]||
{
nlsQ:function(o,r,c){
var s=e.document,
a=s.createElement("script");
a.async=1,
a.src=("http:"===e.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+o+".js#name="+r+"&ns="+n;
var i=s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a,i),
e[n][r]=e[n][r]||{g:c||{},
ggPM:function(o,c,s,a,i){e[n][r].q=e[n][r].q||[];try{var l=t([o,c,s,a,i]);e[n][r].q.push(l)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}},
trackEvent:function(o){e[n][r].te=e[n][r].te||[];try{var c=t(o);e[n][r].te.push(c)}catch(e){console&&console.log&&console.log("Error: Cannot register event in Nielsen SDK queue.")}}},
e[n][r]
}
}
}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "videoPlayer", {
nol_sdkDebug: 'debug',
});

var contentMetadata = {
type: "content",
length: "300",
title: "Skydiving Across Europe",
program: "latacg",
censuscategory: "Enlisted",
assetid: "204558915992",
section: "ProgramAsset8",
tv: "true",
adModel: "0",
dataSrc: "cms",
segA: "S07E04:NBC",
segB: "teams",
segC:"AtlanataFalcons",
}
</script>
</head>
<body>
<p>I'm iframe SDK DCR Video measurement, DCR static measurement should continue when clicking "play" on video</p>
<main>
<video
controls
src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217"
width="620">
Sorry, your browser doesn't support embedded videos, but don't worry, you can
<a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</main>
<script src="../player.js"></script>
</body>
</html>
</syntaxhighlight>

DCR Video Domless SDK

2024-10-29T13:29:39Z

DanielKrotov: /* Nielsen Debug Node.js Server for Event Tracking */ Updated with TAM entry

==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 [[Special:ClickThrough|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 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 apps for dom-less platforms like ReactNative, NodeJS etc. 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)
{| class="wikitable"
!
!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.

Refer to the "[[Domless SDK API Reference#DOM-less SDK Initialization| DOM-less SDK initialization]] " section in the [[Domless SDK API Reference| DOM-less SDK API Reference Guide]].
====SDK Initialization====
The following table contains the list of arguments that can be passed
{| class="wikitable"
!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'
|}
====Nielsen Debug Node.js Server for Event Tracking====
We are excited to announce the beta version of our Debug Node.js server, designed to track requests and events sent from our Dom-less SDK using WebSocket connections. While this feature is not officially released, we are currently looking for users interested in beta testing.

If you'd like to try this tool and provide feedback, please reach out to your Nielsen Technical Account Manager (TAM) for more information. Your insights would be invaluable in helping us refine this feature for a future release!

===DOM-less SDK DCR Video Step 3 - Create DCR Video Content Metadata Object===
====Events that can be passed to `ggPM` method====
1. <code>loadMetadata</code> - This event is used to send DCR Video metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.<syntaxhighlight lang="javascript">
instance.ggPM('loadMetadata', {

'type': 'content',
'assetid': 'VID-123456',
'program': 'program name',
'title': 'episode title with season and episode number',
'length': 'length in seconds',
'airdate': '20210321 09:00:00',
'isfullepisode': 'y',
'adloadtype': '2',
'segB': 'custom segment B', // optional
'segC': 'custom segment C', // optional
'crossId1': 'Standard Episode ID', // optional
'crossId2': 'Content Originator' //optional

});
</syntaxhighlight>2. <code>setPlayheadPosition</code> - This event is used to send the current playhead position to the Nielsen SDK. This event should be called when the video is playing.<syntaxhighlight lang="javascript">

instance.ggPM('setPlayheadPosition', 10);

</syntaxhighlight>3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.<syntaxhighlight lang="javascript">

instance.ggPM('end', 300);

</syntaxhighlight>4. <code>stop</code> - This event is used to send the stop event to the Nielsen SDK. This event should be called when transitioning from ads to content and content to ads, passing the playhead at that time.<syntaxhighlight lang="javascript">

instance.ggPM('stop', 120);
</syntaxhighlight>5. <code>updateMetadata</code> - This event allows updating metadata for the content or ad that is being played. This event cannot be used to update values for type, vidtype, or assetid parameters.<syntaxhighlight lang="javascript">

instance.ggPM('updateMetadata', {
length: 90,
segC: "My segC"
});

</syntaxhighlight>
======Events that can be passed to and processed by <code>processEvent</code> method======
1. <code>`blur`</code> - This event should be passed to processEvent when the app goes to the background.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'blur', 'timestamp': Date.now()});

</syntaxhighlight>2. <code>`focus`</code> - This event should be passed to processEvent when the app goes to the foreground.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'focus', 'timestamp': Date.now()});

</syntaxhighlight>3. <code>`appclose`</code> - This event should be passed prior to closing the app.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'appclose', 'timestamp': Date.now()});

</syntaxhighlight>
===DOM-less SDK DCR Video Step 4 - Basic Set of Events - Sample Playback===
====Sample Nielsen BSDK-Domless NodeJS Example====
*[https://github.com/NielsenDigitalSDK/bsdk-domless-samples/tree/main/nodejs Nielsen bsdk-domless NodeJS Example]
====Sample DCR Video Integration====
<syntaxhighlight lang="javascript">

import { BsdkInstance } from 'bsdk-domless';

const nsdkConfig = {
app_id: 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
instance_name: 'videoInstance',
};

const implementationHooks = {
Log: {
info: function (log: string) {
console.info(log);
},
debug: function (log: string) {
console.debug(log);
},
warn: function (log: string) {
console.warn(log);
},
error: function (error: string) {
console.error(error);
}
},
Storage: {
setItem: async function (key: any, value: string) {
/**
* Sets a string value for given key. This operation can either modify an existing entry,
* if it did exist for given key, or add new one otherwise.
* In order to store object value, you need to serialize it, e.g. using JSON.stringify().
*/
},
getItem: async function (key: any) {
/**
* Gets a string value for given key. This function can either return a string value for
* existing key or return null otherwise.
* In order to store object value, you need to deserialize it, e.g. using JSON.parse().
*/
},
removeItem: async function (key: any) {
/**
* Removes item for a key, invokes (optional) callback once completed.
*/
}
},
Fetch: async function (url: string | URL | Request, options: any) {
/**
* We require that client pass in User-Agent header via options in Fetch request
*/
const clientOpts = {
headers: {
"User-Agent": "react-native-domless/1.6.7.42 Dalvik/2.1.0 (Linux; U; Android 5.1.1; Android SDK built for x86 Build/LMY48X)"
}
}
const data = Object.assign(options, clientOpts);
const response = await fetch(url, data);
if (response.ok) {
return response;
} else {
throw new Error('Request failed');
}
},
SetTimeout: function (callback: () => void, timeout: number | undefined) {
return setTimeout(callback, timeout); },
SetInterval: function (callback: () => void, interval: number | undefined) {
return setInterval(callback, interval);
},
ClearTimeout: function (timeout: string | number | NodeJS.Timeout | undefined) {
clearTimeout(timeout);
},
ClearInterval: function (interval: string | number | NodeJS.Timeout | undefined) {
clearInterval(interval);
}
};

const nSdkInstance = new BsdkInstance(
nsdkConfig.app_id,
nsdkConfig.instance_name,
{
appName: 'BSDK RN Sample App',
deviceId: 'testDeviceId',
nol_sdkDebug: 'debug', // remove debug flag when going to production
domlessEnv: // "1" for React Native | "2" for Amazon | "3" for NodeJS | "4" for Custom
// reference SDK interface documentation
// for additonal metadata properties
},
implementationHooks );

// Sample VideoPlayer component
const VideoPlayer = (props) => {
/**
* Implementation of video player component will vary across the board, for Nielsen DOM-less SDK integration
* clients need only setup event listeners with corresponding ggPM() calls.
*
* Please refer to chosen video player documentation on available events
*/

const video = useRef<Video>(null);
let previousPlayhead = 0; // keep track of previous playhead position
let metadataLoaded = false; // in case of replay scenario set flag for metadata load

// Sample video metadata
const videometadata = {
'type': 'content',
'assetid': 'VID-123456',
'program': 'program name',
'title': 'episode title with season and episode number',
'length': 'length in seconds',
'airdate': '20210321 09:00:00',
'isfullepisode': 'y',
'adloadtype': '2',
'segB': 'custom segment B', // optional
'segC': 'custom segment C', // optional
'crossId1': 'Standard Episode ID', // optional
'crossId2': 'Content Originator' //optional
}

const setUpEventListeners = (): void => {
video.addEventListener('ended', onEnded);
video.addEventListener('timeupdate', onTimeUpdate);
video.addEventListener('playing', onPlay);
};

const onEnded = () => {
// Nielsen SDK ggPM 'end' event
if (nSdkInstance) {
nSdkInstance.then((instance: any) => {
instance.ggPM('end', Math.round(video.currentTime));
metadataLoaded = false;
});
}
};

const onTimeUpdate = () => {
const currPlayhead = Math.round(video.current?.currentTime!);
if (currPlayhead > 0 && currPlayhead !== previousPlayhead) {
previousPlayhead = currPlayhead;
// Nielsen SDK ggPM 'setPlayheadPosition' event
if (nSdkInstance) {
nSdkInstance.then((instance: any) => {
instance.ggPM('setPlayheadPosition', currPlayhead);
});
}
}
};

// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata
const onPlay = () => {
// Nielsen SDK ggPM 'loadmetadata' event
if (nSdkInstance && !metadataLoaded) {
nSdkInstance.then((instance: any) => {
instance.ggPM('loadMetadata', videometadata);
metadataLoaded = true;
});
}
};

return (
<View>
<Video
source={{ uri: 'https://www.w3schools.com/html/mov_bbb.mp4' }}
/>
</View>
);
};

</syntaxhighlight>

DCR Video Domless SDK

2024-10-25T17:06:03Z

DanielKrotov: /* DOM-less SDK DCR Video Step 2 - SDK Initialization */ Added note for Debug Node server.

==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 [[Special:ClickThrough|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 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 apps for dom-less platforms like ReactNative, NodeJS etc. 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)
{| class="wikitable"
!
!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.

Refer to the "[[Domless SDK API Reference#DOM-less SDK Initialization| DOM-less SDK initialization]] " section in the [[Domless SDK API Reference| DOM-less SDK API Reference Guide]].
====SDK Initialization====
The following table contains the list of arguments that can be passed
{| class="wikitable"
!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'
|}
====Nielsen Debug Node.js Server for Event Tracking====
We are excited to announce the beta version of our Debug Node.js server, designed to track messages and events sent from our Dom-less SDK using WebSocket connections. While this feature is not officially released, we are currently looking for users interested in beta testing.

If you'd like to try this tool and provide feedback, please reach out to Nielsen representative for more information. Your insights would be invaluable in helping us refine this feature for a future release!
===DOM-less SDK DCR Video Step 3 - Create DCR Video Content Metadata Object===
====Events that can be passed to `ggPM` method====
1. <code>loadMetadata</code> - This event is used to send DCR Video metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.<syntaxhighlight lang="javascript">
instance.ggPM('loadMetadata', {

'type': 'content',
'assetid': 'VID-123456',
'program': 'program name',
'title': 'episode title with season and episode number',
'length': 'length in seconds',
'airdate': '20210321 09:00:00',
'isfullepisode': 'y',
'adloadtype': '2',
'segB': 'custom segment B', // optional
'segC': 'custom segment C', // optional
'crossId1': 'Standard Episode ID', // optional
'crossId2': 'Content Originator' //optional

});
</syntaxhighlight>2. <code>setPlayheadPosition</code> - This event is used to send the current playhead position to the Nielsen SDK. This event should be called when the video is playing.<syntaxhighlight lang="javascript">

instance.ggPM('setPlayheadPosition', 10);

</syntaxhighlight>3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.<syntaxhighlight lang="javascript">

instance.ggPM('end', 300);

</syntaxhighlight>4. <code>stop</code> - This event is used to send the stop event to the Nielsen SDK. This event should be called when transitioning from ads to content and content to ads, passing the playhead at that time.<syntaxhighlight lang="javascript">

instance.ggPM('stop', 120);
</syntaxhighlight>5. <code>updateMetadata</code> - This event allows updating metadata for the content or ad that is being played. This event cannot be used to update values for type, vidtype, or assetid parameters.<syntaxhighlight lang="javascript">

instance.ggPM('updateMetadata', {
length: 90,
segC: "My segC"
});

</syntaxhighlight>
======Events that can be passed to and processed by <code>processEvent</code> method======
1. <code>`blur`</code> - This event should be passed to processEvent when the app goes to the background.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'blur', 'timestamp': Date.now()});

</syntaxhighlight>2. <code>`focus`</code> - This event should be passed to processEvent when the app goes to the foreground.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'focus', 'timestamp': Date.now()});

</syntaxhighlight>3. <code>`appclose`</code> - This event should be passed prior to closing the app.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'appclose', 'timestamp': Date.now()});

</syntaxhighlight>
===DOM-less SDK DCR Video Step 4 - Basic Set of Events - Sample Playback===
====Sample Nielsen BSDK-Domless NodeJS Example====
*[https://github.com/NielsenDigitalSDK/bsdk-domless-samples/tree/main/nodejs Nielsen bsdk-domless NodeJS Example]
====Sample DCR Video Integration====
<syntaxhighlight lang="javascript">

import { BsdkInstance } from 'bsdk-domless';

const nsdkConfig = {
app_id: 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
instance_name: 'videoInstance',
};

const implementationHooks = {
Log: {
info: function (log: string) {
console.info(log);
},
debug: function (log: string) {
console.debug(log);
},
warn: function (log: string) {
console.warn(log);
},
error: function (error: string) {
console.error(error);
}
},
Storage: {
setItem: async function (key: any, value: string) {
/**
* Sets a string value for given key. This operation can either modify an existing entry,
* if it did exist for given key, or add new one otherwise.
* In order to store object value, you need to serialize it, e.g. using JSON.stringify().
*/
},
getItem: async function (key: any) {
/**
* Gets a string value for given key. This function can either return a string value for
* existing key or return null otherwise.
* In order to store object value, you need to deserialize it, e.g. using JSON.parse().
*/
},
removeItem: async function (key: any) {
/**
* Removes item for a key, invokes (optional) callback once completed.
*/
}
},
Fetch: async function (url: string | URL | Request, options: any) {
/**
* We require that client pass in User-Agent header via options in Fetch request
*/
const clientOpts = {
headers: {
"User-Agent": "react-native-domless/1.6.7.42 Dalvik/2.1.0 (Linux; U; Android 5.1.1; Android SDK built for x86 Build/LMY48X)"
}
}
const data = Object.assign(options, clientOpts);
const response = await fetch(url, data);
if (response.ok) {
return response;
} else {
throw new Error('Request failed');
}
},
SetTimeout: function (callback: () => void, timeout: number | undefined) {
return setTimeout(callback, timeout); },
SetInterval: function (callback: () => void, interval: number | undefined) {
return setInterval(callback, interval);
},
ClearTimeout: function (timeout: string | number | NodeJS.Timeout | undefined) {
clearTimeout(timeout);
},
ClearInterval: function (interval: string | number | NodeJS.Timeout | undefined) {
clearInterval(interval);
}
};

const nSdkInstance = new BsdkInstance(
nsdkConfig.app_id,
nsdkConfig.instance_name,
{
appName: 'BSDK RN Sample App',
deviceId: 'testDeviceId',
nol_sdkDebug: 'debug', // remove debug flag when going to production
domlessEnv: // "1" for React Native | "2" for Amazon | "3" for NodeJS | "4" for Custom
// reference SDK interface documentation
// for additonal metadata properties
},
implementationHooks );

// Sample VideoPlayer component
const VideoPlayer = (props) => {
/**
* Implementation of video player component will vary across the board, for Nielsen DOM-less SDK integration
* clients need only setup event listeners with corresponding ggPM() calls.
*
* Please refer to chosen video player documentation on available events
*/

const video = useRef<Video>(null);
let previousPlayhead = 0; // keep track of previous playhead position
let metadataLoaded = false; // in case of replay scenario set flag for metadata load

// Sample video metadata
const videometadata = {
'type': 'content',
'assetid': 'VID-123456',
'program': 'program name',
'title': 'episode title with season and episode number',
'length': 'length in seconds',
'airdate': '20210321 09:00:00',
'isfullepisode': 'y',
'adloadtype': '2',
'segB': 'custom segment B', // optional
'segC': 'custom segment C', // optional
'crossId1': 'Standard Episode ID', // optional
'crossId2': 'Content Originator' //optional
}

const setUpEventListeners = (): void => {
video.addEventListener('ended', onEnded);
video.addEventListener('timeupdate', onTimeUpdate);
video.addEventListener('playing', onPlay);
};

const onEnded = () => {
// Nielsen SDK ggPM 'end' event
if (nSdkInstance) {
nSdkInstance.then((instance: any) => {
instance.ggPM('end', Math.round(video.currentTime));
metadataLoaded = false;
});
}
};

const onTimeUpdate = () => {
const currPlayhead = Math.round(video.current?.currentTime!);
if (currPlayhead > 0 && currPlayhead !== previousPlayhead) {
previousPlayhead = currPlayhead;
// Nielsen SDK ggPM 'setPlayheadPosition' event
if (nSdkInstance) {
nSdkInstance.then((instance: any) => {
instance.ggPM('setPlayheadPosition', currPlayhead);
});
}
}
};

// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata
const onPlay = () => {
// Nielsen SDK ggPM 'loadmetadata' event
if (nSdkInstance && !metadataLoaded) {
nSdkInstance.then((instance: any) => {
instance.ggPM('loadMetadata', videometadata);
metadataLoaded = true;
});
}
};

return (
<View>
<Video
source={{ uri: 'https://www.w3schools.com/html/mov_bbb.mp4' }}
/>
</View>
);
};

</syntaxhighlight>

DCR Video Domless SDK

2024-10-23T20:35:29Z

DanielKrotov: /* SDK Initialization */ Added Debug Node Server params

==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 [[Special:ClickThrough|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 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 apps for dom-less platforms like ReactNative, NodeJS etc. 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)
{| class="wikitable"
!
!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.

Refer to the "[[Domless SDK API Reference#DOM-less SDK Initialization| DOM-less SDK initialization]] " section in the [[Domless SDK API Reference| DOM-less SDK API Reference Guide]].
====SDK Initialization====
The following table contains the list of arguments that can be passed
{| class="wikitable"
!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' : '<nowiki>http://0.0.0.0:3000'</nowiki>
|-
|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|Nielsen Debug Node Server Repository]]
===DOM-less SDK DCR Video Step 3 - Create DCR Video Content Metadata Object===
====Events that can be passed to `ggPM` method====
1. <code>loadMetadata</code> - This event is used to send DCR Video metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.<syntaxhighlight lang="javascript">
instance.ggPM('loadMetadata', {

'type': 'content',
'assetid': 'VID-123456',
'program': 'program name',
'title': 'episode title with season and episode number',
'length': 'length in seconds',
'airdate': '20210321 09:00:00',
'isfullepisode': 'y',
'adloadtype': '2',
'segB': 'custom segment B', // optional
'segC': 'custom segment C', // optional
'crossId1': 'Standard Episode ID', // optional
'crossId2': 'Content Originator' //optional

});
</syntaxhighlight>2. <code>setPlayheadPosition</code> - This event is used to send the current playhead position to the Nielsen SDK. This event should be called when the video is playing.<syntaxhighlight lang="javascript">

instance.ggPM('setPlayheadPosition', 10);

</syntaxhighlight>3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.<syntaxhighlight lang="javascript">

instance.ggPM('end', 300);

</syntaxhighlight>4. <code>stop</code> - This event is used to send the stop event to the Nielsen SDK. This event should be called when transitioning from ads to content and content to ads, passing the playhead at that time.<syntaxhighlight lang="javascript">

instance.ggPM('stop', 120);
</syntaxhighlight>5. <code>updateMetadata</code> - This event allows updating metadata for the content or ad that is being played. This event cannot be used to update values for type, vidtype, or assetid parameters.<syntaxhighlight lang="javascript">

instance.ggPM('updateMetadata', {
length: 90,
segC: "My segC"
});

</syntaxhighlight>
======Events that can be passed to and processed by <code>processEvent</code> method======
1. <code>`blur`</code> - This event should be passed to processEvent when the app goes to the background.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'blur', 'timestamp': Date.now()});

</syntaxhighlight>2. <code>`focus`</code> - This event should be passed to processEvent when the app goes to the foreground.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'focus', 'timestamp': Date.now()});

</syntaxhighlight>3. <code>`appclose`</code> - This event should be passed prior to closing the app.<syntaxhighlight lang="javascript">

instance.processEvent({'type': 'appclose', 'timestamp': Date.now()});

</syntaxhighlight>
===DOM-less SDK DCR Video Step 4 - Basic Set of Events - Sample Playback===
====Sample Nielsen BSDK-Domless NodeJS Example====
*[https://github.com/NielsenDigitalSDK/bsdk-domless-samples/tree/main/nodejs Nielsen bsdk-domless NodeJS Example]
====Sample DCR Video Integration====
<syntaxhighlight lang="javascript">

import { BsdkInstance } from 'bsdk-domless';

const nsdkConfig = {
app_id: 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
instance_name: 'videoInstance',
};

const implementationHooks = {
Log: {
info: function (log: string) {
console.info(log);
},
debug: function (log: string) {
console.debug(log);
},
warn: function (log: string) {
console.warn(log);
},
error: function (error: string) {
console.error(error);
}
},
Storage: {
setItem: async function (key: any, value: string) {
/**
* Sets a string value for given key. This operation can either modify an existing entry,
* if it did exist for given key, or add new one otherwise.
* In order to store object value, you need to serialize it, e.g. using JSON.stringify().
*/
},
getItem: async function (key: any) {
/**
* Gets a string value for given key. This function can either return a string value for
* existing key or return null otherwise.
* In order to store object value, you need to deserialize it, e.g. using JSON.parse().
*/
},
removeItem: async function (key: any) {
/**
* Removes item for a key, invokes (optional) callback once completed.
*/
}
},
Fetch: async function (url: string | URL | Request, options: any) {
/**
* We require that client pass in User-Agent header via options in Fetch request
*/
const clientOpts = {
headers: {
"User-Agent": "react-native-domless/1.6.7.42 Dalvik/2.1.0 (Linux; U; Android 5.1.1; Android SDK built for x86 Build/LMY48X)"
}
}
const data = Object.assign(options, clientOpts);
const response = await fetch(url, data);
if (response.ok) {
return response;
} else {
throw new Error('Request failed');
}
},
SetTimeout: function (callback: () => void, timeout: number | undefined) {
return setTimeout(callback, timeout); },
SetInterval: function (callback: () => void, interval: number | undefined) {
return setInterval(callback, interval);
},
ClearTimeout: function (timeout: string | number | NodeJS.Timeout | undefined) {
clearTimeout(timeout);
},
ClearInterval: function (interval: string | number | NodeJS.Timeout | undefined) {
clearInterval(interval);
}
};

const nSdkInstance = new BsdkInstance(
nsdkConfig.app_id,
nsdkConfig.instance_name,
{
appName: 'BSDK RN Sample App',
deviceId: 'testDeviceId',
nol_sdkDebug: 'debug', // remove debug flag when going to production
domlessEnv: // "1" for React Native | "2" for Amazon | "3" for NodeJS | "4" for Custom
// reference SDK interface documentation
// for additonal metadata properties
},
implementationHooks );

// Sample VideoPlayer component
const VideoPlayer = (props) => {
/**
* Implementation of video player component will vary across the board, for Nielsen DOM-less SDK integration
* clients need only setup event listeners with corresponding ggPM() calls.
*
* Please refer to chosen video player documentation on available events
*/

const video = useRef<Video>(null);
let previousPlayhead = 0; // keep track of previous playhead position
let metadataLoaded = false; // in case of replay scenario set flag for metadata load

// Sample video metadata
const videometadata = {
'type': 'content',
'assetid': 'VID-123456',
'program': 'program name',
'title': 'episode title with season and episode number',
'length': 'length in seconds',
'airdate': '20210321 09:00:00',
'isfullepisode': 'y',
'adloadtype': '2',
'segB': 'custom segment B', // optional
'segC': 'custom segment C', // optional
'crossId1': 'Standard Episode ID', // optional
'crossId2': 'Content Originator' //optional
}

const setUpEventListeners = (): void => {
video.addEventListener('ended', onEnded);
video.addEventListener('timeupdate', onTimeUpdate);
video.addEventListener('playing', onPlay);
};

const onEnded = () => {
// Nielsen SDK ggPM 'end' event
if (nSdkInstance) {
nSdkInstance.then((instance: any) => {
instance.ggPM('end', Math.round(video.currentTime));
metadataLoaded = false;
});
}
};

const onTimeUpdate = () => {
const currPlayhead = Math.round(video.current?.currentTime!);
if (currPlayhead > 0 && currPlayhead !== previousPlayhead) {
previousPlayhead = currPlayhead;
// Nielsen SDK ggPM 'setPlayheadPosition' event
if (nSdkInstance) {
nSdkInstance.then((instance: any) => {
instance.ggPM('setPlayheadPosition', currPlayhead);
});
}
}
};

// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata
const onPlay = () => {
// Nielsen SDK ggPM 'loadmetadata' event
if (nSdkInstance && !metadataLoaded) {
nSdkInstance.then((instance: any) => {
instance.ggPM('loadMetadata', videometadata);
metadataLoaded = true;
});
}
};

return (
<View>
<Video
source={{ uri: 'https://www.w3schools.com/html/mov_bbb.mp4' }}
/>
</View>
);
};

</syntaxhighlight>