DCR Norway Audio ios App SDK - Revision history

FaraazAli: /* Create Content Metadata */

2021-09-09T10:07:01Z

Create Content Metadata

← Older revision		Revision as of 10:07, 9 September 2021
Line 251:		Line 251:
	\| length \|\| length of content in seconds \|\| <code>seconds</code> ("0" for 24/7 Livestream if only one assetid is used for the whole stream. If reporting on program level, length of the program. For Event-Livestreams planned length. For on-demand stream length) \|\| ✓		\| length \|\| length of content in seconds \|\| <code>seconds</code> ("0" for 24/7 Livestream if only one assetid is used for the whole stream. If reporting on program level, length of the program. For Event-Livestreams planned length. For on-demand stream length) \|\| ✓
	\|-		\|-
	\| airdate \|\| the airdate in the linear over-the-air broadcast \|\| Supported formats are:		\| airdate \|\| the airdate in the linear over-the-air broadcast (publication date). <BR>This is required for both LIVE & VOD\|\| Supported formats are:


Line 266:		Line 266:
	MM-DD-YYYY		MM-DD-YYYY

	MM/DD/YYYY		MM/DD/YYYY
	\|\| ✓		\|\| ✓
	\|-		\|-
	\| scheduledEndDate \|\| the airdate when this particular asset ended in the linear over-the-air broadcast \|\| should be same format as airdate \|\| ✓		\| scheduledEndDate \|\| the airdate when this particular asset ended in the linear over-the-air broadcast. <BR>This is required for both LIVE & VOD. In the case of VOD, this will be the airdate + length. \|\| This should be the same format as airdate \|\| ✓
	\|-		\|-
	\| isfullepisode \|\| full episode flag \|\| <code>"y"</code>- full episode, <code>"n"</code>- non full episode \|\| ✓		\| isfullepisode \|\| full episode flag \|\| <code>"y"</code>- full episode, <code>"n"</code>- non full episode \|\| ✓

ColinBrown at 18:45, 26 May 2021

2021-05-26T18:45:10Z

← Older revision		Revision as of 18:45, 26 May 2021
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|US DCR ~~& DTVR~~}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|International DCR}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

FaraazAli: /* Create Content Metadata */

2021-04-19T09:00:03Z

Create Content Metadata

@@ Line 233: / Line 233: @@
 Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
 <blockquote> program and title metadata values should be passed to SDK as UTF-8 strings. </blockquote>
-{{DCR Content Metadata}}
 ==== Metadata Example ====
@@ Line 241: / Line 325: @@
 let contentMetadata = [
      "type": "content",
      "assetid": "C77664",
      "title": "Program S2, E3",
@@ Line 248: / Line 333: @@
      "airdate": "20200321 10:05:00",
      "adloadtype": "2",
-    "segB": "CustomSegmentValueB", //optional
 ];
 </syntaxhighlight>
@@ Line 259: / Line 341: @@
 NSDictionary * contentMetadata = @ {
      @ "type": @ "content",
      @ "assetid": @ "C77664",
      @ "title": @ "S2,E3",
@@ Line 266: / Line 349: @@
      @ "airdate": @ "20200321 10:05:00",
      @ "adloadtype": @ "2",
-    @ "segB": @ "CustomSegmentValueB", //optional
+}
 </syntaxhighlight>

FaraazAli at 08:50, 19 April 2021

2021-04-19T08:50:57Z

Show changes

ColinBrown at 18:43, 19 January 2021

2021-01-19T18:43:27Z

← Older revision		Revision as of 18:43, 19 January 2021
Line 4:		Line 4:
	== Overview ==		== Overview ==
	The Nielsen software development kit (SDK) is one of multiple frameworks that Nielsen provides to enable measuring linear (live) and on-demand audio and video viewing using desktop computers, mobile devices, OTT devices, etc.		The Nielsen software development kit (SDK) is one of multiple frameworks that Nielsen provides to enable measuring linear (live) and on-demand audio and video viewing using desktop computers, mobile devices, OTT 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:		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]]), and [[Digital Ad Ratings]] (DAR). 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		*Application launch events and how long app was running
	*Time of viewing a sub section / page in the application.		*Time of viewing a sub section / page in the application.

