Engineering Client Portal - User contributions [en]

DCR Poland Video Browser SDK

2019-06-26T07:46:03Z

MagdalenaKostulska: /* Example Ad Object */

DCR Poland Video Browser SDK

2019-06-24T11:19:20Z

MagdalenaKostulska: updated priv policy link (pl)

Template:Android Privacy and Opt-Out

2019-06-24T11:18:16Z

MagdalenaKostulska: undo

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:
# '''[[#OS-level_Opt-out|OS-level Opt-out]]''' - managed by ''Opt out of Ads Personalization'' setting on device ('''preferred approach''').
# '''[[#Legacy_Opt-out|Legacy Opt-out]]''' - Direct call to SDK; used only for older versions of Nielsen Android SDK versions (< 5.1.1.18)

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen Android '''SDK Versions 5.1.1.18 and above'''.

The Nielsen SDK automatically leverages the Android's ''Opt out of Ads Personalization'' setting. The user is opted out of demographic measurement if the OS-level ''"Opt out of Ads Personalization"'' ("Limit Ad Tracking" for iOS) setting is ''enabled''. As a publisher, you cannot override this setting.

=== Legacy Opt-out ===
The ''Legacy opt-out'' method is only necessary for Nielsen Android '''SDK versions less than 5.1.1.18'''.

Nielsen Android SDK 5.1.1.18 and above will check for ''OS-level opt-out'' first, if available. The user will be opted out if indicated at the OS-level '''OR''' the App-level.

==== The legacy opt-out method works as follows: ====
* Get the current Nielsen opt-out URL via [[userOptOutURLString()]]
* Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()]]
* Detect if the WebView URL changes to a special URL that indicates Opt-in, or Opt-out and close the WebView
** Opt-out if the WebView URL = <code>nielsenappsdk://1</code>
** Opt-in if the WebView URL = <code>nielsenappsdk://0</code>
* Pass the detected URL to the [[userOptOut()]] function
** Example: <syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>

==== Legacy Opt Out example code ====
<syntaxhighlight lang="java">
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {

WebView webView;
AppSdk appSdk;

private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";
private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";

// Within your app you would provide your User the option to Opt Out.
// Perhaps via a toggle or button
// This is separate from Limit Ad Tracking

let urlStr = navigationAction.request.url?.absoluteString

if(urlStr == NIELSEN_URL_OPT_OUT || urlStr == NIELSEN_URL_OPT_IN){
let appApi = self.nielsenApi
appApi?.userOptOut(urlStr)
}
</syntaxhighlight>

=== Retrieve current Opt-Out preference ===
Whether the user is opted out viaOS-level Opt-out or via App-level Opt-out, the current Opt-Out status as detected by the SDK is available via the [[getOptOutStatus()]] property in the Nielsen Android SDK API,

=== Required Privacy Links ===
Users must either have access to the "About Nielsen Measurement" page, or have similar text available within the native app. Include "About Nielsen Measurement" and "Your Choices" link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

In addition, the following text must be included in your app store description.
<blockquote>
'''"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see http://priv-policy.imrworldwide.com/priv/mobile/us/en/optout.html for more information"'''</blockquote>
==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<syntaxhighlight lang="java">
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {

WebView webView;
AppSdk appSdk;

@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_optout);
webView = (WebView) findViewById(R.id.webView);

webView.getSettings().setJavaScriptEnabled(true);

webView.setWebViewClient(new WebViewClient() {
@SuppressWarnings("deprecation")
@Override
public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) {
Toast.makeText(OptOutActivity.this, description, Toast.LENGTH_SHORT).show();
}
@TargetApi(android.os.Build.VERSION_CODES.M)
@Override
public void onReceivedError(WebView view, WebResourceRequest req, WebResourceError rerr) {
// Redirect to deprecated method, so you can use it in all SDK versions
onReceivedError(view, rerr.getErrorCode(), rerr.getDescription().toString(), req.getUrl().toString());
}
});

NielsenInit nielsenInit = new NielsenInit();
appSdk = nielsenInit.initAppSdk(getApplicationContext(), this);
//Getting the optPut URL from eventTracker
String url = appSdk.userOptOutURLString();
webView.loadUrl(url);
}
</syntaxhighlight>

Template:Android Privacy and Opt-Out

2019-06-24T11:16:58Z

MagdalenaKostulska: priv policy link updated

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:
# '''[[#OS-level_Opt-out|OS-level Opt-out]]''' - managed by ''Opt out of Ads Personalization'' setting on device ('''preferred approach''').
# '''[[#Legacy_Opt-out|Legacy Opt-out]]''' - Direct call to SDK; used only for older versions of Nielsen Android SDK versions (< 5.1.1.18)

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen Android '''SDK Versions 5.1.1.18 and above'''.

The Nielsen SDK automatically leverages the Android's ''Opt out of Ads Personalization'' setting. The user is opted out of demographic measurement if the OS-level ''"Opt out of Ads Personalization"'' ("Limit Ad Tracking" for iOS) setting is ''enabled''. As a publisher, you cannot override this setting.

=== Legacy Opt-out ===
The ''Legacy opt-out'' method is only necessary for Nielsen Android '''SDK versions less than 5.1.1.18'''.

Nielsen Android SDK 5.1.1.18 and above will check for ''OS-level opt-out'' first, if available. The user will be opted out if indicated at the OS-level '''OR''' the App-level.

==== The legacy opt-out method works as follows: ====
* Get the current Nielsen opt-out URL via [[userOptOutURLString()]]
* Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()]]
* Detect if the WebView URL changes to a special URL that indicates Opt-in, or Opt-out and close the WebView
** Opt-out if the WebView URL = <code>nielsenappsdk://1</code>
** Opt-in if the WebView URL = <code>nielsenappsdk://0</code>
* Pass the detected URL to the [[userOptOut()]] function
** Example: <syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>

==== Legacy Opt Out example code ====
<syntaxhighlight lang="java">
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {

WebView webView;
AppSdk appSdk;

private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";
private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";

// Within your app you would provide your User the option to Opt Out.
// Perhaps via a toggle or button
// This is separate from Limit Ad Tracking

let urlStr = navigationAction.request.url?.absoluteString

if(urlStr == NIELSEN_URL_OPT_OUT || urlStr == NIELSEN_URL_OPT_IN){
let appApi = self.nielsenApi
appApi?.userOptOut(urlStr)
}
</syntaxhighlight>

=== Retrieve current Opt-Out preference ===
Whether the user is opted out viaOS-level Opt-out or via App-level Opt-out, the current Opt-Out status as detected by the SDK is available via the [[getOptOutStatus()]] property in the Nielsen Android SDK API,

=== Required Privacy Links ===
Users must either have access to the "About Nielsen Measurement" page, or have similar text available within the native app. Include "About Nielsen Measurement" and "Your Choices" link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

In addition, the following text must be included in your app store description.
<blockquote>
'''"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see http://priv-policy.imrworldwide.com/priv/mobile/pl/pl/optout.html for more information"'''</blockquote>
==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<syntaxhighlight lang="java">
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {

WebView webView;
AppSdk appSdk;

@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_optout);
webView = (WebView) findViewById(R.id.webView);

webView.getSettings().setJavaScriptEnabled(true);

webView.setWebViewClient(new WebViewClient() {
@SuppressWarnings("deprecation")
@Override
public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) {
Toast.makeText(OptOutActivity.this, description, Toast.LENGTH_SHORT).show();
}
@TargetApi(android.os.Build.VERSION_CODES.M)
@Override
public void onReceivedError(WebView view, WebResourceRequest req, WebResourceError rerr) {
// Redirect to deprecated method, so you can use it in all SDK versions
onReceivedError(view, rerr.getErrorCode(), rerr.getDescription().toString(), req.getUrl().toString());
}
});

NielsenInit nielsenInit = new NielsenInit();
appSdk = nielsenInit.initAppSdk(getApplicationContext(), this);
//Getting the optPut URL from eventTracker
String url = appSdk.userOptOutURLString();
webView.loadUrl(url);
}
</syntaxhighlight>

DCR Italy Static Facebook Instant Articles Browser SDK

2017-12-18T10:27:04Z

MagdalenaKostulska: /* Metadata for Reporting */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

This guide will show you how to enable Digital Content Ratings (DCR) measurement on your Facebook Instant Articles.

== Implementation Steps ==
=== Add Tracking Code ===
DCR measurement can be added to your Instant Articles through the Analytics element:
<syntaxhighlight lang="html"><figure class="op-tracker">
<iframe>

</iframe>
</figure></syntaxhighlight>

For more information on the Analytics element, you can refer to the [https://developers.facebook.com/docs/instant-articles/analytics/overview | Insights and Analytics in Instant Articles] section of Facebook’s Instant Article Developer Documentation.

The Nielsen DCR Tracking code below will need to be added within the <code><iframe></code> of the Analytics element on each article:
<syntaxhighlight lang="html">
<script>
// Static Queue Snippet
!function(t,n){t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i){return s=t.document,r=s.createElement("script"),r.async=1,r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),t[n][o]=t[n][o]||{g:c||{},ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]}}}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nsdkvOverride: "501", nol_sdkDebug: "debug"});

// Content Metadata
var nielsenMetadata = {
type: 'static',
assetid: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: '', // *DYNAMIC METADATA*: section of site **REQUIRED**
segC: 'Instant Articles'
};

// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</script></syntaxhighlight>

=== Configure Metadata ===
Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values, <code><metadataPlaceholder></code>, for dynamic metadata. You will need to update these values.

====Metadata Keys====
The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Example Value !! Required
|-
| apid || unique ID assigned by Nielsen || <code>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</code> || ✓
|-
| section || section of the site to be measured || <code>Entertainment</code> || ✓
|-
| segC || Reserved custom segment for Instant Articles || <code>'Instant Articles'</code> || ✓
|}

====Metadata for Reporting====
You can reference the table to determine how the metadata you pass is used to define your reporting structure:
{| class="wikitable"
|-
! Reporting Level !! Key !! Description
|-
| Brand || apid || brand is determined by assigned App ID passed during initialization
|-
| Sub-brand || apid || sub-brand is determined is determined by assigned App ID passed during initialization
|-
| Section || section || section or category of the page
|-
| Custom Segment C || segC || Custom segment C is reserved for reporting ‘Instant Articles’. The Instant Articles custom segment will be available under sub-brand and will include the total metrics for all your Instant Articles
|}

=== Going Live ===
Once you have added the DCR Tracking Code to your Instant Articles, Nielsen will validate your implementation after which you must disable Debug logging by deleting {nol_sdkDebug: 'DEBUG'} from the initialization call.

Example:
<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nsdkvOverride: "501"});
</syntaxhighlight>

DCR Italy Static Browser SDK

2017-11-08T17:36:16Z

MagdalenaKostulska: /* onPaginate */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>

== Implementation Steps ==
=== Add Tracking Code ===
The Nielsen DCR Tracking Code must be added to each page.
<syntaxhighlight lang="javascript"><script>
// Static Queue Snippet
!function(t,n){t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i){return s=t.document,r=s.createElement("script"),r.async=1,r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),t[n][o]=t[n][o]||{g:c||{},ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]}}}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});

// Content Metadata
var nielsenMetadata = {
type: 'static',
assetid: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: '' // *DYNAMIC METADATA*: section of site **REQUIRED**
};

// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</script></syntaxhighlight>

==== Tracking Code Components ====
The tracking code includes
* Static Queue Snippet
* SDK Initialization
* Content Metadata
* staticstart Event

'''Static Queue Snippet'''

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.
<syntaxhighlight lang="javascript">
!function(t,n){t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},t[o]}
}
}
(window,"NOLBUNDLE");</syntaxhighlight>

'''SDK Initialization'''

While creating an SDK instance, initialize the SDK by calling:

'''Initialization API Call'''

<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "",{nol_sdkDebug: "debug"})</syntaxhighlight>

When the initialization call is made, a unique static config file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and cached by the client-side browser(s).

Once the static config file is downloaded, the SDK will be fully downloaded and initialized. All SDK modules are included in one file:
"nlsSDK600.bundle.min.js".

'''Content Metadata'''

Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values.

Pass dynamic metadata for the keys with the <code><metadataPlaceholder></code> value (e.g. <code>section: ''</code>).

'''staticstart Event'''

There is only one event call required:
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>

The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[Bundled_SDK_-_Static#Configure_Metadata|Step 3]].

=== Pass App ID in Initialization Call ===
Pass the unique App ID in the first parameter of the initialization call, <code><apid></code>.

'''Example SDK Initialization'''

<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});</syntaxhighlight>

The initialization call has three parameters:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site. || <code>PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX</code>
|-
| instanceName || Name of SDK instance || Any string value
|-
| nol_sdkDebug: "debug" || Enables Nielsen console logging. Only required for testing || <code>{nol_sdkDebug: "debug"}</code>
|}

Update <code><apid></code> with the AppID provided. Refer to the [[#Going_Live|Going Live]] section to know about updating the AppID to production after testing is completed.

=== Configure Metadata ===
Map the Nielsen keys to variables so that the content metadata is dynamically updated.

The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Data Type !! Value !! Required?
|-
| type || asset type || fixed || <code>'static'</code> || Yes
|-
| assetid || Unique ID for each article || dynamic || custom || Yes
|-
| section || section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values || dynamic || custom || Yes
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement, the properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Infinite Scrolling ==

<code>onPaginate</code> will refire the view ping with the existing/original metadata.

<source lang="javascript">nSdkInstance.ggPM("onPaginate", scrolloffset);</source>
 
{|
!width="23%"| Parameter
!width="19%"| Description
|-
| event
| <code>onPaginate</code>
|-
| scrolloffset
| The <code>scrolloffset</code> value should be the y-scroll position:
|}

=== onPaginate ===

<code>onPaginate</code> is a slightly modified version of <code>staticstart</code> to enable tracking of user’s focus in pages with continuous scrolling. <code>onPaginate</code> event provides the same behavior as <code>staticstart</code> keeping it local to only clients who wish to implement continuous scrolling. (Note: This event <code>onPaginate</code> will not reset the page duration timer.)

* The maximum number of static View pings allowed per session is ‘1’. This is enforced via the <code>nol_maxPingCount</code> parameter in the tag and the cadence of impression.
* When an <code>onPaginate</code> event is called at the end of section / a focus shift (within the same page), this filter will reset the current ping count to ‘0’ for the static View ping. This change of value will cause a new View ping when the Browser SDK receives the next <code>staticPosition</code> event (at the section end). This sequence continues through the end of scrolling or till the close of static page session.

[[File:StaticPageEvent35.jpg|center|link=]]

== Going Live ==
Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

International

2017-11-08T15:40:20Z

MagdalenaKostulska: come back to previous version

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|International.png|International}}

__NOTOC__

<blockquote>This section is under maintenance. Please contact your Nielsen representative for documentation if the guides for your country aren't listed.</blockquote>

{| class="wikitable"
|-
! style="width: 90px;" | Italy
! style="width: 90px;" |
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Guide
|-
| rowspan="5" | {{SmallIcon|ITFlagIcon.png}}
| rowspan="5" | {{SmallIcon|SDKIcon.png}}
| rowspan="2" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
 
{{OSIcon|AndroidIcon.png}}
| '''[[DCR Italy Video App SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Italy Video Browser SDK (6.0.1)]]'''
|-
| rowspan="3" | {{OSIcon|StaticIcon.png}}
| {{OSIcon|macOSIcon.png}}
 
{{OSIcon|AndroidIcon.png}}
| '''[[DCR Italy Static App SDK]]'''
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png}}
| '''[[DCR Italy Static Browser SDK (6.0.0)]]'''
|-
| '''[[DCR Italy Static Browser SDK (6.0.1)]]'''
|}

International

2017-11-08T15:38:30Z

MagdalenaKostulska:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|International.png|International}}

__NOTOC__

<blockquote>This section is under maintenance. Please contact your Nielsen representative for documentation if the guides for your country aren't listed.</blockquote>

{| class="wikitable"
|-
! style="width: 90px;" | Italy
! style="width: 90px;" |
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Guide
|-
| rowspan="5" | {{SmallIcon|ITFlagIcon.png}}
| rowspan="5" | {{SmallIcon|SDKIcon.png}}
| rowspan="2" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
 
{{OSIcon|AndroidIcon.png}}
| '''[[DCR Italy Video App SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Italy Video Browser SDK (6.0.1)]]'''
|-
| rowspan="3" | {{OSIcon|StaticIcon.png}}
| {{OSIcon|macOSIcon.png}}
 
{{OSIcon|AndroidIcon.png}}
| '''[[DCR Italy Static App SDK]]'''
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png}}
| '''[[DCR Italy Static Browser SDK]]'''
|-
| '''[[DCR Italy Static Browser SDK (6.0.1)]]'''
|}

DCR Italy Video App SDK

2017-11-08T15:31:49Z

