Engineering Client Portal - User contributions [en]

Digital Measurement iOS Simplified API

2019-03-21T20:18:09Z

YaminiKumawat: removed containerId info

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG"
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG"
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement iOS Simplified API

2019-03-21T20:17:03Z

YaminiKumawat: removed containerId obj init info

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG"
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T20:16:12Z

YaminiKumawat: forgot a semicolon

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T20:15:33Z

YaminiKumawat: removed containerId info

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T20:14:18Z

YaminiKumawat: removed containerId obj init info

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T20:10:21Z

YaminiKumawat: removed "containerId" information from chart

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T20:09:22Z

YaminiKumawat: removed "containerId" information from chart

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T20:04:26Z

YaminiKumawat: removed as this feature is not yet live

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T16:50:05Z

YaminiKumawat: minor value edits

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T16:50:01Z

YaminiKumawat: minor value edits

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || Yes
|-
| assetid || unique ID assigned for each article/section || <code> "AID885-9984" </code> || Yes
|-
|section || Unique Value assigned to page/site section || <code> "homeSection" </code> || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueA" </code> || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueB" </code> || No
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || <code> "CustomSegmentValueC" </code> || No
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement iOS Simplified API

2019-03-21T16:46:29Z

YaminiKumawat: minor edit to adidx description

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T16:46:27Z

YaminiKumawat: minor edit to adidx description

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad index (See the "Managing Ads" section below) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T16:39:59Z

YaminiKumawat: changed chart headers

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad Index (*See Note below*) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T16:39:45Z

YaminiKumawat: changed chart headers

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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"
|-
! Key !! Description !! Example !! Required
|-
| assetid || unique ID assigned to ad (no [[Special Characters]]) || <code>"AD12345"</code> || Yes
|-
| title || unique name assigned to ad || <code>"ADtitle"</code> || No
|-
|adldx || ad Index (*See Note below*) || <code> "66478364" </code> || Yes
|-
| type || type of ad ("preroll", "midroll", or "postroll") || <code> "preroll" </code> || Yes
|-
|length || length of ad, in seconds || <code> "20" </code> || No
|}

=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T16:31:27Z

YaminiKumawat: syntax change on DTVR id3 example

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T16:30:51Z

YaminiKumawat: syntax change on DTVR id3 example

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement iOS Simplified API

2019-03-21T16:28:51Z

YaminiKumawat: edits to DTVR table

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T16:28:50Z

YaminiKumawat: edits to DTVR table

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead, pause,
complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete, adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

<tr>

</td></tr>
</table>

=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''channelName''' </td>
<td> name of program (32 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''type''' </td>
<td> 'content', 'ad', 'static' </td>
<td> "content" </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>

Below is a sample event for DTVR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T15:51:22Z

YaminiKumawat: grammar change

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement iOS Simplified API

2019-03-21T15:50:21Z

YaminiKumawat: Changes to DCR content metadata table

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab for the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> Non
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "1"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T15:49:57Z

YaminiKumawat: grammar edit

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the tab of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T15:22:38Z

YaminiKumawat: changes to content metadata table on DCR tab

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the TAB of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types. 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<syntaxhighlight lang="java">"playheadPosition":"1501225191747"</syntaxhighlight>
Position value is playhead:
<syntaxhighlight lang="java">"playheadPosition":"10"</syntaxhighlight>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadPosition update.
<table>
<tr>
<th> Key </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> "B66473" </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>"3600"</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"MyProgram"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> <code>"CustomSegmentValueB"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> <code>"segmentC"</code> </td>
<td> No
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> <code>"S2,E3"</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> unique value assigned to page/site section </td>
<td> <code>"HomePage"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> <code>"20180120 10:00:00"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- not a full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> "Standard Episode ID" </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId2'''</td>
<td> content originator (only required for distributors) </td>
<td> Provided by Nielsen </td>
<td> Yes (if distributor)
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear ("1") vs dynamic ("2") ad model
</td>
<td> "2"
</td>
<td>Yes
</td></tr>
</table>
¹ '''Custom segments''' (segB and segC) can be used to aggregate video and/or static content within a single brand to receive more granular reports. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If there are no ad or static values, the values for these keys can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement Android Simplified API

2019-03-21T14:27:27Z

YaminiKumawat: modified "complete" event description

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the TAB of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> HomePage </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> YYYYMMDD HH24:MI:SS </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- non full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> custom </td>
<td> ✓
</td></tr>
<tr>
<td> '''crossId2 '''</td>
<td> content originator (only required for distributors) </td>
<td> Nielsen provided </td>
<td>
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
¹ '''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. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T14:23:43Z

YaminiKumawat: modified description of "sfcode"

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the TAB of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> HomePage </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> YYYYMMDD HH24:MI:SS </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- non full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> custom </td>
<td> ✓
</td></tr>
<tr>
<td> '''crossId2 '''</td>
<td> content originator (only required for distributors) </td>
<td> Nielsen provided </td>
<td>
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
¹ '''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. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}

Digital Measurement Android Simplified API

2019-03-21T14:23:24Z

YaminiKumawat: modified description of sfcode

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=http://dayrhesdkp001z.enterprisenet.org/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
<big>'''Configuring Android Development Environment'''</big>'
*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) 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 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.
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
==== Google Play Services ====
Add the Google Play Services in the project,
Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click “+” button and select <code>“com.google.android.gms:play-services”</code>.
Ensure it is added in build.gradle (App level) file
==== Manifest File ====
* 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].

* In <code>AndroidManifest.xml </code>under <application> node add the following metadata

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

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

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

==== Classes/package ====

* 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Specifies the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====

'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
import android.content.Context;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;
import org.json.JSONException;
import org.json.JSONObject;

public class NielsenInit {
private NielsenEventTracker mEventTracker = null;
public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0")
.put("appname", "Android Test app")
.put("sfcode", "dcr")
.put("nol_devDebug", "INFO")
.put("containerId", "55"); //Keep container id unique constant, you can use tag property of player.

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);
} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}

</syntaxhighlight>

== Initializing the Nielsen AppSDK to measure the Viewability ==
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

{| class="wikitable"
|-
! # !! Parameter Name !! Description !! Supported Values !! Example
|-
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561
|}

The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]

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

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="java">
void trackEvent(JSONObject data);
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 
=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp (seconds since Jan-1-1970 UTC) or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.)
|-
|'''complete'''||
It is called when session is completed or ends.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the TAB of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-1-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> HomePage </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> YYYYMMDD HH24:MI:SS </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- non full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> custom </td>
<td> ✓
</td></tr>
<tr>
<td> '''crossId2 '''</td>
<td> content originator (only required for distributors) </td>
<td> Nielsen provided </td>
<td>
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
¹ '''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. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="java">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="java">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
id3Data: www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="java">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="java">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
<syntaxhighlight lang="java">
//Loading Ad data
public JSONObject loadPreRollAdData(){
JSONObject data = null;

url = "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8";

try {
//We should pass content dictionary also in Ad video.
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","app_Mainpage")
.put( "airdate","20180207 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2");

JSONObject ad = new JSONObject()
.put("type", "static")
.put("assetid", "AD12345")
.put("title", "ADTestTitle")
.put("type", "preroll")
.put("length", "20");

JSONObject staticObj = new JSONObject()
.put("type","static")
.put("section","homeSection")
.put("segA","CustomSegmentValueA")
.put("segB","CustomSegmentValueB")
.put("segC","CustomSegmentValueC");

JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", ad)
.put("static", staticObj);

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "ad")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;
}
}
</syntaxhighlight>

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
* Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
* Custom implementation of the required methods within your application.

