View source for DCR Czech Video App SDK

{{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 for Android and iOS operating systems.<br />
It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings ([[DCR & DTVR]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]].<br />
This guide covers implementation steps for iOS using Xcode and Android using Android Studio.

== 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.
* '''Nielsen SDK:''' The Nielsen SDK package contains AppSDK itself and sample player for your reference - download package at [[Special:Downloads|Digital Downloads]]

If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team - see [[Czech Contacts]].

== Step 1: Setting up your  Development Environment  ==
{{ExampleCode|
iOS|
=== Configuring Xcode Development Environment ===
Starting with SDK version 6.0.0.0, the Nielsen App SDK is compatible with Apple iOS versions 8.0 and above.  In addition, the SDK uses the WKWebView class instead of the deprecated UIWebView as per Apple guidelines. 

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

==== Importing Frameworks ====

1) Extract “NielsenAppApi.Framework” from the Nielsen App SDK sample app and copy it to Frameworks folder of the Xcode project.<br />

2) Import following frameworks and libraries into the Frameworks 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
* 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<br />

3) Add the code <code>-#import NielsenAppApi/NielsenAppApi.h</code> to the View Controller’s header file.<br />

Note:
* Nielsen App SDK is compatible with Apple iOS versions 9.0 and above.
* The SDK uses the NSURLSession instead of the deprecated NSURLConnection.
* All communications between the SDK and the Census (Collection Facility) use HTTPS
<br />
==== Using Swift ====
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  <br />
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] <br />
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
==== Using Objective-C ====
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
 to the View Controller’s header file.
<br />
|Android =
=== Configuring Android Development Environment ===
<br />
1) Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the app/libs folder on the App’s project. Add it as dependency.<br />
2) Add the following permissions on the project’s ''AndroidManifest.xml'' file.<br />

<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>
3) Add Google Play Services lib into dependencies as Nielsen AppSDK uses the following packages/classes from the Google Play service.
Libraries:
* com.google.android.gms:play-services
Requiered Google Play Service CLasses and Packages :
* 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;

4) Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.<br />
<syntaxhighlight lang="java">import com.nielsen.app.sdk.*;</syntaxhighlight><br />
<br />

Notes:
*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 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.
}}

== Step 2: 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.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required/Obligatory? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || ✓ || 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. Put "cz" (for both dev phase + testing and production)
|| Nielsen-specified || ✓ || "cz"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Optional || "DEBUG"
|}
<br />
==== 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": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "appversion": "1.0",
            "appname": "app name here",
            "sfcode": "cz",
            "nol_devDebug": "DEBUG"
        ]
        return NielsenAppApi(appInfo:appInformation, delegate:delegate)
    }
}
</syntaxhighlight>


Sample code using AVPlayer.
<br />
<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": "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                     @"appversion": "1.0",
                                     @"appname": "app name here",
                                     @"sfcode": "cz",
                                     @"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 =
1) AppSDK() is no longer a singleton object and should be initialized as below.
<syntaxhighlight lang="java">
try{
  // Prepare AppSdk configuration object (JSONObject)
  JSONObject appSdkConfig = new JSONObject()
          .put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
          .put("appversion", "1.0")
          .put("appname", "Sample App Name")
          .put("sfcode", "cz")
          .put("nol_devDebug", "DEBUG"); // only for debug builds

         // Pass appSdkConfig to the AppSdk constructor
         mAppSdk = new AppSdk(appContext, appSdkConfig, this);
}
catch (JSONException e){
         Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
2) implement IAppNotifier into your activity like
<syntaxhighlight lang="java">public class MainActivity extends AppCompatActivity implements IAppNotifier
</syntaxhighlight>
3) implement callback
<syntaxhighlight lang="java">@Override
public void onAppSdkEvent(long timestamp, int code, String description){
  Log.d(TAG, "SDK callback onAppSdkEvent " + description);
}
</syntaxhighlight>

So whole Activity will look like
<syntaxhighlight lang="java">
package com.example.josefvancura.nlsdemotmp;

import android.content.Context;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;

import com.nielsen.app.sdk.*;

import org.json.JSONException;
import org.json.JSONObject;

public class MainActivity extends AppCompatActivity implements IAppNotifier {

