Engineering Client Portal - User contributions [en]

DCR Ireland Video Android SDK

2023-10-11T09:19:31Z

WilsonQuispe: /* Create Content Metadata */

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

__TOC__

== Overview ==
The Nielsen SDK is one of the 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 It supports a variety of Nielsen Measurement Products like Digital in TV Ratings ([[DCR & DTVR|DTVR]]), Digital Content Ratings ([[DCR & DTVR|DCR]]), 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
*Time of viewing a subsection/page in the application.
 
This ''SDK Android integration guide'' is applicable for '''Android TV''' as well.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-style="background-color:#d0f6f8;"
|| ☑ || "App ID (appid)" || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
|-style="background-color:#d0f6f8;"
|| ☑ || "Nielsen SDK" || Includes SDK frameworks and "sample implementation"; "See [[Android SDK Release Notes]]" || [[Special:Downloads|Download]]
|}

== Implementation ==
The Nielsen Android SDK comes in three flavors.

{| class="wikitable"
|-
! SDK Flavor
! Description
|-
| '''Android Ad Version'''
|* Opt-In and Opt-Out functionality managed by Opt out of Ads Personalization setting on device. * The Nielsen SDK will collect the [https://developer.android.com/training/articles/ad-id Google Advertising ID] unless the user Opts out. * If the Google Play Service is unavailable, (ie: Amazon and Huawei devices) the Nielsen SDK will secure the Android ID. * There are 3 versions available starting with the Nielsen SDK 8.1.0.0.
|-
| '''Android No Ad Framework'''
|* Without the Google Play Services SDK, the Nielsen SDK cannot read the Google Advertising ID, so will retrieve the Android ID. * The Android ID is a 64-bit number (expressed as a hexadecimal string), unique to each combination of app-signing key, user and device. * The developer is required to present the User Choice Opt-Out page which is described in the [[#Global_Android_SDK_No_Ad_Framework_Opt-out|Global Android SDK No Ad Framework Opt-out]].
|-
| '''Android SDK noID'''
|* This version of the Nielsen SDK is perfect for Kid apps, or where no ID is required. * For the requirement, please review the [[#Global_Android_SDK_No_ID_Opt-out|Global Android SDK No ID Opt-out]].
|}

=== How to obtain the NielsenAppApi ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of Gradle. We recommend using the Gradle-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_Android_Artifactory_Guide|Select to obtain Gradle implementation guide]]
* [[Special:Downloads|Select to Download Directly]]

== Setting up your Development Environment ==
=== Configuring Android Development Environment ===
*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.
*The Nielsen App SDK can also be added via [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Android_Artifactory_Guide Artifact Repository].

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

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 search for <code>"*play-services*"</code>. Then select the most recent version of the play-services Artifact.
Ensure it is added in build.gradle (App level) file

==== Google AD ID Permissions ====
The following is required if target API level is set to 31 (Android 12) with the Ad Version of the Nielsen SDK.

<syntaxhighlight lang="java">
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
</syntaxhighlight>


==== Manifest File ====
* Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java">
<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 <code><application></code> 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;

== Create SDK Instance ==
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object when needed, which can then be used simultaneously. '''For the general use case where only one video is played at the same time in the App, a single instance of SDK object can then be used to play back and measure all watched streams one after another.'''

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required/Obligatory? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
|-
| appname || Name of the application || Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used || Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
|| Nielsen-specified || Yes || "ire"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Optional || "DEBUG"

|}
 

1) [[AppSDK()|AppSDK()]] is no longer a singleton object and should be created as below.
<syntaxhighlight lang="java">
try{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("appversion", "1.0.2")
.put("appname", "Nielsen Sample App")
.put("sfcode", "ire")
.put("nol_devDebug", "DEBUG"); // only for debug builds

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

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

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

import com.nielsen.app.sdk.*;

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

public class MainActivity extends AppCompatActivity implements IAppNotifier {

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

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

Context context = getApplicationContext();

try{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("appversion", "1.0.2")
.put("appname", "Nielsen Sample App")
.put("sfcode", "ire")
.put("nol_devDebug", "DEBUG"); // only for debug builds

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

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

}

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

}
</syntaxhighlight>

==== APP SDK Error & Event Codes ====
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.

==== Life cycle of SDK instance ====
Life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the ""Initial state"".
# '''Idle state'''– The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. API calls "play" and "loadMetadata" move the SDK instance into this state. In this state, the SDK instance will be able to process the API calls (see below)
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called
<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

== Create Metadata Objects ==
The parameters passed must be either a JSON formatted string. The JSON passed in the SDK must be well-formed.

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

=== Create channelName Metadata ===
channelName 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 || Yes
|-
|}

==== Create Content Metadata ====
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of episode (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For VoD video length) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes
|-
| segB || custom segment for the clients granular reporting within a brand
|| Example: ChannelName
|| Optional
|-
| segC || custom segment for the clients granular reporting within a brand
|| Example: PlayerName
|| Optional
|}

==== Create Ad Metadata ====
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

'''Note:''' All metadata values should be passed as UTF-8 strings.

<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>

=== MetaData Example ===
<syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelName","My Channel Name 1")

JSONObject contentMetadata = new JSONObject()
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "y")
.put("adloadtype", "2")
.put("airdate", "20161013 20:00:00")
.put("segB", "ChannelName") //optional
.put("segC", "PlayerName") //optional

JSONObject adMetadata = new JSONObject()
.put("type", "postroll")
.put("assetid", "AD-ID123");

</syntaxhighlight>

== Start the Measurement ==

=== Overview of SDK API Calls ===

==== play ====
The play method prepares the SDK for reporting once an asset has loaded and playback has begun. Use play to pass the channel descriptor information through channelName parameter when the user taps the ""Play"" button on the player. Call play only when initially starting the video.

<syntaxhighlight lang="java">mAppSdk.play(JSONObject channelInfo);</syntaxhighlight>

==== loadMetadata ====
Needs to be called at the beginning of each asset, pass JSON object for relevant content or ad. Make sure to pass as 1st loadMetadata for content at the begining of playlist - see below API call sequence examples.
<syntaxhighlight lang="java">mAppSdk.loadMetadata(JSONObject contentMetadata);</syntaxhighlight>

==== playheadPosition ====
Pass playhead position every second during playback. for VOD: pass current position in seconds. for Live: current Unix timestamp (seconds since Jan-1-1970 UTC) - if it is possible to seek back in Live content, then pass related Unix time (not current). Pass whole number that increments only by 1 like 1,2,3..
<syntaxhighlight lang="Java">mAppSdk.setPlayheadPosition(long videoPositon);</syntaxhighlight>

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

<syntaxhighlight lang="java">mAppSdk.stop();</syntaxhighlight>

==== end ====
Call when the content asset completes playback. Stops measurement progress.
<syntaxhighlight lang="java">mAppSdk.end();</syntaxhighlight>
 

=== API Call Sequence ===
==== Use Case 1: Content has no Ads ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "vid345-67483",
"program": "ProgramName",
"title": "Program S3, EP1",
"length": "3600",
...
}</syntaxhighlight>
Call [[setPlayheadPosition()]] every one second until a pause.
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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| Resume Content || <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Ads ====
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 / 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="2" | 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
|-
| 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="2" | 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
|-
| 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>

== Handling Foreground and Background states ==
There are a few approaches to managing the Foreground and Background states of an app available to use for state measurement.

*Utilizing the Androidx LifeCycleObserver (The recommended approach starting sdk version 7.1.0.0+)
*Utilizing the SdkBgFgDetectionUtility class
*Adding a tag to the Manifest XML
*Manual Management
=== The LifeCycleObserver ===
AndroidX replaces the original support library APIs with packages in the androidx namespace, and Android Studio 3.2 and higher provides an automated migration tool. (Select '''Refactor> Migrate to AndroidX''' from the menu bar.)

Starting with version 7.1.0, with AndroidX support, an additional utility is provided in the AppSDK - application background/foreground state detection by the AppSdk leveraging the Android Architecture component "LifeCycleObserver".

The AppSdk is now capable of detecting the application UI visibility state transitions between background and foreground, without forcing the applications to register for AppSdk's AppSdkApplication class, which is responsible for handling the detection of application background/foreground state transitions at present.

<blockquote>Please note, that if you already have an app designed that utilizes the depreciated SdkBgFgDetectionUtility Class, the AppSDK will ignore any calls to these methods if it can utilize the LifeCycleObserver. LifeCycleObserver based auto detection will take precedence.</blockquote>

==== Adding the AndroidX dependency ====
In order to make use of the app background/foreground state transition auto detection feature of AndroidX AppSdk, the app gradle file needs the androidx dependency. The AppSdk API calls - <code>appInForeground()</code> and <code>appInBackground()</code> will still be respected by AppSdk by executing the old AppSdk flow of handling "app in foreground" and "app in background" states as is.

==== Using the LifeCycle Extension ====
The following androidx dependency is required in the app gradle file:

<syntaxhighlight lang="java">implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"</syntaxhighlight>

<blockquote>If you would like to take advantage of this auto detection feature of AppSdk at the very initial stage (e.g. splash screen or at of app launch time), before the AppSdk is initialized, can do so by calling the following newly introduced AppSdk public api, passing the application context :

<syntaxhighlight lang="java">public static void registerLifeCycleObserver(Context applicationContext)</syntaxhighlight></blockquote>

==== Log messages for the new auto detection ====

*When the AppSdk app successfully registers for the LifeCycleObserver : <code>Registered LifeCycleObserver for App Background/Foreground auto-detection</code>
*When the app enters the foreground state :<code>App is in foreground, auto detected by AppSDK</code>
*When the app enters the background state :<code>App is in background, auto detected by AppSDK</code>
*If the client app doesn't have the "androidx" gradle dependency and AppSdk fails to register LifeCycleObserver :<code>AndroidX LifecycleObserver can not be observed. Please use androidx dependency to activate SDK auto-detection of app background/foreground state.</code>
*When the appInForeground() is explicitly called while LifeCycleObserver auto detection is active :<code>Ignoring the appInBackground() call, as the App Background/Foreground auto-detection is active. The current state is - foreground</code>
*When the appInBackground() is explicitly called while LifeCycleObserver auto detection is active :<code>Ignoring the appInBackground() call, as the App Background/Foreground auto-detection is active. The current state is - background</code>

=== The SdkBgFgDetectionUtility class ===
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 [[Android Background Foreground|SdkBgFgDetectionUtility class.]] The [[Android Background Foreground|SdkBgFgDetectionUtility class.]] is compatible with Android 4+ and has been made available to Nielsen clients. (You will need to copy/paste the code provided into a file).

==== Manual Background/ForeGround State Management ====
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [[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());</syntaxhighlight>
<syntaxhighlight lang="java">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).