MagdalenaKostulska: /* Handling JSON Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || "it"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"n",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "y")
.put("adloadtype", "2")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
 

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]], [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.

# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-08T15:30:12Z

MagdalenaKostulska: /* Handling JSON Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || "it"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "yes")
.put("adloadtype", "2")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
 

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]], [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.

# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-08T15:29:40Z

MagdalenaKostulska: /* Handling JSON Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || "it"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "yes")
.put( "adloadtype", "2")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
 

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]], [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.

# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-07T16:55:44Z

MagdalenaKostulska: /* SDK Initialization */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || "it"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "yes")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
 

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]] , [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.

# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-07T16:54:54Z

MagdalenaKostulska: /* Going Live */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || it
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "yes")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
 

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]] , [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.

# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-07T16:51:30Z

MagdalenaKostulska: /* Content metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || it
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "yes")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
 

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]] , [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.

# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">"PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</syntaxhighlight>
# '''Collection Environment''': Change the <code>sfcode</code> from <code>'eu-cert'</code> to <code>'it'</code> to point traffic to the Nielsen production collection environment. Please DO NOT use eu-cert for your production traffic!
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-07T16:50:21Z

MagdalenaKostulska: /* Handling JSON Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || it
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "yes")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
Custom segments (segB and segC) can be used to aggregate video and/or static content within a single Brand to receive more granular reports within a brand.

Examples regarding usage of segments within SDK:
* All comedy clips and stories for a Brand rolled into a “Comedy” segment
* genre grouping content by Comedy vs. Drama
* group related Text + Video content - i.e. for a show that has a lot of - static pages associated with it
* packaging based on how clients sell inventory
* grouping related types of content either by genre, category or platform.
 
=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]] , [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.

# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">"PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</syntaxhighlight>
# '''Collection Environment''': Change the <code>sfcode</code> from <code>'eu-cert'</code> to <code>'it'</code> to point traffic to the Nielsen production collection environment. Please DO NOT use eu-cert for your production traffic!
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

DCR Italy Video App SDK

2017-11-07T16:49:11Z

MagdalenaKostulska: /* SDK Initialization */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
*Application launch events and how long app was running
*Time of viewing a sub section / page in the application.

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

== Implementation ==
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== Setting up your Development Environment ==
{{ExampleCode|
xCode|
<big>
'''Configuring Xcode Development Environment'''
</big>

Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

<big>'''Importing Frameworks'''</big>
The first step is to ensure that the following frameworks and libraries are imported into the Frameworks folder of the Xcode project before creating an instance of the Nielsen App SDK object.
* UIKit.framework
* Foundation.framework
* AdSupport.framework
* SystemConfiguration.framework
* Security.framework
** Nielsen Analytics framework makes use of a number of functions in this library.
* AVFoundation.framework
** This framework is mandatory for the iOS SDK version 5.1.1 to work.
* CoreLocation.framework (Not applicable for International (Germany))
* CoreMedia.framework
* NielsenAppApi.framework
* libc++.tbd (as SDK contains Objective C++ source file)
** Alternatively, include -lstdc++ in Build Settings → Other Linker Flag of the Xcode project

<blockquote>'''Example'''
* Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.
* Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.</blockquote>

Ensure that the following are included in the Linked Frameworks and Libraries list (located in the project’s Summary settings).
* Nielsen App SDK
* iOS security framework
 
<big>'''Using Swift'''</big>
To import a set of Objective-C files in the same app target as your Swift code, you rely on an Objective-C bridging header to expose those files to Swift. Xcode offers to create this header file when you add a Swift file to an existing Objective-C app, or an Objective-C file to an existing Swift app.

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 
|Android =
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.

'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''

The Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
* '''For Video player applications'''
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
* App SDK checks to see if there is a Google service available and updated.
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.

<big>'''Library'''</big>

Nielsen App SDK uses the following packages/classes from the Google Play service.
* google-play-services_lib

'''<big>Classes/package</big>'''

* com.google.android.gms.ads.identifier.AdvertisingIdClient;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
* com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
}}

== SDK Initialization ==
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 a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || No|| Nielsen Sample App
|-
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Italian Clients'''
* "it"
|| Nielsen-specified || Yes || it
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">
class ViewController: UIViewController, NielsenAppApiDelegate, AVPictureInPictureControllerDelegate, CLLocationManagerDelegate {

let avPlayerViewController = AVPlayerViewController()
var avPlayer:AVPlayer?
var nielsenAppApi: NielsenAppApi!

override func viewDidLoad() {
super.viewDidLoad()

self.nielsenAppApi = NielsenInit.createNielsenAppApi(delegate: self)
NSLog("Nielsen SDK initialized")

}
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
</syntaxhighlight>

The following would be the <code>NlsAppApiFactory.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

+ (NielsenAppAPI *) createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
|Android =

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">

try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("appversion", "1.0")
.put("appname", "Sample App Name")
.put("sfcode", "it")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

The integration of Nielsen App SDK will depend on type of client app. 
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).
}}

== APP SDK Error & Event Codes ==
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
];

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"No",
"program":"Program Name",
"length":"3600",
"segB":"CustomSegmentValueB", //optional
"segC":"CustomSegmentValueC", //optional
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary *channelInfo = @
{
@"channelname":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
{@"type": @"content",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
@"segB": @"CustomSegmentValueB", //optional
@"segC": @"CustomSegmentValueC", //optional
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("segB", "CustomSegmentValueB") //optional
.put("segC", "CustomSegmentValueC") //optional
.put("isfullepisode", "yes")
.put("airdate", "20161013 20:00:00")
</syntaxhighlight>
}}

=== Configure metadata ===
Configure metadata should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>"content"</code> || Yes
|-
| assetid || unique ID assigned to asset || custom || Yes
|-
| program ||name of program (25 character limit) || custom || Yes
|-
| title ||name of program (40 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (86400 for live stream) || Yes
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || Yes
|}
Custom segments (segB and segC) can be used to aggregate video and/or static content within a single Brand to receive more granular reports within a brand.

Examples regarding usage of segments within SDK:
* All comedy clips and stories for a Brand rolled into a “Comedy” segment
* genre grouping content by Comedy vs. Drama
* group related Text + Video content - i.e. for a show that has a lot of - static pages associated with it
* packaging based on how clients sell inventory
* grouping related types of content either by genre, category or platform.
 
=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[DCR_Video_APP_SDK#play|play]] and [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[DCR_Video_APP_SDK#stop|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[DCR_Video_APP_SDK#end|end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.

'''Note''': In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call [[stop]] to stop the measurement.
* As soon as the playback resumes, call [[DCR_Video_APP_SDK#play|play]] , [[DCR_Video_APP_SDK#loadMetadata|loadMetadata]] and [[DCR_Video_APP_SDK#playheadPosition|playheadPosition]].</blockquote>

=== Sequence of Calls ===
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:(JSONObject channelInfo)];</syntaxhighlight>
|Android = <syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(JSONObject channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos
</syntaxhighlight>

==== Sending playheadposition for content ====
<syntaxhighlight lang="objective-c">
AVPlayer *player;
CMTime curTime=[player currentTime];
int pos = CMTimeGetSeconds(curTime);
[nAppApiObject playheadPosition:pos];
</syntaxhighlight>

|Swift = <syntaxhighlight lang="swift">
//Monitor the Playhead position of the AVPlayer
let timeInterval: CMTime = CMTimeMakeWithSeconds(1.0,10)
self.avPlayerViewController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in
if self.avPlayerViewController.player!.currentItem?.status == .readyToPlay {
let time : Float64 = self.avPlayerViewController.player!.currentTime().seconds;
let pos = Int64(time);
NSLog("New Elapse Time = \(time)");
self.nielsenAppApi?.playheadPosition(pos);
}
}
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>
}}

=== stop ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">public void stop()</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop</syntaxhighlight>
}}

== Privacy and Opt-Out ==
{{ExampleCode|

iOS|
== iOS Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL for the Nielsen Privacy web page should be retrieved from the optOutURL property of the SDK object <code>optOutURL</code> and opened in 'WebView' / External browser.
*If the App SDK returns NULL in the optOutURL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.



The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

*URL to this web page should be called from SDK and opened in 'WebView' / External browser.
*If the App SDK returns NULL as Opt-Out URL, handle this case and retry later.
*To retrieve the current Opt-Out status, use the [[optOutStatus]] property from Nielsen's SDK API.
<syntaxhighlight lang="objective-c">
@property (readonly) BOOL optOutStatus;
</syntaxhighlight>
*App should provide a UI control like 'close' or 'back' button to close the 'WebView' / External browser.

Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on iOS' system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any iOS device: '''Settings → Privacy → Advertising → Limit Ad Tracking'''.

User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.

[[File:Opt-Out iOS.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

|Android =
== Android Opt-Out Implementation ==
To opt out, users must have access to "[https://priv-policy.imrworldwide.com/priv/mobile/it/it/optout.html About Nielsen Measurement]" page. User can click this page from app settings screen.

Include '''About Nielsen Measurement and Your Choices''' link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
*URL to this web page should be called from SDK by invoking <code>userOptOutURLString()</code> and opened in 'WebView' / External browser.
<syntaxhighlight lang="java">
public String userOptOutURLString()
</syntaxhighlight>

*If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
*To retrieve the current Opt-Out status of a device, use the <code> getOptOutStatus() </code> method.
<syntaxhighlight lang="java">
public boolean getOptOutStatus()
</syntaxhighlight>

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
</syntaxhighlight>

The app must provide access to "About Nielsen Measurement" page for the users. Include "About Nielsen Measurement" and Your Choices link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''Note:''' When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

Starting from SDK version 5.1.1.18:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
*Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
'''Google Settings → Ads → Opt out of Ads Personalization'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

== Opt-Out Implementation for Amazon Devices ==
Amazon device users can opt out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).

User is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.

'''For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.'''
=== Retrieving Ad tracking Value ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*Returns limit_ad_tracking value "0" if enabled
*Returns limit_ad_tracking value "1" if disabled
*Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).

<blockquote>'''Note:''' Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through '''Settings → Apps & Games → Advertising ID'''.</blockquote>

}}

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.

# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">"PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</syntaxhighlight>
# '''Collection Environment''': Change the <code>sfcode</code> from <code>'eu-cert'</code> to <code>'it'</code> to point traffic to the Nielsen production collection environment. Please DO NOT use eu-cert for your production traffic!
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

'''<big>iOS Example:</big>'''

<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"sfcode": "it"
// Remove Flag: "nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

'''<big>Android Example:</big>'''
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "it")
// Remove Flag: "nol_devDebug": "DEBUG"

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>

International

2017-10-27T09:10:00Z

MagdalenaKostulska: Undo revision 1855 by MagdalenaKostulska (talk)

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|International.png|International}}

This section is under maintenance. Please contact your Nielsen representative for documentation.

International

2017-10-26T15:51:37Z

MagdalenaKostulska:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|International.png|International}}

__NOTOC__

{| class="wikitable"
|-
! style="width: 90px;" |
! style="width: 42%;" | General Reference
!
|-
| rowspan="7" | {{SmallIcon|DigitalIcon.png}}
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
|-
| '''[[Digital Measurement Testing]]'''
| '''[[Digital Measurement Interruption Scenarios]]'''
|-
| '''[[Digital Measurement FAQ]]'''
|
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
|}

{| class="wikitable"
|-
! style="width: 90px;" |
! General Reference
|-
| rowspan="1" | {{SmallIcon|DigitalIcon.png}}
| '''[[Custom Variables Extension ]]'''
|}

{| class="wikitable"
|-
! style="width: 90px;" | Country
! style="width: 90px;" |
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Guide
|-
| rowspan="3" | {{SmallIcon|DEFlagIcon.png}}
| rowspan="3" | {{SmallIcon|SDKIcon.png}}
| rowspan="3" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR Germany Audio & Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR Germany Audio & Video Android SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Germany Audio & Video Browser SDK]]'''
|-
| colspan="5" style="background-color:white;" |
|-
| rowspan="7" | {{SmallIcon|ITFlagIcon.png}}
| rowspan="7" | {{SmallIcon|SDKIcon.png}}
| rowspan="3" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR Italy Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR Italy Video Android SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Italy Video Browser SDK]]'''
|-
| rowspan="4" | {{OSIcon|StaticIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR Italy Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR Italy Video Android SDK]]'''
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png}}
| '''[[DCR Italy Static Browser SDK (6.0.0)]]'''
|-
| '''[[DCR Italy Static Browser SDK (6.0.1)]]'''
|-
| colspan="5" style="background-color:white;" |
|-
| rowspan="4" | {{SmallIcon|CZFlagIcon.png}}
| rowspan="4" | {{SmallIcon|SDKIcon.png}}
| rowspan="3" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR Czech Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR Czech Video Android SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Czech Video Browser SDK]]'''
|-
| {{OSIcon|StaticIcon.png}}
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Czech Static Browser SDK]]'''
|-
| colspan="5" style="background-color:white;" |
|-
| rowspan="3" | {{SmallIcon|PLFlagIcon.png}}
| rowspan="3" | {{SmallIcon|SDKIcon.png}}
| rowspan="3" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR Poland Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR Poland Audio & Video Android SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Poland Audio & Video Browser SDK]]'''
|-
| colspan="5" style="background-color:white;" |
|-
| rowspan="3" | {{SmallIcon|THFlagIcon.png}}
| rowspan="3" | {{SmallIcon|SDKIcon.png}}
| rowspan="3" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR Thailand Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR Thailand Video Android SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR Thailand Video Browser SDK]]'''
|-
| colspan="5" style="background-color:white;" |
|-
| rowspan="3" | {{SmallIcon|INFlagIcon.png}}
| rowspan="3" | {{SmallIcon|SDKIcon.png}}
| rowspan="3" | {{OSIcon|VideoIcon.png}}
| {{OSIcon|macOSIcon.png}}
| '''[[DCR India Video iOS SDK]]'''
|-
| {{OSIcon|AndroidIcon.png}}
| '''[[DCR India Video Android SDK]]'''
|-
| {{OSIcon|BrowserIcon.png}}
| '''[[DCR India Video Browser SDK]]'''
|}

DCR Italy Video Browser SDK (6.0.1)

2017-10-26T12:37:47Z

MagdalenaKostulska: /* Going Live */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

This guide will show how to integrate the Nielsen Software Development Kit (SDK) to enable Digital Content Ratings (DCR) video measurement on browser players.

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="console">XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</syntaxhighlight>

== Configure SDK ==
There are two steps required for configuring the SDK:
* Add Static Queue Snippet
* Create SDK Instance

=== Add Static Queue Snippet ===

Add the following script tag to the website:
<syntaxhighlight lang="html"><script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script></syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("<apid>", "<instanceName>",
{
clientid: "XX-XXXXXX", // eg. "it-123456"
vcid: "cXX", // eg. "c01"
nol_sdkDebug: "debug" // should be deleted when going live
}
)</syntaxhighlight>

When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || <code>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</code>
|-
| instanceName || Name of SDK instance || <code>"any string value"</code>
|-
| clientid || Brand value has to be passed in 3rd parameter object || Nielsen provided ||
|-
| vcid || VCID value has to be passed 3rd parameter object || Nielsen provided ||
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing. in 3rd parameter object || <code>{nol_sdkDebug: "debug"}</code>
|}

When the initialization call is made, a unique static configuration file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","myPlayerName", {clientid: "it-123456", vcid: "c01", nol_sdkDebug: "debug"});
</script></syntaxhighlight>

== Create Metadata Objects ==
There are two types of asset metadata:
* content: identify video
* ad: identify each ad
The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

=== Content Metadata ===

Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required?
|-
| type ||
Type of measurement:
*video – <code>"content"</code>
|| <code>"content"</code> || ✓
|-
| assetid || Unique ID assigned to content (max. 40 characters) || custom || ✓
|-
| program || Program name (max. 254 characters) || custom || ✓
|-
| title || Episode title (max. 254 characters) || custom || ✓
|-
| length || Length of content in seconds for VOD. The estimated content length has to be passed for live content. || <code>seconds</code> (86400 for live stream) || ✓
|-
| airdate || Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || <code>YYYYMMDD hh:mm:ss</code> || ✓
|-
| isfullepisode || Full episode flag ||
<code>"y"</code> - full episode
<code>"n"</code> - non-full episode
|| ✓
|-
| adloadtype ||
Type of ad load:
#Linear - matches TV ad load
#Dynamic - Dynamic Ad Insertion (DAI)
|| <code>"1"</code> - Linear
<code>"2"</code> - Dynamic
|| ✓
|-
| clientid || Brand value is automatically populated through the App ID provided. The value passed here will override the default value. (e.g. Multiple brands in App) || Nielsen provided ||
|-
| subbrand || subbrand/VCID value is automatically populated through the App ID provided. This value passed here will override the default value. (e.g. Multiple Sub-brands in App) || Nielsen provided ||
|-
| mediaURL || URL location of the content being streamed (max. 254 characters) || custom ||
|-
| segB || Segment B || custom ||
|-
| segC || Segment C || custom ||
|-
| crossId1 || Standard episode ID || custom ||
|-
| crossId2 || Content originator (required only for distributors) || Nielsen provided ||
|-
|| hasAds || Whether the content is ad supported ||
<code>"0"</code> - No Ads
<code>"1"</code> - Ad Supported
<code>"2"</code> - Unknown (default)
||
|}

'''Example Content Object'''
<syntaxhighlight lang="javascript">
//create content object
var contentMetadataObject =
{
type: "content",
assetid: "VID123-123456",
program: "program name",
title: "episode title",
length: "1020",
airdate: "19700101 00:00:00",
isfullepisode: "y",
adloadtype: "2"
};
</syntaxhighlight>

'''Note''': all parameters should be provided as strings (also length)

'''Note''': for Audiweb clients there is no need to use "mediaURL", "segB", "segC", "crossId1", "crossId2" and "hasAds". These parameters can be left out completely from structure. They are optional and not mandatory (and out of current reporting too).

=== Ad Object ===
The ad metadata should be passed for each individual ad.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... you may ignore this paragraph

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || <code>"preroll"</code>, <code>"midroll"</code> or <code>"postroll"</code> || ✓
|-
| assetid || uniqueID assigned to ad || <code>custom</code> || ✓
|}

'''Example Ad Object'''
<syntaxhighlight lang="javascript">//create ad object
var adMetadataObject =
{
assetid: "AD-1",
type: "preroll"
};</syntaxhighlight>

'''URL Character Limit:''' There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers.

== Call Nielsen APIs ==
The method for calling events is <code>ggPM()</code>.
<syntaxhighlight lang="javascript">nSdkInstance.ggPM('event', parameter, ...);</syntaxhighlight>

=== Events ===
The events are included in the table below:
{| class="wikitable"
|-
! Event Number !! Values to pass !! Event Name || Description
|-
| <code>'3'</code> || content/ad metadata object || load content metadata || Load metadata event for content. Has to be called at the very first beginning of each stream.
|-
| <code>'5'</code> || playhead position || content play || Call when content or ads start playing or resumes from pause.
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'6'</code> || playhead position || pause || Call when content or ads is pausing. Use Event 5 to resume ...
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'7'</code> || playhead position || stop || Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop
|-
| <code>'8'</code> || playhead position from, playhead position to || seek || Call when scrubbing forward or backward with playhead position 'from' and 'to'
|-
| <code>'15'</code> || content/ad metadata object || load ad metadata || Call at the beginning of each ad, don’t use ‘play’ (event 5) if event 15 is used
|-
| <code>'49'</code> || playhead position || playhead position || '''VOD''': current position in seconds.
'''Live''': current unix timestamp (seconds since January 1st 1970).
Note: has to be called on a secondly basis.
For each ad the playheads starts with 0 (no Live unix timestamp for ads)
|-
| <code>'57'</code> || playhead position || end || This event has to be called '''once''' for the current video asset at the end of the playback.
At the end of the content stream, if the user switches to another piece of content or when the browser is refreshed or closed.
|}

=== SDK Event Lifecycle ===
The sample event lifecycle can be used as a reference for identifying the order for calling events.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... please see 2nd example how to use without ads!

==== example '''with''' ads: ====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream (even if 1st asset is preroll)

// Preroll
nSdkInstance.ggPM('15', prerollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 for the first segment (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition);

// Midroll
nSdkInstance.ggPM('15', midrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from where it left off before mid-roll (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// Postroll
nSdkInstance.ggPM('15', postrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>

==== example '''without''' ads:====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>
'''Note''': if there are ads played in stream simply use a pause (event 6) when ads start playing and a play (event 5) when content start playing.

'''Note''': Event <code>'49'</code> is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling event <code>'7'</code>, <code>'57'</code>, or <code>'15'</code>.

'''Note''': when buffering occurs you have to send a event 6 (pause) and after buffering finished a 5 (play).

'''Note''': For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

'''Note''': When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.

'''Handling Pause'''
The event <code>6</code> is used for handling pause. To indicate pause, stop passing the playhead position to the SDK and send Event 6 with playhead once. When content resumes, begin sending the playhead again with the correct playhead value. Also if buffering occurs for more than 1 second you may use Event 6 (pause) to indicate that.
e.g. pause at 1m2s and resume after a couple of seconds:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('6', 62); // now send nothing to SDK until player resumes (automatically because of buffering ends or user unpauses/resumes play
nSdkInstance.ggPM('49', 63);
nSdkInstance.ggPM('49', 64);
...
</syntaxhighlight>

'''Handling Seek'''
The event <code>8</code> is used for handling forward/backward seek. To indicate seek, send Event 8 with 'from' and 'to' playhead.
e.g. seek from 1m2s to 2m0s:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('8', 62,120);
nSdkInstance.ggPM('49', 120);
nSdkInstance.ggPM('49', 121);
...
</syntaxhighlight>

'''Interruption Scenarios'''
The following possible browser interruption scenarios must be handled:
* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
<syntaxhighlight lang="javascript">window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate 'stop' for the ad
if (insideMidroll) {
nSdkInstance.ggPM('7', playheadPosition);
}

// Indicate 'end' for the content and 'stop' for the stream
nSdkInstance.ggPM('57', playheadPosition);
nSdkInstance.ggPM('7', playheadPosition);
});</syntaxhighlight>

<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
* A link to the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement.

''The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.''

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Italy Video Browser SDK (6.0.1)

2017-10-26T12:36:53Z

MagdalenaKostulska: /* Ad Object */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

This guide will show how to integrate the Nielsen Software Development Kit (SDK) to enable Digital Content Ratings (DCR) video measurement on browser players.

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="console">XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</syntaxhighlight>

== Configure SDK ==
There are two steps required for configuring the SDK:
* Add Static Queue Snippet
* Create SDK Instance

=== Add Static Queue Snippet ===

Add the following script tag to the website:
<syntaxhighlight lang="html"><script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script></syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("<apid>", "<instanceName>",
{
clientid: "XX-XXXXXX", // eg. "it-123456"
vcid: "cXX", // eg. "c01"
nol_sdkDebug: "debug" // should be deleted when going live
}
)</syntaxhighlight>

When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || <code>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</code>
|-
| instanceName || Name of SDK instance || <code>"any string value"</code>
|-
| clientid || Brand value has to be passed in 3rd parameter object || Nielsen provided ||
|-
| vcid || VCID value has to be passed 3rd parameter object || Nielsen provided ||
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing. in 3rd parameter object || <code>{nol_sdkDebug: "debug"}</code>
|}

When the initialization call is made, a unique static configuration file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","myPlayerName", {clientid: "it-123456", vcid: "c01", nol_sdkDebug: "debug"});
</script></syntaxhighlight>

== Create Metadata Objects ==
There are two types of asset metadata:
* content: identify video
* ad: identify each ad
The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

=== Content Metadata ===

Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required?
|-
| type ||
Type of measurement:
*video – <code>"content"</code>
|| <code>"content"</code> || ✓
|-
| assetid || Unique ID assigned to content (max. 40 characters) || custom || ✓
|-
| program || Program name (max. 254 characters) || custom || ✓
|-
| title || Episode title (max. 254 characters) || custom || ✓
|-
| length || Length of content in seconds for VOD. The estimated content length has to be passed for live content. || <code>seconds</code> (86400 for live stream) || ✓
|-
| airdate || Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || <code>YYYYMMDD hh:mm:ss</code> || ✓
|-
| isfullepisode || Full episode flag ||
<code>"y"</code> - full episode
<code>"n"</code> - non-full episode
|| ✓
|-
| adloadtype ||
Type of ad load:
#Linear - matches TV ad load
#Dynamic - Dynamic Ad Insertion (DAI)
|| <code>"1"</code> - Linear
<code>"2"</code> - Dynamic
|| ✓
|-
| clientid || Brand value is automatically populated through the App ID provided. The value passed here will override the default value. (e.g. Multiple brands in App) || Nielsen provided ||
|-
| subbrand || subbrand/VCID value is automatically populated through the App ID provided. This value passed here will override the default value. (e.g. Multiple Sub-brands in App) || Nielsen provided ||
|-
| mediaURL || URL location of the content being streamed (max. 254 characters) || custom ||
|-
| segB || Segment B || custom ||
|-
| segC || Segment C || custom ||
|-
| crossId1 || Standard episode ID || custom ||
|-
| crossId2 || Content originator (required only for distributors) || Nielsen provided ||
|-
|| hasAds || Whether the content is ad supported ||
<code>"0"</code> - No Ads
<code>"1"</code> - Ad Supported
<code>"2"</code> - Unknown (default)
||
|}