    private AppSdk mAppSdk = null;
    private String TAG = "MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Context context = getApplicationContext();

        try{
            // Prepare AppSdk configuration object (JSONObject)
            JSONObject appSdkConfig = new JSONObject()
                    .put("appid", "TF2D48D99-9B58-B05C-E040-070AAB3176DB")
                    .put("appversion", "1.0")
                    .put("appname", "Sample App Name")
                    .put("sfcode", "cz")
                    .put("nol_devDebug", "DEBUG"); // only for debug builds

            // Pass appSdkConfig to the AppSdk constructor
            mAppSdk = new AppSdk(context, appSdkConfig, this ); // Notifier - activity implements IAppNotifier, callback in onAppSdkEvent()

        }
        catch (JSONException e){
            Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
        }

    }

    @Override
    public void onAppSdkEvent(long timestamp, int code, String description) {
        Log.d(TAG, "SDK callback onAppSdkEvent " + description);
    }

}
</syntaxhighlight>
}}

==== 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.

==== 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. API calls "play" and "loadMetadata" move the SDK instance into this state. In this state, the SDK instance will be able to process the API calls (see below)
# '''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>

== Step 3: Create Metadata Objects ==
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.<br />


=== ChannelName metadata ===
channelName should remain constant throughout the completion of an episode or live stream.
<br />
{| class="wikitable"
|-
! Key !! Description !!	Values	 !! Required
|-
| 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. For detailed information of metadata and custom variables see [[Czech SDK Metadata]].

=== Ad Metadata ===
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
For detailed information of metadata and custom variables see [[Czech SDK Metadata]].


=== MetaData Example ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
     let channelInfo = [
        "channelName": "My Channel Name 1",
     ]

     let contentMetadata = [
       "assetid" : "c1",
        "type" : "content",
        "program" : "myProgram",
        "title" : "Anime Movie",
        "length" : "52",
        "mediaUrl" : "",
        "airdate" : "20161013 20:00:00",
        "isfullepisode" : "y",
        "crossId1" : "9827411",
        "nol_c1" : "p1,",
        "nol_c2" : "p2,TVident",
        "segB" : "Programový typ",
        "segC" : "",
        "adloadtype" : "1",
        "hasAds" : "1"
     ]

    let adMetadata = [
        "assetid" : "ad1",
        "type" : "midroll",
        "length" : "34",
        "title" : "Ad Renault",
        "nol_c4" : "p4,ASMEA code for ad",
        "nol_c5" : "p5,Atribut for ad",
        "nol_c6" : "p6,midroll",
        "nol_ac" : "ad"
    ]

</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary  *channelInfo = @
{
  @"channelName":@"My Channel Name 1",
}

NSDictionary *contentMetadata = @
  {
  @"assetid" : "c1",
  @"type" : "content",
  @"program" : "myProgram",
  @"title" : "Anime Movie",
  @"length" : "52",
  @"mediaUrl" : "",
  @"airdate" : "20161013 20:00:00",
  @"isfullepisode" : "y",
  @"crossId1" : "9827411",
  @"nol_c1" : "p1,",
  @"nol_c2" : "p2,TVident",
  @"segB" : "Programový typ",
  @"segC" : "",
  @"adloadtype" : "1",
  @"hasAds" : "1"
}

NSDictionary *adMetadata = @
  {
  @"assetid" : "ad1",
  @"type" : "midroll",
  @"length" : "34",
  @"title" : "Ad Renault",
  @"nol_c4" : "p4,ASMEA code for ad",
  @"nol_c5" : "p5,Atribut for ad",
  @"nol_c6" : "p6,midroll",
  @"nol_ac" : "ad"
}
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
    .put("channelname","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
   .put("assetid", "assetid_example")
   .put("type", "content")
   .put("program", "ProgramName")
   .put("title", "Bunny in Woods")
   .put("length", "579") // 9min 39sec
   .put("mediaUrl", "") // empty
   .put("airdate", "20171013 20:00:00")
   .put("isfullepisode", "y")
   .put("crossId1", "IDEC")
   .put("nol_c1", "p1,") // empty for VOD
   .put("nol_c2", "p2,TV ident")
   .put("segB", "Program type")
   .put("segC", "") // empty
   .put("adloadtype", "1")
   .put("hasAds",  "1");

JSONObject adMetadata = new JSONObject()
   .put("assetid", "assetid_example_postroll")
   .put("type", "postroll")
   .put("length", "30")
   .put("title", "Nielsen postroll")
   .put("nol_c4", "p4,ASMEAcode")
   .put("nol_c5", "p5,AtributForAd")
   .put("nol_c6", "p6,postroll");

</syntaxhighlight>
}}