== Stop/Resume the Measurement for video Playback Interruptions ==
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 (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call <code>stop</code> immediately (except when content is buffering) and withhold sending playhead position.
* Once the playback resumes, start sending pings <code>playheadPosition</code> for the new viewing session.
Please see the [[Digital Measurement FAQ]] for more details

== Review SDK Integration Architecture Diagram ==

=== For Content Playback ===

[[File:nlsn-sdk-achitecture-diagram-content-v1.png||SDK Integration Architecture Diagram - Content]]

=== For Ad Playback ===
[[File:nlsn-sdk-achitecture-diagram-ad-v1.png||SDK Integration Architecture Diagram - Ad]]

== Privacy and Opt-Out ==

=== Global Android SDK No ID Opt-out ===

# Ensure that you are using the No ID version of the Nielsen SDK Framework.
# Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt-out selection:
<syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>

=== 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 https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=en-ie for more information"
(There is also a version in Irish available: https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=ga )'''
</blockquote>

== Optional Step for DCR Chromecast Android SDK ==
For the implementation of Chromecast SDK architecture. Please refer to this guide: [https://engineeringportal.nielsen.com/docs/DCR_Chromecast_Android_SDK DCR Chromecast Android SDK]

== Test your player by yourself ==
=== Guide ===
1. Connect your PC and test device (tablet or phone) via same router. 
2. PC side: run Proxy sw (like Charles) and get local IP 
3. Test device: modify Wifi setting to pass through Proxy IP from step 2. 
4. Test device: run your player, launch video 
5. PC side: filter traffic by "nmrodam" and confirm presence of SDK pings 

=== Example of SDK ping (https call) ===
<code><nowiki>https://secure-ire.nmrodam.com/cgi-bin/gn?prd=dcr&ci=se-910684&ch=se-910684_c01_P&asn=defChnAsset&fp_id=096ohdsc0jqkmct81qpxhmn19qx041630053963&fp_cr_tm=1630053963&fp_acc_tm=1630053963&fp_emm_tm=1630053963&ve_id=afc5d61a88b62672&sessionId=zc6gh3uhka7d2mtobb2b2m7sixygy1630053963&tl=Djuren%20p%C3%A5%20Djuris&prv=1&c6=vc,c01&ca=se-910684_c01_218531&cg=Hemligheter&c13=asid,T1194003B-797F-4896-A5C0-05914236146E&c32=segA,NA&c33=segB,NA&c34=segC,NA&c15=apn,&plugv=4.4.1&playerv=ExoPlayer&sup=1&segment2=&segment1=&forward=0&ad=1&cr=4_00_99_D1_10000&c9=devid,c041ec5e50722cdf8cc5b4826c24ae54c5747a6570e900006c826b37ca01ce17&enc=true&c1=nuid,c041ec5e50722cdf8cc5b4826c24ae54c5747a6570e900006c826b37ca01ce17&at=timer&rt=video&c16=sdkv,aa.8.1.0&c27=cln,34&crs=0&lat=&lon=&c29=plid,16300539624283525&c30=bldv,aa.8.1.0.0_gaxnons&st=dcr&c7=osgrp,&c8=devgrp,&c10=plt,&c40=adbid,&c14=osver,ANDROID.11&c26=dmap,1&dd=&hrd=&wkd=&c35=adrsid,&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,4.4.1.4004001&c51=adl,0&c52=noad,0&sd=578&pc=NA&c53=fef,n&c54=oad,&c55=cref3,&c57=adldf,2&ai=218531&c3=st,c&c64=starttm,1630053962&adid=218531&c58=isLive,false&c59=sesid,257f8bz854wmqa31gk3icyi7cmj131630053964&c61=createtm,1630053997&c63=pipMode,&ci_userid=&is_auto_play=no&pl_title=&is_prem=no&is_prog=&ad_origin=&adidx=&is_tpad=&ci_passthr=&c62=sendTime,1630053997&c68=bndlid,air.se.urplay.android_player.debug&nodeTM=&logTM=&c73=phtype,&c74=dvcnm,&c76=adbsnid,&c77=adsuprt,2&uoo=&evdata=PL%3A1630053964727%3A0&c71=ottflg,0&c72=otttyp,&c44=progen,&davty=1&si=&c66=mediaurl,&sdd=retry,0~~retryreason,~~devmodel,SM-G981B~~devtypid,samsung-SM-G981B~~sysname,Android~~sysversion,11~~manuf,samsung&cat_id=3398d8e4-e613-42c1-92aa-1a6fc52dcf5c&vtoff=0&rnd=1630053997971</nowiki></code>

== Step 9 : Provide your app for certification ==
Once ready please send your application to Nielsen local staff for certification.

== Step 10 : Going Live ==
After the integration has been certified by Nielsen (but not prior to that), do the following:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

DCR Ireland Video iOS SDK

2023-10-11T09:18:48Z

WilsonQuispe: /* Create Content Metadata */

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

== Overview ==
The Nielsen SDK is one of the 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 Content Ratings (DCR), 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
{{iOS_SpecialNotes_for_iOS14}}

{{iOS_Prerequisites_and_Implementation_Overview}}

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== Create SDK Instance ==
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object when needed, which can then be used simultaneously. '''For the general use case where only one video is played at the same time in the App, a single instance of SDK object can then be used to play back and measure all watched streams one after another.'''

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required/Obligatory? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
|-
| appname || Name of the application || Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used || Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
|| Nielsen-specified || Yes || "ire"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Optional || "DEBUG"

|}
 

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string.

* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': DO NOT activate the Debug flag in a production environment.</blockquote>

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

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>

===== Using Objective-C=====
<syntaxhighlight lang="objective-c">
#import "NlsAppApiFactory.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NlsAppApiFactory

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
{
NSDictionary *appInformation = @{
@"appid": "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
@"appversion": "1.0",
@"appname": "app name here",
@"sfcode": "ire",
@"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>

===== Using Swift =====

<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
class NielsenInit: NSObject {
class func createNielsenAppApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"appversion": "1.0",
"appname": "app name here",
"sfcode": "ire",
"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>

==== APP SDK Error & Event Codes ====
To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.

==== Life cycle of SDK instance ====
The life cycle of SDK instance includes four general states:
# '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the '''Initial state'''.
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. API calls "play" and "loadMetadata" move the SDK instance into this state. In this state, the SDK instance will be able to process the API calls (see below)
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
## Initialization fails
## <code>appDisableApi</code> is called

<syntaxhighlight lang="objective-c">
@property (assign) BOOL appDisableApi;
</syntaxhighlight>

== Create Metadata Objects ==
The parameters passed must be either a JSON formatted NSString 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, 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. 

=== Create channelName Metadata ===
channelName 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 || Yes
|-
|}

===Create Content Metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of episode (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For VoD video length) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes
|-
| segB || custom segment for the clients granular reporting within a brand
|| Example: ChannelName
|| Optional
|-
| segC || custom segment for the clients granular reporting within a brand
|| Example: PlayerName
|| Optional
|}

===Create Ad Metadata ===
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

'''Note:''' All metadata values should be passed as UTF-8 strings.

<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>

=== MetaData Example ===

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

NSDictionary *contentMetadata = @
{
@ "type": @ "content",
@ "assetid": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
@ "segB": @ "ChannelName", //optional
@ "segC": @ "PlayerName" //optional
}

NSDictionary *adMetadata = @
{
@"type" : "postroll",
@"assetid" : "AD-ID123"
}
</syntaxhighlight>

==== Using Swift ====
<syntaxhighlight lang="swift">
let channelInfo = [
"channelName": "My Channel Name 1",
]

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
"segB": "ChannelName", //optional
"segC": "PlayerName" //optional
]

let adMetadata = [
"type": "preroll",
"assetid" : "ad123"
]

</syntaxhighlight>

== Start the Measurement ==

=== Overview of SDK API Calls ===

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

==== loadMetadata ====
Needs to be called at the beginning of each asset, pass JSON object for relevant content or ad. Make sure to pass as 1st loadMetadata for content at the begining of playlist - see below API call sequence examples.
===== Using Objective-C =====
<syntaxhighlight lang="objective-c">[self.nielsenAppApi loadMetadata:metadataDict];</syntaxhighlight>
===== Using Swift =====
<syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(metadataDict)</syntaxhighlight>
 

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

==== stop ====
Call when
* ads complete playing
* when a user pauses playback
* upon any user interruption scenario - see bellow chapter Interruption scenario
===== Using Objective-C =====
<syntaxhighlight lang="objective-c">[self.nielsenAppApi stop];</syntaxhighlight>
===== Using Swift =====
<syntaxhighlight lang="swift">self.nielsenAppApi?.stop;</syntaxhighlight>
 

==== end ====
Call when the content asset completes playback. Stops measurement progress.
===== Using Objective-C =====
<syntaxhighlight lang="objective-c">[self.nielsenAppApi end];</syntaxhighlight>
===== Using Swift =====
<syntaxhighlight lang="swift">self.nielsenAppApi?.end</syntaxhighlight>
 

=== API Call Sequence ===
==== Use Case 1: Content has no Ads ====
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "ChannelName"
}</syntaxhighlight>
Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "vid345-67483",
"program": "ProgramName",
"title": "Program S3, EP1",
"length": "3600",
...
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] every one second until a pause.
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(channelName); </code> || // channelName contains JSON metadata of channel/video name being played
|-
| <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>mAppSdk.playheadPosition(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 Ads ====
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "ChannelName"
}</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 [[playheadPosition|playheadPosition()]] every one second until a pause / 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(channelName); </code> || // channelName contains JSON metadata of channel/video 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.playheadPosition(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="2" | 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
|-
| rowspan="6" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(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.playheadPosition(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="2" | Content (End of stream) || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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>

== Stop/Resume the Measurement for video Playback Interruptions ==
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 (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call <code>stop</code> immediately (except when content is buffering) and withhold sending playhead position.
* Once the playback resumes, start sending pings <code>playheadPosition</code> for the new viewing session.
Please see the [[Digital Measurement FAQ]] for more details

== Review SDK Integration Architecture Diagram ==

=== For Content Playback ===

[[File:nlsn-sdk-achitecture-diagram-content-v1.png||SDK Integration Architecture Diagram - Content]]

=== For Ad Playback ===
[[File:nlsn-sdk-achitecture-diagram-ad-v1.png||SDK Integration Architecture Diagram - Ad]]

{{iOS_NoID_Privacy_and_Opt-Out}}

{{iOS_Airplay}}
== Test your player by yourself ==
=== Guide ===
1. Connect your PC and test device (tablet or phone) via same router. 
2. PC side: run Proxy sw (like Charles) and get local IP 
3. Test device: modify Wifi setting to pass through Proxy IP from step 2. 
4. Test device: run your player, launch video 
5. PC side: filter traffic by "nmrodam" and confirm presence of SDK pings 

=== Example of SDK ping (https call) ===
<code><nowiki>https://secure-ire.nmrodam.com/cgi-bin/gn?prd=dcr&ci=se-910685&ch=se-910685_c01_P&asn=defChnAsset&fp_id=a2nfmy17lyvkhlxqstvmgypqly90m1629966210&fp_cr_tm=1629966210&fp_acc_tm=1629966210&fp_emm_tm=1629966210&ve_id=20A7CFD5-9860-4256-A6CE-45C251F4C243&sessionId=yvx0rtsxydmaxueji8zgfzj0f2f1w1629966209&tl=&prv=1&c6=vc,c01&ca=se-910685_c01_51HERB1501&cg=Play%20%3E%20Webbtv%20%3E%20Nyheter&c13=asid,P3D8D326A-2DBC-486A-8FD8-9AF4452B2A41&c32=segA,NA&c33=segB,NA&c34=segC,NA&c15=apn,Aftonbladet&plugv=&playerv=&sup=1&segment2=&segment1=&forward=0&ad=1&cr=4_00_99_D1_00000&c9=devid,12b9377cbe7e5c94e8a70d9d23929523d14afa954793130f8a3959c7b849aca8&enc=true&c1=nuid,12b9377cbe7e5c94e8a70d9d23929523d14afa954793130f8a3959c7b849aca8&at=timer&rt=video&c16=sdkv,ai.8.1.0&c27=cln,15&crs=&lat=&lon=&c29=plid,16299662096458868&c30=bldv,ai.8.1.0.0_gsxaoni&st=dcr&c7=osgrp,&c8=devgrp,&c10=plt,&c40=adbid,&c14=osver,iOS14.6&c26=dmap,1&dd=&hrd=&wkd=&c35=adrsid,&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,5.47.83.0.25245&c51=adl,15&c52=noad,1&sd=15&pc=NA&c53=fef,n&c54=oad,&c55=cref3,&c57=adldf,2&ai=51HERB1501&c3=st,a&c64=starttm,1629966240&adid=51HERB1501&c58=isLive,false&c59=sesid,iqal6k21r0de8gm901kif5xznar7q1629966240&c61=createtm,1629966255&c63=pipMode,&ci_userid=&is_auto_play=&pl_title=&is_prem=&is_prog=&ad_origin=&adidx=1%2F1&is_tpad=&ci_passthr=&c62=sendTime,1629966255&c68=bndlid,se.aftonbladet.Aftonbladet&c69=cvw,&nodeTM=&logTM=&c73=phtype,&c74=dvcnm,&c76=adbsnid,&uoo=&c44=progen,&davty=1&si=&c66=mediaurl,&sdd=retry,0~~retryreason,~~devmodel,iPhone9%2C4~~devtypid,iPhone9%2C4~~sysname,iOS~~sysversion,14.6~~manuf,Apple&cat_id=a6f7fb13-8801-484c-9692-6db6dfb470aa&vtoff=0&rnd=1629966255319</nowiki></code>

== Provide your app for certification ==
Once ready please send your application to Nielsen local staff for certification.

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

DCR Poland Video iOS SDK

2023-09-28T11:15:24Z

WilsonQuispe: /* Special Notes regarding iOS17 */

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

__TOC__

== 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]]), 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

== Prerequisites ==
To start using the App SDK, the following items are required:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
|-
|| ☑ || '''sfcode''' || Environment that the SDK must point to || Contact Nielsen
|-
|| ☑ || '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|}

If you do not have any of these pre-requisites 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 utilizing the Standard Nielsen SDK for DCR.

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ DCR_and_DTVR_with_iOS17_or_TVOS17|Nielsen Digital Measurement and iOS17 or TVOS17]]

Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

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

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || Optional; automatically detected in SDK 6.0.0.4 and above || Nielsen Sample App
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
* "pl"
|| Nielsen-specified || Yes || pl
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Optional || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"INFO"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': DO NOT activate the Debug flag in a production environment.</blockquote>

=== 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 createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "pl",
"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, AVPlayerViewControllerDelegate {

// your code//

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenApi
self.nielsenApi = NielsenInit.createNielsenApi(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>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NielsenInit

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate
{
NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"sfcode": @"pl",
@"nol_devDebug": @"DEBUG", };

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

@end
</syntaxhighlight>

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

@class NielsenAppApi;
@protocol NielsenAppApiDelegate;

@interface NielsenInit : NSObject

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

@end
</syntaxhighlight>
Sample Code:
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];
</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.

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

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

NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "C77664",
@ "title": @ "S2,E3",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20180120 10:00:00",
@ "adloadtype": @ "2",
@ "segB": @ "CustomSegmentValueB", //optional
@ "segC": @ "CustomSegmentValueC", //optional
}
</syntaxhighlight>
}}

=== ChannelName metadata ===
channelName should remain constant throughout the completion of an episode or live stream.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| channelName || ChannelInfo refers to the Channel name. This can be a free-form value
value such as a friendly name for the content being played. the SDK 
will pass the application name automatically.
|| custom || No
|-
|}

==== Content Metadata ====
Content metadata should remain constant throughout the entirety of an episode / clip including when ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset (max 64 characters; only characters 0-9, a-z, A-Z underscore and minus are allowed - no special characters or vowel mutations) || custom (no [[Special Characters]])|| ✓
|-
| program || (string) name of program (max 254 characters) || custom || ✓
|-
| title || (string) episode title (max 254 characters) || custom - no backslash allowed in string (because of 3rd party data processing) || ✓
|-
| length || (int) length of content in seconds || 86400 seconds for live stream. For Event-Livestreams planned length. For VoD video length|| ✓
|-
| airdate || The airdate in the linear TV. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || 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 
YYYYMMDD HH:MI:SS 
MM-DD-YYYY 
MM/DD/YYYY 
(pass beginning of epoch if unknown)
|| ✓
|-
| isfullepisode || full episode flag || "y"- full episode, "n"- non full episode || ✓
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || ✓
|-
| progen || program genre || custom ||
|-
| segB || custom segment || custom ||
|-
| segC || custom segment || custom ||
|-
| crossId1 || standard episode ID || custom ||
|-
| clientid ||
parent ID – value is automatically populated through provided AppID. 
In order to override the brand configured to the AppID, pass parent 
value here and the sub-brand ID associated to 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 
AppID. In order to override the sub-brand configured to the AppID, value can 
be passed here (e.g. multiple sub-brands in App)
||
provided by Nielsen
||
|}

=== 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 || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code>|| ✓
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || ✓
|}

=== Example Ad Object ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let adMetadata = [
"type": "preroll",
"assetid": "123456"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary * adMetadata = @ {
@ "type": @ "preroll",
@ "assetid": @ "AD-ID123"
}
</syntaxhighlight>
}}

== Nielsen API Documentation ==
=== play ===
Use <code>play</code> to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player. Pass in channelName metadata as described above.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenApi play:([NSDictionary *channel loadChannelInfo)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.play(channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
Call to inform SDK about asset being played. Pass in metadata as described here [[#Configure Payload]], [[#Content Metadata]]
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
Call to inform Nielsen SDK about position in video asset (for VOD pass second within video, for livestreams UTC timestamp in seconds).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi playheadPosition:secondsAsInt];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.playheadPosition(secondsAsInt)</syntaxhighlight>
}}

=== stop ===
Call to indicate interruption during playback, e.g. pause. (more on interruption scenarios here: [[#Interruptions during playback]] )
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.stop()</syntaxhighlight>
}}

=== end ===
Call when content finished playback and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi end];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.end()</syntaxhighlight>
}}

== Call Nielsen APIs ==
[[File:appsdkTimeline-DCR.png|icon|link=]]
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
nielsenApi = NielsenInit.createNielsenApi(delegate: self);
data = loadStaticMetadata();
nielsenApi.loadMetadata(self.data);</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenApi.play(channelName)</code> || // channelName now automatically generated by Nielsen SDK
|-
| <code>nielsenApi.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenApi.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenApi.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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

== API Call Sequence ==
=== Use Case 1: Content has no Advertisements ===
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "vid345-67483",
"program": "ProgramName",
"title": "Program S3, EP1",
"length": "3600",
...
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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>nielsenApi.play(channelName); </code> || // channelName now automatically generated by Nielsen SDK
|-
| <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenApi.end();</code> || // Content playback is completed.
|}

=== Use Case 2: Content has Advertisements ===
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</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 [[playheadPosition|playheadPosition()]] 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>nielsenApi.play(channelName); </code> || // channelName now automatically generated by Nielsen SDK
|-
| <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| rowspan="3" | Preroll || <code>nielsenApi.loadMetadata(prerollMetadataObject);</code> || // prerollMetadataObject contains the JSON metadata for the preroll ad
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the preroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after preroll occurs
|-
| rowspan="3" | Content || <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after the content is paused (ad starts)
|-
| rowspan="6" | Midroll || <code>nielsenApi.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // App moves to background(midroll pauses)
|-
| <code>nielsenApi.loadMetadata(midrollMetaDataObject);</code> || // App moves to foreground (midroll resumes)
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // playheadPosition is position of the playhead while the midroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="3" | Content (End of stream) || <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| <code>nielsenApi.stop();</code> || // Always call stop irrespective of postroll is followed or not
|-
| End of Stream || <code>nielsenApi.end();</code> || // Call end() at the end of content
|-
| rowspan="3" | Postroll || <code>nielsenApi.loadMetadata(postrollMetaDataObject);</code> || // postrollMetadataObject contains the JSON metadata for the postroll ad
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the postroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after postroll occurs
|}

<blockquote>Note: Each Ad playhead should 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>

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

== 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 (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call [[stop]] immediately and withhold sending playhead position.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Pre-Certification Checklists ==
After the application is ready to be sent for Nielsen Certification, please go through the [[Digital Pre-Certification Checklist App SDK]] and ensure the app behaves as expected, before submitting to Nielsen.

== 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"'' 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 ====
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>
|Swift = <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 via OS-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

=== First Party ID (FPID)===
- The broadcaster must enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK. 

- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is true. If this flag is changed from true to false, then the AppSDK should wipe out the stored FPID and use a blank value for the FPID parameter in all the pings. 

- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired. 

- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated. 

- Example: disable FPID during init call
<syntaxhighlight lang="swift">
class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "pl", // sfcode for Poland
"enableFpid": "false" //false = FPID is disabled, true= FPID is enabled
"nol_devDebug": "DEBUG" // only for debug builds and see the Nielsen logs
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

=== 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 https://priv-policy.imrworldwide.com/priv/mobile/pl/pl/optout.html for more information"'''</blockquote>

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
- (void)viewDidLoad {

[super viewDidLoad];

//Setting background image
UIImage *backgroundImage = [UIImage imageNamed:@"new_ios_bg.png"];
UIImageView *backgroundImageView=[[UIImageView alloc]initWithFrame:self.view.frame];
backgroundImageView.image=backgroundImage;
[self.view insertSubview:backgroundImageView atIndex:0];

self.nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];

//Initialising the webview
WKWebViewConfiguration *theConfiguration = [[WKWebViewConfiguration alloc] init];
_wkwebView = [[WKWebView alloc] initWithFrame:self.view.frame configuration:theConfiguration];
_wkwebView.navigationDelegate = self;

//Getting the optPut URL from SDK
NSURL *nsurl=[NSURL URLWithString:[self.nielsenApi optOutURL]];

//Setting url request in webview
NSURLRequest *nsrequest=[NSURLRequest requestWithURL:nsurl];

//Setting url request in webview
[_wkwebView loadRequest:nsrequest];

//Adding webview to the controller view
[self.view addSubview:_wkwebView];
}