=== ForeGround/Background Measurement via AndroidManifest ===
The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
<syntaxhighlight lang="java">
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
</syntaxhighlight>

=== Using the Android SdkBgFbDetectionUtility Class ===
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.

=== Manual Background/ForeGround State Management ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.

The SDK is informed about app state using the below methods.
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
</syntaxhighlight>
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.

Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).

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

== Example code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.

[[File:Android1.jpg|thumb]]
== Android Studio Java Code Example ==
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDK-Android.zip Download Project Files]
==== NielsenInit.java ====

<syntaxhighlight lang="java">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//

import android.content.Context;

import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

public class NielsenInit {

private NielsenEventTracker mEventTracker = null;

public NielsenEventTracker initEventTracker(Context mContext, IAppNotifier appNotifier){

try {

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

JSONObject appInformation = new JSONObject()

.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788BC653CA")
.put("appversion", "1.0")
.put("appname", "Abdul's Android Test app")
.put("sfcode", "dcr")
.put("ccode", "123")
.put("dma","456")
.put("uoo","0")
.put("nol_devDebug", "INFO")
.put("containerId", "0");

mEventTracker = new NielsenEventTracker(mContext, appInformation, appNotifier);

} catch (JSONException e) {
e.printStackTrace();
}

return mEventTracker;
}
}
</syntaxhighlight>

==== SDKMethods.java ====
<syntaxhighlight lang="java">
import org.json.JSONException;
import org.json.JSONObject;

/**
* Created on 07/02/18.
*/

public class SDKMethods {

public String url = "";
JSONObject content = null;
//Loading content Data
public JSONObject loadContentData(){

url = "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8";

JSONObject data = null;
try {
JSONObject content = new JSONObject()
.put( "assetName","ChromeCast1")
.put( "assetid","C77664")
.put( "length","3600")
.put( "program","MyProgram")
.put( "segB","CustomSegmentValueB")
.put( "segC","segmentC")
.put( "title","S2,E3")
.put( "type","content")
.put( "section","cloudApi_app")
.put( "airdate","20180120 10:00:00")
.put( "isfullepisode","y")
.put( "adloadtype","2")
.put( "channelName","My Channel 1")
.put( "pipMode","false");

//Ad data,static data should be empty in content video dictionary
JSONObject metaData = new JSONObject()
.put("content", content)
.put("ad", new JSONObject())
.put("static", new JSONObject());

data = new JSONObject()
.put("metadata", metaData)
.put("event", "playhead")
.put("type", "content")
.put("playheadPosition", "0");

} catch (JSONException e) {
e.printStackTrace();
}

return data;

}
</syntaxhighlight>

==== MainActivity.java ====
<syntaxhighlight lang="java">
package com.simplifiedapiapp.activities;

import android.app.ProgressDialog;
import android.media.MediaPlayer;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.SurfaceHolder;
import android.view.SurfaceView;
import android.view.View;
import android.widget.Button;
import android.widget.SeekBar;

import com.simplifiedapiapp.utils.Constants;
import com.simplifiedapiapp.models.NielsenInit;
import com.simplifiedapiapp.R;
import com.simplifiedapiapp.models.SDKMethods;
import com.nielsen.app.sdk.IAppNotifier;
import com.nielsen.app.sdk.NielsenEventTracker;

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

import java.io.IOException;

public class MainActivity extends AppCompatActivity implements IAppNotifier, SurfaceHolder.Callback, MediaPlayer.OnPreparedListener, View.OnClickListener, MediaPlayer.OnCompletionListener, MediaPlayer.OnErrorListener {

public static final String TAG = MainActivity.class.getSimpleName();

private SurfaceView mSurfaceView;
private SeekBar seek;
Button btnPlay;

NielsenEventTracker eventTracker;
private int videoType, totalVideos;
private int totalVideosPlayed = 0;
private boolean isVideoStarted = false, isPaused = false;
JSONObject data = null;

private MediaPlayer mMediaPlayer;
private SurfaceHolder mSurfaceHolder;

SDKMethods sdkMethods;

private ProgressDialog dialog;
private Handler playheadHandler;
private Runnable playheadRunnable;

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

//In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = new SDKMethods();

getIntents();
initUI();

//In NielsenInit class we are initialising the NielsenEventTracker.
//Getting the instance of NielsenEventTracker
NielsenInit nielsenInit = new NielsenInit();

//3rd parameter "this" referes to IAppNotifier interface which is needed to initialise NielsenEventTracker
eventTracker = nielsenInit.initEventTracker(getApplicationContext(), this);
}

@Override
protected void onResume() {
super.onResume();

//loading static data
JSONObject staticObj = sdkMethods.loadStaticData();

//sending static data to SDK.
eventTracker.trackEvent(staticObj);
}

private void initUI() {

seek = (SeekBar) findViewById(R.id.seek);
btnPlay = (Button) findViewById(R.id.btnPlay);
btnPlay.setOnClickListener(this);
}

private void getIntents() {

videoType = getIntent().getIntExtra(Constants.INTENT_VIDEO_TYPE, 0);
totalVideos = getIntent().getIntExtra(Constants.INTENT_TOTAL_VIDEOS, 0);

if (videoType == Constants.onlyContent) {

//loading video content data
data = sdkMethods.loadContentData();
} else {

//loading Ad data
data = sdkMethods.loadPreRollAdData();
}
}

@Override
public void surfaceCreated(SurfaceHolder holder) {

Log.v(TAG, "surfaceCreated Called");

if (isPaused) {
//Once video is resumed after pause, setting surfaceholder to player.
if (mMediaPlayer != null) {

mSurfaceHolder = mSurfaceView.getHolder();
mMediaPlayer.setDisplay(mSurfaceHolder);
}

} else {

//This will execute for first time.
setUpPlayer();
mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);
}
}