'''Example Content Object'''
<syntaxhighlight lang="javascript">
//create content object
var contentMetadataObject =
{
type: "content",
assetid: "VID123-123456",
program: "program name",
title: "episode title",
length: "1020",
airdate: "19700101 00:00:00",
isfullepisode: "y",
adloadtype: "2"
};
</syntaxhighlight>

'''Note''': all parameters should be provided as strings (also length)

'''Note''': for Audiweb clients there is no need to use "mediaURL", "segB", "segC", "crossId1", "crossId2" and "hasAds". These parameters can be left out completely from structure. They are optional and not mandatory (and out of current reporting too).

=== Ad Object ===
The ad metadata should be passed for each individual ad.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... you may ignore this paragraph

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || <code>"preroll"</code>, <code>"midroll"</code> or <code>"postroll"</code> || ✓
|-
| assetid || uniqueID assigned to ad || <code>custom</code> || ✓
|}

'''Example Ad Object'''
<syntaxhighlight lang="javascript">//create ad object
var adMetadataObject =
{
assetid: "AD-1",
type: "preroll"
};</syntaxhighlight>

'''URL Character Limit:''' There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers.

== Call Nielsen APIs ==
The method for calling events is <code>ggPM()</code>.
<syntaxhighlight lang="javascript">nSdkInstance.ggPM('event', parameter, ...);</syntaxhighlight>

=== Events ===
The events are included in the table below:
{| class="wikitable"
|-
! Event Number !! Values to pass !! Event Name || Description
|-
| <code>'3'</code> || content/ad metadata object || load content metadata || Load metadata event for content. Has to be called at the very first beginning of each stream.
|-
| <code>'5'</code> || playhead position || content play || Call when content or ads start playing or resumes from pause.
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'6'</code> || playhead position || pause || Call when content or ads is pausing. Use Event 5 to resume ...
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'7'</code> || playhead position || stop || Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop
|-
| <code>'8'</code> || playhead position from, playhead position to || seek || Call when scrubbing forward or backward with playhead position 'from' and 'to'
|-
| <code>'15'</code> || content/ad metadata object || load ad metadata || Call at the beginning of each ad, don’t use ‘play’ (event 5) if event 15 is used
|-
| <code>'49'</code> || playhead position || playhead position || '''VOD''': current position in seconds.
'''Live''': current unix timestamp (seconds since January 1st 1970).
Note: has to be called on a secondly basis.
For each ad the playheads starts with 0 (no Live unix timestamp for ads)
|-
| <code>'57'</code> || playhead position || end || This event has to be called '''once''' for the current video asset at the end of the playback.
At the end of the content stream, if the user switches to another piece of content or when the browser is refreshed or closed.
|}

=== SDK Event Lifecycle ===
The sample event lifecycle can be used as a reference for identifying the order for calling events.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... please see 2nd example how to use without ads!

==== example '''with''' ads: ====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream (even if 1st asset is preroll)

// Preroll
nSdkInstance.ggPM('15', prerollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 for the first segment (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition);

// Midroll
nSdkInstance.ggPM('15', midrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from where it left off before mid-roll (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// Postroll
nSdkInstance.ggPM('15', postrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>

==== example '''without''' ads:====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>
'''Note''': if there are ads played in stream simply use a pause (event 6) when ads start playing and a play (event 5) when content start playing.

'''Note''': Event <code>'49'</code> is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling event <code>'7'</code>, <code>'57'</code>, or <code>'15'</code>.

'''Note''': when buffering occurs you have to send a event 6 (pause) and after buffering finished a 5 (play).

'''Note''': For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

'''Note''': When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.

'''Handling Pause'''
The event <code>6</code> is used for handling pause. To indicate pause, stop passing the playhead position to the SDK and send Event 6 with playhead once. When content resumes, begin sending the playhead again with the correct playhead value. Also if buffering occurs for more than 1 second you may use Event 6 (pause) to indicate that.
e.g. pause at 1m2s and resume after a couple of seconds:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('6', 62); // now send nothing to SDK until player resumes (automatically because of buffering ends or user unpauses/resumes play
nSdkInstance.ggPM('49', 63);
nSdkInstance.ggPM('49', 64);
...
</syntaxhighlight>

'''Handling Seek'''
The event <code>8</code> is used for handling forward/backward seek. To indicate seek, send Event 8 with 'from' and 'to' playhead.
e.g. seek from 1m2s to 2m0s:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('8', 62,120);
nSdkInstance.ggPM('49', 120);
nSdkInstance.ggPM('49', 121);
...
</syntaxhighlight>

'''Interruption Scenarios'''
The following possible browser interruption scenarios must be handled:
* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
<syntaxhighlight lang="javascript">window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate 'stop' for the ad
if (insideMidroll) {
nSdkInstance.ggPM('7', playheadPosition);
}

// Indicate 'end' for the content and 'stop' for the stream
nSdkInstance.ggPM('57', playheadPosition);
nSdkInstance.ggPM('7', playheadPosition);
});</syntaxhighlight>

<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
* A link to the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement.

''The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.''

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Italy Video Browser SDK (6.0.1)

2017-10-26T12:36:13Z

MagdalenaKostulska: /* Content Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

This guide will show how to integrate the Nielsen Software Development Kit (SDK) to enable Digital Content Ratings (DCR) video measurement on browser players.

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="console">XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</syntaxhighlight>

== Configure SDK ==
There are two steps required for configuring the SDK:
* Add Static Queue Snippet
* Create SDK Instance

=== Add Static Queue Snippet ===

Add the following script tag to the website:
<syntaxhighlight lang="html"><script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script></syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("<apid>", "<instanceName>",
{
clientid: "XX-XXXXXX", // eg. "it-123456"
vcid: "cXX", // eg. "c01"
nol_sdkDebug: "debug" // should be deleted when going live
}
)</syntaxhighlight>

When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || <code>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</code>
|-
| instanceName || Name of SDK instance || <code>"any string value"</code>
|-
| clientid || Brand value has to be passed in 3rd parameter object || Nielsen provided ||
|-
| vcid || VCID value has to be passed 3rd parameter object || Nielsen provided ||
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing. in 3rd parameter object || <code>{nol_sdkDebug: "debug"}</code>
|}

When the initialization call is made, a unique static configuration file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","myPlayerName", {clientid: "it-123456", vcid: "c01", nol_sdkDebug: "debug"});
</script></syntaxhighlight>

== Create Metadata Objects ==
There are two types of asset metadata:
* content: identify video
* ad: identify each ad
The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

=== Content Metadata ===

Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required?
|-
| type ||
Type of measurement:
*video – <code>"content"</code>
|| <code>"content"</code> || ✓
|-
| assetid || Unique ID assigned to content (max. 40 characters) || custom || ✓
|-
| program || Program name (max. 254 characters) || custom || ✓
|-
| title || Episode title (max. 254 characters) || custom || ✓
|-
| length || Length of content in seconds for VOD. The estimated content length has to be passed for live content. || <code>seconds</code> (86400 for live stream) || ✓
|-
| airdate || Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || <code>YYYYMMDD hh:mm:ss</code> || ✓
|-
| isfullepisode || Full episode flag ||
<code>"y"</code> - full episode
<code>"n"</code> - non-full episode
|| ✓
|-
| adloadtype ||
Type of ad load:
#Linear - matches TV ad load
#Dynamic - Dynamic Ad Insertion (DAI)
|| <code>"1"</code> - Linear
<code>"2"</code> - Dynamic
|| ✓
|-
| clientid || Brand value is automatically populated through the App ID provided. The value passed here will override the default value. (e.g. Multiple brands in App) || Nielsen provided ||
|-
| subbrand || subbrand/VCID value is automatically populated through the App ID provided. This value passed here will override the default value. (e.g. Multiple Sub-brands in App) || Nielsen provided ||
|-
| mediaURL || URL location of the content being streamed (max. 254 characters) || custom ||
|-
| segB || Segment B || custom ||
|-
| segC || Segment C || custom ||
|-
| crossId1 || Standard episode ID || custom ||
|-
| crossId2 || Content originator (required only for distributors) || Nielsen provided ||
|-
|| hasAds || Whether the content is ad supported ||
<code>"0"</code> - No Ads
<code>"1"</code> - Ad Supported
<code>"2"</code> - Unknown (default)
||
|}

'''Example Content Object'''
<syntaxhighlight lang="javascript">
//create content object
var contentMetadataObject =
{
type: "content",
assetid: "VID123-123456",
program: "program name",
title: "episode title",
length: "1020",
airdate: "19700101 00:00:00",
isfullepisode: "y",
adloadtype: "2"
};
</syntaxhighlight>

'''Note''': all parameters should be provided as strings (also length)

'''Note''': for Audiweb clients there is no need to use "mediaURL", "segB", "segC", "crossId1", "crossId2" and "hasAds". These parameters can be left out completely from structure. They are optional and not mandatory (and out of current reporting too).

=== Ad Object ===
The ad metadata should be passed for each individual ad.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... you may ignore this paragraph

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || <code>"preroll"</code>, <code>"midroll"</code> or <code>"postroll"</code> || ✓
|-
| assetid || uniqueID assigned to ad || <code>custom</code> || ✓
|}

'''Example Ad Object'''
<syntaxhighlight lang="javascript">//create ad object
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};</syntaxhighlight>

'''URL Character Limit:''' There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers.

== Call Nielsen APIs ==
The method for calling events is <code>ggPM()</code>.
<syntaxhighlight lang="javascript">nSdkInstance.ggPM('event', parameter, ...);</syntaxhighlight>

=== Events ===
The events are included in the table below:
{| class="wikitable"
|-
! Event Number !! Values to pass !! Event Name || Description
|-
| <code>'3'</code> || content/ad metadata object || load content metadata || Load metadata event for content. Has to be called at the very first beginning of each stream.
|-
| <code>'5'</code> || playhead position || content play || Call when content or ads start playing or resumes from pause.
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'6'</code> || playhead position || pause || Call when content or ads is pausing. Use Event 5 to resume ...
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'7'</code> || playhead position || stop || Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop
|-
| <code>'8'</code> || playhead position from, playhead position to || seek || Call when scrubbing forward or backward with playhead position 'from' and 'to'
|-
| <code>'15'</code> || content/ad metadata object || load ad metadata || Call at the beginning of each ad, don’t use ‘play’ (event 5) if event 15 is used
|-
| <code>'49'</code> || playhead position || playhead position || '''VOD''': current position in seconds.
'''Live''': current unix timestamp (seconds since January 1st 1970).
Note: has to be called on a secondly basis.
For each ad the playheads starts with 0 (no Live unix timestamp for ads)
|-
| <code>'57'</code> || playhead position || end || This event has to be called '''once''' for the current video asset at the end of the playback.
At the end of the content stream, if the user switches to another piece of content or when the browser is refreshed or closed.
|}

=== SDK Event Lifecycle ===
The sample event lifecycle can be used as a reference for identifying the order for calling events.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... please see 2nd example how to use without ads!

==== example '''with''' ads: ====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream (even if 1st asset is preroll)

// Preroll
nSdkInstance.ggPM('15', prerollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 for the first segment (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition);

// Midroll
nSdkInstance.ggPM('15', midrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from where it left off before mid-roll (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// Postroll
nSdkInstance.ggPM('15', postrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>

==== example '''without''' ads:====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>
'''Note''': if there are ads played in stream simply use a pause (event 6) when ads start playing and a play (event 5) when content start playing.

'''Note''': Event <code>'49'</code> is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling event <code>'7'</code>, <code>'57'</code>, or <code>'15'</code>.

'''Note''': when buffering occurs you have to send a event 6 (pause) and after buffering finished a 5 (play).

'''Note''': For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

'''Note''': When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.

'''Handling Pause'''
The event <code>6</code> is used for handling pause. To indicate pause, stop passing the playhead position to the SDK and send Event 6 with playhead once. When content resumes, begin sending the playhead again with the correct playhead value. Also if buffering occurs for more than 1 second you may use Event 6 (pause) to indicate that.
e.g. pause at 1m2s and resume after a couple of seconds:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('6', 62); // now send nothing to SDK until player resumes (automatically because of buffering ends or user unpauses/resumes play
nSdkInstance.ggPM('49', 63);
nSdkInstance.ggPM('49', 64);
...
</syntaxhighlight>

'''Handling Seek'''
The event <code>8</code> is used for handling forward/backward seek. To indicate seek, send Event 8 with 'from' and 'to' playhead.
e.g. seek from 1m2s to 2m0s:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('8', 62,120);
nSdkInstance.ggPM('49', 120);
nSdkInstance.ggPM('49', 121);
...
</syntaxhighlight>

'''Interruption Scenarios'''
The following possible browser interruption scenarios must be handled:
* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
<syntaxhighlight lang="javascript">window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate 'stop' for the ad
if (insideMidroll) {
nSdkInstance.ggPM('7', playheadPosition);
}

// Indicate 'end' for the content and 'stop' for the stream
nSdkInstance.ggPM('57', playheadPosition);
nSdkInstance.ggPM('7', playheadPosition);
});</syntaxhighlight>

<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
* A link to the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement.

''The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.''

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Italy Video Browser SDK (6.0.1)

2017-10-26T12:33:40Z

MagdalenaKostulska: /* Create SDK Instance */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

This guide will show how to integrate the Nielsen Software Development Kit (SDK) to enable Digital Content Ratings (DCR) video measurement on browser players.

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="console">XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</syntaxhighlight>

== Configure SDK ==
There are two steps required for configuring the SDK:
* Add Static Queue Snippet
* Create SDK Instance

=== Add Static Queue Snippet ===

Add the following script tag to the website:
<syntaxhighlight lang="html"><script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script></syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("<apid>", "<instanceName>",
{
clientid: "XX-XXXXXX", // eg. "it-123456"
vcid: "cXX", // eg. "c01"
nol_sdkDebug: "debug" // should be deleted when going live
}
)</syntaxhighlight>

When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || <code>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"</code>
|-
| instanceName || Name of SDK instance || <code>"any string value"</code>
|-
| clientid || Brand value has to be passed in 3rd parameter object || Nielsen provided ||
|-
| vcid || VCID value has to be passed 3rd parameter object || Nielsen provided ||
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing. in 3rd parameter object || <code>{nol_sdkDebug: "debug"}</code>
|}

When the initialization call is made, a unique static configuration file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","myPlayerName", {clientid: "it-123456", vcid: "c01", nol_sdkDebug: "debug"});
</script></syntaxhighlight>

== Create Metadata Objects ==
There are two types of asset metadata:
* content: identify video
* ad: identify each ad
The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

=== Content Metadata ===

Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required?
|-
| type ||
Type of measurement:
*video – <code>"content"</code>
|| <code>"content"</code> || ✓
|-
| assetid || Unique ID assigned to content (max. 40 characters) || custom || ✓
|-
| program || Program name (max. 254 characters) || custom || ✓
|-
| title || Episode title (max. 254 characters) || custom || ✓
|-
| length || Length of content in seconds for VOD. The estimated content length has to be passed for live content. || <code>seconds</code> (86400 for live stream) || ✓
|-
| airdate || Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || <code>YYYYMMDD hh:mm:ss</code> || ✓
|-
| isfullepisode || Full episode flag ||
<code>"y"</code> - full episode
<code>"n"</code> - non-full episode
|| ✓
|-
| adloadtype ||
Type of ad load:
#Linear - matches TV ad load
#Dynamic - Dynamic Ad Insertion (DAI)
|| <code>"1"</code> - Linear
<code>"2"</code> - Dynamic
|| ✓
|-
| clientid || Brand value is automatically populated through the App ID provided. The value passed here will override the default value. (e.g. Multiple brands in App) || Nielsen provided ||
|-
| subbrand || subbrand/VCID value is automatically populated through the App ID provided. This value passed here will override the default value. (e.g. Multiple Sub-brands in App) || Nielsen provided ||
|-
| mediaURL || URL location of the content being streamed (max. 254 characters) || custom ||
|-
| segB || Segment B || custom ||
|-
| segC || Segment C || custom ||
|-
| crossId1 || Standard episode ID || custom ||
|-
| crossId2 || Content originator (required only for distributors) || Nielsen provided ||
|-
|| hasAds || Whether the content is ad supported ||
<code>"0"</code> - No Ads
<code>"1"</code> - Ad Supported
<code>"2"</code> - Unknown (default)
||
|}

'''Example Content Object'''
<syntaxhighlight lang="javascript">
//create content object
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: '1020',
airdate: '19700101 00:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</syntaxhighlight>

'''Note''': all parameters should be provided as strings (also length)

'''Note''': for Audiweb clients there is no need to use 'mediaURL', 'segB', 'segC', 'crossId1', 'crossId2' and 'hasAds'. These parameters can be left out completely from structure. They are optional and not mandatory (and out of current reporting too).

=== Ad Object ===
The ad metadata should be passed for each individual ad.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... you may ignore this paragraph

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || <code>"preroll"</code>, <code>"midroll"</code> or <code>"postroll"</code> || ✓
|-
| assetid || uniqueID assigned to ad || <code>custom</code> || ✓
|}

'''Example Ad Object'''
<syntaxhighlight lang="javascript">//create ad object
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};</syntaxhighlight>

'''URL Character Limit:''' There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers.

== Call Nielsen APIs ==
The method for calling events is <code>ggPM()</code>.
<syntaxhighlight lang="javascript">nSdkInstance.ggPM('event', parameter, ...);</syntaxhighlight>