</syntaxhighlight>
|Swift = <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 ====
{{ExampleCode|
|Objective C = <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>
|Swift = <syntaxhighlight lang="swift">
func webView(webView: UIWebView, shouldStartLoadWithRequest request: NSURLRequest, navigationType: UIWebViewNavigationType) -> Bool {

let command = request.url?.absoluteString
if command == "kNielsenWebClose"{

self.perform(#selector(closeOptOutView), with: nil, afterDelay: 0)

return false
}
return NielsenAppApi.optOutURL
}

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

== AirPlay ==
To implement OTT measurement, report OTT changes to the SDK using public API interface: [[updateOTT]]

In order to detect AirPlay and mirroring changes we use AVAudioSessionPortDescription properties that are different on different iOS versions. We found that on iOS versions 8 - 10 <code>AVAudioSessionPortDescription</code> has the following values: 
<code>
AirPlay: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-airplay 
Mirroring: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-screen
</code> 

For iOS 11+ some parameters like name and UID have different values: 
<code>
AirPlay: type = AirPlay; name = AirPlay; UID = 0eb63aae-5915-45f1-b0f7-0102a0e50d53 
Mirroring: type = AirPlay; name = Apple TV 4K; UID = 4335E8A9-1C0A-4251-9000-28CA5FA2F3CF-192731714653291-screen 
</code>

The following code snipped is suggested for AirPlay / mirroring detection on iOS devices.

{{ExampleCode|
|Objective C =
<syntaxhighlight lang="objective-c">
– (void)updateOTT:(id)ottInfo;
</syntaxhighlight>
=== Subscribe to AVAudioSessionRouteChangeNotification ===
<syntaxhighlight lang="objective-c">
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleRouteChanged:) name:AVAudioSessionRouteChangeNotification object:nil];
</syntaxhighlight>

=== Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:===
<syntaxhighlight lang="objective-c">
- (void)handleRouteChanged:(NSNotification *)notification
{
NSMutableDictionary *ottDict = [NSMutableDictionary dictionaryWithDictionary: @{@"ottStatus": @"0"}];

AVAudioSession *audioSession = [AVAudioSession sharedInstance];
AVAudioSessionRouteDescription *currentRoute = audioSession.currentRoute;
for (AVAudioSessionPortDescription *outputPort in currentRoute.outputs) {
if ([outputPort.portType isEqualToString:AVAudioSessionPortAirPlay]) {
ottDict[@"ottStatus"] = @"1";
ottDict[@"ottDeviceModel"] = outputPort.portName;
ottDict[@"ottDeviceID"] = outputPort.UID;

if ([outputPort.portName isEqualToString:@"AirPlay"]) {
ottDict[@"ottDevice"] = @"airplay";
ottDict[@"ottType"] = @"airplay";
}
else {
if ([outputPort.portName containsString:@"Apple TV"]) {
ottDict[@"ottDevice"] = @"appleTV";
}
else {
ottDict[@"ottDevice"] = @"other";
}

if ([outputPort.UID hasSuffix:@"airplay"]) {
ottDict[@"ottType"] = @"airplay";
}
else if ([outputPort.UID hasSuffix:@"screen"]) {
ottDict[@"ottType"] = @"mirroring";
}
else {
ottDict[@"ottType"] = @"other";
}
}
}
}

// report OTT status update to Nielsen SDK
[self reportOTTWithDict:ottDict];
}
</syntaxhighlight>

=== Report OTT update to the Nielsen SDK ===
<syntaxhighlight lang="objective-c">
- (void)reportOTTWithDict:(NSDictionary *)ottDict
{
[self.nielsenSDK updateOTT:ottDict];
}
</syntaxhighlight>

|Swift =
<syntaxhighlight lang="swift">
nielsenSdk.updateOTT(currentStatus)
</syntaxhighlight>

=== Subscribe to AVAudioSessionRouteChangeNotification ===
<syntaxhighlight lang="swift">
NotificationCenter.default.addObserver(self, selector: #selector(handleRouteChanged(_:)), name: NSNotification.Name.AVAudioSessionRouteChange, object: nil)
</syntaxhighlight>

=== Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:===

<syntaxhighlight lang ="Swift">
func handleRouteChanged(_ notification: Notification) {
var currentStatus: [String: String] = ["ottStatus": "0"]

let session = AVAudioSession.sharedInstance()
let currentRoute = session.currentRoute
for outputPort in currentRoute.outputs {
if outputPort.portType == AVAudioSessionPortAirPlay {
currentStatus["ottStatus"] = "1"
currentStatus["ottDeviceModel"] = outputPort.portName
currentStatus["ottDeviceID"] = outputPort.uid

if outputPort.portName == "AirPlay" {
currentStatus["ottDevice"] = "airplay"
currentStatus["ottType"] = "airplay"
}
else {
if outputPort.portName.contains("Apple TV") {
currentStatus["ottDevice"] = "appleTV"
}
else {
currentStatus["ottDevice"] = "other"
}

if outputPort.uid.hasSuffix("airplay") {
currentStatus["ottType"] = "airplay"
}
else if outputPort.uid.hasSuffix("screen") {
currentStatus["ottType"] = "mirroring"
}
else {
currentStatus["ottType"] = "other"
}
}
}
}

// report OTT status update to Nielsen SDK
self.reportOTTUpdate(currentStatus)
}
</syntaxhighlight>

=== Report OTT update to the Nielsen SDK===
<syntaxhighlight lang ="Swift">
func reportOTTUpdate(_ ottDict: [String: String]) {
if let nielsenSdk = self.nielsenAppApi {
nielsenSdk.updateOTT(currentStatus)
}
}
</syntaxhighlight>
}}

== 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_sdkDebug: 'DEBUG'}</code> from initialization call.
 
'''Note''': before going live you have to inform Nielsen team - this is necessary, because Nielsen team has to adjust internal configuration parameter to enable data collection. Without that notification no data will be collected and no data will be reported.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
The below sample applications have been designed to show the Simplified API's functionality and are broken into two distinct categories:
* '''Basic''' - To show the functionality of the Nielsen Simplified API using a standard no-frills player.
** [[Swift Basic Sample|Swift 4.0 Sample]]
** [[Objective-c Basic example|Objective-C Sample]]
** [[Android Basic example|Android Studio Example]]

* '''Advanced''' - Nielsen Simplified API integrated into a custom video player.
** [https://engineeringportal.nielsen.com/docs/Special:Downloads Swift 4.0 Sample]
** [https://engineeringportal.nielsen.com/docs/Special:Downloads Objective-C Sample]
** [https://engineeringportal.nielsen.com/docs/Special:Downloads Java/Android Studio Sample]

DCR Italy Static iOS SDK

2023-09-28T11:14:45Z

WilsonQuispe: /* Special Notes regarding iOS17 */

DCR Italy Video iOS SDK

2023-09-28T11:14:07Z

WilsonQuispe: /* Special Notes regarding iOS17 */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>
__TOC__

== Implementation ==
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.

<code>If you are building an app for the 'kids category' please review the [[DCR_Italy_Video_iOS_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category|Opt Out Requirement.]]</code>

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ DCR_and_DTVR_with_iOS17_or_TVOS17|Nielsen Digital Measurement and iOS17 or TVOS17]]

Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
Italian Clients:
*"it"
|| Nielsen-specified || Yes || "it"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===

==== App tracking transparency framework ====

To display the App Tracking Transparency authorization request for accessing the IDFA, update your <code>info.plist</code> to add the <code>NSUserTrackingUsageDescription</code> key with a custom message describing your usage. Below is an example description text:
<code><key>NSUserTrackingUsageDescription</key></code>
<code><string>This identifier will be used to deliver personalized ads to you.</string></code>

The system automatically generates the prompt’s title, which includes the name of your app, then the usage description appears as part of the App Tracking

To present the authorization request, call requestTrackingAuthorizationWithCompletionHandler.

<blockquote>Please NOTE: It is important to initialize the NielsenSDK after the ATTrackingManager has Authorized usage. When the SDK initializes, it checks the status of the ATTrackingManager.</blockquote>

You can find an example in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section, folder name NielsenSampleVideoPlayer.

====Swift 4.0 Example:====
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0.2",
"appname": "Nielsen Sample App",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

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

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

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

override func viewDidLoad() {
super.viewDidLoad()

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

}
}
</syntaxhighlight>

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

@implementation NlsAppApiFactory

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

NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": "1.0.2",
@"appname": "Nielsen Sample App",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};

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