@Override
public void onCompletion(MediaPlayer mediaPlayer) {
try {

playheadHandler.removeCallbacks(playheadRunnable);

///As 1 video completed playing, incrementing the variable value.
totalVideosPlayed++;

if (videoType == Constants.onlyContent || totalVideosPlayed == totalVideos) {

//on content video complete, updating event as "complete" in object
data.put("event", "complete");
} else {
//on Ad complete, updating event as "adStop" in object
data.put("event", "adStop");
}

//sending the object to SDK.
eventTracker.trackEvent(data);

releaseMediaPlayer();

checkVideosToBePlayed();

} catch (JSONException e) {
e.printStackTrace();
}
}

private void checkVideosToBePlayed(){

//Checking if total videos played or not.
if (totalVideosPlayed != totalVideos) {

data = new JSONObject();

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if (videoType == Constants.contentWithOneAd) {

//loading video content data
data = sdkMethods.loadContentData();

} else if (videoType == Constants.contentWithTwoAds) {
if (totalVideosPlayed == 1) {

//loading 2nd Ad data
data = sdkMethods.loadMidRollAdData();
} else {

//loading video content data
data = sdkMethods.loadContentData();
}
}

showProgressDialog();

setUpPlayer();

mMediaPlayer.setOnCompletionListener(this);
mMediaPlayer.setOnErrorListener(this);

}
}

@Override
public boolean onError(MediaPlayer mediaPlayer, int i, int li) {
Log.e(TAG, "Player error codes:" + i + ", " + li);
return false;
}

//creating player
private void setUpPlayer() {
try {

mMediaPlayer = new MediaPlayer();
mMediaPlayer.setDisplay(mSurfaceHolder);
mMediaPlayer.setDataSource(sdkMethods.url);
mMediaPlayer.setOnPreparedListener(MainActivity.this);
mMediaPlayer.prepareAsync();

} catch (IOException e) {
e.printStackTrace();
}
}

@Override
public void surfaceChanged(SurfaceHolder holder, int format, int width, int height) {
Log.v(TAG, "surfaceChanged Called");
}

@Override
public void surfaceDestroyed(SurfaceHolder holder) {
Log.v(TAG, "surfaceDestroyed Called");
}

@Override
public void onPrepared(MediaPlayer mp) {

if (dialog.isShowing()) {
dialog.dismiss();
}

seek.setMax(convertTotime(mMediaPlayer.getDuration()));
isVideoStarted = true;

updateSeekbarAndPlayhead();
mMediaPlayer.start();

}

@Override
protected void onPause() {
super.onPause();

setPauseAction();
}

private void setPauseAction() {
try {
if (mMediaPlayer != null) {

isVideoStarted = false;
isPaused = true;
mMediaPlayer.pause();

//on video pause, updating event as pause in object
data.put("event", "pause");

//sending the object to SDK with "pause" event.
eventTracker.trackEvent(data);

btnPlay.setText(getString(R.string.play));

}

} catch (JSONException e) {
e.printStackTrace();
}
}

@Override
protected void onDestroy() {
super.onDestroy();
releaseMediaPlayer();
}

private void releaseMediaPlayer() {
if (mMediaPlayer != null) {
mMediaPlayer.release();
mMediaPlayer = null;
}
}

@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.btnPlay:
try {
//If video is not yet played, then it will play else it will pause the video
if (!isVideoStarted) {

btnPlay.setText(getString(R.string.pause));

if (isPaused) {

isVideoStarted = true;
isPaused = false;

//Once the video is resumed after pause, setting event as "playhead".
data.put("event", "playhead");
mMediaPlayer.start();

} else {

mSurfaceView = (SurfaceView) findViewById(R.id.surface_view);
mSurfaceView.setVisibility(View.VISIBLE);

showProgressDialog();

mSurfaceHolder = mSurfaceView.getHolder();
mSurfaceHolder.addCallback(MainActivity.this);

}

} else {
setPauseAction();
}

} catch (JSONException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
break;
}

}

//Updates seekbar
private void updateSeekbarAndPlayhead() {
try {
//to update playhead, setting the event as "playhead".
data.put("event", "playhead");
playheadHandler = new Handler();

//Make sure you update Seekbar on UI thread
MainActivity.this.runOnUiThread(playheadRunnable = new Runnable() {

@Override
public void run() {
if (mMediaPlayer != null) {
int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
seek.setProgress(mCurrentPosition);
try {
if (!isPaused && mMediaPlayer.isPlaying()) {

//updating playHead position in Object each second.
data.put("playheadPosition", String.valueOf(mCurrentPosition));

//Sending data object to SDK with updated playHead position.
eventTracker.trackEvent(data);
}
} catch (JSONException e) {
e.printStackTrace();
}

}
playheadHandler.postDelayed(this, 1000);
}
});

} catch (JSONException e) {
e.printStackTrace();
}
}

private int convertTotime(long milliSec) {

int minutes = (int) (milliSec / 1000);
return minutes;
}

private void showProgressDialog() {

runOnUiThread(new Runnable() {
public void run() {
dialog = new ProgressDialog(MainActivity.this);
dialog.setCancelable(false);
dialog.setMessage(getString(R.string.loading));
dialog.show();
}
});
}

@Override
public void onAppSdkEvent(long l, int i, String s) {

//IAppNotifier method
}
}
</syntaxhighlight>

Digital Measurement iOS Simplified API

2019-03-21T14:22:47Z