ColinBrown: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{CurrentBreadcrumb}} Category:Digital == Overview == The Nielsen software development kit (SDK)..."

2021-01-19T18:41:31Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{CurrentBreadcrumb}} Category:Digital == Overview == The Nielsen software development kit (SDK)..."

New page

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

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

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

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

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

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

The SDK uses the NSURLSession instead of the deprecated NSURLConnection.

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

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

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

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

Select File/New File/Objective-C File 
Xcode will prompt you to create a bridging header.
[[File:bridgingheader 2x.png|600px|center|link=]] 
Once this file has been created, you need to add the following:
<syntaxhighlight lang="swift">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
<big>'''Using Objective-C'''</big>
Add the code
<syntaxhighlight lang ="objective-c">
#import <NielsenAppApi/NielsenAppApi.h>
</syntaxhighlight>
to the View Controller’s header file.
 

}}

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

* A maximum of four SDK instances per appid are supported. When a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
* When four SDK instances exist, you must destroy an old instance before creating a new one.

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

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required/Obligatory? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || ✓ || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appversion || Release version of the client app. Not needed anymore.|| custom || || 0.1.1
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
'''Norway RAM integrations'''
* "nor"
|| Nielsen-specified || ✓ || "nor"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || required until cretification/going live || "DEBUG"
|}
 
==== Sample SDK Initialization Code ====
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA",
"sfcode": "nor",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

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

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

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

override func viewDidLoad() {
super.viewDidLoad()

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

@implementation NlsAppApiFactory

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

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

@class NielsenAppApi;
@protocol NielsenAppApiDeligate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

*Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

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

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

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

NSDictionary *contentMetadata = @{
@"type": @"content",
@"isAudio": @"true",
@"assetid": [NSString stringWithFormat:@"ProgramAssetId-%d", i],
@"length": @"3600",
@"program", "Program Name",
@"title": @"Program S3, EP1",
@"isfullepisode": @"y",
@"adloadtype": "2",
@"airdate": "20161013 20:00:00",
}
</syntaxhighlight>
}}

=== Configure metadata ===
When starting a streaming session a channel info metadata object needs to be passed to the SDK containing a channelName. The name should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}
 

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

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required/Obligatory
|-
| type || type of asset || <code>"content"</code> || ✓
|-
| isAudio || indicate measurement of audio ads or audio content || <code>"true"</code> || ✓
|-
| assetid || unique ID assigned to asset (64 character limit)|| custom (no [[Special Characters]]) || ✓
|-
| program ||(string) name of program (254 character limit) || custom || ✓
|-
| title ||(string) episode title (max 254 characters) || custom || ✓
|-
| length || length of content in seconds || <code>seconds</code> ("0" for 24/7 Livestream if only one assetid is used for the whole stream. If reporting on program level, length of the program. For Event-Livestreams planned length. For on-demand stream length) || ✓
|-
| airdate || the airdate in the linear over-the-air broadcast || Supported formats are:

YYYY-MM-DDTHH:MI:SS

YYYY-MM-DDHH:MI:SS

YYYY-MM-DDTHH:MI:SS+xx:xx

YYYY-MM-DDTHH:MI:SS-xx:xx

YYYYMMDDHH:MI:SS

MM-DD-YYYY

MM/DD/YYYY
|| ✓
|-
| scheduledEndDate || the airdate when this particular asset ended in the linear over-the-air broadcast || should be same format as airdate || ✓
|-
| isfullepisode || full episode flag || <code>"y"</code>- full episode, <code>"n"</code>- non full episode || ✓
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches over-the-air ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || ✓
|-
| stationType || OTA station flag and/or OTA station type
||
<code>"0"</code> Custom station built per user