== Step 4: Configure API Calls ==

=== API Calls Types ===

==== play ====
The play method prepares the SDK for reporting once an asset has loaded and playback has begun. Use play to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player. Call play only when initially starting the video.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">nielsenAppApi play:(JSONObject channelInfo);</syntaxhighlight>
|Android = <syntaxhighlight lang="java">mAppSdk.play(JSONObject channelInfo);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.play(channelInfo);</syntaxhighlight>
}}

==== loadMetadata ====
Needs to be called at the beginning of each asset, pass JSON object for relevant content or ad. Make sure to pass as 1st loadMetadata for content at the begining of playlist - see below API call sequence examples.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">nielsenAppApi loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">mAppSdk.loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

==== playheadPosition ====
Pass playhead position every second during playback. for VOD: pass current position in seconds. for Live: current Unix timestamp (seconds since Jan-1-1970 UTC) - if it is possible to seek back in Live content, then pass related Unix time (not current). Pass whole number that increments only by 1 like 1,2,3..
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
nielsenAppApi playheadPosition: (long long) playheadPos
</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">
self.nielsenAppApi?.playheadPosition(pos);
</syntaxhighlight>
|Android = <syntaxhighlight lang="java">
mAppSdk.setPlayheadPosition(long videoPositon);
</syntaxhighlight>
}}

==== stop ====
Call when
* content or ads complete playing
* when a user pauses playback
* upon any user interruption scenario - see bellow chapter Interruption scenario

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

==== end ====
Call when the content asset completes playback.  Stops measurement progress.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">nielsenAppApi end;</syntaxhighlight>
|Android = <syntaxhighlight lang="java">mAppSdk.end();</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.end</syntaxhighlight>
}}
<br />

=== API Call sequence ===
==== Use Case 1: Content has no Advertisements ====
Only content in playlist, A Sample API sequence follow this flow:
{| class="wikitable"
|-
! Playlist !! Sample code !! Description
|-
| rowspan="2" | 1. Start of stream || <code>play(channelName)</code> || channelName contains JSON metadata of channel/video name being played
|-
| <code>loadMetadata(contentMetadataObject)</code> || contentMetadataObject contains the JSON metadata for the content being played
|-
| 2. Content || <code>playheadPosition(position)</code> || playheadPosition is position of the playhead while the content is being played
|-
| 3. End of Stream || <code>end</code> || Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====
Playlist : ad preroll - content - ad midroll - content continues - ad postroll.<br />
The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.
{| class="wikitable"
|-
! Playlist !! Sample code !! Description
|-
| rowspan="2" | 1. Start of stream || <code>play(channelName); </code> || channelName contains JSON metadata of channel/video name being played
|-
| <code>loadMetadata(contentMetaDataObject);</code> || contentMetadataObject contains the JSON metadata for the content being played
|-
| rowspan="3" | 2. Preroll || <code>loadMetadata(prerollMetadataObject);</code> || prerollMetadataObject contains the JSON metadata for the preroll ad
|-
| <code>setPlayheadPosition(playheadPosition);</code> || position is position of the playhead while the preroll ad is being played
|-
| <code>stop();</code> || Call stop after preroll occurs
|-
| rowspan="3" | 3. Content || <code>loadMetadata(contentMetaDataObject);</code> || contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>setPlayheadPosition(playheadPosition);</code> || position is position of the playhead while the content is being played
|-
| <code>stop();</code> || Call stop after the content is paused (ad starts)
|-
| rowspan="3" | 4. Midroll || <code>loadMetadata(midrollMetaDataObject);</code> || midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>setPlayheadPosition(playheadPosition);</code> || position is position of the playhead while the midroll ad is being played
|-
| <code>stop();</code> || Call stop after midroll occurs
|-
| rowspan="3" | 5. Content (End) || <code>loadMetadata(contentMetaDataObject);</code> || contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>setPlayheadPosition(playheadPosition);</code> || position is position of the playhead while the content is being played
|-
| <code>stop();</code> || Always call stop irrespective of postroll is followed or not
|-
| 6. End of Stream || <code>end();</code> || Call end() at the end of content
|-
| rowspan="3" | 7. Postroll || <code>loadMetadata(postrollMetaDataObject);</code> || postrollMetadataObject contains the JSON metadata for the postroll ad
|-
| <code>setPlayheadPosition(playheadPosition);</code> || position is position of the playhead while the postroll ad is being played
|-
| <code>stop();</code> || Call stop after postroll occurs
|}

<blockquote>Note: Each Ad playhead should reset or begin from 0 at ad start. When content has resumed following an ad break, playhead position must continue from where previous content segment was left off.</blockquote>

== Step 5: Interruptions during playback ==
As part of integrating Nielsen App SDK with the player application, the Audio / Video app developer needs to handle the following possible interruption scenarios:
* Pause / Play
* Network Loss (Wi-Fi / Airplane / Cellular)
* Call Interrupt (SIM or Third party Skype / Hangout call)
* Alarm Interrupt
* Content Buffering continues for 30 seconds
* Device Lock / Unlock (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call <code>stop</code> immediately (except when content is buffering) and withhold sending playhead position.
* Start sending pings – [[Czech_SDK_Metadata|loadMetadata]] and <code>playheadPosition</code> for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details

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

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

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

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

Nielsen iOS SDK 5.1.1.17 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 legacy Nielsen opt-out URL via [[optOutURL]]
* Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL]]
* 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=swift>NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>