YaminiKumawat: modified description of sfcode and nol_devDebug

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{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.

__TOC__

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

== Simplified SDK API ==
As part of making the SDK more user-friendly and reducing the number of app integration touch points, Nielsen has designed a simple interface to pass metadata to the SDK. The new trackevent() API has been implemented as a wrapper for the existing SDK and will be responsible for handling new API calls, performing validation, and translating new API calls to the existing Nielsen App SDK API methods. Applications which are already integrated with the existing SDK API are unaffected by this new API.
[[File:SimplifiedAPI_vs_StandardAPI_New.jpg|2048px|link=https://engineeringportal.nielsen.com/w/images/9/91/SimplifiedAPI_vs_StandardAPI_New.jpg]]
In the Simplified API, one API call will be used to reference many methods. The key-value structure of this API call will provide information for proper crediting. The SDK will utilize the data received in this call and translate it into a sequence of calls linking to the existing API.

[[File:Co-Existance.jpg|center|700px]]
''For iOS SDK framework package will contain 2 public header files. One header file will contain old SDK interface and will be used by existing clients (NielsenAppApi.h). New API will be defined in a new public header file (NielsenEventTracker.h).''

''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

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

== Setting up your Development Environment ==
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release ([[iOS_Static_Framework_Setup|static framework]] is still available).

If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required:<code> [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++] </code>
 

The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be [[DCR_Video_iOS_SDK#Removing_Simulators|found below]].

=== How to obtain the NielsenAppApi.Framework ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of a CocoaPod or Gradle.
* [[Special:Downloads|Select to Download Directly]]
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain Cocoapod implementation guide]]

=== 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 framework support modules, so all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

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

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory.
=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries.
=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting.
=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
You can use Objective-C and Swift files together in a single project, no matter which language the project used originally. This makes creating mixed-language app and framework targets as straightforward as creating an app or framework target written in a single language.

For more detailed information regarding importing [https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift Objective-C into Swift]

==== Using Objective-C ====
Add the code to the View Controller’s header file.
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenEventTracker.h>
</syntaxhighlight>

== 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:]]

The following table contains the list of arguments that should be passed during initialization.

* The appid is provided by the Nielsen Technical Account Manager (TAM).
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen.
It is GUID data type, provided by the Nielsen Technical Account Manager (TAM).
|| 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 || Determines the Nielsen collection facility to which the SDK should connect
'''DTVR'''
* "us"
'''Digital Audio'''
* "drm"
'''DCR'''
* "dcr"
|| Nielsen-specified || Yes || "dcr"
|-
|containerId || View ID of the UI element used as player view in application for Viewability (Future Feature) ||Client-defined||No||"1234567"
|-
|nol_devDebug || Enables Nielsen console logging and is only required for testing ||Nielsen-specified || Optional || "DEBUG"
|}
 

==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">

import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId) //Keep container id unique constant, you can use tag property of player.
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation1, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

Sample code: ViewController
 
<code>ViewController.swift</code>

<syntaxhighlight lang="swift">

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenEventTracker

self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)
</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>
Objective-C Example:
<code>NielsenInit.m</code>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"appname": @"Objc Test app",
@"sfcode": @"dcr",
@"nol_devDebug": @"INFO",
@"containerId": @"1" }; //Keep container id unique constant, you can use tag property of player.

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}
</syntaxhighlight>

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

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

The ViewController.m file could then contain the following line(s):
<syntaxhighlight lang="objective-c">
//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];
/////
-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}
</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.

== Simplified API Syntax ==
The existing API has a number of methods used for reporting player and application state changes to the SDK. The order of calls is important for the SDK in the existing API. In the new simplified API, all these calls will be replaced with one API call that will get one dictionary object with many key-value pairs, where any value could be another complex dictionary object. All the data provided in the older API in separate calls will be provided in one single call.

Main API call for the new NielsenEventTracker API:

<syntaxhighlight lang="objective-c">
- (void)trackEvent:(NSDictionary *)data;
</syntaxhighlight>

=== Handling JSON Metadata ===
Parameter “data” is a JSON object with many key-value pairs that holds all information required by SDK.

Format of input object is the following:
<syntaxhighlight lang="json">
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | Unix Timestamp>,
"id3Data": <id3 payload>,
}
</syntaxhighlight>
 

=== Event Types ===
The New API method supports the following event types:
{| class="wikitable"
!Key
!Description
|-
|'''playhead'''||
It is used to pass content, ad or static metadata, the current playhead value, Unix timestamp or id3 payload, OTT information to the SDK.
|-
|'''pause'''||
This event should be used to in the following cases:
application enters background,
any application interruptions,
content playback is paused. (Pause is detected by SDK automatically only if the time gap between commands exceeds 30 minutes.)
|-
|'''complete'''||
This event should be called when the session is completed, ends, or the user initiates a stop.
|-
|'''adStop'''||
This event should be called at the end of each ad and is required when advertisements have the same assetId.
|}
 