<code>"1"</code> OTA streaming station with the same adload

<code>"2"</code> OTA station with a different ad load

<code>"3"</code> Multicast eRadio or online station

<code>"4"</code> On Demand Audio(podcasting)
||
✓
|-
| stationId || (string) name of the channel || custom||✓
|-
| clientid ||
parent ID – value is automatically populated through provided App ID. 
In order to override the brand configured to the App ID, pass parent 
the value here and the sub-brand ID associated with that brand in the subbrand 
key (e.g. multiple brands in App)
||
provided by Nielsen
||
|-
| subbrand || vcid/sub-brand ID – value is automatically populated through provided 
App ID. In order to override the sub-brand configured to the App ID, value can 
be passed here (e.g. multiple sub-brands in App). clientId does not need to be provided.
||
provided by Nielsen
||
|-
| progen || (string) genre information (max 254 characters)
||
custom
||
|}
 

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

== Configure API Calls ==
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelInfo];</code> || // channelInfo contains JSON metadata of channel name being played
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}

=== Life cycle of SDK instance ===
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[play]] and [[loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## [[playheadPosition]] – Call this API every one second when playhead position timer is fired.
## [[stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[end]] – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

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

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

=== API Call sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "My Channel Name 1"
}</syntaxhighlight>

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"isAudio": "true",
"assetid": "stream345-67483",
"program": "ProgramName",
"title": "Program S3, EP1",
"length": "3600",
...
}</syntaxhighlight>

Call [[setPlayheadPosition()]] every one second until a pause / stop.
Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
| rowspan="2" | Start of stream || <code>mAppSdk.play(channelInfo); </code> || // channelInfo contains JSON metadata of channel name being played
|-
| <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "My Channel Name 1"
}</syntaxhighlight>

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad=123"
}</syntaxhighlight>

<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>

Call [[setPlayheadPosition()]] every one second until a pause / stop / another [[loadMetadata()]] is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata()]].

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

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

=== Sequence of Calls ===

=== play ===
Use [[play]] to pass the channel information containing the channelName parameter when the streaming session starts.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> - (void)play:(id)channelInfo;</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play(channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
The loadMetadata function is used to inform the SDK about new content. The contentMetadata object passed in should contain the values as described above.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void)loadMetadata:(id)contentMetadata;</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
Use playheadPosition to tell the SDK about the current position in the stream. For live content this should be the Unix timestamp (seconds since Jan-1-1970 UTC). For on-demand content, simply the position in seconds in the stream.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
– (void) playheadPosition: (long long) playheadPos;
</syntaxhighlight>

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

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

=== stop ===
Tell the SDK that content playback has stopped.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">– (void) stop;</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.stop();</syntaxhighlight>
}}

=== end ===
When content stop is initiated and content cannot be resumed from the same position. For example when the stream has reached its end or in situations where it can only be restarted from the beginning.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">- (void) end;</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.end();</syntaxhighlight>
}}

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

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

iOS|

== iOS Opt-Out Implementation ==
To opt-out, users must have access to the page referenced by the opt-out URL provided by the SDK. Users can click this page from the app settings screen.

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

== iOS 14, PRIVACY, AND OPT-OUT Integration settings. ==
*Version 8 of our App SDK will come in two versions. One that is enabled to work with the App Tracking Transparency Framework, and another version that does not use the Ad Framework.
* Code examples of both methods can be found on this [[Template:iOS_Privacy_and_Opt-Out#User_Choice|LINK]]



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

[[File:Screenshot 2019-05-02 at 11.11.27.png|audio measurement choices]]

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

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

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

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

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

}}

== Going Live ==
Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.

# '''Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:

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

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

'''Note''': before going live you have to inform the Nielsen team - this is necessary because the Nielsen team has to adjust the internal configuration parameter to enable data collection. Without that notification, no data will be collected and no data will be reported.