@end
</syntaxhighlight>

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

@class NielsenAppApi;
@protocol NielsenAppApiDelegate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

=== Sample Code: ===
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NlsAppApiFactory createNielsenAppApiWithDelegate:nil];
}}
</syntaxhighlight>



== 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 Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">

let channelInfo = [
"channelName": "My Channel Name 1",
];

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

NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
}
</syntaxhighlight>
}}


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

=== Content Metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (0 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

=== Ad Metadata ===
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create Ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
NielsenInit.createMainBrandApi(delegate: self)
self.data = loadStaticMetadata()
self.nielsenMeter .loadMetadata(self.data)</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenMeter.play()</code> || // Call at start of each new stream
|-
| <code>nielsenMeter.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenMeter.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenMeter.end()</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
VOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the videoplayer is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for VOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

<blockquote>Note:
*For Audiweb there is no need to tag ads in video stream ... please see 1st example about how to use the SDK without ads.</blockquote>

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing videos or watching a new video, call <code>play()</code> each time.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:()];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play();</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">

-(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;

//Sending data dictionary to SDK with updated playHead position.
[nielsenApi playheadPosition:(intSec)];
}];
}
</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 ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi.stop()</syntaxhighlight>
}}

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

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

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:

*[[DCR_Italy_Video_iOS_SDK#OS-level_Opt-out|OS-level Opt-out]] - managed by AppTracking or Limit Ad Tracking setting on device (preferred approach).
*[[DCR_Italy_Video_iOS_SDK#User_Choice|User Choice]] - Direct call to SDK. Can be used without the Ad Framework

=== Special Note Regarding Apps in the Kids Category ===
If you are building an app that will be listed in the Kids Category:

Ensure that you are using the [https://nielsendownloads-green.digitalengsdk.com/digital/Nielsen-iOS-App-SDK-GlobalNoId_latest.zip NoID version:] of the Nielsen SDK Framework. Also, you can use the [[Digital_Measurement_iOS_Artifactory_Guide|Artifactory method.]]
Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang="swift">NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-outv</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen iOS

The Nielsen SDK automatically leverages the iOS's '''Limit Ad Tracking''' or '''AppTracking''' setting.

*If the User's device is running < iOS 13.x, the Nielsen SDK will check the status of '''Limit Ad Tracking'''.
*iOS14 modifies the way Apple manages the collection of a User's Opt-In status through '''AppTracking'''. Starting with Version 8.x+, the Nielsen App SDK will check the iOS version during initialization. If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested. If iOS14.x +, then AppTracking is utilized.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[optOutURL|optOutURL]]
*Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL|optOutURL]]

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>
<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) //create an instance

if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) { //query the nielsensdk for the current privacy page
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}}}}
</syntaxhighlight>

=== User Choice ===
The User Choice method can be used without the Ad Framework, or in situations where the publisher does not wish to use the [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency Framework.]

==== The User Choice opt-out method works as follows: ====

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

==== Opt-out example code ====
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>

===== Objective-C =====

<syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)
navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>

===== Swift =====
<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 via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the [[optOutStatus|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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
You can find some examples in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section

DCR Italy AUDIO iOS SDK

2023-09-28T11:13:28Z

WilsonQuispe: /* Special Notes regarding iOS17 */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>
__TOC__

== Implementation ==
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.

<code>If you are building an app for the 'kids category' please review the [[DCR_Italy_Video_iOS_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category|Opt Out Requirement.]]</code>

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Audio/Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ DCR_and_DTVR_with_iOS17_or_TVOS17|Nielsen Digital Measurement and iOS17 or TVOS17]]

Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.

|| Nielsen-specified || Yes ||
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===

==== App tracking transparency framework ====

To display the App Tracking Transparency authorization request for accessing the IDFA, update your <code>info.plist</code> to add the <code>NSUserTrackingUsageDescription</code> key with a custom message describing your usage. Below is an example description text:
<code><key>NSUserTrackingUsageDescription</key></code>
<code><string>This identifier will be used to deliver personalized ads to you.</string></code>

The system automatically generates the prompt’s title, which includes the name of your app, then the usage description appears as part of the App Tracking

To present the authorization request, call requestTrackingAuthorizationWithCompletionHandler.

<blockquote>Please NOTE: It is important to initialize the NielsenSDK after the ATTrackingManager has Authorized usage. When the SDK initializes, it checks the status of the ATTrackingManager.</blockquote>

You can find an example in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section, folder name NielsenSampleVideoPlayer.

====Swift 4.0 Example:====
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0.2",
"appname": "Nielsen Sample App",
"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-4123-9277-2A788XXXXXXX",
@"appversion": "1.0.2",
@"appname": "Nielsen Sample App",
@"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 NielsenAppApiDelegate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

=== Sample Code: ===
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NlsAppApiFactory createNielsenAppApiWithDelegate:nil];
}}
</syntaxhighlight>



== 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 Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) 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.

Example for Audio measurement:
{{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":"y",
"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": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
}
</syntaxhighlight>
}}


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

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify audio /video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

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

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| isAudio || indicate measurement of audio ads or audio content || <code>'true'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Audio Content Object =====

<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>

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

'''Don't pass audio key "isAudio" into the loadmetadata call for video measurement'''.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Video Content Object =====

<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>

==== Ad Metadata ====
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

==== Example Ad Object ====

<syntaxhighlight lang="swift">

let adMetadata = [
"assetid" : "unique_postroll_ad_id",
"type" : "preroll"
]
</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
NielsenInit.createMainBrandApi(delegate: self)
self.data = loadStaticMetadata()
self.nielsenMeter .loadMetadata(self.data)</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenMeter.play()</code> || // Call at start of each new stream
|-
| <code>nielsenMeter.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenMeter.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenMeter.end()</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
AOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current audio asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the media player is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for AOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing audio or listening to a new audio, call <code>play()</code> each time.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:()];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play();</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">

-(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;

//Sending data dictionary to SDK with updated playHead position.
[nielsenApi playheadPosition:(intSec)];
}];
}
</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 ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi.stop()</syntaxhighlight>
}}

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

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

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:

*[[DCR_Italy_Video_iOS_SDK#OS-level_Opt-out|OS-level Opt-out]] - managed by AppTracking or Limit Ad Tracking setting on device (preferred approach).
*[[DCR_Italy_Video_iOS_SDK#User_Choice|User Choice]] - Direct call to SDK. Can be used without the Ad Framework

=== Special Note Regarding Apps in the Kids Category ===
If you are building an app that will be listed in the Kids Category:

Ensure that you are using the [https://nielsendownloads-green.digitalengsdk.com/digital/Nielsen-iOS-App-SDK-GlobalNoId_latest.zip NoID version:] of the Nielsen SDK Framework. Also, you can use the [[Digital_Measurement_iOS_Artifactory_Guide|Artifactory method.]]
Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang="swift">NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-outv</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen iOS

The Nielsen SDK automatically leverages the iOS's '''Limit Ad Tracking''' or '''AppTracking''' setting.

*If the User's device is running < iOS 13.x, the Nielsen SDK will check the status of '''Limit Ad Tracking'''.
*iOS14 modifies the way Apple manages the collection of a User's Opt-In status through '''AppTracking'''. Starting with Version 8.x+, the Nielsen App SDK will check the iOS version during initialization. If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested. If iOS14.x +, then AppTracking is utilized.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[optOutURL|optOutURL]]
*Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL|optOutURL]]

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>
<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) //create an instance

if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) { //query the nielsensdk for the current privacy page
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}}}}
</syntaxhighlight>

=== User Choice ===
The User Choice method can be used without the Ad Framework, or in situations where the publisher does not wish to use the [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency Framework.]

==== The User Choice opt-out method works as follows: ====

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

==== Opt-out example code ====
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>

===== Objective-C =====

<syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)
navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>

===== Swift =====
<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 via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the [[optOutStatus|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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
You can find some examples in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section

DCR Italy AUDIO iOS SDK

2023-09-13T14:39:01Z

WilsonQuispe: /* Special Notes regarding iOS14 */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>
__TOC__

== Implementation ==
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.

<code>If you are building an app for the 'kids category' please review the [[DCR_Italy_Video_iOS_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category|Opt Out Requirement.]]</code>

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Audio/Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ Nielsen Digital Measurement and_iOS17 or TVOS17 |Nielsen Digital Measurement and_iOS17 or TVOS17]]

Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.

|| Nielsen-specified || Yes ||
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===

==== App tracking transparency framework ====

To display the App Tracking Transparency authorization request for accessing the IDFA, update your <code>info.plist</code> to add the <code>NSUserTrackingUsageDescription</code> key with a custom message describing your usage. Below is an example description text:
<code><key>NSUserTrackingUsageDescription</key></code>
<code><string>This identifier will be used to deliver personalized ads to you.</string></code>

The system automatically generates the prompt’s title, which includes the name of your app, then the usage description appears as part of the App Tracking

To present the authorization request, call requestTrackingAuthorizationWithCompletionHandler.

<blockquote>Please NOTE: It is important to initialize the NielsenSDK after the ATTrackingManager has Authorized usage. When the SDK initializes, it checks the status of the ATTrackingManager.</blockquote>

You can find an example in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section, folder name NielsenSampleVideoPlayer.

====Swift 4.0 Example:====
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0.2",
"appname": "Nielsen Sample App",
"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-4123-9277-2A788XXXXXXX",
@"appversion": "1.0.2",
@"appname": "Nielsen Sample App",
@"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 NielsenAppApiDelegate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

=== Sample Code: ===
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NlsAppApiFactory createNielsenAppApiWithDelegate:nil];
}}
</syntaxhighlight>



== 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 Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) 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.

Example for Audio measurement:
{{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":"y",
"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": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
}
</syntaxhighlight>
}}


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

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify audio /video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

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

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| isAudio || indicate measurement of audio ads or audio content || <code>'true'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Audio Content Object =====

<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>

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

'''Don't pass audio key "isAudio" into the loadmetadata call for video measurement'''.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Video Content Object =====

<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>

==== Ad Metadata ====
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

==== Example Ad Object ====

<syntaxhighlight lang="swift">

let adMetadata = [
"assetid" : "unique_postroll_ad_id",
"type" : "preroll"
]
</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
NielsenInit.createMainBrandApi(delegate: self)
self.data = loadStaticMetadata()
self.nielsenMeter .loadMetadata(self.data)</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenMeter.play()</code> || // Call at start of each new stream
|-
| <code>nielsenMeter.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenMeter.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenMeter.end()</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
AOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current audio asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the media player is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for AOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing audio or listening to a new audio, call <code>play()</code> each time.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:()];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play();</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">

-(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;

//Sending data dictionary to SDK with updated playHead position.
[nielsenApi playheadPosition:(intSec)];
}];
}
</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 ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi.stop()</syntaxhighlight>
}}

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

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

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:

*[[DCR_Italy_Video_iOS_SDK#OS-level_Opt-out|OS-level Opt-out]] - managed by AppTracking or Limit Ad Tracking setting on device (preferred approach).
*[[DCR_Italy_Video_iOS_SDK#User_Choice|User Choice]] - Direct call to SDK. Can be used without the Ad Framework

=== Special Note Regarding Apps in the Kids Category ===
If you are building an app that will be listed in the Kids Category:

Ensure that you are using the [https://nielsendownloads-green.digitalengsdk.com/digital/Nielsen-iOS-App-SDK-GlobalNoId_latest.zip NoID version:] of the Nielsen SDK Framework. Also, you can use the [[Digital_Measurement_iOS_Artifactory_Guide|Artifactory method.]]
Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang="swift">NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-outv</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen iOS

The Nielsen SDK automatically leverages the iOS's '''Limit Ad Tracking''' or '''AppTracking''' setting.

*If the User's device is running < iOS 13.x, the Nielsen SDK will check the status of '''Limit Ad Tracking'''.
*iOS14 modifies the way Apple manages the collection of a User's Opt-In status through '''AppTracking'''. Starting with Version 8.x+, the Nielsen App SDK will check the iOS version during initialization. If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested. If iOS14.x +, then AppTracking is utilized.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[optOutURL|optOutURL]]
*Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL|optOutURL]]

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>
<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) //create an instance

if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) { //query the nielsensdk for the current privacy page
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}}}}
</syntaxhighlight>

=== User Choice ===
The User Choice method can be used without the Ad Framework, or in situations where the publisher does not wish to use the [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency Framework.]

==== The User Choice opt-out method works as follows: ====

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

==== Opt-out example code ====
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>

===== Objective-C =====

<syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)
navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>

===== Swift =====
<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 via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the [[optOutStatus|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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
You can find some examples in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section

DCR Italy Static iOS SDK

2023-09-13T14:38:08Z

WilsonQuispe: /* Special Notes regarding iOS17 */

DCR Italy Video iOS SDK

2023-09-13T14:37:27Z

WilsonQuispe: /* Special Notes regarding iOS17 */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>
__TOC__

== Implementation ==
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.

<code>If you are building an app for the 'kids category' please review the [[DCR_Italy_Video_iOS_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category|Opt Out Requirement.]]</code>

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ Nielsen Digital Measurement and_iOS17 or TVOS17 |Nielsen Digital Measurement and_iOS17 or TVOS17]]

Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
Italian Clients:
*"it"
|| Nielsen-specified || Yes || "it"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===

==== App tracking transparency framework ====

To display the App Tracking Transparency authorization request for accessing the IDFA, update your <code>info.plist</code> to add the <code>NSUserTrackingUsageDescription</code> key with a custom message describing your usage. Below is an example description text:
<code><key>NSUserTrackingUsageDescription</key></code>
<code><string>This identifier will be used to deliver personalized ads to you.</string></code>

The system automatically generates the prompt’s title, which includes the name of your app, then the usage description appears as part of the App Tracking

To present the authorization request, call requestTrackingAuthorizationWithCompletionHandler.

<blockquote>Please NOTE: It is important to initialize the NielsenSDK after the ATTrackingManager has Authorized usage. When the SDK initializes, it checks the status of the ATTrackingManager.</blockquote>

You can find an example in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section, folder name NielsenSampleVideoPlayer.

====Swift 4.0 Example:====
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0.2",
"appname": "Nielsen Sample App",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

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

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

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

override func viewDidLoad() {
super.viewDidLoad()

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

}
}
</syntaxhighlight>

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

@implementation NlsAppApiFactory

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

NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": "1.0.2",
@"appname": "Nielsen Sample App",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};

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

@end
</syntaxhighlight>

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

@class NielsenAppApi;
@protocol NielsenAppApiDelegate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

=== Sample Code: ===
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NlsAppApiFactory createNielsenAppApiWithDelegate:nil];
}}
</syntaxhighlight>



== 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 Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">

let channelInfo = [
"channelName": "My Channel Name 1",
];

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

NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
}
</syntaxhighlight>
}}


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

=== Content Metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (0 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

=== Ad Metadata ===
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create Ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
NielsenInit.createMainBrandApi(delegate: self)
self.data = loadStaticMetadata()
self.nielsenMeter .loadMetadata(self.data)</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenMeter.play()</code> || // Call at start of each new stream
|-
| <code>nielsenMeter.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenMeter.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenMeter.end()</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
VOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the videoplayer is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for VOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

<blockquote>Note:
*For Audiweb there is no need to tag ads in video stream ... please see 1st example about how to use the SDK without ads.</blockquote>

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing videos or watching a new video, call <code>play()</code> each time.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:()];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play();</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">

-(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;

//Sending data dictionary to SDK with updated playHead position.
[nielsenApi playheadPosition:(intSec)];
}];
}
</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 ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi.stop()</syntaxhighlight>
}}

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

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

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:

*[[DCR_Italy_Video_iOS_SDK#OS-level_Opt-out|OS-level Opt-out]] - managed by AppTracking or Limit Ad Tracking setting on device (preferred approach).
*[[DCR_Italy_Video_iOS_SDK#User_Choice|User Choice]] - Direct call to SDK. Can be used without the Ad Framework

=== Special Note Regarding Apps in the Kids Category ===
If you are building an app that will be listed in the Kids Category:

Ensure that you are using the [https://nielsendownloads-green.digitalengsdk.com/digital/Nielsen-iOS-App-SDK-GlobalNoId_latest.zip NoID version:] of the Nielsen SDK Framework. Also, you can use the [[Digital_Measurement_iOS_Artifactory_Guide|Artifactory method.]]
Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang="swift">NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-outv</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen iOS

The Nielsen SDK automatically leverages the iOS's '''Limit Ad Tracking''' or '''AppTracking''' setting.

*If the User's device is running < iOS 13.x, the Nielsen SDK will check the status of '''Limit Ad Tracking'''.
*iOS14 modifies the way Apple manages the collection of a User's Opt-In status through '''AppTracking'''. Starting with Version 8.x+, the Nielsen App SDK will check the iOS version during initialization. If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested. If iOS14.x +, then AppTracking is utilized.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[optOutURL|optOutURL]]
*Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL|optOutURL]]

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>
<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) //create an instance

if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) { //query the nielsensdk for the current privacy page
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}}}}
</syntaxhighlight>

=== User Choice ===
The User Choice method can be used without the Ad Framework, or in situations where the publisher does not wish to use the [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency Framework.]

==== The User Choice opt-out method works as follows: ====

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

==== Opt-out example code ====
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>

===== Objective-C =====

<syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)
navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>

===== Swift =====
<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 via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the [[optOutStatus|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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
You can find some examples in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section

DCR Poland Video iOS SDK

2023-09-13T12:56:34Z

WilsonQuispe: /* Special Notes regarding iOS17 */

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

__TOC__

== 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]]), 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

== Prerequisites ==
To start using the App SDK, the following items are required:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
|-
|| ☑ || '''sfcode''' || Environment that the SDK must point to || Contact Nielsen
|-
|| ☑ || '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|}

If you do not have any of these pre-requisites 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 utilizing the Standard Nielsen SDK for DCR.

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ Nielsen Digital Measurement and_iOS17 or TVOS17 |Nielsen Digital Measurement and_iOS17 or TVOS17]]

Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

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

* The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application || Client-defined || Optional; automatically detected in SDK 6.0.0.4 and above || Nielsen Sample App
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
* "pl"
|| Nielsen-specified || Yes || pl
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Optional || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"INFO"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': DO NOT activate the Debug flag in a production environment.</blockquote>

=== 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 createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "pl",
"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, AVPlayerViewControllerDelegate {

// your code//

override func viewDidLoad() {
super.viewDidLoad()

//Getting the instance of NielsenApi
self.nielsenApi = NielsenInit.createNielsenApi(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>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenAppApi.h>

@implementation NielsenInit

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate
{
NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"sfcode": @"pl",
@"nol_devDebug": @"DEBUG", };

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

@end
</syntaxhighlight>

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

@class NielsenAppApi;
@protocol NielsenAppApiDelegate;

@interface NielsenInit : NSObject

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

@end
</syntaxhighlight>
Sample Code:
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];
</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.

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

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

NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "C77664",
@ "title": @ "S2,E3",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20180120 10:00:00",
@ "adloadtype": @ "2",
@ "segB": @ "CustomSegmentValueB", //optional
@ "segC": @ "CustomSegmentValueC", //optional
}
</syntaxhighlight>
}}

=== ChannelName metadata ===
channelName should remain constant throughout the completion of an episode or live stream.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| channelName || ChannelInfo refers to the Channel name. This can be a free-form value
value such as a friendly name for the content being played. the SDK 
will pass the application name automatically.
|| custom || No
|-
|}

==== Content Metadata ====
Content metadata should remain constant throughout the entirety of an episode / clip including when ads play.
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| assetid || unique ID assigned to asset (max 64 characters; only characters 0-9, a-z, A-Z underscore and minus are allowed - no special characters or vowel mutations) || custom (no [[Special Characters]])|| ✓
|-
| program || (string) name of program (max 254 characters) || custom || ✓
|-
| title || (string) episode title (max 254 characters) || custom - no backslash allowed in string (because of 3rd party data processing) || ✓
|-
| length || (int) length of content in seconds || 86400 seconds for live stream. For Event-Livestreams planned length. For VoD video length|| ✓
|-
| airdate || The airdate in the linear TV. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || 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 
YYYYMMDD HH:MI:SS 
MM-DD-YYYY 
MM/DD/YYYY 
(pass beginning of epoch if unknown)
|| ✓
|-
| isfullepisode || full episode flag || "y"- full episode, "n"- non full episode || ✓
|-
| adloadtype || type of ad load:
<code>"1"</code> Linear – matches TV ad load

<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>"2"</code> - DCR measures content with dynamic ads || ✓
|-
| progen || program genre || custom ||
|-
| segB || custom segment || custom ||
|-
| segC || custom segment || custom ||
|-
| crossId1 || standard episode ID || custom ||
|-
| clientid ||
parent ID – value is automatically populated through provided AppID. 
In order to override the brand configured to the AppID, pass parent 
value here and the sub-brand ID associated to 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 
AppID. In order to override the sub-brand configured to the AppID, value can 
be passed here (e.g. multiple sub-brands in App)
||
provided by Nielsen
||
|}

=== 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 || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code>|| ✓
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || ✓
|}

=== Example Ad Object ===
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let adMetadata = [
"type": "preroll",
"assetid": "123456"
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary * adMetadata = @ {
@ "type": @ "preroll",
@ "assetid": @ "AD-ID123"
}
</syntaxhighlight>
}}

== Nielsen API Documentation ==
=== play ===
Use <code>play</code> to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player. Pass in channelName metadata as described above.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenApi play:([NSDictionary *channel loadChannelInfo)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.play(channelInfo);</syntaxhighlight>
}}

=== loadMetadata ===
Call to inform SDK about asset being played. Pass in metadata as described here [[#Configure Payload]], [[#Content Metadata]]
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
Call to inform Nielsen SDK about position in video asset (for VOD pass second within video, for livestreams UTC timestamp in seconds).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi playheadPosition:secondsAsInt];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.playheadPosition(secondsAsInt)</syntaxhighlight>
}}

=== stop ===
Call to indicate interruption during playback, e.g. pause. (more on interruption scenarios here: [[#Interruptions during playback]] )
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.stop()</syntaxhighlight>
}}

=== end ===
Call when content finished playback and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi end];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi?.end()</syntaxhighlight>
}}

== Call Nielsen APIs ==
[[File:appsdkTimeline-DCR.png|icon|link=]]
=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
nielsenApi = NielsenInit.createNielsenApi(delegate: self);
data = loadStaticMetadata();
nielsenApi.loadMetadata(self.data);</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenApi.play(channelName)</code> || // channelName now automatically generated by Nielsen SDK
|-
| <code>nielsenApi.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenApi.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenApi.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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

== API Call Sequence ==
=== Use Case 1: Content has no Advertisements ===
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "vid345-67483",
"program": "ProgramName",
"title": "Program S3, EP1",
"length": "3600",
...
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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>nielsenApi.play(channelName); </code> || // channelName now automatically generated by Nielsen SDK
|-
| <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenApi.end();</code> || // Content playback is completed.
|}

=== Use Case 2: Content has Advertisements ===
Call [[play()]] with channelName JSON as below.
<syntaxhighlight lang="json">{
"channelName": "TheMovieTitle"
}</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 [[playheadPosition|playheadPosition()]] 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>nielsenApi.play(channelName); </code> || // channelName now automatically generated by Nielsen SDK
|-
| <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| rowspan="3" | Preroll || <code>nielsenApi.loadMetadata(prerollMetadataObject);</code> || // prerollMetadataObject contains the JSON metadata for the preroll ad
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the preroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after preroll occurs
|-
| rowspan="3" | Content || <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after the content is paused (ad starts)
|-
| rowspan="6" | Midroll || <code>nielsenApi.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // App moves to background(midroll pauses)
|-
| <code>nielsenApi.loadMetadata(midrollMetaDataObject);</code> || // App moves to foreground (midroll resumes)
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // playheadPosition is position of the playhead while the midroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="3" | Content (End of stream) || <code>nielsenApi.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| <code>nielsenApi.stop();</code> || // Always call stop irrespective of postroll is followed or not
|-
| End of Stream || <code>nielsenApi.end();</code> || // Call end() at the end of content
|-
| rowspan="3" | Postroll || <code>nielsenApi.loadMetadata(postrollMetaDataObject);</code> || // postrollMetadataObject contains the JSON metadata for the postroll ad
|-
| <code>nielsenApi.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the postroll ad is being played
|-
| <code>nielsenApi.stop();</code> || // Call stop after postroll occurs
|}

<blockquote>Note: Each Ad playhead should 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>

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

== 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 (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call [[stop]] immediately and withhold sending playhead position.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Pre-Certification Checklists ==
After the application is ready to be sent for Nielsen Certification, please go through the [[Digital Pre-Certification Checklist App SDK]] and ensure the app behaves as expected, before submitting to Nielsen.

== 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"'' 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 ====
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>
|Swift = <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 via OS-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

=== First Party ID (FPID)===
- The broadcaster must enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK. 

- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is true. If this flag is changed from true to false, then the AppSDK should wipe out the stored FPID and use a blank value for the FPID parameter in all the pings. 

- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired. 

- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated. 

- Example: disable FPID during init call
<syntaxhighlight lang="swift">
class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "pl", // sfcode for Poland
"enableFpid": "false" //false = FPID is disabled, true= FPID is enabled
"nol_devDebug": "DEBUG" // only for debug builds and see the Nielsen logs
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

=== 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 https://priv-policy.imrworldwide.com/priv/mobile/pl/pl/optout.html for more information"'''</blockquote>

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
- (void)viewDidLoad {

[super viewDidLoad];

//Setting background image
UIImage *backgroundImage = [UIImage imageNamed:@"new_ios_bg.png"];
UIImageView *backgroundImageView=[[UIImageView alloc]initWithFrame:self.view.frame];
backgroundImageView.image=backgroundImage;
[self.view insertSubview:backgroundImageView atIndex:0];

self.nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];

//Initialising the webview
WKWebViewConfiguration *theConfiguration = [[WKWebViewConfiguration alloc] init];
_wkwebView = [[WKWebView alloc] initWithFrame:self.view.frame configuration:theConfiguration];
_wkwebView.navigationDelegate = self;

//Getting the optPut URL from SDK
NSURL *nsurl=[NSURL URLWithString:[self.nielsenApi optOutURL]];

//Setting url request in webview
NSURLRequest *nsrequest=[NSURLRequest requestWithURL:nsurl];

//Setting url request in webview
[_wkwebView loadRequest:nsrequest];

//Adding webview to the controller view
[self.view addSubview:_wkwebView];
}

</syntaxhighlight>
|Swift = <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 ====
{{ExampleCode|
|Objective C = <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>
|Swift = <syntaxhighlight lang="swift">
func webView(webView: UIWebView, shouldStartLoadWithRequest request: NSURLRequest, navigationType: UIWebViewNavigationType) -> Bool {

let command = request.url?.absoluteString
if command == "kNielsenWebClose"{

self.perform(#selector(closeOptOutView), with: nil, afterDelay: 0)

return false
}
return NielsenAppApi.optOutURL
}

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

== AirPlay ==
To implement OTT measurement, report OTT changes to the SDK using public API interface: [[updateOTT]]

In order to detect AirPlay and mirroring changes we use AVAudioSessionPortDescription properties that are different on different iOS versions. We found that on iOS versions 8 - 10 <code>AVAudioSessionPortDescription</code> has the following values: 
<code>
AirPlay: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-airplay 
Mirroring: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-screen
</code> 

For iOS 11+ some parameters like name and UID have different values: 
<code>
AirPlay: type = AirPlay; name = AirPlay; UID = 0eb63aae-5915-45f1-b0f7-0102a0e50d53 
Mirroring: type = AirPlay; name = Apple TV 4K; UID = 4335E8A9-1C0A-4251-9000-28CA5FA2F3CF-192731714653291-screen 
</code>

The following code snipped is suggested for AirPlay / mirroring detection on iOS devices.

{{ExampleCode|
|Objective C =
<syntaxhighlight lang="objective-c">
– (void)updateOTT:(id)ottInfo;
</syntaxhighlight>
=== Subscribe to AVAudioSessionRouteChangeNotification ===
<syntaxhighlight lang="objective-c">
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleRouteChanged:) name:AVAudioSessionRouteChangeNotification object:nil];
</syntaxhighlight>

=== Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:===
<syntaxhighlight lang="objective-c">
- (void)handleRouteChanged:(NSNotification *)notification
{
NSMutableDictionary *ottDict = [NSMutableDictionary dictionaryWithDictionary: @{@"ottStatus": @"0"}];

AVAudioSession *audioSession = [AVAudioSession sharedInstance];
AVAudioSessionRouteDescription *currentRoute = audioSession.currentRoute;
for (AVAudioSessionPortDescription *outputPort in currentRoute.outputs) {
if ([outputPort.portType isEqualToString:AVAudioSessionPortAirPlay]) {
ottDict[@"ottStatus"] = @"1";
ottDict[@"ottDeviceModel"] = outputPort.portName;
ottDict[@"ottDeviceID"] = outputPort.UID;

if ([outputPort.portName isEqualToString:@"AirPlay"]) {
ottDict[@"ottDevice"] = @"airplay";
ottDict[@"ottType"] = @"airplay";
}
else {
if ([outputPort.portName containsString:@"Apple TV"]) {
ottDict[@"ottDevice"] = @"appleTV";
}
else {
ottDict[@"ottDevice"] = @"other";
}

if ([outputPort.UID hasSuffix:@"airplay"]) {
ottDict[@"ottType"] = @"airplay";
}
else if ([outputPort.UID hasSuffix:@"screen"]) {
ottDict[@"ottType"] = @"mirroring";
}
else {
ottDict[@"ottType"] = @"other";
}
}
}
}

// report OTT status update to Nielsen SDK
[self reportOTTWithDict:ottDict];
}
</syntaxhighlight>

=== Report OTT update to the Nielsen SDK ===
<syntaxhighlight lang="objective-c">
- (void)reportOTTWithDict:(NSDictionary *)ottDict
{
[self.nielsenSDK updateOTT:ottDict];
}
</syntaxhighlight>

|Swift =
<syntaxhighlight lang="swift">
nielsenSdk.updateOTT(currentStatus)
</syntaxhighlight>

=== Subscribe to AVAudioSessionRouteChangeNotification ===
<syntaxhighlight lang="swift">
NotificationCenter.default.addObserver(self, selector: #selector(handleRouteChanged(_:)), name: NSNotification.Name.AVAudioSessionRouteChange, object: nil)
</syntaxhighlight>

=== Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:===

<syntaxhighlight lang ="Swift">
func handleRouteChanged(_ notification: Notification) {
var currentStatus: [String: String] = ["ottStatus": "0"]

let session = AVAudioSession.sharedInstance()
let currentRoute = session.currentRoute
for outputPort in currentRoute.outputs {
if outputPort.portType == AVAudioSessionPortAirPlay {
currentStatus["ottStatus"] = "1"
currentStatus["ottDeviceModel"] = outputPort.portName
currentStatus["ottDeviceID"] = outputPort.uid

if outputPort.portName == "AirPlay" {
currentStatus["ottDevice"] = "airplay"
currentStatus["ottType"] = "airplay"
}
else {
if outputPort.portName.contains("Apple TV") {
currentStatus["ottDevice"] = "appleTV"
}
else {
currentStatus["ottDevice"] = "other"
}

if outputPort.uid.hasSuffix("airplay") {
currentStatus["ottType"] = "airplay"
}
else if outputPort.uid.hasSuffix("screen") {
currentStatus["ottType"] = "mirroring"
}
else {
currentStatus["ottType"] = "other"
}
}
}
}

// report OTT status update to Nielsen SDK
self.reportOTTUpdate(currentStatus)
}
</syntaxhighlight>

=== Report OTT update to the Nielsen SDK===
<syntaxhighlight lang ="Swift">
func reportOTTUpdate(_ ottDict: [String: String]) {
if let nielsenSdk = self.nielsenAppApi {
nielsenSdk.updateOTT(currentStatus)
}
}
</syntaxhighlight>
}}

== 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_sdkDebug: 'DEBUG'}</code> from initialization call.
 
'''Note''': before going live you have to inform Nielsen team - this is necessary, because Nielsen team has to adjust internal configuration parameter to enable data collection. Without that notification no data will be collected and no data will be reported.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
The below sample applications have been designed to show the Simplified API's functionality and are broken into two distinct categories:
* '''Basic''' - To show the functionality of the Nielsen Simplified API using a standard no-frills player.
** [[Swift Basic Sample|Swift 4.0 Sample]]
** [[Objective-c Basic example|Objective-C Sample]]
** [[Android Basic example|Android Studio Example]]

* '''Advanced''' - Nielsen Simplified API integrated into a custom video player.
** [https://engineeringportal.nielsen.com/docs/Special:Downloads Swift 4.0 Sample]
** [https://engineeringportal.nielsen.com/docs/Special:Downloads Objective-C Sample]
** [https://engineeringportal.nielsen.com/docs/Special:Downloads Java/Android Studio Sample]

DCR Italy Video iOS SDK

2023-09-13T12:54:28Z

WilsonQuispe: /* Special Notes regarding iOS14 */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>
__TOC__

== Implementation ==
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.

<code>If you are building an app for the 'kids category' please review the [[DCR_Italy_Video_iOS_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category|Opt Out Requirement.]]</code>

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Video iOS14 Migration]] page.

== Special Notes regarding iOS17 ==

Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:

* [[ Nielsen Digital Measurement and_iOS17 or TVOS17 |Nielsen Digital Measurement and_iOS17 or TVOS17]]

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
Italian Clients:
*"it"
|| Nielsen-specified || Yes || "it"
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===

==== App tracking transparency framework ====

To display the App Tracking Transparency authorization request for accessing the IDFA, update your <code>info.plist</code> to add the <code>NSUserTrackingUsageDescription</code> key with a custom message describing your usage. Below is an example description text:
<code><key>NSUserTrackingUsageDescription</key></code>
<code><string>This identifier will be used to deliver personalized ads to you.</string></code>

The system automatically generates the prompt’s title, which includes the name of your app, then the usage description appears as part of the App Tracking

To present the authorization request, call requestTrackingAuthorizationWithCompletionHandler.

<blockquote>Please NOTE: It is important to initialize the NielsenSDK after the ATTrackingManager has Authorized usage. When the SDK initializes, it checks the status of the ATTrackingManager.</blockquote>

You can find an example in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section, folder name NielsenSampleVideoPlayer.

====Swift 4.0 Example:====
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0.2",
"appname": "Nielsen Sample App",
"sfcode": "it",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

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

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

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

override func viewDidLoad() {
super.viewDidLoad()

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

}
}
</syntaxhighlight>

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

@implementation NlsAppApiFactory

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

NSDictionary *appInformation = @{
@"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": "1.0.2",
@"appname": "Nielsen Sample App",
@"sfcode": "it",
@"nol_devDebug": @"DEBUG"
};

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

@end
</syntaxhighlight>

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

@class NielsenAppApi;
@protocol NielsenAppApiDelegate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

=== Sample Code: ===
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NlsAppApiFactory createNielsenAppApiWithDelegate:nil];
}}
</syntaxhighlight>



== 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 Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">

let channelInfo = [
"channelName": "My Channel Name 1",
];

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

NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
}
</syntaxhighlight>
}}


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