DCR and DTVR require various levels of data. Please select the TAB of the product you are interested in reviewing.
{{DCRDTVRTabs
|DCR=
=== Digital Content Ratings===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object
that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value as reported by video player. Unix timestamp (seconds since Jan-01-1970 UTC) for live video.
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp (live):
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td>'''assetName''' </td>
<td> name of program (100 character limit) </td>
<td> <code>"MyTest789"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> '''assetid''' </td>
<td> unique ID assigned to asset </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream or unknown) </td>
<td> Yes
</td></tr>
<tr>
<td> '''program''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td> '''segB''' </td>
<td> custom segment B ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''segC''' </td>
<td> custom segment C ¹</td>
<td> custom </td>
<td>
</td></tr>
<tr>
<td> '''title''' </td>
<td>name of program (100 character limit) </td>
<td> custom </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>'content', 'ad', 'static'</code></td>
<td> <code> 'content'</code> </td>
<td> Yes
</td></tr>
<tr>
<td>'''section''' </td>
<td> Unique Value assigned to page/site section </td>
<td> HomePage </td>
<td> Yes
</td></tr>
<tr>
<td> '''airdate''' </td>
<td> the airdate in the linear TV ² </td>
<td> YYYYMMDD HH24:MI:SS </td>
<td> Yes
</td></tr>
<tr>
<td> '''isfullepisode''' </td>
<td> full episode flag </td>
<td> <code>"y"</code>- full episode, <code>"n"</code>- non full episode </td>
<td> Yes
</td></tr>
<tr>
<td> '''crossId1''' </td>
<td> standard episode ID </td>
<td> custom </td>
<td> ✓
</td></tr>
<tr>
<td> '''crossId2 '''</td>
<td> content originator (only required for distributors) </td>
<td> Nielsen provided </td>
<td>
</td></tr>
<tr>
<td> adloadtype
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
¹ '''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. 
² Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
For USA all times should be EST, for all other countries Local Time.
Below is a sample event for DCR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"cloudApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"},
"ad": {},
"static": {}
},
"playheadPosition": "",
}
</syntaxhighlight>

|DTVR=
=== Digital TV Ratings info ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,pause,complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> channelName
</td>
<td> Any string representing the.channel/stream
</td>
<td> <code>Object</code>
</td>
<td>custom
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1542797780"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>String</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

<tr>

</td></tr>
</table>
Below is a sample event for DTVR. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"adModel":"1",
"channelname":"channel1"
},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
|DCRDTVR=
=== Applies to DCR and DTVR ===
<table>
<tr>
<th> Parameter
</th>
<th> Description
</th>
<th> Supported values
</th>
<th> Example
</th></tr>
<tr>
<td> event
</td>
<td> Event identifier
</td>
<td>
<code> String:
playhead,
pause,
complete,
adStop</code>

</td>
<td><syntaxhighlight lang="swift">"event":"playhead"</syntaxhighlight>
</td></tr>
<tr>
<td> type
</td>
<td> Determines the metadata object that should be used for crediting.
</td>
<td>
<code> String: 
content,
ad,
static</code>

</td>
<td><syntaxhighlight lang="swift">"type":"content"</syntaxhighlight>
</td></tr>
<tr>
<td> metadata
</td>
<td> Object that holds metadata values of specific types 
 Detailed in tables below

</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
</syntaxhighlight>
</td></tr>
<tr>
<td> playheadPosition
</td>
<td> Playhead value or Unix timestamp (seconds since Jan-01-1970 UTC)
</td>
<td> <code>String</code>
</td>
<td>
Position value is Unix timestamp:
<code>
"playheadPosition":"1501225191747"</code>
Position value is playhead:
<code>
"playheadPosition":"10"</code>

</td></tr>
<tr>
<td> id3Data
</td>
<td> Nielsen ID3 payload
</td>
<td> <code>Object</code>
</td>
<td>
<code>
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg
==/_EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60
kZO_Ejkcn2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzC
yBEoIDv2kA2g1QJmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxa
hBcQP5tqbjhyMzdVqrMKuvvJO1jhtSXa9AroChb11ZUnG1W
VJx2O4M=/33648/22847/00"</code>

</td></tr>
<tr>
<td> ottData
</td>
<td> Object that holds OTT information
</td>
<td> <code>Object</code>
</td>
<td><syntaxhighlight lang="swift">
"ottData": {
"ottStatus": 1,
"ottType": casting,
"ottDevice": chromecast,
"ottDeviceID": 1234
}
</syntaxhighlight>
</td></tr>
</table>
=== Content Metadata ===
Content metadata sent for every playheadposition update.
<table>
<tr>
<th> Keys </th>
<th> Description </th>
<th> Example </th>
<th> Required
</th></tr>
<tr>
<td> '''length''' </td>
<td> length of content in seconds </td>
<td> <code>seconds</code> (0 for live stream) </td>
<td> Yes
</td></tr>
<tr>
<td>'''type'''</td>
<td><code>"content", "ad", "static"</code></td>
<td> <code> "content"</code> </td>
<td> Yes
</td></tr>
<tr>
<td> adModel
</td>
<td> linear vs dynamic ad model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
<tr>
<td> adloadtype
</td>
<td> DCR Ad Model
</td>
<td> 1=Linear
2=Dynamic Ads
</td>
<td>custom
</td></tr>
</table>
+ '''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. 
++ Acceptable '''Air Date''' Formats:
<syntaxhighlight lang="json">
YYYYMMDD HH24:MI:SS
YYYYMMDDHH24MISS
YYYY-MM-DDTHH:MI:SS
YYYY-MM-DDHH:MI:SS
YYYYMMDDHH:MI:SS
MM-DD-YYYY
YYYYMMDD HH:MI:SS
</syntaxhighlight>
 
Below is a sample event for DCR/DTVR joint integration. If no ad or static values, these can be left as blank/null.
<syntaxhighlight lang="json">
{
"event": "playhead",
"type": "content",
"metadata": {
"content":{
"type":"content",
"length":"0",
"adModel":"1",
"adloadtype":"1"},
"ad": {},
"static": {}
},
"playheadPosition": "",
"id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}
</syntaxhighlight>
}}

=== 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 !! Example
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || <code>'AD1234'</code>
|-
| title || unique name assigned to ad || custom ||<code>'ADtitle'</code>
|-
|adldx || Ad Index (*See Note below*) || custom || <code> "66478364" </code>
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || <code>'preroll'</code>
|-
|length || length of ad || In Seconds ||<code> '20' </code>
|}
=== Ad Metadata Sample ===
<syntaxhighlight lang="json">
{
"ad": {
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
},
}
</syntaxhighlight>

=== Managing Ads ===
If there is an Ad block within the playing content (such as a midroll) you need to:
* Reset the playhead position to 0 for each ad.
* Call the '''adStop''' event at the end of each ad or increment the adldx

The Simplified SDK can automatically detect the change from ad to content as well as ad to ad if the assetID changes; however, there could be situations where the same ad is played back to back.

Sometimes it is not possible for integrators to provide different assetId value for individual ads in a sequence of ads. Taking this into account, the Simplified API will support a new parameter for ad metadata: '''adIdx'''. This parameter is an index of an individual ad in a sequence of ads. Once the next ad is started the adIdx parameter should be changed and provided as part of ad metadata.
You can either increment/change the adldx value, and/or call adStop at the end of each Ad.

<syntaxhighlight lang="swift">
// Example of passing both values
self.data.updateValue("adStop", forKey: "event")
self.data.updateValue("223", forKey: "adldx")
self.nielsenEventTracker.trackEvent(data)
</syntaxhighlight>

=== Static Metadata ===
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type identifier || <code> "static" </code> || ✓
|-
| assetid || unique ID assigned for each article/section || custom || ✓
|-
|section || Unique Value assigned to page/site section || HomePage || Yes
|-
| segA ||name of program (25 character limit); limit to 25 unique values across custom segments (segA + segB + segC) || custom || Yes
|-
| segB || custom segment B; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
| segC || custom segment C; limit to 25 unique values across custom segments (segA + segB + segC) || custom ||
|-
|}
<syntaxhighlight lang="json">
{
"static":
{
"type": "static",
"section": "homeSection",
"assetid": "AID885-9984",
"segA": "CustomSegmentValueA",
"segB": "CustomSegmentValueB",
"segC": "CustomSegmentValueC",
}
},
</syntaxhighlight>

=== Putting it all together ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
func loadPreRollAd() -> [String : Any] {

//Loading Ad data

url = NSURL(string: "http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8")

let content = [
"assetName":"Big Buck Bunny",
"assetid":"B66473",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"app_Mainpage",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"crossId1":"Standard Episode ID",
"crossId2" :"Content Originator",
"adloadtype":"2"
]

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"
]