=== Events ===
The events are included in the table below:
{| class="wikitable"
|-
! Event Number !! Values to pass !! Event Name || Description
|-
| <code>'3'</code> || content/ad metadata object || load content metadata || Load metadata event for content. Has to be called at the very first beginning of each stream.
|-
| <code>'5'</code> || playhead position || content play || Call when content or ads start playing or resumes from pause.
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'6'</code> || playhead position || pause || Call when content or ads is pausing. Use Event 5 to resume ...
'''VOD''' (or ad): The playhead position must be passed.
'''Live''': current unix timestamp (seconds since January 1st 1970).
|-
| <code>'7'</code> || playhead position || stop || Call when ads complete playing and at the very end of the stream. The playhead position must be passed when calling stop
|-
| <code>'8'</code> || playhead position from, playhead position to || seek || Call when scrubbing forward or backward with playhead position 'from' and 'to'
|-
| <code>'15'</code> || content/ad metadata object || load ad metadata || Call at the beginning of each ad, don’t use ‘play’ (event 5) if event 15 is used
|-
| <code>'49'</code> || playhead position || playhead position || '''VOD''': current position in seconds.
'''Live''': current unix timestamp (seconds since January 1st 1970).
Note: has to be called on a secondly basis.
For each ad the playheads starts with 0 (no Live unix timestamp for ads)
|-
| <code>'57'</code> || playhead position || end || This event has to be called '''once''' for the current video asset at the end of the playback.
At the end of the content stream, if the user switches to another piece of content or when the browser is refreshed or closed.
|}

=== SDK Event Lifecycle ===
The sample event lifecycle can be used as a reference for identifying the order for calling events.

'''Attention:''' for Audiweb there is no need to tag ads in video stream ... please see 2nd example how to use without ads!

==== example '''with''' ads: ====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream (even if 1st asset is preroll)

// Preroll
nSdkInstance.ggPM('15', prerollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 for the first segment (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition);

// Midroll
nSdkInstance.ggPM('15', midrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from where it left off before mid-roll (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// Postroll
nSdkInstance.ggPM('15', postrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // must be fired every second with playhead starting from 0
... /*** pass playhead every second ***/
nSdkInstance.ggPM('49', individualAdPlayheadPosition);
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>

==== example '''without''' ads:====
<syntaxhighlight lang="javascript">
// Start of stream
nSdkInstance.ggPM('3', contentMetadataObject); // must be called as start of stream

// Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // must be fired every second with playhead starting from 0 (or with seconds since 1970-01-01 00:00:00 in case of livestream)
... /*** pass playheads every second ***/
nSdkInstance.ggPM('49', contentPlayheadPosition);
nSdkInstance.ggPM('6', contentPlayheadPosition); // pause is also needed for legacy reasons before event 57
nSdkInstance.ggPM('57', contentPlayheadPosition); // has to be called here at the end of the content only once

// End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition); // must be called as indicator for end-of-stream
</syntaxhighlight>
'''Note''': if there are ads played in stream simply use a pause (event 6) when ads start playing and a play (event 5) when content start playing.

'''Note''': Event <code>'49'</code> is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling event <code>'7'</code>, <code>'57'</code>, or <code>'15'</code>.

'''Note''': when buffering occurs you have to send a event 6 (pause) and after buffering finished a 5 (play).

'''Note''': For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

'''Note''': When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.

'''Handling Pause'''
The event <code>6</code> is used for handling pause. To indicate pause, stop passing the playhead position to the SDK and send Event 6 with playhead once. When content resumes, begin sending the playhead again with the correct playhead value. Also if buffering occurs for more than 1 second you may use Event 6 (pause) to indicate that.
e.g. pause at 1m2s and resume after a couple of seconds:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('6', 62); // now send nothing to SDK until player resumes (automatically because of buffering ends or user unpauses/resumes play
nSdkInstance.ggPM('49', 63);
nSdkInstance.ggPM('49', 64);
...
</syntaxhighlight>

'''Handling Seek'''
The event <code>8</code> is used for handling forward/backward seek. To indicate seek, send Event 8 with 'from' and 'to' playhead.
e.g. seek from 1m2s to 2m0s:
<syntaxhighlight lang="javascript">
...
nSdkInstance.ggPM('49', 61);
nSdkInstance.ggPM('49', 62);
nSdkInstance.ggPM('8', 62,120);
nSdkInstance.ggPM('49', 120);
nSdkInstance.ggPM('49', 121);
...
</syntaxhighlight>

'''Interruption Scenarios'''
The following possible browser interruption scenarios must be handled:
* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
<syntaxhighlight lang="javascript">window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate 'stop' for the ad
if (insideMidroll) {
nSdkInstance.ggPM('7', playheadPosition);
}

// Indicate 'end' for the content and 'stop' for the stream
nSdkInstance.ggPM('57', playheadPosition);
nSdkInstance.ggPM('7', playheadPosition);
});</syntaxhighlight>

<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
* A link to the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement.

''The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/it/it/optout.html.''

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Video Browser SDK

2017-10-26T12:32:04Z

MagdalenaKostulska: /* Content Metadata */

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

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">
apid: "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
</syntaxhighlight>

== Configure SDK ==
There are two steps required for configuring the SDK:
*Add Static Queue Snippet
*Create SDK Instance

=== Static Queue Snippet ===
Add the following script tag to the website:
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
To initialize the SDK, create an SDK instance by making the initialization call:

==== Initialization API Call ====
<syntaxhighlight lang="javascript">
NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>

When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}

==== Example SDK Initialization ====
<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>

When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.

=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","myPlayerName", {clientid: "it-123456", vcid: "c01", nol_sdkDebug: "debug"});
</script></syntaxhighlight>

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

==== Content Metadata ====
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds (86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}

==== Example Content Object ====
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
The ad metadata should be passed for each individual ad.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}

==== Example Ad Object ====
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>

==== Call Nielsen APIs ====
The method for calling events is ggPM().

<syntaxhighlight lang="javascript">
nSdkInstance.ggPM('event', parameter, ...);
</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===
The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===
The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button

There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>

<blockquote>'''Note:''' User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}

== SDK Playhead Event Sequence ==
The sample event lifecycle can be used as a reference for identifying the order for calling events.

<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement.
<blockquote>
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
</blockquote>

=== Opt Back In ===
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

=== Going Live ===
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");
</syntaxhighlight>

Digital Pre-Certification Checklist Browser SDK

2017-10-26T10:42:56Z

MagdalenaKostulska: /* loadMetadata() - Content */

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

== Pre-Certification Checklist - VOD with Ads ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an APID
** informed you of our Opt-Out requirement to be included in your Privacy Policy section of your site
** informed you to add the Static Queue Snippit on each page you wish to enable video measurement
** informed you that the apid, 'instanceName', and ‘nol_sdkDebug’ : ‘DEBUG’ should be present in the SDK initialization

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing on page load, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| apid || <code>"PXXXXX-XXXXXX-XXXXX-XXXXX"</code>
|-
| instanceName || <code>"nlsnInstance"</code>
|-
| nol_sdkDebug || <code>"debug"</code>
|}

'''Browser SDK Queue Snippit & Initialization Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>apid</code> || Correct APID ||
|-
| || <code>instanceName</code> || SDK Instance Name ||
|-
| || <code>nol_sdkDebug</code> || <code>"DEBUG"</code> ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second, and starts at 0 ||
|-
| <code>stop()</code> || Called at the end of each asset before transition ie. content to ad, ad to content, ad to ad ||
|}

=== stop() ===
* Should Be Called:
* Before each transition from ad to content, content to ad, or ad to ad
* Upon pause
* When playback is interrupted (connection lost, user exits video or page)

=== end() ===
* Reached the end of content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>end</code> || Called once content has completed fully ||
|}

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** refresh page
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadata()</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of or opt back into Nielsen measurement. Include the following two items in the site’s Privacy Policy:
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy

The following paragraph is a template for an opt-out statement
Our properties may feature Nielsen proprietary measurement software, which will allow you to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, refer to Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

Digital Pre-Certification Checklist Browser SDK

2017-10-26T10:42:31Z

MagdalenaKostulska: /* loadMetadata() - Content */

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

== Pre-Certification Checklist - VOD with Ads ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an APID
** informed you of our Opt-Out requirement to be included in your Privacy Policy section of your site
** informed you to add the Static Queue Snippit on each page you wish to enable video measurement
** informed you that the apid, 'instanceName', and ‘nol_sdkDebug’ : ‘DEBUG’ should be present in the SDK initialization

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing on page load, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| apid || <code>"PXXXXX-XXXXXX-XXXXX-XXXXX"</code>
|-
| instanceName || <code>"nlsnInstance"</code>
|-
| nol_sdkDebug || <code>"debug"</code>
|}

'''Browser SDK Queue Snippit & Initialization Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>apid</code> || Correct APID ||
|-
| || <code>instanceName</code> || SDK Instance Name ||
|-
| || <code>nol_sdkDebug</code> || <code>"DEBUG"</code> ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second, and starts at 0 ||
|-
| <code>stop()</code> || Called at the end of each asset before transition ie. content to ad, ad to content, ad to ad ||
|}

=== stop() ===
* Should Be Called:
* Before each transition from ad to content, content to ad, or ad to ad
* Upon pause
* When playback is interrupted (connection lost, user exits video or page)

=== end() ===
* Reached the end of content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>end</code> || Called once content has completed fully ||
|}

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** refresh page
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadata()</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of or opt back into Nielsen measurement. Include the following two items in the site’s Privacy Policy:
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy

The following paragraph is a template for an opt-out statement
Our properties may feature Nielsen proprietary measurement software, which will allow you to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, refer to Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

Digital Pre-Certification Checklist Browser SDK

2017-10-26T10:42:08Z

MagdalenaKostulska: /* Test Cases */

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

== Pre-Certification Checklist - VOD with Ads ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an APID
** informed you of our Opt-Out requirement to be included in your Privacy Policy section of your site
** informed you to add the Static Queue Snippit on each page you wish to enable video measurement
** informed you that the apid, 'instanceName', and ‘nol_sdkDebug’ : ‘DEBUG’ should be present in the SDK initialization

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing on page load, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| apid || <code>"PXXXXX-XXXXXX-XXXXX-XXXXX"</code>
|-
| instanceName || <code>"nlsnInstance"</code>
|-
| nol_sdkDebug || <code>"debug"</code>
|}

'''Browser SDK Queue Snippit & Initialization Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>apid</code> || Correct APID ||
|-
| || <code>instanceName</code> || SDK Instance Name ||
|-
| || <code>nol_sdkDebug</code> || <code>"DEBUG"</code> ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second, and starts at 0 ||
|-
| <code>stop()</code> || Called at the end of each asset before transition ie. content to ad, ad to content, ad to ad ||
|}

=== stop() ===
* Should Be Called:
* Before each transition from ad to content, content to ad, or ad to ad
* Upon pause
* When playback is interrupted (connection lost, user exits video or page)

=== end() ===
* Reached the end of content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>end</code> || Called once content has completed fully ||
|}

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** refresh page
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadata()</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of or opt back into Nielsen measurement. Include the following two items in the site’s Privacy Policy:
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy

The following paragraph is a template for an opt-out statement
Our properties may feature Nielsen proprietary measurement software, which will allow you to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, refer to Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

Digital Pre-Certification Checklist Browser SDK

2017-10-26T10:41:33Z

MagdalenaKostulska: /* Initialization */

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

== Pre-Certification Checklist - VOD with Ads ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an APID
** informed you of our Opt-Out requirement to be included in your Privacy Policy section of your site
** informed you to add the Static Queue Snippit on each page you wish to enable video measurement
** informed you that the apid, 'instanceName', and ‘nol_sdkDebug’ : ‘DEBUG’ should be present in the SDK initialization

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing on page load, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| apid || <code>"PXXXXX-XXXXXX-XXXXX-XXXXX"</code>
|-
| instanceName || <code>"nlsnInstance"</code>
|-
| nol_sdkDebug || <code>"debug"</code>
|}

'''Browser SDK Queue Snippit & Initialization Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>apid</code> || Correct APID ||
|-
| || <code>instanceName</code> || SDK Instance Name ||
|-
| || <code>nol_sdkDebug</code> || <code>'DEBUG'</code> ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second, and starts at 0 ||
|-
| <code>stop()</code> || Called at the end of each asset before transition ie. content to ad, ad to content, ad to ad ||
|}

=== stop() ===
* Should Be Called:
* Before each transition from ad to content, content to ad, or ad to ad
* Upon pause
* When playback is interrupted (connection lost, user exits video or page)

=== end() ===
* Reached the end of content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>end</code> || Called once content has completed fully ||
|}

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** refresh page
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadata()</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of or opt back into Nielsen measurement. Include the following two items in the site’s Privacy Policy:
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy

The following paragraph is a template for an opt-out statement
Our properties may feature Nielsen proprietary measurement software, which will allow you to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, refer to Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

Digital Pre-Certification Checklist App SDK

2017-10-26T10:34:44Z

MagdalenaKostulska: /* loadMetadata() - Content */

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

== Pre-certification Checklist ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an AppID
** informed you of our Opt-Out requirement for your App/Play Store description
** informed you of our Opt-Out requirement for a WebView inside your apps
* Retrieving AppSDK logs
** 'nol_devDebug' : 'DEBUG' should be present in initialization call (see below)
** Android: use adb logcat (note: requires Android Studio)
** iOS: idevicesyslog (note: requires XCode)

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing at app startup, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| appid || <code>XXXXX-XXXXXX-XXXXX-XXXXX</code>
|-
| appname || <code>example app name</code>
|-
| appversion || <code>2.0</code>
|-
| nol_devDebug || <code>debug</code>
|}

'''iOS Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
{ // AppID is Nielsen-supplied
@"appid": @"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
@"appname": @"Sample App Name",
@"appversion": @"2.0",
@"nol_devDebug": @"DEBUG" // required for testing only
}</syntaxhighlight>

'''Android Example'''
<syntaxhighlight lang="java">JSONObject appSdkConfig = new JSONObject()
.put("appid", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("appname", "Sample App Name")
.put("appversion","2.0")
.put("nol_devDebug”, "DEBUG"); // required for testing only
// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>appid</code> || Correct app id ||
|-
| || <code>appname</code> || Player name ||
|-
| || <code>appversion</code> || Correct build ||
|-
| || <code>nol_devDebug</code> || <code>"DEBUG"</code> ||
|}

=== play() ===
* The <code>play()</code> call is required only once per viewing session (until app is killed)
* Called just before playback commences for first piece of content
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| Play || <code>channelname</code> || Name of Channel ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Content ||
|}

=== stop() ===
* Indicates one of the following:
* Playback of content or ad was interrupted
* Reached end of ad (no parameters or metadata)

=== end() ===
* Reached the end of content (no parameters or metadata)

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** app sent to background
** headphones removed (note, if app simply switches audio output from headphones to speaker without pausing, there is no need to call stop())
** alarm/call interruption
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| app sent to background || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| headphones removed || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| alarm/call interruption || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadataM</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
Users must have access to "About Nielsen Measurement" page. User can click this page from app settings screen.
* URL to this web page should be called from SDK by invoking optOutURL and opened in 'WebView' / External browser.
* If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
* To retrieve the current Opt-Out status of a device, use the optOutStatus method.
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>optOutView</code> || User can Opt-Out ||
|}

Digital Pre-Certification Checklist App SDK

2017-10-26T10:33:07Z

MagdalenaKostulska: /* loadMetadata() - Content */

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

== Pre-certification Checklist ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an AppID
** informed you of our Opt-Out requirement for your App/Play Store description
** informed you of our Opt-Out requirement for a WebView inside your apps
* Retrieving AppSDK logs
** 'nol_devDebug' : 'DEBUG' should be present in initialization call (see below)
** Android: use adb logcat (note: requires Android Studio)
** iOS: idevicesyslog (note: requires XCode)

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing at app startup, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| appid || <code>XXXXX-XXXXXX-XXXXX-XXXXX</code>
|-
| appname || <code>example app name</code>
|-
| appversion || <code>2.0</code>
|-
| nol_devDebug || <code>debug</code>
|}

'''iOS Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
{ // AppID is Nielsen-supplied
@"appid": @"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
@"appname": @"Sample App Name",
@"appversion": @"2.0",
@"nol_devDebug": @"DEBUG" // required for testing only
}</syntaxhighlight>

'''Android Example'''
<syntaxhighlight lang="java">JSONObject appSdkConfig = new JSONObject()
.put("appid", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("appname", "Sample App Name")
.put("appversion","2.0")
.put("nol_devDebug”, "DEBUG"); // required for testing only
// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>appid</code> || Correct app id ||
|-
| || <code>appname</code> || Player name ||
|-
| || <code>appversion</code> || Correct build ||
|-
| || <code>nol_devDebug</code> || <code>"DEBUG"</code> ||
|}

=== play() ===
* The <code>play()</code> call is required only once per viewing session (until app is killed)
* Called just before playback commences for first piece of content
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| Play || <code>channelname</code> || Name of Channel ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Content ||
|}

=== stop() ===
* Indicates one of the following:
* Playback of content or ad was interrupted
* Reached end of ad (no parameters or metadata)

=== end() ===
* Reached the end of content (no parameters or metadata)

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** app sent to background
** headphones removed (note, if app simply switches audio output from headphones to speaker without pausing, there is no need to call stop())
** alarm/call interruption
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| app sent to background || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| headphones removed || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| alarm/call interruption || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadataM</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
Users must have access to "About Nielsen Measurement" page. User can click this page from app settings screen.
* URL to this web page should be called from SDK by invoking optOutURL and opened in 'WebView' / External browser.
* If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
* To retrieve the current Opt-Out status of a device, use the optOutStatus method.
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>optOutView</code> || User can Opt-Out ||
|}

Digital Pre-Certification Checklist App SDK

2017-10-26T10:32:03Z

MagdalenaKostulska: /* Test Cases */

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

== Pre-certification Checklist ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an AppID
** informed you of our Opt-Out requirement for your App/Play Store description
** informed you of our Opt-Out requirement for a WebView inside your apps
* Retrieving AppSDK logs
** 'nol_devDebug' : 'DEBUG' should be present in initialization call (see below)
** Android: use adb logcat (note: requires Android Studio)
** iOS: idevicesyslog (note: requires XCode)

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing at app startup, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-
| appid || <code>XXXXX-XXXXXX-XXXXX-XXXXX</code>
|-
| appname || <code>example app name</code>
|-
| appversion || <code>2.0</code>
|-
| nol_devDebug || <code>debug</code>
|}