==== Legacy Opt-out example code ====

<syntaxhighlight lang="swift">
var webView: WKWebView!
var NIELSEN_URL_OPT_OUT : String = "nielsenappsdk://1"
var NIELSEN_URL_OPT_IN : String = "nielsenappsdk://0"

func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) {

       let urlStr = navigationAction.request.url?.absoluteString

        if(urlStr == NIELSEN_URL_OPT_OUT || urlStr == NIELSEN_URL_OPT_IN){
            let appApi = self.nielsenApi
            appApi?.userOptOut(urlStr)
            decisionHandler(.allow)

        }else{
           decisionHandler(.cancel)
        }
    }
</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 [[optOutStatus]] property in the Nielsen 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/cz/cs/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="swift">
import UIKit
import WebKit
import NielsenAppApi

class OptOutVC: UIViewController, NielsenAppApiDelegate, WKNavigationDelegate {
    
    var webView: WKWebView!
    var nielsenApi: NielsenAppApi!
    
    override func loadView() {
        webView = WKWebView()
        webView.navigationDelegate = self
        view = webView
    }
    
    override func viewDidLoad() {
        super.viewDidLoad()
        self.view.backgroundColor = UIColor(patternImage: UIImage(named: "new_ios_bg.png")!) 
        self.nielsenApi = NielsenInit.createNielsenApi(delegate: self)
        
        if let appApi = self.nielsenApi {
            //Getting the optPut URL from SDK
            if let url = URL(string: appApi.optOutURL) {
                webView.load(URLRequest(url: url))
                webView.allowsBackForwardNavigationGestures = true
            }
        }
    }
    
}
</syntaxhighlight>
<br>


|Android=
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''', or where '''[https://developers.google.com/android/guides/overview Google Play Services] are not available.'''

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/cz/cs/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>
<br>

}}

== Step 7 :  Test your player by yourself ==
=== Guide ===
1. Connect your PC and test device (tablet or phone) via same router.<br />
2. PC side: run Proxy sw (like Charles) and get local IP<br />
3. Test device: modify Wifi setting to pass throug Proxy IP from add 2<br />
4. Test device: run your player, launch video<br />
5. PC side: filter trafic by "imr" and confirm presence of GN pings<br />

for Android see https://youtu.be/zOKOinb-zdc, for iOS see https://youtu.be/Gk0YQttiXRI