=== Content Metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || <code>seconds</code> (0 for live stream) || Yes
|-
| airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

=== Ad Metadata ===
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create Ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
NielsenInit.createMainBrandApi(delegate: self)
self.data = loadStaticMetadata()
self.nielsenMeter .loadMetadata(self.data)</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenMeter.play()</code> || // Call at start of each new stream
|-
| <code>nielsenMeter.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenMeter.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenMeter.end()</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
VOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the videoplayer is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for VOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

<blockquote>Note:
*For Audiweb there is no need to tag ads in video stream ... please see 1st example about how to use the SDK without ads.</blockquote>

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing videos or watching a new video, call <code>play()</code> each time.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:()];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play();</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">

-(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;

//Sending data dictionary to SDK with updated playHead position.
[nielsenApi playheadPosition:(intSec)];
}];
}
</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 ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi.stop()</syntaxhighlight>
}}

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

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

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:

*[[DCR_Italy_Video_iOS_SDK#OS-level_Opt-out|OS-level Opt-out]] - managed by AppTracking or Limit Ad Tracking setting on device (preferred approach).
*[[DCR_Italy_Video_iOS_SDK#User_Choice|User Choice]] - Direct call to SDK. Can be used without the Ad Framework

=== Special Note Regarding Apps in the Kids Category ===
If you are building an app that will be listed in the Kids Category:

Ensure that you are using the [https://nielsendownloads-green.digitalengsdk.com/digital/Nielsen-iOS-App-SDK-GlobalNoId_latest.zip NoID version:] of the Nielsen SDK Framework. Also, you can use the [[Digital_Measurement_iOS_Artifactory_Guide|Artifactory method.]]
Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang="swift">NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-outv</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen iOS

The Nielsen SDK automatically leverages the iOS's '''Limit Ad Tracking''' or '''AppTracking''' setting.

*If the User's device is running < iOS 13.x, the Nielsen SDK will check the status of '''Limit Ad Tracking'''.
*iOS14 modifies the way Apple manages the collection of a User's Opt-In status through '''AppTracking'''. Starting with Version 8.x+, the Nielsen App SDK will check the iOS version during initialization. If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested. If iOS14.x +, then AppTracking is utilized.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[optOutURL|optOutURL]]
*Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL|optOutURL]]

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>
<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) //create an instance

if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) { //query the nielsensdk for the current privacy page
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}}}}
</syntaxhighlight>

=== User Choice ===
The User Choice method can be used without the Ad Framework, or in situations where the publisher does not wish to use the [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency Framework.]

==== The User Choice opt-out method works as follows: ====

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

==== Opt-out example code ====
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>

===== Objective-C =====

<syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)
navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>

===== Swift =====
<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 via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the [[optOutStatus|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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
You can find some examples in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section

2023-07-17T07:55:36Z

WilsonQuispe: /* Ad Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>
__TOC__

== Implementation ==
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.

<code>If you are building an app for the 'kids category' please review the [[DCR_Italy_Video_iOS_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category|Opt Out Requirement.]]</code>

=== 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 CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]
* [[DCR_Video_iOS_SDK_xcframework|Using the XCFramework bundle]]

== Special Notes regarding iOS14 ==
=== Permission to Track ===

Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.

For more information, see:
* [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency]
* [https://developer.apple.com/design/human-interface-guidelines/ios/app-architecture/requesting-permission/ Human Interface Guidelines]
* [https://developer.apple.com/documentation/adsupport AdSupport Framework]

More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our [[ DCR Video iOS14 Migration|DCR Audio/Video iOS14 Migration]] page.

== 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_.28Dynamic_Framework_Only.29|found below]].

'''[[DCR_Video_iOS_SDK_xcframework|XCFramework]]''' is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.

=== 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, when using the dynamic framework, 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>

=== Special Note for Static Framework ===
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source codse.
If [[iOS_Static_Framework_Setup|static (xc)framework is integrated additional settings]] should be applied to fix build or runtime issues.

=== Download Framework ===
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

=== Add Framework ===
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

=== Add Path ===
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

=== Import Framework ===
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

==== xCode 12 building errors ====
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
<blockquote>Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.</blockquote>
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
* https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
* https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built

==== IPA processing failure ====
<code>Assertion failed: Expected 4 archs in otool output:</code>

The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a [[DCR_Video_iOS_SDK_xcframework|XCFramework]] to avoid the 4 archs in otool output message.

== 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. [[Dual_Instances_of_SDK|(Click here for an example of multiple instances)]]

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.

|| Nielsen-specified || Yes ||
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===

==== App tracking transparency framework ====

To display the App Tracking Transparency authorization request for accessing the IDFA, update your <code>info.plist</code> to add the <code>NSUserTrackingUsageDescription</code> key with a custom message describing your usage. Below is an example description text:
<code><key>NSUserTrackingUsageDescription</key></code>
<code><string>This identifier will be used to deliver personalized ads to you.</string></code>

The system automatically generates the prompt’s title, which includes the name of your app, then the usage description appears as part of the App Tracking

To present the authorization request, call requestTrackingAuthorizationWithCompletionHandler.

<blockquote>Please NOTE: It is important to initialize the NielsenSDK after the ATTrackingManager has Authorized usage. When the SDK initializes, it checks the status of the ATTrackingManager.</blockquote>

You can find an example in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section, folder name NielsenSampleVideoPlayer.

====Swift 4.0 Example:====
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"appversion": "1.0.2",
"appname": "Nielsen Sample App",
"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-4123-9277-2A788XXXXXXX",
@"appversion": "1.0.2",
@"appname": "Nielsen Sample App",
@"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 NielsenAppApiDelegate;

@interface NlsAppApiFactory : NSObject

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

@end
</syntaxhighlight>

=== Sample Code: ===
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NlsAppApiFactory createNielsenAppApiWithDelegate:nil];
}}
</syntaxhighlight>



== 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 Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) 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.

Example for Audio measurement:
{{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":"y",
"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": @ "88675545",
@ "title": @ "Program S3, EP1",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2"
}
</syntaxhighlight>
}}


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

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify audio /video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

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

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| isAudio || indicate measurement of audio ads or audio content || <code>'true'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Audio Content Object =====

<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>

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

'''Don't pass audio key "isAudio" into the loadmetadata call for video measurement'''.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Video Content Object =====

<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
];
</syntaxhighlight>

==== Ad Metadata ====
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create Ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<syntaxhighlight lang=Swift>
NielsenInit.createMainBrandApi(delegate: self)
self.data = loadStaticMetadata()
self.nielsenMeter .loadMetadata(self.data)</syntaxhighlight> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>nielsenMeter.play()</code> || // Call at start of each new stream
|-
| <code>nielsenMeter.loadMetadata(contentMetadata)</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>nielsenMeter.playheadPosition(pos);</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>nielsenMeter.end()</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
AOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current audio asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the media player is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for AOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing audio or listening to a new audio, call <code>play()</code> each time.
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c"> [nielsenAppApi play:()];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenAppApi?.play();</syntaxhighlight>
}}

=== loadMetadata ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi loadMetadata:(contentMetadata)];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">self.nielsenAppApi?.loadMetadata(contentMetadata)</syntaxhighlight>
}}

=== playheadPosition ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">

-(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;

//Sending data dictionary to SDK with updated playHead position.
[nielsenApi playheadPosition:(intSec)];
}];
}
</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 ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">[nielsenApi stop];</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">nielsenApi.stop()</syntaxhighlight>
}}

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

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

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Privacy and Opt-Out ==
There are two primary methods for implementing user Opt-out preferences:

*[[DCR_Italy_Video_iOS_SDK#OS-level_Opt-out|OS-level Opt-out]] - managed by AppTracking or Limit Ad Tracking setting on device (preferred approach).
*[[DCR_Italy_Video_iOS_SDK#User_Choice|User Choice]] - Direct call to SDK. Can be used without the Ad Framework

=== Special Note Regarding Apps in the Kids Category ===
If you are building an app that will be listed in the Kids Category:

Ensure that you are using the [https://nielsendownloads-green.digitalengsdk.com/digital/Nielsen-iOS-App-SDK-GlobalNoId_latest.zip NoID version:] of the Nielsen SDK Framework. Also, you can use the [[Digital_Measurement_iOS_Artifactory_Guide|Artifactory method.]]
Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang="swift">NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-outv</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen iOS

The Nielsen SDK automatically leverages the iOS's '''Limit Ad Tracking''' or '''AppTracking''' setting.

*If the User's device is running < iOS 13.x, the Nielsen SDK will check the status of '''Limit Ad Tracking'''.
*iOS14 modifies the way Apple manages the collection of a User's Opt-In status through '''AppTracking'''. Starting with Version 8.x+, the Nielsen App SDK will check the iOS version during initialization. If the device is running iOS12 or iOS13, the Limit Ad Tracking setting is requested. If iOS14.x +, then AppTracking is utilized.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[optOutURL|optOutURL]]
*Display a WebView element whose loadUrl is set to the value obtained from [[optOutURL|optOutURL]]

==== Webview Example ====
The below code is an example of displaying the Nielsen Privacy page to the user.
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>
<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) //create an instance

if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) { //query the nielsensdk for the current privacy page
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}}}}
</syntaxhighlight>

=== User Choice ===
The User Choice method can be used without the Ad Framework, or in situations where the publisher does not wish to use the [https://developer.apple.com/documentation/apptrackingtransparency App Tracking Transparency Framework.]

==== The User Choice opt-out method works as follows: ====

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

==== Opt-out example code ====
<blockquote>Note: Apple released a policy update stating that the App Store will no longer accept updates for apps using the deprecated UIWebView (no specific date has been confirmed). Since then, we’ve recommended that you adopt WKWebView instead of UIWebView and WebView.
</blockquote>

===== Objective-C =====

<syntaxhighlight lang="objective-c">
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)
navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {

NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];

if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
</syntaxhighlight>

===== Swift =====
<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 via OS-level Opt-out or via User Choice Opt-out, the current Opt-Out status as detected by the SDK is available via the [[optOutStatus|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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Removing Simulators (Dynamic Framework Only)==

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. Here is an example Shell script that could be added as a Run Script phase in the application.

<syntaxhighlight lang='bash'>

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
</syntaxhighlight>

== Sample Applications ==
You can find some examples in the file [[Special:Downloads|Global iOS SDK Download]] from the '''SDK Downloads''' section

2023-07-17T07:21:21Z

WilsonQuispe: /* Audio Content Metadata */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{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]]), 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
*Time of viewing a page / sub section in the application.

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|-
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[Android SDK Release Notes]]'' || [[Special:Downloads|Download]]
|-
|| '''sfcode''' || Unique identifier for the environment that the SDK should point to || Provided by Nielsen
|}

If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

=== Notes for WebView Contents ===
<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK|browser static SDK]] have to inhibit from this pages.</code>

== Implementation ==
This guide covers implementation steps for Android Studio utilizing the Standard Nielsen SDK for DCR.

__TOC__

=== How to obtain the NielsenAppApi ===
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of Gradle. We recommend using the Gradle-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_Android_Artifactory_Guide|Select to obtain Gradle implementation guide]]
* [[Special:Downloads|Select to Download Directly]]

== Setting up your Development Environment ==
=== Configuring Android Development Environment ===
*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.
*The Nielsen App SDK can also be added via [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Android_Artifactory_Guide Artifact Repository].

'''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 media 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.

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 search for <code>"*play-services*"</code>. Then select the most recent version of the play-services Artifact.
Ensure it is added in build.gradle (App level) file

==== Google AD ID Permissions ====
The following is required if target API level is set to 31 (Android 12) with the Ad Version of the Nielsen SDK.

<syntaxhighlight lang="java">
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
</syntaxhighlight>


==== Manifest File ====
* Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java">
<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 <code><application></code> 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)

The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
*The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
{| class="wikitable"
|-
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
| appid || Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. || Nielsen-specified || Yes || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
| appname || Name of the application
|| Client-defined || Yes || "Nielsen Sample App"
|-
| appversion || Current version of the app used
|| Client-defined || Yes || "1.0.2"
|-
| sfcode || Nielsen collection facility to which the SDK should connect.

|| Nielsen-specified || Yes ||
|-
| nol_devDebug || Enables Nielsen console logging. Only required for testing
|| Nielsen-specified || Yes for Debugging / Testing App || "DEBUG"
|}

== Debug flag for development environment ==
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument <code>@"nol_devDebug":@"DEBUG"</code>, in the JSON string . The permitted values are:

* '''INFO''': Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
* '''WARN''': Indicates potential integration / configuration errors or SDK issues.
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues.
* '''DEBUG''': Debug logs, used by the developers to debug more complex issues.

Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
<blockquote>'''Note''': Activate the Debug flag in a Test environment.</blockquote>

=== Sample SDK Initialization Code ===
[[AppSDK()|AppSDK()]] is no longer a singleton object and should be initialized as below.
====Initialization of App SDK object through a JSON object====
<syntaxhighlight lang="java">
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX")
.put("appversion", "1.0.2")
.put("appname", "Nielsen Sample App")
.put("nol_devDebug", "DEBUG"); // only for debug builds

// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
</syntaxhighlight>
 
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>) 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 Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.

== Configure Metadata ==
=== 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 Nielsen Key names (e.g. appid, program) 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.

==== Java ====
<syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

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

</syntaxhighlight>

=== Configure metadata ===
channelName 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 || Yes
|-
|}

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify audio /video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

==== Audio Content Metadata ====
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of asset || <code>'content'</code> || Yes
|-
| isAudio || indicate measurement of audio ads or audio content || <code>'true'</code> || Yes
|-
| assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
|-
| program || name of program (100 character limit) || custom || Yes
|-
| title || name of program (100 character limit) || custom || Yes
|-
| length || length of content in seconds || Length of content in seconds (86400 seconds for live stream (24/7). For Event-Live streams planned length. For AOD video length)|| Yes
|-
| airdate || The airdate in the linear over-the-air broadcast. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" || YYYYMMDD HH24:MI:SS
(if not known set it to eg. "19700101 00:00:00")
|| Yes
|-
| isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
|-
| adloadtype || type of ad load:
*<code>'1'</code> Linear – matches TV ad load
*<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
|| <code>'2'</code> - DCR measures content with dynamic ads
|| Yes

|}

===== Example Audio Content Object =====
<syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
.put("channelname","My Channel Name 1")

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

</syntaxhighlight>

=== Ad Metadata ===
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create Ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== 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> || // Pass Static Metadata here if applicable
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play];</code> || // Call at start of each new stream
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // MetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter setplayheadPosition: 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.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'playheadPosition' || playhead position as integer 
AOD: current position in seconds 
Live: current UNIX timestamp (seconds since Jan-1-1970 UTC) 
Note: 'PlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current audio asset completes playback and pass the playhead position. 
Example: At the end of the content stream, if the user switches to another piece of content, when the media player is reloaded or closed.
|}
<blockquote>Note: For livestream, send the UNIX timestamp, for AOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the content or Ad playback is interrupted and at the end of each Ad.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

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

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

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
"type": "content",
"isAudio": "true",
"assetid": "88675545",
"title": "Program S3, EP1",
"isfullepisode":"y",
"adloadtype":"2",
"program":"Program Name",
"length":"3600",
"airdate":"20171020 10:05:00"
}</syntaxhighlight>
Call [[playheadPosition|playheadPosition()]] 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(); </code> || // Call at start of each new stream
|-
| <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
|-
| Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
|-
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
|}

==== Use Case 2: Content has Advertisements ====

Call [[play()]] at start of stream

Call [[loadMetadata()]] with JSON metadata for ad as below.
<syntaxhighlight lang="json">{
"type": "preroll",
"assetid": "ad123"
}</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 [[playheadPosition|playheadPosition()]] 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(); </code> || // stream starts
|-
| <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.playheadPosition(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="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
|-
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| <code>mAppSdk.playheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
|-
| 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.playheadPosition(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 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 ===
Call <code>play</code> at the start of each new stream. If changing audio or listening to a new audio, call <code>play()</code> each time.
<syntaxhighlight lang="java">public void play(JSONObject channelInfo);</syntaxhighlight>

=== loadMetadata ===
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>

=== playheadPosition ===
<syntaxhighlight lang="java">public void setPlayheadPosition(long position);</syntaxhighlight>
=== stop ===
<syntaxhighlight lang="java">public void stop()</syntaxhighlight>
=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
<syntaxhighlight lang="java">public void end()</syntaxhighlight>

== Handling Foreground and Background states ==
There are a few approaches to managing the Foreground and Background states of an app available to use for state measurement.

*Utilizing the Androidx LifeCycleObserver (The recommended approach starting sdk version 7.1.0.0+)
*Utilizing the SdkBgFgDetectionUtility class
*Adding a tag to the Manifest XML
*Manual Management
=== The LifeCycleObserver ===
AndroidX replaces the original support library APIs with packages in the androidx namespace, and Android Studio 3.2 and higher provides an automated migration tool. (Select '''Refactor> Migrate to AndroidX''' from the menu bar.)

Starting with version 7.1.0, with AndroidX support, an additional utility is provided in the AppSDK - application background/foreground state detection by the AppSdk leveraging the Android Architecture component "LifeCycleObserver".

The AppSdk is now capable of detecting the application UI visibility state transitions between background and foreground, without forcing the applications to register for AppSdk's AppSdkApplication class, which is responsible for handling the detection of application background/foreground state transitions at present.

<blockquote>Please note, that if you already have an app designed that utilizes the depreciated SdkBgFgDetectionUtility Class, the AppSDK will ignore any calls to these methods if it can utilize the LifeCycleObserver. LifeCycleObserver based auto detection will take precedence.</blockquote>

==== Adding the AndroidX dependency ====
In order to make use of the app background/foreground state transition auto detection feature of AndroidX AppSdk, the app gradle file needs the androidx dependency. The AppSdk API calls - <code>appInForeground()</code> and <code>appInBackground()</code> will still be respected by AppSdk by executing the old AppSdk flow of handling "app in foreground" and "app in background" states as is.

==== Using the LifeCycle Extension ====
The following androidx dependency is required in the app gradle file:

<syntaxhighlight lang="java">implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"</syntaxhighlight>

<blockquote>If you would like to take advantage of this auto detection feature of AppSdk at the very initial stage (e.g. splash screen or at of app launch time), before the AppSdk is initialized, can do so by calling the following newly introduced AppSdk public api, passing the application context :

<syntaxhighlight lang="java">public static void registerLifeCycleObserver(Context applicationContext)</syntaxhighlight></blockquote>

==== Log messages for the new auto detection ====

*When the AppSdk app successfully registers for the LifeCycleObserver : <code>Registered LifeCycleObserver for App Background/Foreground auto-detection</code>
*When the app enters the foreground state :<code>App is in foreground, auto detected by AppSDK</code>
*When the app enters the background state :<code>App is in background, auto detected by AppSDK</code>
*If the client app doesn't have the "androidx" gradle dependency and AppSdk fails to register LifeCycleObserver :<code>AndroidX LifecycleObserver can not be observed. Please use androidx dependency to activate SDK auto-detection of app background/foreground state.</code>
*When the appInForeground() is explicitly called while LifeCycleObserver auto detection is active :<code>Ignoring the appInBackground() call, as the App Background/Foreground auto-detection is active. The current state is - foreground</code>
*When the appInBackground() is explicitly called while LifeCycleObserver auto detection is active :<code>Ignoring the appInBackground() call, as the App Background/Foreground auto-detection is active. The current state is - background</code>

=== The SdkBgFgDetectionUtility class ===
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 [[Android Background Foreground|SdkBgFgDetectionUtility class.]] The [[Android Background Foreground|SdkBgFgDetectionUtility class.]] is compatible with Android 4+ and has been made available to Nielsen clients. (You will need to copy/paste the code provided into a file).

==== Manual Background/ForeGround State Management ====
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [[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());</syntaxhighlight>
<syntaxhighlight lang="java">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).

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
In 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.
* Start sending API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== 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''').
# '''[[#User Choice|User Choice]]''' - Direct call to SDK. Can be used without Google Play Services.

=== Special Note Regarding Apps in the '''Kids Category''' ===
If you are building an app that will be listed in the Kids Category:
# Ensure that you are using the NoID version of the Nielsen SDK Framework.
# Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
<syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>

=== OS-level Opt-out ===
''OS-level Opt-out'' method available on Nielsen Android.

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"'' setting is ''enabled''. As a publisher, you cannot override this setting.

==== Get the latest Nielsen opt-out URL ====

*Get the current Nielsen opt-out URL via [[userOptOutURLString()|userOptOutURLString()]]
*Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()|userOptOutURLString()]]

==== Webview Example ====
The below code is an AndroidX 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(); // Initializing the NielsenSDK
appSdk = nielsenInit.initAppSdk(getApplicationContext(), this); //Create Instance
String url = appSdk.userOptOutURLString(); // Request Optout URL from NielsenSDK
webView.loadUrl(url); //Display to the user in a Webview
}
</syntaxhighlight>
 

=== User Choice ===
The ''User Choice'' method is only necessary when the host application does not leverage Google Play Services.

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">
private class MonitorWebView extends WebViewClient
{
private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";
private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";

@Override
public boolean shouldOverrideUrlLoading(WebView view, String url)
{
if (NIELSEN_URL_OPT_OUT.equals(url)
|| NIELSEN_URL_OPT_IN.equals(url))
{
// Get AppSdk instance from the host
AppSdk appSdk = HostApp.getAppSdk();
// Send the URL to the AppSdk instance
appSdk.userOptOut(url);
return true;
}
return false;
}
}
</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.

Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

== Going Live ==
Following Nielsen testing, you will need to:

# '''Disable Debug Logging''': Disable logging by deleting <code>{nol_devDebug: 'DEBUG'}</code> from initialization call.
# '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.

== Sample Applications ==

*You can find some examples in the file [[Special:Downloads|Global Android SDK Download]] from the '''SDK Downloads''' section

DCR Italy AUDIO Browser SDK

2023-07-17T07:19:42Z

WilsonQuispe: /* Example Ad Object */