'''iOS Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
{ // AppID is Nielsen-supplied
@"appid": @"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
@"appname": @"Sample App Name",
@"appversion": @"2.0",
@"nol_devDebug": @"DEBUG" // required for testing only
}</syntaxhighlight>

'''Android Example'''
<syntaxhighlight lang="java">JSONObject appSdkConfig = new JSONObject()
.put("appid", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("appname", "Sample App Name")
.put("appversion","2.0")
.put("nol_devDebug”, "DEBUG"); // required for testing only
// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>appid</code> || Correct app id ||
|-
| || <code>appname</code> || Player name ||
|-
| || <code>appversion</code> || Correct build ||
|-
| || <code>nol_devDebug</code> || <code>"DEBUG"</code> ||
|}

=== play() ===
* The <code>play()</code> call is required only once per viewing session (until app is killed)
* Called just before playback commences for first piece of content
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| Play || <code>channelname</code> || Name of Channel ||
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) ||
|-
| || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Ad ||
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> ||
|-
| || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) ||
|-
| || <code>length</code> || <code>"600"</code> || length in seconds (int or float) ||
|-
| || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) ||
|-
| || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) ||
|-
| || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown ||
|-
| || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown ||
|-
| || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID ||
|-
| || <code>crossId2</code> || <code>"ABC"</code> || Network Name ||
|-
| || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) ||
|-
| || <code>airdate</code> || <code>"20160206 23:00:00</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time ||
|-
| || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI ||
|-
| || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads ||
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second ||
|-
| <code>stop()</code> || Called at the end of Content ||
|}

=== stop() ===
* Indicates one of the following:
* Playback of content or ad was interrupted
* Reached end of ad (no parameters or metadata)

=== end() ===
* Reached the end of content (no parameters or metadata)

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** app sent to background
** headphones removed (note, if app simply switches audio output from headphones to speaker without pausing, there is no need to call stop())
** alarm/call interruption
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| app sent to background || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| headphones removed || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| alarm/call interruption || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> ||
|-
| content paused || <code>playheadPosition</code> is not passed ||
|-
| resume content || <code>loadMetadata()</code> is called for content ||
|-
| || <code>loadMetadataM</code> is the same as original ||
|-
| || <code>playheadPosition</code> continues from resumed position ||
|}

'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub Forward || new playhead position is accurate ||
|-
| || new playhead continues from new position ||
|-
| Scrub to end || final playhead position is passed ||
|-
| || end event called at completion of content playback ||
|-
| Scrub past midroll || Playhead for content stops ||
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad ||
|-
| || Required Metadata is accurate ||
|-
| <code>playheadPosition</code> || Passed every second ||
|-
| <code>stop()</code> || called for each ad ||
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad ||
|}

== Opt-Out ==
Users must have access to "About Nielsen Measurement" page. User can click this page from app settings screen.
* URL to this web page should be called from SDK by invoking optOutURL and opened in 'WebView' / External browser.
* If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
* To retrieve the current Opt-Out status of a device, use the optOutStatus method.
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>optOutView</code> || User can Opt-Out ||
|}

Digital Measurement Testing

2017-10-26T09:11:26Z

MagdalenaKostulska: /* Step 7: Video Duration Ping */

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

== Monitoring Tools ==
HTTP traffic-monitoring tool, such as Charles or Fiddler are required.
*'''Charles:''' http://www.charlesproxy.com
*'''Fiddler:''' http://www.telerik.com/fiddler

== Step 1: Filter traffic ==
Filter HTTP traffic with the string "imr" to capture traffic from the SDK as shown in the below figure. This will capture traffic going to Nielsen servers. Now set up the device to proxy to this traffic analyzer.
<blockquote>'''Note:''' Instructions may vary from device to device and are available online.</blockquote>
[[File:fiddler-web-debugger.png|link=]]

== Step 2: Check Opt-Out ==
If the opt-out function or app disable feature is previously tested, it has to be ensured that an opt-in is completed on the device before continuing. Terminate the app completely before starting.

== Step 3: Hello Ping ==
The first HTTPS traffic that should be seen is the SDK request for configuration information, called a '''hello ping'''. In order to see this ping, Charles / Fiddler has to be configured to capture HTTPS traffic.

<code><nowiki>https://secure-dcr.imrworldwide.com/cgi-bin/cfg?cfgv=100&longitude=-82.66&latitude=28.05&apid=&apv=3.84.043&apn=com.video.videop
layer&sdkv=aa .1.2.3&nuid=7B341CD-5109-B88-B77D-8ADE904717A7&osver=ANDROID.4.2.2&devtypid=LGE-Nexus-4&devid=FFA503E7-
7749-4448-9922-132492ED4E12&fmt=json&adf=&uoo=&sfcode=dcr&ccode=1&dma=&rnd=1527112029</nowiki></code>
<blockquote>'''Note:''' If this ping fails to fire, it is likely that the instance of the SDK failed to initialize. Please see Initialization ([[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] and [[Android SDK API Reference#Initialization|Android SDK API Reference - Initialization]]) to see how to initialize the SDK.</blockquote>

== Step 4: The L Ping ==
When the app is started after installing for the first time, and app is measuring '''DCR Static''' content only, a DCR static app launch known as '''L''' ping firing to secure-dcr.imrworldwide.com server in the traffic-monitor should be seen. However, the '''L''' ping will be observed again if app goes into background and resumes back after 5 minutes.

<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr&ci=APRP7&ch=APRP7_NA_defChnAsset&asn=defChnAsset&tl=&c6=vc,NA&c13=asid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c32=segA,&c33=segB,&c34=segC,&c15=apn,MTVR-APT-QA&sup=0&segment2=539&segment1=usa&forward=1&ad=1&cr=L&c9=devid,a69983bc65ad94f9e57109fec68cc847bf59575ee03cadb76b187f4c24eaf793&enc=true&c1=nuid,142a40706f9c03bfea020f7297828534a1f14895d7a8c5303d9b8a19b3337c13&r=&at=launch&rt=text&c16=sdkv ,aa.4.0.0&c27=cln,473&crs=0&si=&lat=28.09&lon=-82.76&c29=plid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c30=bldv,aa.4.0.0.3&st=dcr&c7=osgrp,DROID&c8=devgrp,TAB&c10=plt,MBL&c40=adbid,&c14=osver,ANDROID.4.4.4&c26=1&c35=&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,apt.4.0.0.3&h33=2&c51=adl,0&c52=noad,0&devtypid=asus-Nexus-7&rnd=1432529128693</code>

If the app is measuring '''DCR Video Content''' only, then the '''hello ping''' will fire but the '''L''' ping will not be observed upon app launch.

== Step 5: Static View Ping ==
For any sections that are tagged for static content, a '''DCR Static – view''' ping should be received. The first landing page should always be tagged. An example of this ping is:

<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr&ci=APRP7&ch=APRP7_NA_defChnAsset&asn=defChnAsset&tl=&c6=vc,NA&c13=asid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c32=segA,&c33=segB,&c34=segC,&c15=apn,MTVR-APT-QA&sup=0&segment2=539&segment1=usa&forward=1&ad=1&cr=V&c9=devid,a69983bc65ad94f9e57109fec68cc847bf59575ee03cadb76b187f4c24eaf793&enc=true&c1=nuid,142a40706f9c03bfea020f7297828534a1f14895d7a8c5303d9b8a19b3337c13&r=&at=view&rt=text&c16=sdkv,a a.4.0.0&c27=cln,0&crs=0&si=&lat=&lon=&c29=plid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c30=bldv,aa.4.0.0.1&st=dcr&c7=osgrp,DROID&c8=devgrp,TAB&c10=plt,MBL&c40=adbid,&c14=osver,ANDROID.4.4.4&c26=1&c35=&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,apt.4.0.0.2&h33=2&c51=adl,0&c52=noad,0&devtypid=asus-Nexus-7&rnd=1432068181560</code>
{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || us-123456
|-
| asn || Asset Name – this value should represent the asset’s name assigned in the metadata. || Page-Asset
|-
| at || Action Type || Start
|-
| rt || This value should be “text” and indicates that this is a DCR tag for static content. || text
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| c32 || Segment A – Client customized metadata || CustomSegmentValueA
|-
| c33 || Segment B – Client customized metadata || CustomSegmentValueB
|-
| c34 || Segment C – Client customized metadata || CustomSegmentValueC
|}

== Step 6: Video View Ping ==
Approximately 60 seconds into viewing of the stream, a '''DCR Video – view''' ping fire to secure-dcr.imrworldwide.com server indicated by the '''cr''' value containing a '''V''' in the format of 4_00_99_'''V'''1_00000 should be seen.

{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || us-123456
|-
| asn || Asset Name – this value should represent asset’s name assigned in the metadata. || Video-Asset
|-
| tl || Episode Title || Episode Name – S2 – E1 – LF
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| cr || Crediting Ping Identifier || 4_00_99_V1_00000
|-
| rt || This Value should be “video” and indicates that this is a DCR tag for video content. || video
|-
| c10 || Platform Indicator || plt,DSK or plt,MBL
|}
<blockquote>'''Note:''' If this ping fails to fire, a common cause is improper metadata being passed to the SDK. Examples of the proper metadata to be passed in the </code>loadMetadata</code></blockquote>

== Step 7: Video Duration Ping ==
The first duration ping is fired after 5 minutes of content is viewed. A '''DCR Video''' – duration ping fire to secure-dcr.imrworldwide.com indicated by the '''cr''' value containing a '''D''' in the format of 4_00_99_'''D'''1_11111 should be seen. This D ping should fire approximately every 5 minutes after the initial duration ping has fired or when the content switches to an advertisement. The ad length (c51) is the total ad duration viewed in the previous session, and the ad count (c52) is the number of ads viewed in previous segment.
{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || us-123456
|-
| asn || Asset Name – this value should represent asset’s name assigned in the metadata. || Video-Asset
|-
| tl || Episode Title || Episode Name – S2 – E1 – LF
|-
| cr || Crediting Ping Identifier || 4_00_99_V1_00000
|-
| rt || This Value should be “video” and indicates that this is a DCR tag for video content. || video
|-
| c10 || Platform Indicator || plt,DSK or plt,MBL
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| c51 || Ad Duration || adl,88
|-
| c52 || Ad Count || noad,1
|}
<blockquote>'''Note:''' If this ping fails to fire, it may be caused by not passing the setPlayheadPosition API call as expected. The instruction as well as examples can be found in the Developer’s Guide.</code></blockquote>

== Step 8: 5min Duration Ping ==
View all channels for 5 minutes to ensure all channels fire a '''duration''' ping.

== Step 9: Pending Duration Ping ==
Play a stream and move the app to the background. A pending '''duration''' ping should fire; crediting the appropriate number of minutes viewed from last ping (i.e. 4_00_99_D1_'''111'''00). No other pings should fire after it has been moved to the background. In case SDK does not get a chance to send out the ping while going to background, SDK will send the pending ping on next re-launch.

== Step 10: Pending Duration Pings cont. ==
The same action will occur with any interruption to the stream’s playback (e.g., alarm, incoming call, etc.).

== Step 11: Opt-Out Implementation ==
Test the Opt-Out implementation in four steps.
*Complete an opt-out in the app through the Nielsen opt-out webview.
*User opt-out, a '''goodbye ping''' is fired off to the Nielsen server. '''Example Goodbye Ping''':
<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/cfg?cfgv=200&longitude=&latitude=&apid=&apv=01.00.00&apn=Nielsen%2520sample&sdkv=aa.4.0.0&bldv=aa.4.0.0.4&nuid=00b5926fea1807638ebfe6f04af6a455c5d9b2a1ed3e39f550f44daa39d0886d&osver=ANDROID.4.4.4&devtypid=samsung-SAMSUNG-SM-N910A&devid=42ec6a26b000ccd34015ba8625ee29cd283190a8c00f1622f356e900bb5b2a23&enc=true&tz=-14400&fmt=json&adf=&uoo=true&sfcode=dcr&ccode=&dma=539&rnd=1434632964945</code>
*Watch any content (static or video) for at least three minutes. No pings will be rendered.
*Opt back in, a '''hello ping''' is fired off to the Nielsen server. ''Example Hello Ping'':
<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/cfg?cfgv=200&longitude=-82.65&latitude=28.05&apid=&apv=01.00.00&apn=Nielsen%2520sample&sdkv=aa.4.0.0&bldv=aa.4.0.0.4&nuid=00b5926fea1807638ebfe6f04af6a455c5d9b2a1ed3e39f550f44daa39d0886d&osver=ANDROID.4.4.4&devtypid=samsung-SAMSUNG-SM-N910A&devid=42ec6a26b000ccd34015ba8625ee29cd283190a8c00f1622f356e900bb5b2a23&enc=true&tz=-14400&fmt=json&adf=&uoo=false&sfcode=dcr&ccode=&dma=539&rnd=1434633027479</code>
*Watch any video content for at least three minutes and V/D pings – '''view''' and '''duration''' pings will be visible.

Digital Measurement Testing

2017-10-26T09:10:56Z

MagdalenaKostulska: /* Step 6: Video View Ping */

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

== Monitoring Tools ==
HTTP traffic-monitoring tool, such as Charles or Fiddler are required.
*'''Charles:''' http://www.charlesproxy.com
*'''Fiddler:''' http://www.telerik.com/fiddler

== Step 1: Filter traffic ==
Filter HTTP traffic with the string "imr" to capture traffic from the SDK as shown in the below figure. This will capture traffic going to Nielsen servers. Now set up the device to proxy to this traffic analyzer.
<blockquote>'''Note:''' Instructions may vary from device to device and are available online.</blockquote>
[[File:fiddler-web-debugger.png|link=]]

== Step 2: Check Opt-Out ==
If the opt-out function or app disable feature is previously tested, it has to be ensured that an opt-in is completed on the device before continuing. Terminate the app completely before starting.

== Step 3: Hello Ping ==
The first HTTPS traffic that should be seen is the SDK request for configuration information, called a '''hello ping'''. In order to see this ping, Charles / Fiddler has to be configured to capture HTTPS traffic.

<code><nowiki>https://secure-dcr.imrworldwide.com/cgi-bin/cfg?cfgv=100&longitude=-82.66&latitude=28.05&apid=&apv=3.84.043&apn=com.video.videop
layer&sdkv=aa .1.2.3&nuid=7B341CD-5109-B88-B77D-8ADE904717A7&osver=ANDROID.4.2.2&devtypid=LGE-Nexus-4&devid=FFA503E7-
7749-4448-9922-132492ED4E12&fmt=json&adf=&uoo=&sfcode=dcr&ccode=1&dma=&rnd=1527112029</nowiki></code>
<blockquote>'''Note:''' If this ping fails to fire, it is likely that the instance of the SDK failed to initialize. Please see Initialization ([[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] and [[Android SDK API Reference#Initialization|Android SDK API Reference - Initialization]]) to see how to initialize the SDK.</blockquote>

== Step 4: The L Ping ==
When the app is started after installing for the first time, and app is measuring '''DCR Static''' content only, a DCR static app launch known as '''L''' ping firing to secure-dcr.imrworldwide.com server in the traffic-monitor should be seen. However, the '''L''' ping will be observed again if app goes into background and resumes back after 5 minutes.

<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr&ci=APRP7&ch=APRP7_NA_defChnAsset&asn=defChnAsset&tl=&c6=vc,NA&c13=asid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c32=segA,&c33=segB,&c34=segC,&c15=apn,MTVR-APT-QA&sup=0&segment2=539&segment1=usa&forward=1&ad=1&cr=L&c9=devid,a69983bc65ad94f9e57109fec68cc847bf59575ee03cadb76b187f4c24eaf793&enc=true&c1=nuid,142a40706f9c03bfea020f7297828534a1f14895d7a8c5303d9b8a19b3337c13&r=&at=launch&rt=text&c16=sdkv ,aa.4.0.0&c27=cln,473&crs=0&si=&lat=28.09&lon=-82.76&c29=plid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c30=bldv,aa.4.0.0.3&st=dcr&c7=osgrp,DROID&c8=devgrp,TAB&c10=plt,MBL&c40=adbid,&c14=osver,ANDROID.4.4.4&c26=1&c35=&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,apt.4.0.0.3&h33=2&c51=adl,0&c52=noad,0&devtypid=asus-Nexus-7&rnd=1432529128693</code>

If the app is measuring '''DCR Video Content''' only, then the '''hello ping''' will fire but the '''L''' ping will not be observed upon app launch.

== Step 5: Static View Ping ==
For any sections that are tagged for static content, a '''DCR Static – view''' ping should be received. The first landing page should always be tagged. An example of this ping is:

<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr&ci=APRP7&ch=APRP7_NA_defChnAsset&asn=defChnAsset&tl=&c6=vc,NA&c13=asid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c32=segA,&c33=segB,&c34=segC,&c15=apn,MTVR-APT-QA&sup=0&segment2=539&segment1=usa&forward=1&ad=1&cr=V&c9=devid,a69983bc65ad94f9e57109fec68cc847bf59575ee03cadb76b187f4c24eaf793&enc=true&c1=nuid,142a40706f9c03bfea020f7297828534a1f14895d7a8c5303d9b8a19b3337c13&r=&at=view&rt=text&c16=sdkv,a a.4.0.0&c27=cln,0&crs=0&si=&lat=&lon=&c29=plid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c30=bldv,aa.4.0.0.1&st=dcr&c7=osgrp,DROID&c8=devgrp,TAB&c10=plt,MBL&c40=adbid,&c14=osver,ANDROID.4.4.4&c26=1&c35=&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,apt.4.0.0.2&h33=2&c51=adl,0&c52=noad,0&devtypid=asus-Nexus-7&rnd=1432068181560</code>
{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || us-123456
|-
| asn || Asset Name – this value should represent the asset’s name assigned in the metadata. || Page-Asset
|-
| at || Action Type || Start
|-
| rt || This value should be “text” and indicates that this is a DCR tag for static content. || text
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| c32 || Segment A – Client customized metadata || CustomSegmentValueA
|-
| c33 || Segment B – Client customized metadata || CustomSegmentValueB
|-
| c34 || Segment C – Client customized metadata || CustomSegmentValueC
|}

== Step 6: Video View Ping ==
Approximately 60 seconds into viewing of the stream, a '''DCR Video – view''' ping fire to secure-dcr.imrworldwide.com server indicated by the '''cr''' value containing a '''V''' in the format of 4_00_99_'''V'''1_00000 should be seen.

{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || us-123456
|-
| asn || Asset Name – this value should represent asset’s name assigned in the metadata. || Video-Asset
|-
| tl || Episode Title || Episode Name – S2 – E1 – LF
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| cr || Crediting Ping Identifier || 4_00_99_V1_00000
|-
| rt || This Value should be “video” and indicates that this is a DCR tag for video content. || video
|-
| c10 || Platform Indicator || plt,DSK or plt,MBL
|}
<blockquote>'''Note:''' If this ping fails to fire, a common cause is improper metadata being passed to the SDK. Examples of the proper metadata to be passed in the </code>loadMetadata</code></blockquote>

== Step 7: Video Duration Ping ==
The first duration ping is fired after 5 minutes of content is viewed. A '''DCR Video''' – duration ping fire to secure-dcr.imrworldwide.com indicated by the '''cr''' value containing a '''D''' in the format of 4_00_99_'''D'''1_11111 should be seen. This D ping should fire approximately every 5 minutes after the initial duration ping has fired or when the content switches to an advertisement. The ad length (c51) is the total ad duration viewed in the previous session, and the ad count (c52) is the number of ads viewed in previous segment.
{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || APRP7
|-
| asn || Asset Name – this value should represent asset’s name assigned in the metadata. || Video-Asset
|-
| tl || Episode Title || Episode Name – S2 – E1 – LF
|-
| cr || Crediting Ping Identifier || 4_00_99_V1_00000
|-
| rt || This Value should be “video” and indicates that this is a DCR tag for video content. || video
|-
| c10 || Platform Indicator || plt,DSK or plt,MBL
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| c51 || Ad Duration || adl,88
|-
| c52 || Ad Count || noad,1
|}
<blockquote>'''Note:''' If this ping fails to fire, it may be caused by not passing the setPlayheadPosition API call as expected. The instruction as well as examples can be found in the Developer’s Guide.</code></blockquote>

== Step 8: 5min Duration Ping ==
View all channels for 5 minutes to ensure all channels fire a '''duration''' ping.

== Step 9: Pending Duration Ping ==
Play a stream and move the app to the background. A pending '''duration''' ping should fire; crediting the appropriate number of minutes viewed from last ping (i.e. 4_00_99_D1_'''111'''00). No other pings should fire after it has been moved to the background. In case SDK does not get a chance to send out the ping while going to background, SDK will send the pending ping on next re-launch.

== Step 10: Pending Duration Pings cont. ==
The same action will occur with any interruption to the stream’s playback (e.g., alarm, incoming call, etc.).

== Step 11: Opt-Out Implementation ==
Test the Opt-Out implementation in four steps.
*Complete an opt-out in the app through the Nielsen opt-out webview.
*User opt-out, a '''goodbye ping''' is fired off to the Nielsen server. '''Example Goodbye Ping''':
<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/cfg?cfgv=200&longitude=&latitude=&apid=&apv=01.00.00&apn=Nielsen%2520sample&sdkv=aa.4.0.0&bldv=aa.4.0.0.4&nuid=00b5926fea1807638ebfe6f04af6a455c5d9b2a1ed3e39f550f44daa39d0886d&osver=ANDROID.4.4.4&devtypid=samsung-SAMSUNG-SM-N910A&devid=42ec6a26b000ccd34015ba8625ee29cd283190a8c00f1622f356e900bb5b2a23&enc=true&tz=-14400&fmt=json&adf=&uoo=true&sfcode=dcr&ccode=&dma=539&rnd=1434632964945</code>
*Watch any content (static or video) for at least three minutes. No pings will be rendered.
*Opt back in, a '''hello ping''' is fired off to the Nielsen server. ''Example Hello Ping'':
<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/cfg?cfgv=200&longitude=-82.65&latitude=28.05&apid=&apv=01.00.00&apn=Nielsen%2520sample&sdkv=aa.4.0.0&bldv=aa.4.0.0.4&nuid=00b5926fea1807638ebfe6f04af6a455c5d9b2a1ed3e39f550f44daa39d0886d&osver=ANDROID.4.4.4&devtypid=samsung-SAMSUNG-SM-N910A&devid=42ec6a26b000ccd34015ba8625ee29cd283190a8c00f1622f356e900bb5b2a23&enc=true&tz=-14400&fmt=json&adf=&uoo=false&sfcode=dcr&ccode=&dma=539&rnd=1434633027479</code>
*Watch any video content for at least three minutes and V/D pings – '''view''' and '''duration''' pings will be visible.

Digital Measurement Testing

2017-10-26T09:10:25Z

MagdalenaKostulska: /* Step 5: Static View Ping */

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

== Monitoring Tools ==
HTTP traffic-monitoring tool, such as Charles or Fiddler are required.
*'''Charles:''' http://www.charlesproxy.com
*'''Fiddler:''' http://www.telerik.com/fiddler

== Step 1: Filter traffic ==
Filter HTTP traffic with the string "imr" to capture traffic from the SDK as shown in the below figure. This will capture traffic going to Nielsen servers. Now set up the device to proxy to this traffic analyzer.
<blockquote>'''Note:''' Instructions may vary from device to device and are available online.</blockquote>
[[File:fiddler-web-debugger.png|link=]]

== Step 2: Check Opt-Out ==
If the opt-out function or app disable feature is previously tested, it has to be ensured that an opt-in is completed on the device before continuing. Terminate the app completely before starting.

== Step 3: Hello Ping ==
The first HTTPS traffic that should be seen is the SDK request for configuration information, called a '''hello ping'''. In order to see this ping, Charles / Fiddler has to be configured to capture HTTPS traffic.

<code><nowiki>https://secure-dcr.imrworldwide.com/cgi-bin/cfg?cfgv=100&longitude=-82.66&latitude=28.05&apid=&apv=3.84.043&apn=com.video.videop
layer&sdkv=aa .1.2.3&nuid=7B341CD-5109-B88-B77D-8ADE904717A7&osver=ANDROID.4.2.2&devtypid=LGE-Nexus-4&devid=FFA503E7-
7749-4448-9922-132492ED4E12&fmt=json&adf=&uoo=&sfcode=dcr&ccode=1&dma=&rnd=1527112029</nowiki></code>
<blockquote>'''Note:''' If this ping fails to fire, it is likely that the instance of the SDK failed to initialize. Please see Initialization ([[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] and [[Android SDK API Reference#Initialization|Android SDK API Reference - Initialization]]) to see how to initialize the SDK.</blockquote>

== Step 4: The L Ping ==
When the app is started after installing for the first time, and app is measuring '''DCR Static''' content only, a DCR static app launch known as '''L''' ping firing to secure-dcr.imrworldwide.com server in the traffic-monitor should be seen. However, the '''L''' ping will be observed again if app goes into background and resumes back after 5 minutes.

<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr&ci=APRP7&ch=APRP7_NA_defChnAsset&asn=defChnAsset&tl=&c6=vc,NA&c13=asid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c32=segA,&c33=segB,&c34=segC,&c15=apn,MTVR-APT-QA&sup=0&segment2=539&segment1=usa&forward=1&ad=1&cr=L&c9=devid,a69983bc65ad94f9e57109fec68cc847bf59575ee03cadb76b187f4c24eaf793&enc=true&c1=nuid,142a40706f9c03bfea020f7297828534a1f14895d7a8c5303d9b8a19b3337c13&r=&at=launch&rt=text&c16=sdkv ,aa.4.0.0&c27=cln,473&crs=0&si=&lat=28.09&lon=-82.76&c29=plid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c30=bldv,aa.4.0.0.3&st=dcr&c7=osgrp,DROID&c8=devgrp,TAB&c10=plt,MBL&c40=adbid,&c14=osver,ANDROID.4.4.4&c26=1&c35=&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,apt.4.0.0.3&h33=2&c51=adl,0&c52=noad,0&devtypid=asus-Nexus-7&rnd=1432529128693</code>

If the app is measuring '''DCR Video Content''' only, then the '''hello ping''' will fire but the '''L''' ping will not be observed upon app launch.

== Step 5: Static View Ping ==
For any sections that are tagged for static content, a '''DCR Static – view''' ping should be received. The first landing page should always be tagged. An example of this ping is:

<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr&ci=APRP7&ch=APRP7_NA_defChnAsset&asn=defChnAsset&tl=&c6=vc,NA&c13=asid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c32=segA,&c33=segB,&c34=segC,&c15=apn,MTVR-APT-QA&sup=0&segment2=539&segment1=usa&forward=1&ad=1&cr=V&c9=devid,a69983bc65ad94f9e57109fec68cc847bf59575ee03cadb76b187f4c24eaf793&enc=true&c1=nuid,142a40706f9c03bfea020f7297828534a1f14895d7a8c5303d9b8a19b3337c13&r=&at=view&rt=text&c16=sdkv,a a.4.0.0&c27=cln,0&crs=0&si=&lat=&lon=&c29=plid,XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c30=bldv,aa.4.0.0.1&st=dcr&c7=osgrp,DROID&c8=devgrp,TAB&c10=plt,MBL&c40=adbid,&c14=osver,ANDROID.4.4.4&c26=1&c35=&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,apt.4.0.0.2&h33=2&c51=adl,0&c52=noad,0&devtypid=asus-Nexus-7&rnd=1432068181560</code>
{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || us-123456
|-
| asn || Asset Name – this value should represent the asset’s name assigned in the metadata. || Page-Asset
|-
| at || Action Type || Start
|-
| rt || This value should be “text” and indicates that this is a DCR tag for static content. || text
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| c32 || Segment A – Client customized metadata || CustomSegmentValueA
|-
| c33 || Segment B – Client customized metadata || CustomSegmentValueB
|-
| c34 || Segment C – Client customized metadata || CustomSegmentValueC
|}

== Step 6: Video View Ping ==
Approximately 60 seconds into viewing of the stream, a '''DCR Video – view''' ping fire to secure-dcr.imrworldwide.com server indicated by the '''cr''' value containing a '''V''' in the format of 4_00_99_'''V'''1_00000 should be seen.

{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || APRP7
|-
| asn || Asset Name – this value should represent asset’s name assigned in the metadata. || Video-Asset
|-
| tl || Episode Title || Episode Name – S2 – E1 – LF
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| cr || Crediting Ping Identifier || 4_00_99_V1_00000
|-
| rt || This Value should be “video” and indicates that this is a DCR tag for video content. || video
|-
| c10 || Platform Indicator || plt,DSK or plt,MBL
|}
<blockquote>'''Note:''' If this ping fails to fire, a common cause is improper metadata being passed to the SDK. Examples of the proper metadata to be passed in the </code>loadMetadata</code></blockquote>

== Step 7: Video Duration Ping ==
The first duration ping is fired after 5 minutes of content is viewed. A '''DCR Video''' – duration ping fire to secure-dcr.imrworldwide.com indicated by the '''cr''' value containing a '''D''' in the format of 4_00_99_'''D'''1_11111 should be seen. This D ping should fire approximately every 5 minutes after the initial duration ping has fired or when the content switches to an advertisement. The ad length (c51) is the total ad duration viewed in the previous session, and the ad count (c52) is the number of ads viewed in previous segment.
{| class="wikitable"
|-
! Parameter !! Description !! Example
|-
| ci || Client ID – this value should be consistent throughout all of the pings that fire for the implementation. || APRP7
|-
| asn || Asset Name – this value should represent asset’s name assigned in the metadata. || Video-Asset
|-
| tl || Episode Title || Episode Name – S2 – E1 – LF
|-
| cr || Crediting Ping Identifier || 4_00_99_V1_00000
|-
| rt || This Value should be “video” and indicates that this is a DCR tag for video content. || video
|-
| c10 || Platform Indicator || plt,DSK or plt,MBL
|-
| c13 || This value should contain the appid of the application. || asid,XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| c51 || Ad Duration || adl,88
|-
| c52 || Ad Count || noad,1
|}
<blockquote>'''Note:''' If this ping fails to fire, it may be caused by not passing the setPlayheadPosition API call as expected. The instruction as well as examples can be found in the Developer’s Guide.</code></blockquote>

== Step 8: 5min Duration Ping ==
View all channels for 5 minutes to ensure all channels fire a '''duration''' ping.

== Step 9: Pending Duration Ping ==
Play a stream and move the app to the background. A pending '''duration''' ping should fire; crediting the appropriate number of minutes viewed from last ping (i.e. 4_00_99_D1_'''111'''00). No other pings should fire after it has been moved to the background. In case SDK does not get a chance to send out the ping while going to background, SDK will send the pending ping on next re-launch.

== Step 10: Pending Duration Pings cont. ==
The same action will occur with any interruption to the stream’s playback (e.g., alarm, incoming call, etc.).

== Step 11: Opt-Out Implementation ==
Test the Opt-Out implementation in four steps.
*Complete an opt-out in the app through the Nielsen opt-out webview.
*User opt-out, a '''goodbye ping''' is fired off to the Nielsen server. '''Example Goodbye Ping''':
<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/cfg?cfgv=200&longitude=&latitude=&apid=&apv=01.00.00&apn=Nielsen%2520sample&sdkv=aa.4.0.0&bldv=aa.4.0.0.4&nuid=00b5926fea1807638ebfe6f04af6a455c5d9b2a1ed3e39f550f44daa39d0886d&osver=ANDROID.4.4.4&devtypid=samsung-SAMSUNG-SM-N910A&devid=42ec6a26b000ccd34015ba8625ee29cd283190a8c00f1622f356e900bb5b2a23&enc=true&tz=-14400&fmt=json&adf=&uoo=true&sfcode=dcr&ccode=&dma=539&rnd=1434632964945</code>
*Watch any content (static or video) for at least three minutes. No pings will be rendered.
*Opt back in, a '''hello ping''' is fired off to the Nielsen server. ''Example Hello Ping'':
<code><nowiki>http://secure-dcr.imrworldwide.com</nowiki>/cgi-bin/cfg?cfgv=200&longitude=-82.65&latitude=28.05&apid=&apv=01.00.00&apn=Nielsen%2520sample&sdkv=aa.4.0.0&bldv=aa.4.0.0.4&nuid=00b5926fea1807638ebfe6f04af6a455c5d9b2a1ed3e39f550f44daa39d0886d&osver=ANDROID.4.4.4&devtypid=samsung-SAMSUNG-SM-N910A&devid=42ec6a26b000ccd34015ba8625ee29cd283190a8c00f1622f356e900bb5b2a23&enc=true&tz=-14400&fmt=json&adf=&uoo=false&sfcode=dcr&ccode=&dma=539&rnd=1434633027479</code>
*Watch any video content for at least three minutes and V/D pings – '''view''' and '''duration''' pings will be visible.

Browser SDK API Reference

2017-10-24T11:37:27Z

MagdalenaKostulska: /* Step 1: Configure Content Management System (CMS) */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Setting up Development Environment ==
=== Step 1: Configure Content Management System (CMS) ===
Configure CMS to send the required values (see table below). Any internal CMS_variable names can be used for passing the data.

Ensure to capture these CMS_variable names in the SDK Configuration Form.

For more information on setting variable names, see the SDK Configuration Form included within the SDK package.

{| class="wikitable"
|-
! Required Data !! Description !! Value
|-
| dataSrc || Used when both CMS metadata and ID3 data are present in the player. Setting this field tells the SDK whether to use the CMS metadata or the ID3 payload to derive the pings || cms
|-
| type || Type of asset: ad or content || preroll, midroll, postroll, or content
|-
| assetid || unique ID assigned to asset || custom
|-
| OCR Tag || OCR tag provided by Nielsen for implementation on the ad unit || Complete OCR URL
|-
| program || Name of program (25 character limit) || custom
|-
| title || Episode title (40 character limit) || custom
|-
| length || Length of content in seconds || Length in seconds, 86400 for live stream
|-
| adloadtype || Type of ad load || "1" - Linear "2" - Dynamic(default)
|-
| hasAds || Identify if content includes Ads || "0" - no ads "1" - includes ads "2" - unknown(default)
|-
| isfullepisode || Full episode flag || "y" - full episode "n" - non full episode
|-
| segA || Segment A (this is not available for video reporting as the episode title is reported) || custom value
|-
| segB || Custom segment B || custom value
|-
| segC || Custom segment C || custom value
|-
| crossId1 || Standard episode ID || custom value
|-
| crossId2 || Content originator (required only for distributors) || custom value
|-
| airdate || Original air date and time in Eastern Time. For non-US countries, it should be local time. || YYYYMMDD HH24:MI:SS
|}

==== Content Management System for Digital Audio ====
Digital Audio measurement is for digital-only audio content. For Digital Audio, clients should provide the parameters shown in CMS Table for Digital Audio.
{| class="wikitable"
|-
! Required Data !! Description !! Value
|-
| dataSrc ** || Source of the data. For Digital Audio, pass dataSrc as “cms”. || cms
|-
| type || Type of content . For Digital Audio, set type as “radio”. || radio
|-
| assetid || Station identifier, should include call letters and band. || WXYZ-FM
|-
| stationType || OTA station flag and / or OTA station type
*0: Custom station built per user
*1: OTA streaming station with the same ad load
*2: OTA station with a different ad load
*3: Multicast eRadio or online station
*4: On Demand Audio (podcasting)
|| 0, 1, 2, 3, or 4
|-
| provider || Name of Provider || XYZ Provider
|}

=== Step 2: Complete the Nielsen SDK Configuration Form ===
The SDK is designed to map the <code>CMS_variable names</code>. To support the custom mapping, the developer is required to complete the SDK Configuration Form. The form will be provided during onboarding along with this guide.

== Initialization ==
=== Obtain the Nielsen Application ID (apid) and Browser SDK URLs ===
The Nielsen <code>apid</code> is required to enable SDK functionality. Technical Account Manager will provide an apid for each player configuration.
Browser SDK can support URLs that use any of the protocols – HTTPS and HTTP.

=== Configure Browser SDK ===
There are two steps required for configuring the SDK:

'''Add Static Queue Snippet'''

*Add Static Queue Snippet
*Create SDK Instance

Add the following script tag to the website:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script>

</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

'''Create SDK Instance'''

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})

</syntaxhighlight>

When creating an instance, pass the following three values:

=== SDK Initialization – Global Parameters ===
{| class="wikitable"
|-
! Parameters !! Description !! Value
|-
| apid || UniqueID assigned to player/site. || 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
| instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}

'''Example SDK Initialization'''
<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});

</syntaxhighlight>

<blockquote>'''Note:''' The debug parameter, <code>nol_sdkDebug</code>, is only used for testing and should be removed before moving to production. The output is displayed in console debuggers when enabled.</code>.</blockquote>

When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

'''Example SDK Configuration'''
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

<script type="text/javascript">
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>

</syntaxhighlight>

== Browser SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Method / Property !! Event # !! DTVR !! DAR !! Digital Audio !! DCR !! International (Germany) !! Description
|-
| [[loadMetadata (Browser)]] || 3 || ✔ || ✔ || ✔ || ✔ || ✔ || Used when there is a preroll ad that needs to be associated with content metadata. The loadMetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad.
|-
| [[play (Browser)]] || 5 || ✔ || ✘ || ✘ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. When the client passes in the channelName, they can change the CMS data stored by passing new values. If this event is not called then the “channel name” value populated will be the default value of “defaultChannelName”.

'''VA Beacon:''' Called when content or ads start playing. The playhead position must be passed.
|-
| [[sendID3 (Browser)]] || 55 || ✔ || ✘ || ✘ || ✘ || ✘ || Used to send the ID3 metadata.
|-
| [[setPlayheadPosition (Browser)]] || 49 || ✘ || ✘ || ✔ || ✔ || ✔ || Used to send the playhead position.
|-
| [[stop (Browser)]] || 7 || ✘ || ✘ || ✘ || ✔ || ✔ || Used when switching between ad and content or content and ad.
|-
| [[end (Browser)]] || 57 || ✔ || ✘ || ✔ || ✔ || ✔ || This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content 3) when the browser is refreshed or closed
|-
| [[staticstart (Browser)]] || 14 || ✘ || ✘ || ✘ || ✔ || ✔ || Used to send the metadata for the static page.
|-
| [[getOptOutStatus (Browser)]] || 4 || ✘ || ✘ || ✘ || ✘ || ✔ || '''VA Beacon Only:''' Sent only after calling stop. The current position must be passed. Not needed for new International (Germany) implementations.
|-
| [[updateOTT (Browser)]] || - || ✘ || ✘ || ✘ || ✘ || ✔ || Used to notify Browser SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| [[ onPaginate (Browser)]] || 30 || ✘ || ✘ || ✘ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| [[updateMetadata (Browser)]] || 35 || ✔ || ✔ || ✔ || ✔ || ✔ || This event is used for updating metadata parameters for the content or ad that is being played.
|}

== Retrieving ID3 Tags ==
The video player must have the ability to extract ID3 tags and supply them to the Browser SDK, based on the HLS standard.
*An ID3 tag spans two PES packets.
**In the first PES packet, look for www.nielsen.com, this is the start of the ID3 tag. Continue to parse the first PES packet until the undefined char "\ufffd" is found. This forms the first half of the ID3 tag
**In the second PES packet, identify the end pattern – a regEx of /(\/\d+){3}/ and look to remove the lowest index of either "\x00" and/or "\ufffd". Now the second packet has been appended and the demarcation of the Nielsen-specific data has been defined.

Follow the procedure below, to extract Nielsen ID3 tags from an MPEG-2 transport stream (including HLS streams).
#Parse the Program Map Table (PMT) to find the PID of the metadata stream. Confirm the presence of the metadata descriptor described in section 2.3.3 of Apple’s “HTTP Live Streaming Metadata Spec.pdf”. Only private streams with metadata descriptor present should be considered as ID3-tag metadata streams.
#Parse the HLS/Transport stream for any '''PES header''' with the PID found in step 1.
#Follow standard MPEG-2 parsing procedures to locate the start of the payload of the PES packet.
#Copy the PES payload into a buffer.
#The ID3 tag spans 2 PES packets. Parse the stream for the next packet whose PID is set to the PID found in step 1. Typically the ID3 Tag is of 249 bytes. The steps below guide towards extraction of the ID3 tag
##In the first PES packet, look for "www.nielsen.com" , this is the start of the ID3 tag. Keep on parsing the first PES packet until the undefined char "\ufffd" is found. This forms the first half of the ID3 tag
##In the second PES packet, identify the end pattern, a regEx of /(\/\d+){3}/ and look to remove the lowest index of either “\x00” and/or “\ufffd”. Now the second packet has been appended and the demarcation of the Nielsen specific data has been defined. This segment can be simply substringed.
##Concatenate this substringed segment with the payload derived from the first packet get the ID3 payload.
#Check the length of the contents in the buffer to make sure that it is equal to the size of a Nielsen ID3 tag.
#Ensure that the ID3 byte array is converted into the string and escape it, so that the SDK can consume it.
Repeat steps 2 through 7 for all ID3 tags in the stream.

'''References'''
*[http://www.iso.org/iso/catalogue_detail?csnumber=44169. ISO/IEC 13818-1:2007] Information technology – Generic coding of moving pictures and associated audio information: Systems
*https://developer.apple.com/library/ios/sdk/developers/AudioVideo/Conceptual/HTTP_Live_Streaming_Metadata_Spec/HTTP_Live_Streaming_Metadata_Spec.pdf

=== Sample ID3 tags ===
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</code>
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</code>
<blockquote>'''Note''': ID3 tags are not applicable for International (Germany)</blockquote>

== Browser Opt-Out Implementation ==
The site in which video content is being measure via Nielsen methodology must provide the means for the user to opt-out of, or opt back into Nielsen Measurement.

For Browser-based applications, opt-out setting is stored via Nielsen cookie. Therefore, it is only necessary that users be made aware of measurement opt-out by incorporating the template below in the user interface.

=== Sample Opt Out Template ===
Our properties may feature Nielsen’s proprietary measurement software which will allow to contribute to market research, like Nielsen’s TV Ratings. To learn more about this information, see http://www.nielsen.com/digitalprivacy. Nielsen’s software may collect your choices with regards to it.

== Nielsen Privacy Requirements ==
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in app store description
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="7" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Cache Buster || Yes || Yes
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd&placement_id=a4164b8fba9ee7c873a9c72c7091bb58&creative_id=25280139b61a947e127a52f56c8a2fdd&segment1=9000&segment2=41&segment3=iOS&OSVer=iOS6.1&c9=&devgrp=tablet&h=f5f243fe6d&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

=== Nielsen Measurement Opt-Out ===
The site must provide a means for the user to opt‐out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt‐out option, it is mandatory to include the following two items in the site’s privacy policy
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy
On the Nielsen Digital Measurement Privacy Policy page, users can click '''Choices''' to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement

<blockquote>Our properties may feature Nielsen proprietary measurement software, which will allow you to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, refer to Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.</blockquote>

For information, please see Opt-Out Implementation below.

=== Opt-Out Implementation ===
The site must provide the means for the user to opt-out of, or opt back into Nielsen Measurement.

'''Sample Opt Out Template'''

Our properties may feature Nielsen’s proprietary measurement software which will allow to contribute to market research, like Nielsen’s TV Ratings. To learn more about this information, please [http://www.nielsen.com/digitalprivacy| click here]. Nielsen’s software may collect your choices with regards to it.

== Testing ==
See [[Digital Measurement Testing#Testing Browser Implementation|Digital Measurement Testing - Testing Browser Implementation]].

Browser SDK API Reference

2017-10-24T11:36:40Z

MagdalenaKostulska: /* Step 1: Configure Content Management System (CMS) */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Setting up Development Environment ==
=== Step 1: Configure Content Management System (CMS) ===
Configure CMS to send the required values (see table below). Any internal CMS_variable names can be used for passing the data.

Ensure to capture these CMS_variable names in the SDK Configuration Form.

For more information on setting variable names, see the SDK Configuration Form included within the SDK package.

{| class="wikitable"
|-
! Required Data !! Description !! Value
|-
| dataSrc || Used when both CMS metadata and ID3 data are present in the player. Setting this field tells the SDK whether to use the CMS metadata or the ID3 payload to derive the pings || cms
|-
| type || Type of asset: ad or content || preroll, midroll, postroll, or content
|-
| assetid || unique ID assigned to asset || custom
|-
| OCR Tag || OCR tag provided by Nielsen for implementation on the ad unit || Complete OCR URL
|-
| program || Name of program (25 character limit) || custom
|-
| title || Episode title (40 character limit) || custom
|-
| length || Length of content in seconds || Length in seconds, 86400 for live stream
|-
| adloadtype || Type of ad load || "1" - Linear "2" Dynamic(default)
|-
| hasAds || Identify if content includes Ads || "0" - no ads "1" - includes ads "2" - unknown(default)
|-
| isfullepisode || Full episode flag || "y" - full episode "n" - non full episode
|-
| segA || Segment A (this is not available for video reporting as the episode title is reported) || custom value
|-
| segB || Custom segment B || custom value
|-
| segC || Custom segment C || custom value
|-
| crossId1 || Standard episode ID || custom value
|-
| crossId2 || Content originator (required only for distributors) || custom value
|-
| airdate || Original air date and time in Eastern Time. For non-US countries, it should be local time. || YYYYMMDD HH24:MI:SS
|}

==== Content Management System for Digital Audio ====
Digital Audio measurement is for digital-only audio content. For Digital Audio, clients should provide the parameters shown in CMS Table for Digital Audio.
{| class="wikitable"
|-
! Required Data !! Description !! Value
|-
| dataSrc ** || Source of the data. For Digital Audio, pass dataSrc as “cms”. || cms
|-
| type || Type of content . For Digital Audio, set type as “radio”. || radio
|-
| assetid || Station identifier, should include call letters and band. || WXYZ-FM
|-
| stationType || OTA station flag and / or OTA station type
*0: Custom station built per user
*1: OTA streaming station with the same ad load
*2: OTA station with a different ad load
*3: Multicast eRadio or online station
*4: On Demand Audio (podcasting)
|| 0, 1, 2, 3, or 4
|-
| provider || Name of Provider || XYZ Provider
|}

=== Step 2: Complete the Nielsen SDK Configuration Form ===
The SDK is designed to map the <code>CMS_variable names</code>. To support the custom mapping, the developer is required to complete the SDK Configuration Form. The form will be provided during onboarding along with this guide.

== Initialization ==
=== Obtain the Nielsen Application ID (apid) and Browser SDK URLs ===
The Nielsen <code>apid</code> is required to enable SDK functionality. Technical Account Manager will provide an apid for each player configuration.
Browser SDK can support URLs that use any of the protocols – HTTPS and HTTP.

=== Configure Browser SDK ===
There are two steps required for configuring the SDK:

'''Add Static Queue Snippet'''

*Add Static Queue Snippet
*Create SDK Instance

Add the following script tag to the website:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script>

</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

'''Create SDK Instance'''

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})

</syntaxhighlight>

When creating an instance, pass the following three values:

=== SDK Initialization – Global Parameters ===
{| class="wikitable"
|-
! Parameters !! Description !! Value
|-
| apid || UniqueID assigned to player/site. || 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
| instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}

'''Example SDK Initialization'''
<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});

</syntaxhighlight>

<blockquote>'''Note:''' The debug parameter, <code>nol_sdkDebug</code>, is only used for testing and should be removed before moving to production. The output is displayed in console debuggers when enabled.</code>.</blockquote>

When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

'''Example SDK Configuration'''
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

<script type="text/javascript">
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>

</syntaxhighlight>

== Browser SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Method / Property !! Event # !! DTVR !! DAR !! Digital Audio !! DCR !! International (Germany) !! Description
|-
| [[loadMetadata (Browser)]] || 3 || ✔ || ✔ || ✔ || ✔ || ✔ || Used when there is a preroll ad that needs to be associated with content metadata. The loadMetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad.
|-
| [[play (Browser)]] || 5 || ✔ || ✘ || ✘ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. When the client passes in the channelName, they can change the CMS data stored by passing new values. If this event is not called then the “channel name” value populated will be the default value of “defaultChannelName”.

'''VA Beacon:''' Called when content or ads start playing. The playhead position must be passed.
|-
| [[sendID3 (Browser)]] || 55 || ✔ || ✘ || ✘ || ✘ || ✘ || Used to send the ID3 metadata.
|-
| [[setPlayheadPosition (Browser)]] || 49 || ✘ || ✘ || ✔ || ✔ || ✔ || Used to send the playhead position.
|-
| [[stop (Browser)]] || 7 || ✘ || ✘ || ✘ || ✔ || ✔ || Used when switching between ad and content or content and ad.
|-
| [[end (Browser)]] || 57 || ✔ || ✘ || ✔ || ✔ || ✔ || This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content 3) when the browser is refreshed or closed
|-
| [[staticstart (Browser)]] || 14 || ✘ || ✘ || ✘ || ✔ || ✔ || Used to send the metadata for the static page.
|-
| [[getOptOutStatus (Browser)]] || 4 || ✘ || ✘ || ✘ || ✘ || ✔ || '''VA Beacon Only:''' Sent only after calling stop. The current position must be passed. Not needed for new International (Germany) implementations.
|-
| [[updateOTT (Browser)]] || - || ✘ || ✘ || ✘ || ✘ || ✔ || Used to notify Browser SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| [[ onPaginate (Browser)]] || 30 || ✘ || ✘ || ✘ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| [[updateMetadata (Browser)]] || 35 || ✔ || ✔ || ✔ || ✔ || ✔ || This event is used for updating metadata parameters for the content or ad that is being played.
|}

== Retrieving ID3 Tags ==
The video player must have the ability to extract ID3 tags and supply them to the Browser SDK, based on the HLS standard.
*An ID3 tag spans two PES packets.
**In the first PES packet, look for www.nielsen.com, this is the start of the ID3 tag. Continue to parse the first PES packet until the undefined char "\ufffd" is found. This forms the first half of the ID3 tag
**In the second PES packet, identify the end pattern – a regEx of /(\/\d+){3}/ and look to remove the lowest index of either "\x00" and/or "\ufffd". Now the second packet has been appended and the demarcation of the Nielsen-specific data has been defined.

Follow the procedure below, to extract Nielsen ID3 tags from an MPEG-2 transport stream (including HLS streams).
#Parse the Program Map Table (PMT) to find the PID of the metadata stream. Confirm the presence of the metadata descriptor described in section 2.3.3 of Apple’s “HTTP Live Streaming Metadata Spec.pdf”. Only private streams with metadata descriptor present should be considered as ID3-tag metadata streams.
#Parse the HLS/Transport stream for any '''PES header''' with the PID found in step 1.
#Follow standard MPEG-2 parsing procedures to locate the start of the payload of the PES packet.
#Copy the PES payload into a buffer.
#The ID3 tag spans 2 PES packets. Parse the stream for the next packet whose PID is set to the PID found in step 1. Typically the ID3 Tag is of 249 bytes. The steps below guide towards extraction of the ID3 tag
##In the first PES packet, look for "www.nielsen.com" , this is the start of the ID3 tag. Keep on parsing the first PES packet until the undefined char "\ufffd" is found. This forms the first half of the ID3 tag
##In the second PES packet, identify the end pattern, a regEx of /(\/\d+){3}/ and look to remove the lowest index of either “\x00” and/or “\ufffd”. Now the second packet has been appended and the demarcation of the Nielsen specific data has been defined. This segment can be simply substringed.
##Concatenate this substringed segment with the payload derived from the first packet get the ID3 payload.
#Check the length of the contents in the buffer to make sure that it is equal to the size of a Nielsen ID3 tag.
#Ensure that the ID3 byte array is converted into the string and escape it, so that the SDK can consume it.
Repeat steps 2 through 7 for all ID3 tags in the stream.

'''References'''
*[http://www.iso.org/iso/catalogue_detail?csnumber=44169. ISO/IEC 13818-1:2007] Information technology – Generic coding of moving pictures and associated audio information: Systems
*https://developer.apple.com/library/ios/sdk/developers/AudioVideo/Conceptual/HTTP_Live_Streaming_Metadata_Spec/HTTP_Live_Streaming_Metadata_Spec.pdf

=== Sample ID3 tags ===
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</code>
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</code>
<blockquote>'''Note''': ID3 tags are not applicable for International (Germany)</blockquote>

== Browser Opt-Out Implementation ==
The site in which video content is being measure via Nielsen methodology must provide the means for the user to opt-out of, or opt back into Nielsen Measurement.

For Browser-based applications, opt-out setting is stored via Nielsen cookie. Therefore, it is only necessary that users be made aware of measurement opt-out by incorporating the template below in the user interface.

=== Sample Opt Out Template ===
Our properties may feature Nielsen’s proprietary measurement software which will allow to contribute to market research, like Nielsen’s TV Ratings. To learn more about this information, see http://www.nielsen.com/digitalprivacy. Nielsen’s software may collect your choices with regards to it.

== Nielsen Privacy Requirements ==
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in app store description
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="7" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Cache Buster || Yes || Yes
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd&placement_id=a4164b8fba9ee7c873a9c72c7091bb58&creative_id=25280139b61a947e127a52f56c8a2fdd&segment1=9000&segment2=41&segment3=iOS&OSVer=iOS6.1&c9=&devgrp=tablet&h=f5f243fe6d&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

=== Nielsen Measurement Opt-Out ===
The site must provide a means for the user to opt‐out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt‐out option, it is mandatory to include the following two items in the site’s privacy policy
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy
On the Nielsen Digital Measurement Privacy Policy page, users can click '''Choices''' to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement

<blockquote>Our properties may feature Nielsen proprietary measurement software, which will allow you to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, refer to Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.</blockquote>

For information, please see Opt-Out Implementation below.

=== Opt-Out Implementation ===
The site must provide the means for the user to opt-out of, or opt back into Nielsen Measurement.

'''Sample Opt Out Template'''

Our properties may feature Nielsen’s proprietary measurement software which will allow to contribute to market research, like Nielsen’s TV Ratings. To learn more about this information, please [http://www.nielsen.com/digitalprivacy| click here]. Nielsen’s software may collect your choices with regards to it.

== Testing ==
See [[Digital Measurement Testing#Testing Browser Implementation|Digital Measurement Testing - Testing Browser Implementation]].

DCR Static Browser SDK (6.0.0)

2017-09-11T18:31:55Z

MagdalenaKostulska: /* Prerequisites */

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

'''Prior Version Guide:''' [[DCR Static Browser SDK (5.1.1)|5.1.1]]

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>

== Implementation Steps ==
=== Add Tracking Code ===
The Nielsen DCR Tracking Code must be added to each page.
<syntaxhighlight lang="javascript"><script>
// Static Queue Snippet
!function(t,n){t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i){return s=t.document,r=s.createElement("script"),r.async=1,r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),t[n][o]=t[n][o]||{g:c||{},ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]}}}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});

// Content Metadata
var nielsenMetadata = {
type: 'static',
assetid: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: '', // *DYNAMIC METADATA*: section of site **REQUIRED**
segA: '', // *DYNAMIC METADATA*: custom segment
segB: '', // *DYNAMIC METADATA*: custom segment
segC: '' // *DYNAMIC METADATA*: custom segment
};

// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</script></syntaxhighlight>

==== Tracking Code Components ====
The tracking code includes
* Static Queue Snippet
* SDK Initialization
* Content Metadata
* staticstart Event

'''Static Queue Snippet'''

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.
<syntaxhighlight lang="javascript">
!function(t,n){t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},t[o]}
}
}
(window,"NOLBUNDLE");</syntaxhighlight>

'''SDK Initialization'''

While creating an SDK instance, initialize the SDK by calling:

'''Initialization API Call'''

<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "",{nol_sdkDebug: "debug"})</syntaxhighlight>

When the initialization call is made, a unique static config file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and cached by the client-side browser(s).

Once the static config file is downloaded, the SDK will be fully downloaded and initialized. All SDK modules are included in one file:
"nlsSDK600.bundle.min.js".

'''Content Metadata'''

Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values.

Pass dynamic metadata for the keys with the <code><metadataPlaceholder></code> value (e.g. <code>section: ''</code>).

'''staticstart Event'''

There is only one event call required:
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>

The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[Bundled_SDK_-_Static#Configure_Metadata|Step 3]].

=== Pass App ID in Initialization Call ===
Pass the unique App ID in the first parameter of the initialization call, <code><apid></code>.

'''Example SDK Initialization'''

<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});</syntaxhighlight>

The initialization call has three parameters:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site. || <code>PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX</code>
|-
| instanceName || Name of SDK instance || Any string value
|-
| nol_sdkDebug: "debug" || Enables Nielsen console logging. Only required for testing || <code>{nol_sdkDebug: "debug"}</code>
|}

Update <code><apid></code> with the AppID provided. Refer to the [[#Going_Live|Going Live]] section to know about updating the AppID to production after testing is completed.

=== Configure Metadata ===
Map the Nielsen keys to variables so that the content metadata is dynamically updated.

The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Data Type !! Value !! Required?
|-
| type || asset type || fixed || <code>'static'</code> || Yes
|-
| assetid || Unique ID for each article || dynamic || custom || Yes
|-
| section || section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values || dynamic || custom || Yes
|-
| segA || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segB || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segC || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || fixed || custom || No
|}

The values passed through the Nielsen keys will determine the breakouts that are seen in reporting. The custom segments (A, B & C) will roll into the sub-brand. To not use custom segments A, B and C, do not pass any value in these keys.

'''Aggregation Limits'''
There are limits on the number of unique values that can be aggregated on in reporting. The specific limitations by key are:
{| class="wikitable"
|-
! Key !! Aggregation Limit
|-
| section || maximum of 25 unique values (section <= 25)
|-
| segA || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segB || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segC || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement, the properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Infinite Scrolling ==

<code>onPaginate</code> will refire the view ping with the existing/original metadata.

<source lang="javascript">nSdkInstance.ggPM("onPaginate", scrolloffset);</source>
 
{|
!width="23%"| Parameter
!width="19%"| Description
|-
| event
| <code>onPaginate</code>
|-
| scrolloffset
| The <code>scrolloffset</code> value should be the y-scroll position:
|}

=== onPaginate ===

<code>onPageinate</code> is a slightly modified version of <code>staticstart</code> to enable tracking of user’s focus in pages with continuous scrolling. <code>onPaginate</code> event provides the same behavior as <code>staticstart</code> keeping it local to only clients who wish to implement continuous scrolling. (Note: This event <code>onPaginate</code> will not reset the page duration timer.)

* The maximum number of static View pings allowed per session is ‘1’. This is enforced via the <code>nol_maxPingCount</code> parameter in the tag and the cadence of impression.
* When an <code>onPaginate</code> event is called at the end of section / a focus shift (within the same page), this filter will reset the current ping count to ‘0’ for the static View ping. This change of value will cause a new View ping when the Browser SDK receives the next <code>staticPosition</code> event (at the section end). This sequence continues through the end of scrolling or till the close of static page session.

[[File:StaticPageEvent35.jpg|center|link=]]

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Video Browser SDK

2017-09-11T18:31:02Z

MagdalenaKostulska: /* Nielsen Opt-Out */

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

== Prerequisites ==
 
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

</syntaxhighlight>

== Configure SDK ==
 
There are two steps required for configuring the SDK:
 
*Add Static Queue Snippet
*Create SDK Instance
 
'''Static Queue Snippet'''
 
Add the following script tag to the website:
 
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
 
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
 
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
 
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}
 
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript"> var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
 
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
 
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
 
'''Example SDK Configuration'''
 
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
 
There are two types of asset metadata:
 
*content: identify video
*ad: identify each ad
 
The metadata received for each asset is used for classification and reporting.
 
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
 
''Content Metadata''
 
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds 86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}
 
'''Example Content Object'''
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
 
The ad metadata should be passed for each individual ad.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}
 
'''Example Ad Object'''
 
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
 
'''Call Nielsen APIs'''
 
The method for calling events is ggPM().
 
<syntaxhighlight lang="javascript">

nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
 
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
 
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
 

 
'''SDK Events'''
 
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
 
== SDK Playhead Event Sequence ==
 
The sample event lifecycle can be used as a reference for identifying the order for calling events.
 
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
 
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
 
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
 
The following paragraph is a template for an opt-out statement.
 
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
'''Opt Back In'''
 
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
 
'''Going Live'''
 
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>

DCR Video Browser SDK

2017-09-11T18:30:07Z

MagdalenaKostulska: /* Configure SDK */

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

== Prerequisites ==
 
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

</syntaxhighlight>

== Configure SDK ==
 
There are two steps required for configuring the SDK:
 
*Add Static Queue Snippet
*Create SDK Instance
 
'''Static Queue Snippet'''
 
Add the following script tag to the website:
 
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
 
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
 
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
 
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}
 
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript"> var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
 
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
 
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
 
'''Example SDK Configuration'''
 
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
 
There are two types of asset metadata:
 
*content: identify video
*ad: identify each ad
 
The metadata received for each asset is used for classification and reporting.
 
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
 
''Content Metadata''
 
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds 86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}
 
'''Example Content Object'''
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
 
The ad metadata should be passed for each individual ad.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}
 
'''Example Ad Object'''
 
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
 
'''Call Nielsen APIs'''
 
The method for calling events is ggPM().
 
<syntaxhighlight lang="javascript">

nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
 
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
 
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
 

 
'''SDK Events'''
 
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
 
== SDK Playhead Event Sequence ==
 
The sample event lifecycle can be used as a reference for identifying the order for calling events.
 
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
 
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
 
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
 
The following paragraph is a template for an opt-out statement.
 
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
'''Opt Back In'''
 
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
 
'''Going Live'''
 
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
 
Change the apid to the production ID starting with the letter 'P'.
 
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>

DCR Video Browser SDK

2017-09-11T18:29:17Z

MagdalenaKostulska: /* Prerequisites */

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

== Prerequisites ==
 
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

</syntaxhighlight>

== Configure SDK ==
 
There are two steps required for configuring the SDK:
 
*Add Static Queue Snippet
*Create SDK Instance
 
'''Static Queue Snippet'''
 
Add the following script tag to the website:
 
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("TXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
 
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
 
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
 
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'TXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}
 
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript"> var nSdkInstance = NOLBUNDLE.nlsQ("TXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
 
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
 
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
 
'''Example SDK Configuration'''
 
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
 
There are two types of asset metadata:
 
*content: identify video
*ad: identify each ad
 
The metadata received for each asset is used for classification and reporting.
 
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
 
''Content Metadata''
 
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds 86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}
 
'''Example Content Object'''
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
 
The ad metadata should be passed for each individual ad.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}
 
'''Example Ad Object'''
 
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
 
'''Call Nielsen APIs'''
 
The method for calling events is ggPM().
 
<syntaxhighlight lang="javascript">

nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
 
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
 
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
 

 
'''SDK Events'''
 
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
 
== SDK Playhead Event Sequence ==
 
The sample event lifecycle can be used as a reference for identifying the order for calling events.
 
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
 
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
 
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
 
The following paragraph is a template for an opt-out statement.
 
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
'''Opt Back In'''
 
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
 
'''Going Live'''
 
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
 
Change the apid to the production ID starting with the letter 'P'.
 
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>

DCR Italy Video Browser SDK (6.0.1)

2017-09-08T09:14:51Z

MagdalenaKostulska: /* Prerequisites */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}}
[[Category:Digital]]

This guide will show how to integrate the Nielsen Software Development Kit (SDK) to enable Digital Content Ratings (DCR) video measurement on browser players.

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="console">TXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</syntaxhighlight>

== Configure SDK ==
There are two steps required for configuring the SDK:
* Add Static Queue Snippet
* Create SDK Instance

=== Add Static Queue Snippet ===

Add the following script tag to the website:
<syntaxhighlight lang="html"><script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
</script></syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})</syntaxhighlight>

When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || <code>'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</code>
|-
| instanceName || Name of SDK instance || <code>"any string value"</code>
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || <code>"{nol_sdkDebug: "debug"})"</code>
|}

'''Example SDK Initialization'''
<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});</syntaxhighlight>

When the initialization call is made, a unique static configuration file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK601.bundle.min.js”.

=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script></syntaxhighlight>

== Create Metadata Objects ==
There are two types of asset metadata:
* content: identify video
* ad: identify each ad
The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

=== Content Metadata ===

Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required?
|-
| clientid || Brand value is automatically populated through the App ID provided. The value passed here will override the default value. (e.g. Multiple brands in App) || Nielsen provided ||
|-
| vcid || VCID value is automatically populated through the App ID provided. This value passed here will override the default value. (e.g. Multiple Sub-brands in App) || Nielsen provided ||
|-
| type ||
Type of measurement:
*video – <code>"content"</code>
|| <code>"content"</code> || ✓
|-
| assetid || Unique ID assigned to content || custom || ✓
|-
| program || Program name || custom || ✓
|-
| title || Episode title || custom || ✓
|-
| length || Length of content in seconds for VOD. The estimated content length has to be passed for live content. || <code>seconds</code> (86400 for live stream) || ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| airdate || Original (local) air date and time (Eastern Time for US) || <code>YYYYMMDD HH24:MI:SS</code> || ✓
|-
| isfullepisode || Full episode flag ||
<code>"y"</code> - full episode

<code>"n"</code> - non-full episode
|| ✓
|-
| segB || Segment B || custom ||
|-
| segC || Segment C || custom ||
|-
| crossId1 || Standard episode ID || custom || ✓
|-
| crossId2 || Content originator (required only for distributors) || Nielsen provided ||
|-
| adloadtype ||
Type of ad load:
#Linear - matches TV ad load
#Dynamic - Dynamic Ad Insertion (DAI)
|| <code>"1"</code> - Linear
<code>"2"</code> - Dynamic
|| ✓
|-
|| hasAds || Whether the content is ad supported ||
<code>"0"</code> - No Ads

<code>"1"</code> - Ad Supported

<code>"2"</code> - Unknown (default)
|| ✓
|}

'''Example Content Object'''
<syntaxhighlight lang="javascript">//create content object
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2',
hasAds: '1'
};</syntaxhighlight>

=== Ad Object ===
The ad metadata should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || <code>"preroll"</code>, <code>"midroll"</code> or <code>"postroll"</code> || ✓
|-
| assetid || uniqueID assigned to ad || <code>custom</code> || ✓
|}

'''Example Ad Object'''
<syntaxhighlight lang="javascript">//create ad object
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};</syntaxhighlight>

'''URL Character Limit:''' There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers.

== Call Nielsen APIs ==
The method for calling events is <code>ggPM()</code>.
<syntaxhighlight lang="javascript">nSdkInstance.ggPM('event', parameter, ...);</syntaxhighlight>

=== Events ===
The events are included in the table below:
{| class="wikitable"
|-
! Event Number !! Values to pass !! Description
|-
| <code>'3'</code> || content/ad metadata object || Load metadata event for content.
|-
| <code>'5'</code> || playhead position || Call when content or ads start playing.

'''VOD''': The playhead position must be passed.

'''Live''': Playhead in seconds from 1970
|-
| <code>'6'</code> || playhead position || Call when content or ads start playing.

'''VOD''': The playhead position must be passed.

'''Live''': Playhead in seconds from 1970
|-
| <code>'7'</code> || playhead position || Call when content or ads complete playing. The playhead position must be passed when calling stop
|-
| <code>'15'</code> || content/ad metadata object || Call at the beginning of each asset, don’t use ‘play’ if event 15 is used
|-
| <code>'49'</code> || playhead position || '''VOD''': current position in seconds.

'''Live''': current unix timestamp Notehas to be called on a secondly basis
|-
| <code>'57'</code> || playhead position || This event has to be called for the current video asset at the end of the playback.

'''Example''': at the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}

=== SDK Event Lifecycle ===
The sample event lifecycle can be used as a reference for identifying the order for calling events.
<syntaxhighlight lang="javascript">//Start of stream
nSdkInstance.ggPM('3', contentMetadataObject);

//Preroll
nSdkInstance.ggPM('15', prerollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // Event 49 should be fired every second with playhead starting from 0
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

//Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // Event 49 should be fired every second with playhead starting from 0 if this is the first segment
nSdkInstance.ggPM('6', contentPlayheadPosition);

//Midroll
nSdkInstance.ggPM('15', midrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // Event 49 should be fired every second with playhead starting from 0
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

//Content
nSdkInstance.ggPM('5', contentPlayheadPosition);
nSdkInstance.ggPM('49', contentPlayheadPosition); // Event 49 should be fired every second with playhead starting from where it left off before mid-roll
nSdkInstance.ggPM('6', contentPlayheadPosition);
nSdkInstance.ggPM('57', contentPlayheadPosition);

//Postroll
nSdkInstance.ggPM('15', postrollMetadataObject);
nSdkInstance.ggPM('49', individualAdPlayheadPosition); // Event 49 should be fired every second with playhead starting from 0
nSdkInstance.ggPM('7', individualAdPlayheadPosition);

//End of Stream
nSdkInstance.ggPM('7', contentPlayheadPosition);</syntaxhighlight>
<blockquote>'''Note''': Event <code>'49'</code> is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling event <code>'7'</code>, <code>'57'</code>, or <code>'15'</code>.</blockquote>
<blockquote>'''Note''': For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.</blockquote>
<blockquote>'''Note''': When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.</blockquote>

'''Handling Pause'''
The event <code>49</code> is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

'''Interruption Scenarios'''
The following possible browser interruption scenarios must be handled:
* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).
<syntaxhighlight lang="javascript">window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate for the ad
nSdkInstance.ggPM('7', playheadPosition);

// Indicate and for the content
nSdkInstance.ggPM('57', playheadPosition);
nSdkInstance.ggPM('7', playheadPosition);
});</syntaxhighlight>
<blockquote>'''Note''': User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement.

''The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.''

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Video Browser SDK

2017-09-04T14:33:38Z

MagdalenaKostulska: /* Nielsen Opt-Out */

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

== Prerequisites ==
 
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

</syntaxhighlight>

== Configure SDK ==
 
There are two steps required for configuring the SDK:
 
*Add Static Queue Snippet
*Create SDK Instance
 
'''Static Queue Snippet'''
 
Add the following script tag to the website:
 
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("TXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
 
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
 
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
 
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'TXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}
 
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript"> var nSdkInstance = NOLBUNDLE.nlsQ("TXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
 
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
 
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
 
'''Example SDK Configuration'''
 
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
 
There are two types of asset metadata:
 
*content: identify video
*ad: identify each ad
 
The metadata received for each asset is used for classification and reporting.
 
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
 
''Content Metadata''
 
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds 86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}
 
'''Example Content Object'''
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
 
The ad metadata should be passed for each individual ad.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}
 
'''Example Ad Object'''
 
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
 
'''Call Nielsen APIs'''
 
The method for calling events is ggPM().
 
<syntaxhighlight lang="javascript">

nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
 
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
 
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
 

 
'''SDK Events'''
 
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
 
== SDK Playhead Event Sequence ==
 
The sample event lifecycle can be used as a reference for identifying the order for calling events.
 
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
 
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
 
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
 
The following paragraph is a template for an opt-out statement.
 
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
'''Opt Back In'''
 
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
 
'''Going Live'''
 
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
 
Change the apid to the production ID starting with the letter 'P'.
 
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>

DCR Static Browser SDK (6.0.0)

2017-09-04T11:40:59Z

MagdalenaKostulska: /* Prerequisites */

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

'''Prior Version Guide:''' [[DCR Static Browser SDK (5.1.1)|5.1.1]]

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="javascript">'TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>

== Implementation Steps ==
=== Add Tracking Code ===
The Nielsen DCR Tracking Code must be added to each page.
<syntaxhighlight lang="javascript"><script>
// Static Queue Snippet
!function(t,n){t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i){return s=t.document,r=s.createElement("script"),r.async=1,r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),t[n][o]=t[n][o]||{g:c||{},ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]}}}(window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});

// Content Metadata
var nielsenMetadata = {
type: 'static',
assetid: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: '', // *DYNAMIC METADATA*: section of site **REQUIRED**
segA: '', // *DYNAMIC METADATA*: custom segment
segB: '', // *DYNAMIC METADATA*: custom segment
segC: '' // *DYNAMIC METADATA*: custom segment
};

// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</script></syntaxhighlight>

==== Tracking Code Components ====
The tracking code includes
* Static Queue Snippet
* SDK Initialization
* Content Metadata
* staticstart Event

'''Static Queue Snippet'''

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.
<syntaxhighlight lang="javascript">
!function(t,n){t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},t[o]}
}
}
(window,"NOLBUNDLE");</syntaxhighlight>

'''SDK Initialization'''

While creating an SDK instance, initialize the SDK by calling:

'''Initialization API Call'''

<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "",{nol_sdkDebug: "debug"})</syntaxhighlight>

When the initialization call is made, a unique static config file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and cached by the client-side browser(s).

Once the static config file is downloaded, the SDK will be fully downloaded and initialized. All SDK modules are included in one file:
"nlsSDK600.bundle.min.js".

'''Content Metadata'''

Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values.

Pass dynamic metadata for the keys with the <code><metadataPlaceholder></code> value (e.g. <code>section: ''</code>).

'''staticstart Event'''

There is only one event call required:
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>

The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[Bundled_SDK_-_Static#Configure_Metadata|Step 3]].

=== Pass App ID in Initialization Call ===
Pass the unique App ID in the first parameter of the initialization call, <code><apid></code>.

'''Example SDK Initialization'''

<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});</syntaxhighlight>

The initialization call has three parameters:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site. || <code>PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX</code>
|-
| instanceName || Name of SDK instance || Any string value
|-
| nol_sdkDebug: "debug" || Enables Nielsen console logging. Only required for testing || <code>{nol_sdkDebug: "debug"}</code>
|}

Update <code><apid></code> with the AppID provided. Refer to the [[#Going_Live|Going Live]] section to know about updating the AppID to production after testing is completed.

=== Configure Metadata ===
Map the Nielsen keys to variables so that the content metadata is dynamically updated.

The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Data Type !! Value !! Required?
|-
| type || asset type || fixed || <code>'static'</code> || Yes
|-
| assetid || Unique ID for each article || dynamic || custom || Yes
|-
| section || section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values || dynamic || custom || Yes
|-
| segA || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segB || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segC || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || fixed || custom || No
|}

The values passed through the Nielsen keys will determine the breakouts that are seen in reporting. The custom segments (A, B & C) will roll into the sub-brand. To not use custom segments A, B and C, do not pass any value in these keys.

'''Aggregation Limits'''
There are limits on the number of unique values that can be aggregated on in reporting. The specific limitations by key are:
{| class="wikitable"
|-
! Key !! Aggregation Limit
|-
| section || maximum of 25 unique values (section <= 25)
|-
| segA || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segB || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segC || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.

The following paragraph is a template for an opt-out statement, the properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Infinite Scrolling ==

<code>onPaginate</code> will refire the view ping with the existing/original metadata.

<source lang="javascript">nSdkInstance.ggPM("onPaginate", scrolloffset);</source>
 
{|
!width="23%"| Parameter
!width="19%"| Description
|-
| event
| <code>onPaginate</code>
|-
| scrolloffset
| The <code>scrolloffset</code> value should be the y-scroll position:
|}

=== onPaginate ===

<code>onPageinate</code> is a slightly modified version of <code>staticstart</code> to enable tracking of user’s focus in pages with continuous scrolling. <code>onPaginate</code> event provides the same behavior as <code>staticstart</code> keeping it local to only clients who wish to implement continuous scrolling. (Note: This event <code>onPaginate</code> will not reset the page duration timer.)

* The maximum number of static View pings allowed per session is ‘1’. This is enforced via the <code>nol_maxPingCount</code> parameter in the tag and the cadence of impression.
* When an <code>onPaginate</code> event is called at the end of section / a focus shift (within the same page), this filter will reset the current ping count to ‘0’ for the static View ping. This change of value will cause a new View ping when the Browser SDK receives the next <code>staticPosition</code> event (at the section end). This sequence continues through the end of scrolling or till the close of static page session.

[[File:StaticPageEvent35.jpg|center|link=]]

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Video Browser SDK

2017-09-04T11:35:40Z

MagdalenaKostulska: /* Configure SDK */

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

== Prerequisites ==
 
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

</syntaxhighlight>

== Configure SDK ==
 
There are two steps required for configuring the SDK:
 
*Add Static Queue Snippet
*Create SDK Instance
 
'''Static Queue Snippet'''
 
Add the following script tag to the website:
 
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("TXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
 
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
 
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
 
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'TXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}
 
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript"> var nSdkInstance = NOLBUNDLE.nlsQ("TXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
 
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
 
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
 
'''Example SDK Configuration'''
 
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
 
There are two types of asset metadata:
 
*content: identify video
*ad: identify each ad
 
The metadata received for each asset is used for classification and reporting.
 
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
 
''Content Metadata''
 
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds 86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}
 
'''Example Content Object'''
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
 
The ad metadata should be passed for each individual ad.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}
 
'''Example Ad Object'''
 
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
 
'''Call Nielsen APIs'''
 
The method for calling events is ggPM().
 
<syntaxhighlight lang="javascript">

nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
 
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
 
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
 

 
'''SDK Events'''
 
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
 
== SDK Playhead Event Sequence ==
 
The sample event lifecycle can be used as a reference for identifying the order for calling events.
 
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
 
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
 
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
 
The following paragraph is a template for an opt-out statement.
 
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
'''Opt Back In'''
 
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
 
'''Going Live'''
 
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
 
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>

DCR Video Browser SDK

2017-09-04T11:34:29Z

MagdalenaKostulska: /* Prerequisites */

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

== Prerequisites ==
 
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.

<syntaxhighlight lang="html">

apid: "TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

</syntaxhighlight>

== Configure SDK ==
 
There are two steps required for configuring the SDK:
 
*Add Static Queue Snippet
*Create SDK Instance
 
'''Static Queue Snippet'''
 
Add the following script tag to the website:
 
<syntaxhighlight lang="javascript">
<script>
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}

(window,"NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</script>
</syntaxhighlight>
 
The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

===Create SDK Instance===
 
To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript"> NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
 
When creating an instance, pass the following three values:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|}
 
'''Example SDK Initialization'''

<syntaxhighlight lang="javascript"> var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>
 
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.
 
Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.
 
'''Example SDK Configuration'''
 
The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},
t[o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

=== Create Metadata Objects ===
 
There are two types of asset metadata:
 
*content: identify video
*ad: identify each ad
 
The metadata received for each asset is used for classification and reporting.
 
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
 
''Content Metadata''
 
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
value here and the sub-brand ID associated to that brand in the subbrand 
key (e.g. multiple brands in App)
||
Nielsen provided
||
|-
| vcid || sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App)
||
Nielsen provided
||
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset || custom || ✓
|-
| program || name of program (25 character limit) || custom || ✓
|-
| title || episode title (40 character limit) || custom || ✓
|-
| length || length of content in seconds || seconds 86400 for live stream)|| ✓
|-
| mediaURL || URL location of the content being streamed || custom || ✓
|-
| segB || custom segment B || custom ||
|-
| segC || custom segment C || custom ||
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH:MI:SS || ✓
|-
| isfullepisode || full episode flag ||
*"y"– full episode
*"n"– non full episode
||
✓
|-
| crossId1 || standard episode ID || custom || ✓
|-
| crossId2 || content originator (only required for distributors) || Nielsen provided ||
|-
|adloadtype || type of ad load:
* 1) - Linear – matches TV ad load
* 2) Dynamic – Dynamic Ad Insertion (DAI)
||
*"1" – content with linear ads
*"2" – content with dynamic ads
||
✓
|}
 
'''Example Content Object'''
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID123-123456',
program: 'program name',
title: 'episode title',
length: 'length in seconds',
mediaURL: 'http://www.site.com/videoAsset',
segB: 'custom segment B',
segC: 'custom segment C',
airdate: 'YYYYMMDD HH:MI:SS',
isfullepisode: 'y',
crossId1: 'Standard Episode ID',
crossId2: 'Content Originator',
adloadtype: '2'
};
</syntaxhighlight>

=== Ad Metadata Object ===
 
The ad metadata should be passed for each individual ad.
 
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
|-
| assetid || unique ID assigned to ad || custom || ✓
|}
 
'''Example Ad Object'''
 
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};
</syntaxhighlight>
 
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
 
'''Call Nielsen APIs'''
 
The method for calling events is ggPM().
 
<syntaxhighlight lang="javascript">

nSdkInstance.ggPM('event', parameter, ...);

</syntaxhighlight>
== Interrupt Scenarios ==

=== Pause Event ===

The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===

The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
 
There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>
 
<blockquote>User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>
 

 
'''SDK Events'''
 
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer 
VOD: || current position in seconds 
Live: current UTC timestamp 
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
 
== SDK Playhead Event Sequence ==
 
The sample event lifecycle can be used as a reference for identifying the order for calling events.
 
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

== Nielsen Opt-Out ==
 
The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the opt-out option, include the following two items in your privacy policy.
 
*A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
*A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
 
The following paragraph is a template for an opt-out statement.
 
The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.
 
'''Opt Back In'''
 
Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.
 
'''Going Live'''
 
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
 
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.
Example Production Initialization Call

<syntaxhighlight lang="javascript">

var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");

</syntaxhighlight>