=== Example of GN ping ===
<code><nowiki>http://secure-eu-cert.imrworldwide.com</nowiki>/cgi-bin/gn?prd=dcr<wbr />&ci=de-205177<wbr />&ch=de-205177_c01_P<wbr />&asn=defChnAsset<wbr />&tl=Bunny%2520in%2520Woods<wbr />&prv=1<wbr />&c6=vc,c01<wbr />&ca=de-205177_c01_assetid<wbr />&cg=ProgramName<wbr />&c13=asid,T885AAE54-AFE4-431D-B60B-FF4C75FCA357<wbr />&c32=segA,NA<wbr />&c33=segB,CustomSegmentValueB<wbr />&c34=segC,CustomSegmentValueC<wbr />&c15=apn,CZ%20demo%20player<wbr />&sup=1<wbr />&segment2=-1<wbr />&segment1=cze<wbr />&forward=0<wbr />&ad=1<wbr />&cr=4_00_99_V1_00000<wbr />&c9=devid,d6df553edcc70bf62812069af7252d5e905399c711378b6ee0a1f0a9381fdec6<wbr />&enc=true<wbr />&c1=nuid,62ef4e4aeb2c3d390c224e3aaf686ec063895e9dd9a64f4d2b84059e1148e29c<wbr />&at=view<wbr />&rt=video<wbr />&c16=sdkv,aa.5.1.1<wbr />&c27=cln,0<wbr />&crs=0<wbr />&lat=<wbr />&lon=<wbr />&c29=plid,T885AAE54-AFE4-431D-B60B-FF4C75FCA357<wbr />&c30=bldv,aa.5.1.1.18<wbr />&st=dcr<wbr />&c7=osgrp,DROID<wbr />&c8=devgrp,TAB<wbr />&c10=plt,MBL<wbr />&c40=adbid,<wbr />&c14=osver,Android6.0.1<wbr />&c26=dmap,1<wbr />&dd=<wbr />&hrd=<wbr />&wkd=<wbr />&c35=adrsid,<wbr />&c36=cref1,IDEC<wbr />&c37=cref2,<wbr />&c11=agg,1<wbr />&c12=apv,1.0.1<wbr />&c51=adl,0<wbr />&c52=noad,0<wbr />&sd=596<wbr />&devtypid=asus-Nexus-7<wbr />&pc=NA<wbr />&c53=fef,y<wbr />&c54=oad,20171013%2020%3A00%3A00<wbr />&c55=cref3,<wbr />&c57=adldf,1<wbr />&ai=assetid<wbr />&c3=st%252Cc<wbr />&c64=starttm,1500474035<wbr />&adid=assetid<wbr />&c58=isLive,false<wbr />&c59=sesid,1500474032<wbr />&c61=createtm,1500474037<wbr />&c63=pipMode,<wbr />&c60=agfall,p0%252C~~p1%252Ccontent%2520-%2520ID%2520for%2520content%2520matching%2520TVIDENT~~p2%252Ccontent%2520-%2520Reserved%2520for%2520future%2520use~~st%252Cc21:31, 13 September 2018 (UTC)~<wbr />&c62=sendTime,1500474123<wbr />&c68=bndlid,com.example.kunalbhatia.hlsexomy<wbr />&nodeTM=<wbr />&logTM=<wbr />&c73=phtype,Tablet<wbr />&c74=dvcnm,Google+Nexus+7<wbr />&c76=adbsnid,<wbr />&df=-1<wbr />&c77=adsuprt,1<wbr />&evdata=<wbr />&c71=ottflg,0<wbr />&c72=otttyp,<wbr />&sessionId=<wbr />&c44=progen,<wbr />&davty=0<wbr />&si=<wbr />&c66=mediaurl,<wbr />&uoo=<wbr />&vtoff=86<wbr />&rnd=1500474122131</code>

== Step 8 :  Provide your app for certification ==
Once ready please send your application to Nielsen local staff for verification - see [[Czech Contacts]].

== Step 9 :  Going Live ==
After the integration has been certified (but not prior that), disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call - see Step 2.

== Demos ==
see live demos with sample implementation available at at http://sdkdemo.admosphere.cz/

== FAQs ==
*'''Question:''' When to instantiate Nielsen SDK?
*'''Answer:''' At application start and only once during runtime.


*'''Question:''' Which API calls shall be executed and when?
*'''Answer:'''
** For standard runtime - please see Chapter 4 - API Call sequence
** For interruption scenario - see Chapter 5 Interruptions during playback