let ad = [
"assetid":"AD12345",
"title":"ADTestTitle",
"adldx":"1",
"type":"preroll",
"length":"20"
]

let metadata = [
"content" : content,
"ad" : ad,
"static" : staticObj
] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"playheadPosition": "0",
"type": "ad",
] as [String : Any]

return data
}
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods
//Loading content Data
- (NSDictionary *)loadContentData
{
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"app_Mainpage",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

NSDictionary *staticObj = @{ @"type":@"static",
@"section":@"homeSection",
@"segA":@"CustomSegmentValueA",
@"segB":@"CustomSegmentValueB",
@"segC":@"CustomSegmentValueC" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @staticObj };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}
</syntaxhighlight>
}}

== JSON examples ==
Additional JSON examples such as:

* [[Digital_Measurement_Simplified_SDK_Supplements#Static_Metadata|Static Metadata Only]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Ad_Metadata|Ad Metadata Example]]
* [[Digital_Measurement_Simplified_SDK_Supplements#ID3_Payload|ID3 payload for DTVR]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Pause_Event|Sample Pause Event]]
* [[Digital_Measurement_Simplified_SDK_Supplements#Complete_Event|Sample Complete Event]]

== Handling Foreground and Background states ==
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by [https://developer.apple.com/library/content/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/TheAppLifeCycle/TheAppLifeCycle.html Apple:]

Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.

== Privacy and Opt-Out ==
There are three 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)
# '''[[#App_Level_Opt_Out|App Level Opt-Out]]''' - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged

=== 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/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="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>
 
=== App Level Opt Out ===
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
* Implement the UIWebView delegate method to open the Nielsen Privacy web page
* Capture user's selection
* Pass the selection back to the SDK via the <code>userOptOut</code>.

==== Capture and forward user selection ====
<syntaxhighlight lang="objective-c">-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@”%@”,request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}</syntaxhighlight>

*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== Example Code ==
=== Putting it all together ===
The below code was built to show the functionality of the Nielsen Simplified API using a standard no-frills player. An Advanced Player is available with the SDK Bundle.
{{ExampleCode|
|Swift =
[[File:iphonescreenshot.png|thumb]]
=== Swift Version 4 Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKSwift.zip Download Project Files]
==== NielsenInit.swift ====

<syntaxhighlight lang="swift">
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only
//
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createEventTracker(delegate: NielsenEventTrackerDelegate) -> NielsenEventTracker?{

//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

var nielsenEventTracker: NielsenEventTracker?

let appInformation = [

"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0",
"appname": "Amazing app",
"sfcode": "dcr",
"nol_devDebug": "DEBUG",
"containerId": String(containerId)
]

nielsenEventTracker = NielsenEventTracker(appInfo:appInformation, delegate:delegate)
return nielsenEventTracker
}
}
</syntaxhighlight>

==== SDKMethods.swift ====
<syntaxhighlight lang="swift">

import Foundation

class SDKMethods : NSObject {

var nielsenApi : NielsenAppApi!
var url = NSURL(string: "")
var content : NSDictionary!

//Loading Static Data
func loadStatic() -> [String : Any] {

let staticObj = [
"type":"static",
"section":"homeSection",
"segA":"CustomSegmentValueA",
"segB":"CustomSegmentValueB",
"segC":"CustomSegmentValueC"]

let metadata = [
"content" : [String:String](),
"ad" : [String:String](),
"static" : staticObj ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type": "static",
"playheadPosition": "0" ] as [String : Any]

return data
}

//Loading content Data
func loadContent() -> [String : Any] {

url = NSURL(string: "http://www.nielseninternet.com/NielsenConsumer/prog_index.m3u8")

let content = [
"assetName":"ChromeCast1",
"assetid":"C77664",
"length":"3600",
"program":"MyProgram",
"segB":"CustomSegmentValueB",
"segC":"segmentC",
"title":"S2,E3",
"type":"content",
"section":"myApi_app",
"airdate":"20180120 10:00:00",
"isfullepisode":"y",
"adloadtype":"2",
"channelName":"My Channel 1",
"pipMode":"false" ]

//Ad data,static data should be empty in content video dictionary
let metadata = [
"content" : content,
"ad" : [String:String](),
"static" : [String:String]() ] as [String : Any]

let data = [
"metadata" : metadata,
"event": "playhead",
"type":"content",
"playheadPosition": "0" ] as [String : Any]

return data

}
}
</syntaxhighlight>
==== ViewController.swift ====
<syntaxhighlight lang="swift">

import UIKit
import AVKit
import CoreLocation
import AdSupport
import AVFoundation
import NielsenAppApi

class ViewController: UIViewController, NielsenEventTrackerDelegate, AVPlayerViewControllerDelegate {

var videoType : Int!
var player : AVPlayer!
var playerController : AVPlayerViewController!
var sdkMethods : SDKMethods!
var nielsenEventTracker : NielsenEventTracker!

var data : [String : Any]!
var timeObserver: Any!
var totalVideosPlayed = 0
var totalVideos : Int!

override func viewDidLoad() {
super.viewDidLoad()

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
self.nielsenEventTracker = NielsenInit.createEventTracker(delegate: self)

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = SDKMethods()

if(videoType == Constants.onlyContent){
//loading video content data
self.data = sdkMethods.loadContent()
}else{
//loading Ad data
self.data = sdkMethods.loadPreRollAd()
}

setPlayer()
setPlayHeadPosition()

//Setting observer to know the completion of video
setVideoFinishObserver()
}

override func viewDidAppear(_ animated: Bool) {
//loading static data
let staticData = sdkMethods.loadStatic()

//sending static data to SDK.
self.nielsenEventTracker.trackEvent(staticData)
}

func setPlayer() {

//creating player
player = AVPlayer.init(url: sdkMethods.url! as URL)
playerController = AVPlayerViewController()
playerController.view.frame = CGRect(x:0 , y:100, width: self.view.frame.width, height: 300)
playerController.player = player;
playerController.showsPlaybackControls = true;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
player.addObserver(self, forKeyPath: "rate", options: NSKeyValueObservingOptions.new, context: nil)
player.play()

self.addChildViewController(playerController)
self.view.addSubview(playerController.view)
}

func setPlayHeadPosition() {

//Setting play head position
let timeInterval : CMTime = CMTimeMakeWithSeconds(1.0, 10)
playerController.player?.addPeriodicTimeObserver(forInterval: timeInterval, queue: DispatchQueue.main) {(elapsedTime: CMTime) -> Void in

let time : Float64 = self.playerController.player!.currentTime().seconds;
let pos = Int64(time);
let playHeadPos = String(pos)

//updating playHead position in dictionary.
self.data.updateValue(playHeadPos, forKey: "playheadPosition")

//Sending data dictionary to SDK with updated playHead position.
self.nielsenEventTracker.trackEvent(self.data)
}
}

func setVideoFinishObserver() {

//observer fires on completion of Video
NotificationCenter.default.addObserver(self, selector: #selector(playerDidFinishPlaying), name: NSNotification.Name.AVPlayerItemDidPlayToEndTime, object: playerController.player?.currentItem)
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
if keyPath == "rate" {
if let rate = change?[NSKeyValueChangeKey.newKey] as? Float {

if rate == 0.0 {
print("Playback stopped")

//on video pause, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

//sending the dictionary to SDK with "pause" event.
self.nielsenEventTracker.trackEvent(self.data)
}
if rate == 1.0 {
print("normal playback")

//On Play resume setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
}
}
}
}

override func viewDidDisappear(_ animated: Bool) {

//on moving to other screen, updating event as pause in dictionary
self.data.updateValue("pause", forKey: "event")

player.rate = 0
player.pause()
}

@objc func playerDidFinishPlaying(note: NSNotification) {

self.player?.removeObserver(self, forKeyPath: "rate")

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1

if(videoType == Constants.onlyContent || totalVideosPlayed == totalVideos){
//When content video completes or total videos finishs, let's send complete event to SDK
sendCompleteEventToSDK()
}else{
//On completion of Ad updating "adStop" event to SDK.
self.data.updateValue("adStop", forKey: "event")

//sending "adStop" event to SDK.
self.nielsenEventTracker.trackEvent(data)
}

//Checking if total videos played or not.
if(totalVideosPlayed != totalVideos){

//Checking if videoType is contentWithOneAd, then after completion of Ad, will play the content video.
if(videoType == Constants.contentWithOneAd){

//loading video content data
self.data = sdkMethods.loadContent()
}else if(videoType == Constants.contentWithTwoAds){
if(totalVideosPlayed == 1){

//loading 2nd Ad data
self.data = sdkMethods.loadMidRollAd()
}else{

//loading video content data
self.data = sdkMethods.loadContent()
}
}
setPlayer()

//Adding observer to player to check is buffering finished
self.timeObserver = player.addPeriodicTimeObserver(forInterval: CMTime(value: 1, timescale: 3), queue: DispatchQueue.main) { [weak self] time in

//checking the video player status
self?.handlePlayerStatus(time: time)
self?.setPlayHeadPosition()

//Setting observer to know the completion of video
self?.setVideoFinishObserver()

}
}
}

func handlePlayerStatus(time: CMTime) {
if player.status == .readyToPlay {

// buffering is finished, setting event as Playhead
self.data.updateValue("playhead", forKey: "event")
player.removeTimeObserver(self.timeObserver)
}
if player.status == .unknown{
print("Buffering")
}
}

func sendCompleteEventToSDK(){

//onCompletion of video, updating event as complete in dictionary
self.data.updateValue("complete", forKey: "event")

//sending the dictionary to SDK with "complete" event.
self.nielsenEventTracker.trackEvent(self.data)
}

deinit {

print("Remove NotificationCenter Deinit")
NotificationCenter.default.removeObserver(self)
}
}

</syntaxhighlight>

|Objective C =
[[File:iphonescreenshot.png|thumb]]
=== Objective-C Code Example ===
Select the below link to download the sample files 
[https://engineeringportal.nielsen.com/w/downloads/digital/sampleapplications/TrackEvent-SDKObjC.zip Download Project Files]
==== NielsenInit.m ====
<syntaxhighlight lang="Objective-C">
// NielsenInit.m
// VideoPlayerAppObjC
// This is sample code of a very basic implementation of the Nielsen 'Simplified API'
// This code is for educational purposes only

#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788BC653CA",
@"appversion": @"1.0",
@"appname": @"Abdul's Objc Test app",
@"sfcode": @"dcr",
@"ccode": @"123",
@"dma":@"456",
@"uoo":@"0",
@"nol_devDebug": @"INFO",
@"containerId": @"1" };

return [[NielsenEventTracker alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

==== NielsenInit.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface NielsenInit : NSObject

+ (NielsenEventTracker *)createNielsenEventTrackerWithDelegate:(id<NielsenEventTrackerDelegate>)delegate;

@end
</syntaxhighlight>

==== SDKMethods.m ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>
#import "SDKMethods.h"

@implementation SDKMethods

//Loading content Data
- (NSDictionary *)loadContentData
{

self.url = [NSURL URLWithString:@"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerEscapes.mp4"];

NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

//Ad data,static data should be empty in content video dictionary
NSDictionary *metadata = @{ @"content" : content,
@"ad" : @{},
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"content",
@"playheadPosition": @"0" };

return data;
}

//Loading Ad data
- (NSDictionary *)loadPreRollAd
{
self.url = [NSURL URLWithString:@"http://www.nielseninternet.com/NWCC-3002/prog_index.m3u8"];

//We should pass content dictionary also in Ad video.
NSDictionary *content = @{ @"assetName":@"ChromeCast1",
@"assetid":@"C77664",
@"length":@"3600",
@"program":@"MyProgram",
@"segB":@"CustomSegmentValueB",
@"segC":@"segmentC",
@"title":@"S2,E3",
@"type":@"content",
@"section":@"cloudApi_app",
@"airdate":@"20180120 10:00:00",
@"isfullepisode":@"y",
@"adloadtype":@"2",
@"channelName":@"My Channel 1",
@"pipMode":@"false" };

NSDictionary *ad = @{ @"assetid":@"AD12345",
@"title":@"ADTestTitle",
@"type":@"preroll",
@"length":@"20" };

//static data should be empty in Ad video
NSDictionary *metadata = @{ @"content" : content,
@"ad" : ad,
@"static" : @{} };

NSDictionary *data = @{ @"metadata" : metadata,
@"event": @"playhead",
@"type": @"ad",
@"playheadPosition": @"0" };

return data;
}

@end

</syntaxhighlight>

==== SDKMethods.h ====
<syntaxhighlight lang="Objective-C">
#import <Foundation/Foundation.h>

@interface SDKMethods : NSObject

@property(nonatomic, strong) NSURL *url;

- (NSDictionary *)loadContentData;
- (NSDictionary *)loadPreRollAd;

@end
</syntaxhighlight>

==== ViewController.m ====
<syntaxhighlight lang="Objective-C">
#import "ViewController.h"
#import "NielsenInit.h"
#import "SDKMethods.h"
#import <MediaPlayer/MediaPlayer.h>
#import <AVKit/AVKit.h>
#import "Constants.h"

#import <NielsenAppApi/NielsenEventTracker.h>

NSMutableDictionary *mutableData;
NSDictionary *data;
SDKMethods *sdkMethods;
AVPlayer *player;
AVPlayerViewController *playerController;
NielsenEventTracker *nielsenEventTracker;

int totalVideosPlayed = 0;
id timeObserver;

@interface ViewController()<AVPlayerViewControllerDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Mark: In NielsenInit class we are initialising the NielsenEventTracker.

//Getting the instance of NielsenEventTracker
nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Mark: In SDKMethods class we wrote methods which creates content,Ad objects
sdkMethods = [[SDKMethods alloc] init];

if(self.videoType == onlyContent){
//loading video content data
data = [sdkMethods loadContentData];
}else{
//loading Ad data
data = [sdkMethods loadPreRollAd];
}

//Converting "data" to mutable dictionary as we have to update playhead, event values.
mutableData =[data mutableCopy];

[self setPlayer];
[self setPlayHeadPosition];

//Setting observer to know the completion of video
[self setVideoFinishObserver];
}

-(void) setPlayer {

//creating player
player = [AVPlayer playerWithURL:[sdkMethods url]];
playerController = [[AVPlayerViewController alloc] init];
playerController.view.frame = CGRectMake(0,100,self.view.frame.size.width,300);
playerController.player = player;
playerController.showsPlaybackControls = YES;
playerController.delegate = self;

//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];

[player play];

[self addChildViewController:playerController];
[self.view addSubview:playerController.view];
}

-(void) setPlayHeadPosition {

//Setting play head position
CMTime timeInterval = CMTimeMakeWithSeconds(1, 1);
[player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){
NSTimeInterval seconds = CMTimeGetSeconds(time);
NSInteger intSec = seconds;
NSString* strSec = [NSString stringWithFormat:@"%li", intSec];

//updating playHead position in dictionary.
[mutableData setValue:strSec forKey:@"playheadPosition"];

//Sending data dictionary to SDK with updated playHead position.
[nielsenEventTracker trackEvent:mutableData];
}];
}

- (void) setVideoFinishObserver {

//observer fires on completion of Ad
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(itemDidFinishPlaying:) name:AVPlayerItemDidPlayToEndTimeNotification object:playerController.player.currentItem];
}

//rate 0.0 = Video Pause or stopped
//rate 1.0 = Video played or resumed
//rate -1.0 = Play reversed/rewind.
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if (object == player && [keyPath isEqualToString:@"rate"]) {
NSNumber * newValue = [change objectForKey:NSKeyValueChangeNewKey];
int intValue = newValue.intValue;
if(intValue == 0){
NSLog(@"playback paused");

//on video pause, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//sending the dictionary to SDK with "pause" event.
[nielsenEventTracker trackEvent:mutableData];

}else if(intValue == 1){
NSLog(@"Normal playback");

//On Play resume setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];

}
}
}

- (void)viewDidDisappear:(BOOL)animated
{
//on moving to other screen, updating event as pause in dictionary
[mutableData setValue:@"pause" forKey:@"event"];

//As it is a pause event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

player.rate = 0;
[player pause];

[super viewDidDisappear:animated];
}

-(void)itemDidFinishPlaying:(NSNotification *) notification {

[player removeObserver:self forKeyPath:@"rate"];

[self sendCompleteEventToSDK];

//As 1 video completed playing, incrementing the variable value.
totalVideosPlayed += 1;

//Checking if total videos played or not.
if(totalVideosPlayed != self.totalVideos){

//Checking if videoType is contentWithAd, then after completion of Ad, will play the content video.
if(self.videoType == contentWithAd){

//loading video content data
data = [sdkMethods loadContentData];

mutableData =[data mutableCopy];

[self setPlayer];

//Adding observer to player to check is buffering finished
CMTime timeInterval = CMTimeMakeWithSeconds(1, 3);
timeObserver = [player addPeriodicTimeObserverForInterval:(timeInterval) queue:dispatch_get_main_queue() usingBlock:^(CMTime time){

//checking the video player status
[self handlePlayerStatus:time];
[self setPlayHeadPosition];
//Setting observer to know the completion of video
[self setVideoFinishObserver];

}];

}
}
}

- (void) handlePlayerStatus : (CMTime) time {

if(player.status == AVPlayerItemStatusReadyToPlay){

// buffering is finished, setting event as Playhead
[mutableData setValue:@"playhead" forKey:@"event"];
[player removeTimeObserver:timeObserver];
}
}

- (void) sendCompleteEventToSDK {

//onCompletion of video, updating event as complete in dictionary
[mutableData setValue:@"complete" forKey:@"event"];

//As it is a complete event setting the playheadPosition to empty.
[mutableData setValue:@"" forKey:@"playheadPosition"];

//sending the dictionary to SDK with "complete" event.
[nielsenEventTracker trackEvent:mutableData];
}

- (void)dealloc {
NSLog(@"Remove NotificationCenter dealloc");
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
@end
</syntaxhighlight>

==== ViewController.h ====
<syntaxhighlight lang="Objective-C">
#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface ViewController : UIViewController

@property (nonatomic) int videoType;
@property (nonatomic) int totalVideos;

@end
</syntaxhighlight>

==== OptOutVC.m ====
<syntaxhighlight lang="Objective-C">
#import "OptOutVC.h"
#import "NielsenInit.h"

#import <NielsenAppApi/NielsenEventTracker.h>

@interface OptOutVC ()

@property (weak, nonatomic) IBOutlet UIWebView *webView;

@end

@implementation OptOutVC

- (void)viewDidLoad {
[super viewDidLoad];

self.nielsenEventTracker = [NielsenInit createNielsenEventTrackerWithDelegate:nil];

//Getting the optPut URL from eventTracker
[self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.nielsenEventTracker.optOutURL]]];
}

@end
</syntaxhighlight>

==== OptOutVC.h ====
<syntaxhighlight lang="Objective-C">

#import <UIKit/UIKit.h>

@class NielsenEventTracker;
@protocol NielsenEventTrackerDelegate;

@interface OptOutVC : UIViewController

@property (nonatomic, weak) NielsenEventTracker *nielsenEventTracker;

@end
</syntaxhighlight>

}}