Difference between revisions of "DCR Thailand Video Android SDK"

From Engineering Client Portal

(Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}} Category:Digital == Overview == The Nielsen SDK is one of multiple framework SD...")
 
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}}  {{CurrentBreadcrumb}}
+
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International_DCR}}  {{CurrentBreadcrumb}}
 
[[Category:Digital]]
 
[[Category:Digital]]
  
 
== Overview ==
 
== Overview ==
The Nielsen SDK is one of multiple framework SDKs that Nielsen provides to enable measuring live streaming and on-demand video content viewing using TVs, mobile devices, etc.
+
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. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
 +
*Application launch events and how long app was running
 +
*Time of viewing a sub section / page in the application.
  
 
== Prerequisites ==
 
== Prerequisites ==
To start using the App SDK, the following details are required:
+
Before you start the integration, you will need:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
+
{| class="wikitable"
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
+
|-
* '''Nielsen SDK:''' The Nielsen SDK package contains a variety of sample players for your reference.
+
! style="width: 15%;" | Item
If you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team.
+
! Description
 +
! Source
 +
|-style="background-color:#d0f6f8;"
 +
|| '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
 +
|-style="background-color:#d0f6f8;"
 +
|| '''Nielsen SDK''' || Includes SDK frameworks and '''sample implementation'''; ''See [[Android SDK Release Notes]]'' || [[Special:Downloads|Download]]
 +
|}
 +
 
 +
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.
 
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.
  
 
==  Implementation ==
 
==  Implementation ==
This guide covers implementation steps for Android using Android Studio.
+
This guide covers implementation steps for Android Studio utilizing the Nielsen SDK for DCR.
 +
 
 +
{| class="wikitable"
 +
|-
 +
! SDK Flavor
 +
! Description
 +
|-
 +
| '''Android Ad Version'''
 +
|* Opt-In and Opt-Out functionality managed by Opt out of Ads Personlization setting on device. '''(Preferred approach)''' <br />* The Nielsen SDK will collect the [https://developer.android.com/training/articles/ad-id Google Advertising ID] unless the user Opts Out.<br>* If the Google Play Service is unavailable, (ie: Amazon and Huawei devices) the Nielsen sdk will secure the Android ID.<br> * There are 3 versions available starting with the Nielsen SDK 8.1.0.0.
 +
|-
 +
| '''Android No Ad Framework'''
 +
|* Without the Ad Framework, the Nielsen SDK cannot read the Google Advertising ID, so will retrieve the '''AndroidID'''.<br />* The AndroidID is a 64-bit number (expressed as a hexadecimal string), unique to each combination of app-signing key, user and device.<br />* The developer is required to present the User Choice Opt Out page which is described in the [[DCR_Thailand_Video_Android_SDK#Global_Android_SDK_No_Ad_Framework_Optout|Global Android SDK No Ad Opt-out]].
 +
|-
 +
| '''Android SDK noID'''
 +
|* This version of the Nielsen SDK is perfect for Kid apps, or where no ID is required.<br>* Please review the [[DCR_Thailand_Video_Android_SDK#Global_Android_SDK_No_ID_Optout_.28Kids_Category.29|Opt Out Requirement]].
 +
|}
 +
 
 +
=== 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]]
 +
__TOC__
  
 
== Setting up your  Development Environment  ==
 
== Setting up your  Development Environment  ==
  
<big>'''Configuring Android Development Environment'''</big>'
+
=== Configuring Android Development Environment ===
*The Nielsen App SDK (located in the ''com.nielsen.app.sdk'' package) class is the primary application interface to the Nielsen App SDK on Android.
+
*The Nielsen App SDK (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 class is defined as the only public class belonging to the com.nielsen.app.sdk package.
 +
*The Nielsen App SDK can also be added as a [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Android_Artifactory_Guide Artifact Repository]. If implemented this way, you do not need to download the appsdk from the Nielsen Portal.
  
 
'''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.'''
 
'''Nielsen App SDK is compatible with Android OS versions 2.3+. Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.'''
 
The Nielsen App SDK 1.2 library is composed of two parts:
 
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
 
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
 
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>
 
  
 
The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
 
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.
Line 33: Line 61:
 
** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).
 
** 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.
 
** If the player application uses a 3rd party media player implementing its own HLS, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
* '''For Audio player applications'''
+
 
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.
+
Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
Ensure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
+
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; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
+
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
+
 
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
+
==== 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 [https://developers.google.com/admob/android/quick-start play-services Artifact].
 +
Ensure it is added in build.gradle (App level) file
 +
 
 +
==== Manifest File ====
 +
* Add the following permissions on the project’s ''AndroidManifest.xml'' file.
 +
<syntaxhighlight lang="html">
 
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
 
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
 
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
 
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html].  Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.
+
For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html].   
* App SDK checks to see if there is a Google service available and updated.
 
* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
 
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
 
* Access '''File > Import'''.
 
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
 
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
 
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
 
** Android 4.4.2, etc. OR
 
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.
 
Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.
 
  
<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>
+
* In <code>AndroidManifest.xml </code>under <application> node add the following metadata
  
Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
+
<syntaxhighlight lang="html"><manifest>
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.
+
    <application>
 +
        <!-- Sample AdMob app ID: ca-app-pub-3940256099942544~3347511713 -->
 +
        <meta-data
 +
            android:name="com.google.android.gms.ads.APPLICATION_ID"
 +
            android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
 +
    </application>
 +
</manifest>></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.
  
<big>'''Library'''</big>
+
==== Library ====
 +
Nielsen App SDK uses the following packages/classes from the [https://developers.google.com/android/guides/setup Google Play service].
 +
<syntaxhighlight lang="coffeescript">
 +
dependencies {
 +
  implementation 'com.google.android.gms:play-services-ads:xx.x.x'
 +
}
 +
</syntaxhighlight>
  
Nielsen App SDK uses the following packages/classes from the Google Play service.
+
==== Classes/package ====
* google-play-services_lib
+
<syntaxhighlight lang ="javascript">
 
+
import com.google.android.gms.ads.identifier.AdvertisingIdClient;
'''<big>Classes/package</big>'''
+
import com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
 
+
import com.google.android.gms.common.ConnectionResult;
* com.google.android.gms.ads.identifier.AdvertisingIdClient;
+
import com.google.android.gms.common.GooglePlayServicesUtil;
* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
+
import com.google.android.gms.common.GooglePlayServicesRepairableException;
* com.google.android.gms.common.ConnectionResult;
+
import com.google.android.gms.common.GooglePlayServicesNotAvailableException;
* com.google.android.gms.common.GooglePlayServicesUtil;
+
</syntaxhighlight>
* com.google.android.gms.common.GooglePlayServicesRepairableException;
 
* com.google.android.gms.common.GooglePlayServicesNotAvailableException;
 
  
 
== SDK Initialization ==
 
== 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 latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issue. The sharedInstance API that creates a singleton object was deprecated prior to version 5.1.1. (Version 4.0 for Android)
 
* A maximum of four SDK instances per appid are supported. When a fifth SDK instance is launched, the SDK will return “nil” from [[initWithAppInfo:delegate:]]
 
* When four SDK instances exist, you must destroy an old instance before creating a new one.
 
  
 
The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
 
The 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"
 
{| class="wikitable"
 
|-
 
|-
! Parameter / Argument !! Description !! Source !! Required/Obligatory? !! Example
+
! Parameter / Argument !! Description !! Source !! Required? !! Example
|-
 
| appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || ✓ || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 
|-
 
| appversion || Current version of the app used || Client-defined || No || "1.0.2"
 
 
|-
 
|-
| sfcode || Nielsen collection facility to which the SDK should connect.
+
| 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
|| Nielsen-specified || || "dcr"
 
 
|-
 
|-
 
| nol_devDebug || Enables Nielsen console logging. Only required for testing
 
| nol_devDebug || Enables Nielsen console logging. Only required for testing
 
|| Nielsen-specified || Optional || "DEBUG"
 
|| Nielsen-specified || Optional || "DEBUG"
 
|}
 
|}
<br />
+
 
 +
== 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 ====
 
==== Sample SDK Initialization Code ====
 
[[AppSDK()]] is no longer a singleton object and should be initialized as below.
 
[[AppSDK()]] is no longer a singleton object and should be initialized as below.
  
 
'''Initialization of App SDK object through a JSON object'''
 
'''Initialization of App SDK object through a JSON object'''
<syntaxhighlight lang="java">
+
<syntaxhighlight lang="java">try
try
 
 
{
 
{
 
   // Prepare AppSdk configuration object (JSONObject)
 
   // Prepare AppSdk configuration object (JSONObject)
 
   JSONObject appSdkConfig = new JSONObject()
 
   JSONObject appSdkConfig = new JSONObject()
           .put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXXX")
+
           .put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
          .put("appversion", "1.0")
 
          .put("sfcode", "dcr")
 
 
           .put("nol_devDebug", "DEBUG"); // only for debug builds
 
           .put("nol_devDebug", "DEBUG"); // only for debug builds
  
Line 119: Line 155:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>appname</code>, <code>sfcode</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.
+
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.<br />
 
The integration of Nielsen App SDK will depend on type of client app.<br />
Line 127: Line 162:
 
== APP SDK Error & Event Codes ==
 
== 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.
 
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 ==
 
== Configure Payload ==
 
=== Handling JSON Metadata ===
 
=== Handling JSON Metadata ===
Line 137: Line 173:
 
** 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.
 
** 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.
 
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
 
 
  <syntaxhighlight lang="java">
 
  <syntaxhighlight lang="java">
JSONObject channelInfo = new JSONObject()
 
    .put("channelname","My Channel Name 1")
 
 
 
JSONObject contentMetadata = new JSONObject()
 
JSONObject contentMetadata = new JSONObject()
 
//SDK Metadata
 
//SDK Metadata
Line 149: Line 181:
 
     .put("title", "Program S3, EP1")
 
     .put("title", "Program S3, EP1")
 
     .put("length", "3600")
 
     .put("length", "3600")
     .put("isfullepisode", "y")
+
     .put("isfullepisode", "y")  
 
     .put("adloadtype", "2")
 
     .put("adloadtype", "2")
     .put("segmentB", "custom")
+
     .put("segB", "CustomSegmentValueB") //optional
     .put("segmentC", "custom")
+
     .put("segC", "CustomSegmentValueC") //optional 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
=== Configure metadata ===  
+
=== Content metadata ===
channelName should remain constant throughout the completion of an episode or live stream.
+
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
<br />
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! Key !! Description !! Values !! Required
 
! Key !! Description !! Values !! Required
 
|-
 
|-
| channelName || Any string representing the channel/stream || custom || ✓
+
| clientid ||  
 +
parent ID – value is automatically populated through provided App ID.<br/>
 +
In order to override the brand configured to the App ID, pass parent <br/>
 +
value here and the sub-brand ID associated to that brand in the subbrand <br/>
 +
key (e.g. multiple brands in App)
 +
||
 +
Nielsen provided
 +
||
 +
|-
 +
| subbrand || sub-brand ID – value is automatically populated through provided<br/>
 +
App ID. In order to override the sub-brand configured to the App ID, value can <br/>
 +
be passed here (e.g. multiple sub-brands in App)
 +
||
 +
Nielsen provided
 +
||
 +
|-
 +
| type || type of asset || "content" || ✓
 +
|-
 +
| assetid || unique ID assigned to asset || custom<br>(no [[Special Characters]]). The Content ID should be populated here which should correspond to the same value in the post transmission logs. || ✓
 +
|-
 +
| program || name of program || custom || ✓
 +
|-
 +
| title || episode name || custom || ✓
 +
|-
 +
| length || length of content in seconds || seconds (86400 for live stream)|| ✓
 +
|-
 +
| segB || custom segment B. Custom segments can be used to aggregate content however you choose. Some examples include genre, category, or platform. || custom ||
 +
|-
 +
| segC || For VOD: Populate TVContent ID, For livestream: leave blank || custom || Required for VOD only
 +
|-
 +
| isfullepisode || full episode flag ||
 +
*'y', 'yes', or 'lf' – full episode
 +
*'n', 'no', or 'sf' – non full episode
 +
'''Note:''' For livestream content with Dynamic Ad Insertion (DAI), the isfullepisode value should be set to 'y'.
 +
||
 +
 +
|-
 +
|adloadtype || type of Ad load:
 +
* 1) Linear – matches TV Ad load. Content with linear Ad Load is not eligible for DCR measurement and will not be included in DCR reporting.
 +
* 2) Dynamic – Dynamic Ad Insertion (DAI)
 +
||
 +
*"1" – content with linear Ads. Note: Content with linear Ad load is not included in DCR measurement.
 +
*"2" – content with dynamic Ads
 +
||
 +
 
|-
 
|-
 
|}
 
|}
<br/>
 
  
=== Content Metadata (VOD) ===
+
=== Ad Metadata ===
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
+
The Ad Metadata (if applicable) should be passed for each individual ad.
<table>
+
{| class="wikitable"
<tr>
+
|-
<th> Keys </th>
+
! Keys !! Description !! Values !! Required
<th> Description </th>
+
|-
<th> Example </th>
+
| type || type of Ad ||  <code>'preroll'</code><code>'midroll'</code><code>'postroll'</code> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
<th> Required
+
|-
</th></tr>
+
| assetid || unique ID assigned to Ad || custom <br>(no [[Special Characters]]) || ✓
<tr>
+
|}
<td>'''type'''</td>
 
<td><code>'content', 'ad'</code></td>
 
<td> <code> 'content'</code> </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''assetid''' </td>
 
<td> unique ID assigned to asset </td>
 
<td> custom </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''program''' </td>
 
<td>name of program (25 character limit) </td>
 
<td> custom </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''title''' </td>
 
<td>name of program (40 character limit) </td>
 
<td> custom </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''length''' </td>
 
<td> length of content in seconds </td>
 
<td> <code>seconds</code> </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''isfullepisode''' </td>
 
<td> full episode flag</td>
 
<td> "y"- full episode, "n"- non full episode</td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> <b>adloadtype</b>
 
</td>
 
<td> ad model only pass value as 2
 
</td>
 
<td> 2
 
</td>
 
<td>Yes
 
</td></tr>
 
<tr>
 
<td> '''segB''' </td>
 
<td> custom segment B</td>
 
<td> custom </td>
 
<td>
 
</td></tr>
 
<tr>
 
<td> '''segC''' </td>
 
<td> custom segment C</td>
 
<td> custom </td>
 
<td>
 
</td></tr>
 
<tr>
 
<td> '''crossId2 '''</td>
 
<td> content originator (only required for distributors) </td>
 
<td> Nielsen provided </td>
 
<td>
 
</td></tr>
 
  
</table>
+
=== Example Ad Object ===
 +
<syntaxhighlight lang="javascript">
 +
// create ad object
 +
"ad": {
 +
  "type": "preroll",
 +
  "assetid": "AD-ID123"
 +
}
 +
</syntaxhighlight>
  
 +
== Sequence of Calls ==
 +
=== play ===
 +
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
 +
<syntaxhighlight lang="java">    public void play(JSONObject channelInfo);</syntaxhighlight>
  
==== Example Content Object (VOD)====
+
=== loadMetadata ===
 +
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
 +
 
 +
=== playheadPosition ===
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
JSONObject contentMetadata = new JSONObject()
+
public void setPlayheadPosition(long position)
//SDK Metadata
 
    .put("type", "content")
 
    .put("assetid", "vid345-67483")
 
    .put("program", "Program Name")
 
    .put("title", "Program S3, EP1")
 
    .put("length", "3600")
 
    .put("isfullepisode", "y")
 
    .put("adloadtype", "2")
 
    .put("segmentB", "custom")
 
    .put("segmentC", "custom")
 
 
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==== Content Metadata (Live Streaming)====
+
=== stop ===
Content metadata should remain constant throughout the completion of an episode / clip including the ads play.
+
<syntaxhighlight lang="java">public void stop()</syntaxhighlight>
<table>
 
<tr>
 
<th> Keys </th>
 
<th> Description </th>
 
<th> Example </th>
 
<th> Required
 
</th></tr>
 
<tr>
 
<td>'''type'''</td>
 
<td><code>'content', 'ad'</code></td>
 
<td> <code> 'content'</code> </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''assetid''' </td>
 
<td> unique ID for each quarter </td>
 
<td> live021 </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''program''' </td>
 
<td>name of program (25 character limit) </td>
 
<td> "CH Live" </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''title''' </td>
 
<td>Use period as title name per each quarter </td>
 
<td>”02.00-02.14”</td>
 
<td> Yes</td></tr>
 
<tr>
 
<td> '''length''' </td>
 
<td> length of content in seconds </td>
 
<td>  900 </td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> '''isfullepisode''' </td>
 
<td> full episode flag</td>
 
<td> 'y'- full episode</td>
 
<td> Yes
 
</td></tr>
 
<tr>
 
<td> <b>adloadtype</b>
 
</td>
 
<td> ad model (only pass value as 2)
 
</td>
 
<td> '2'</td>
 
<td>Yes
 
</td></tr>
 
<tr>
 
<td> '''segB''' </td>
 
<td> custom segment B</td>
 
<td> custom </td>
 
<td>
 
</td></tr>
 
<tr>
 
<td> '''segC''' </td>
 
<td> custom segment C</td>
 
<td> custom </td>
 
<td>
 
</td></tr>
 
<tr>
 
<td> '''crossId2 '''</td>
 
<td> content originator (only required for distributors) </td>
 
<td> Nielsen provided </td>
 
<td>
 
</td></tr>
 
</table>
 
  
==== Example Content Object (Live Streaming)====
+
=== end ===
<syntaxhighlight lang="java">
+
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>
  
JSONObject contentMetadata = new JSONObject()
+
== Configure API Calls ==
//SDK Metadata
 
    .put("type", "content")
 
    .put("assetid", "live021")
 
    .put("program", "CHLive")
 
    .put("title", "02.00-02.14")
 
    .put("length", "900")
 
    .put("isfullepisode", "y")
 
    .put("adloadtype", "2")
 
</syntaxhighlight>
 
  
<br/>
+
=== Sample API Sequence ===
=== Ad Metadata ===
+
A Sample API sequence could follow this flow:
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
 
<br/>
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Keys !! Description !! Values !! Required
+
! Type !! Sample code !! Description
 +
|-
 +
| rowspan="2" | Start of stream || <code>[nielsenMeter play];</code> || // call at start of each new stream
 +
|-
 +
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
 
|-
 
|-
| type || type of ad || 'preroll', 'midroll', or 'postroll' || ✓
+
| Content || <code>[nielsenMeter setplayheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
 
|-
 
|-
| assetid || unique ID assigned to ad || custom || ✓
+
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
 
|}
 
|}
  
==== Example Ad Object ====
+
=== SDK Events ===
<syntaxhighlight lang="java">
+
{| class="wikitable"
 
+
|-
JSONObject AdsMetadata = new JSONObject()
+
! Event !! Parameter !! Description
//SDK Metadata
+
|-
    .put("type", "preroll")
+
| 'play' || || Call at start of each new stream
    .put("assetid", "AD-123")
+
|-
</syntaxhighlight>
+
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
 
+
|-
== Configure API Calls  ==
+
| 'setPlayheadPosition' || playhead position as integer<br/>
 +
VOD: || current position in seconds <br/>
 +
Live: current Unix timestamp (seconds since Jan-1-1970 UTC) <br/>
 +
Note: 'setPlayheadPosition' 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. <br/>
 +
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed 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 ===
Line 373: Line 325:
 
# '''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'''.
 
# '''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.
 
# '''Idle state''' – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
# '''Processing state''' – The SDK instance is processing playing information. [[#play|play]] and [[#Content_metadata|loadMetadata]] calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
+
# '''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.
## [[#play|playheadPosition]] – Call this API every one second when playhead position timer is fired.
+
## <code>'''setplayheadPosition'''</code> – Call this API every one second when playhead position timer is fired.  If a LIVE event, use the current Unix timestamp (seconds since Jan-1-1970 UTC).
## [[#play|stop]] – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
+
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## [[#play|end]] – SDK instance exits from Processing state when this API is called.
+
## <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. SDK instance moves into this state in one of the following scenarios.
 
# '''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
 
## Initialization fails
## <code>appDisableApi</code> is called
+
## <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.
  
<blockquote>
+
'''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.
'''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, <code>'''loadMetadata''' </code> and   <code>'''playheadPosition'''</code> </blockquote>
* As soon as the playback resumes, call [[play]], [[loadMetadata]] and [[playheadPosition]].</blockquote>
 
  
=== API Call sequence ===
+
=== API Call Sequence ===
 
==== Use Case 1: Content has no Advertisements ====
 
==== Use Case 1: Content has no Advertisements ====
Call [[play()]] with channelName JSON as below.
+
Call [[play()]] at start of stream
<syntaxhighlight lang="json">{
+
 
  "channelName": "TheMovieTitle"
 
}</syntaxhighlight>
 
 
Call [[loadMetadata()]] with JSON metadata for content as below.
 
Call [[loadMetadata()]] with JSON metadata for content as below.
 
<syntaxhighlight lang="json">{
 
<syntaxhighlight lang="json">{
Line 406: Line 357:
 
! Type !! Sample code !! Description
 
! Type !! Sample code !! Description
 
|-
 
|-
| rowspan="2" | Start of stream || <code>mAppSdk.play(channelName); </code> || // channelName contains JSON metadata of channel/video name being played
+
| 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
 
| <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
Line 412: Line 363:
 
| Content || <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is 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.
 
| End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
 
|}
 
|}
  
 
==== Use Case 2: Content has Advertisements ====
 
==== Use Case 2: Content has Advertisements ====
Call [[play()]] with channelName JSON as below.
+
Call [[play()]]  
<syntaxhighlight lang="json">{
+
 
  "channelName": "TheMovieTitle"
 
}</syntaxhighlight>
 
 
Call [[loadMetadata()]] with JSON metadata for ad as below.
 
Call [[loadMetadata()]] with JSON metadata for ad as below.
 
<syntaxhighlight lang="json">{
 
<syntaxhighlight lang="json">{
 
   "type": "preroll",
 
   "type": "preroll",
   "assetid": "ad=123"
+
   "assetid": "ad-123"
 
}</syntaxhighlight>
 
}</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>
 
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>
  
 
Call [[setPlayheadPosition()]] every one second until a pause / stop / another [[loadMetadata()]] is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata()]].
 
Call [[setPlayheadPosition()]] every one second until a pause / stop / another [[loadMetadata()]] is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata()]].
 +
 +
'''Ad Content'''
 +
<syntaxhighlight lang="java">    long pos = mAdPlayer.videoPosition() / 1000;
 +
  if (mAppSdk != null)
 +
  {
 +
    mAppSdk.setPlayheadPosition(pos);
 +
  }</syntaxhighlight>
 +
<blockquote>Note: The playhead positions for ad and content should be maintained separately.</blockquote>
  
 
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.
 
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.
Line 434: Line 397:
 
! Type !! Sample code !! Description
 
! Type !! Sample code !! Description
 
|-
 
|-
| rowspan="2" | Start of stream || <code>mAppSdk.play(channelName); </code> || // channelName contains JSON metadata of channel/video name being played
+
| 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
 
| <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
Line 444: Line 407:
 
| <code>mAppSdk.stop();</code> || // Call stop after preroll occurs
 
| <code>mAppSdk.stop();</code> || // Call stop after preroll occurs
 
|-
 
|-
| rowspan="3" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
+
| 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
 
| <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
 
|-
 
|-
| <code>mAppSdk.stop();</code> || // Call stop after the content is paused (ad starts)
+
| rowspan="3" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
|-
 
| 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.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
 
| <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
 
|-
 
|-
| rowspan="3" | Content (End of stream) || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
+
| rowspan="2" | Content Resumes || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
 
|-
 
|-
 
| <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
 
| <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
 
|-
 
|-
| <code>mAppSdk.end();</code> || // Call end() at the end of content
+
|  rowspan="1" | 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
 
| rowspan="3" | Postroll || <code>mAppSdk.loadMetadata(postrollMetaDataObject);</code> || // postrollMetadataObject contains the JSON metadata for the postroll ad
Line 477: Line 432:
 
<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>
 
<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 [[DCR_Video_Android_SDK#The_SdkBgFgDetectionUtility_class|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.)
  
=== Sequence Examples VOD ===
+
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 example code below will differ from your production application. Provided to assist in explaining how to implement.
 
  
=== play ===
+
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.
Use [[play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
 
  
  <syntaxhighlight lang="java">   public void play(JSONObject channelInfo);</syntaxhighlight>
+
<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.
  
=== loadMetadata ===
+
==== Using the LifeCycle Extension ====
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
+
The following androidx dependency is required in the app gradle file:
 +
<syntaxhighlight lang="java">
 +
implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"
 +
</syntaxhighlight>
  
=== playheadPosition/setPlayheadPosition ===
+
<blockquote>
Please note: iOS sdk uses playheadPosition. Android uses setPlayheadPosition.
+
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">
<syntaxhighlight lang="java">
+
public static void registerLifeCycleObserver(Context applicationContext)
public void run() {
 
      if (mMediaPlayer != null) {
 
 
 
      //getting current position of media player
 
    int mCurrentPosition = mMediaPlayer.getCurrentPosition() / 1000;
 
 
 
    seek.setProgress(mCurrentPosition);
 
    try {
 
      //Checking If video player is not paused and video is playing
 
          if (!isPaused && mMediaPlayer.isPlaying() && videoType != Constants.dtvrVideo) {
 
      //Sending playHeadPosition to SDK.
 
      appSdk.setPlayheadPosition(mCurrentPosition);
 
        }
 
      } catch (Exception e) {
 
      e.printStackTrace();
 
        }
 
        }
 
    playheadHandler.postDelayed(this, 1000);
 
                }
 
if (mAppSdk != null)
 
{
 
mAppSdk.setPlayheadPosition(pos);
 
}
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
</blockquote>
  
=== stop ===
+
==== Log messages for the new auto detection ====
<syntaxhighlight lang="java">mAppSdk.stop()</syntaxhighlight>
 
  
=== end ===
+
When the AppSdk app successfully registers for the LifeCycleObserver : <code>Registered LifeCycleObserver for App Background/Foreground auto-detection</code>
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">mAppSdk.end()</syntaxhighlight>
 
  
=== Sequence Examples Live Streaming ===
+
* When the app enters the foreground state :<code>App is in foreground, auto detected by AppSDK</code>
The example code below will differ from your production application. Provided to assist in explaining how to implement.
+
* 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>
  
=== play ===
+
=== The SdkBgFgDetectionUtility class ===
Use [[play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
+
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.
  
<syntaxhighlight lang="java">   public void play(JSONObject channelInfo);</syntaxhighlight>
+
==== 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>
  
=== loadMetadata ===
+
==== Using the Android SdkBgFbDetectionUtility Class ====
Pass metadata for live streaming - Title will be dynamic depend on current time on device that user play the live streaming
+
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class].  The  [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients. (You will need to copy/paste the code provided into a file).
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
 
  
=== playheadPosition/setPlayheadPosition ===
+
==== Manual Background/ForeGround State Management ====
Please note: iOS sdk uses playheadPosition. Android uses setPlayheadPosition.
+
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided  [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.
  
<syntaxhighlight lang="java">
+
The SDK is informed about app state using the below methods.
public void run() {
+
<syntaxhighlight lang="java">
      if (mMediaPlayer != null) {
+
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
      //Live streaming
+
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
      Live Streaming :
 
      Calendar c = Calendar.getInstance();
 
      long pos = (c.getTimeInMillis()/ 1000);
 
      if (mAppSdk != null)
 
      {
 
        mAppSdk.setPlayheadPosition(pos);
 
      }
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.
  
=== When the quarter hour change===
 
=== end ===
 
Call end for the previous quarter hour.
 
<syntaxhighlight lang="java">mAppSdk.end()</syntaxhighlight>
 
  
=== play ===
+
Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).
Call play for start of new quarter hour
+
== Using the NielsenAppSDKJSHandler ==
<syntaxhighlight lang="java">    public void play(JSONObject channelInfo);</syntaxhighlight>
+
There could be a scenario in which a browser page, that is already tagged with the Nielsen BSDK, needs to be loaded via a webview.  In this situation it is recommended to use the '''NielsenAppSDKJSHandler''' which will allow communication between the AppSDK and the BSDK.
 +
<br>
  
=== loadMetadata ===
+
'''This feature is supported in versions 7.2 and above.'''
Call loadMetadata and pass content metadata for new quarter hour
+
<br>
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
 
  
=== playheadPosition/setPlayheadPosition ===
+
=== Implementation ===
Please note: iOS sdk uses playheadPositionAndroid uses setPlayheadPosition.
+
* Make sure you have the latest AppSdk.jar from Nielsen
 +
* Enable the javascript on webview using below lines
 +
<br>
 +
<syntaxhighlight lang=java>
 +
WebSettings webSetting = webView.getSettings();
 +
webSetting.setJavaScriptEnabled(true);
 +
</syntaxhighlight>
 +
<br>
 +
* Add  NielsenAppSDKJSHandler instance as javascript interface to webview with name “NielsenAppSDK” like below snippet
 +
<br>
 +
<syntaxhighlight lang=java>
 +
webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext()), "NielsenAppSDK");
 +
</syntaxhighlight>
 +
<br>
 +
This will enable listening to BSDK api calls within the APPSDKPlease make sure your Technical Account Manager is aware that you wish to implement this method so a configuration file can be modified on the Nielsen servers; however, there are '''no changes required to the Browser page'''.
  
<syntaxhighlight lang="java">
+
==== Example:====
public void run() {
+
The below is an example of opening a webview with the NielsenAppSDKJSHandler
      if (mMediaPlayer != null) {
+
<syntaxhighlight lang=java>
       //Live streaming
+
      WebSettings webSetting = webView.getSettings();
      Live Streaming :
+
      webView.getSettings().setDomStorageEnabled(true);
      Calendar c = Calendar.getInstance();
+
       webSetting.setJavaScriptEnabled(true);
      long pos = (c.getTimeInMillis()/ 1000);
+
      webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext(), ""), "NielsenAppSDK");
      if (mAppSdk != null)
+
      String url = "https://nielsen.com.index.htm";
      {
+
      webView.loadUrl(url);
        mAppSdk.setPlayheadPosition(pos);
+
</syntaxhighlight>
      }
+
<br>
 +
<code>AndroidManifest.xml</code> may need the following permissions set:
 +
<syntaxhighlight lang=java>
 +
    <uses-permission android:name="android.permission.INTERNET"/>
 +
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
<br>
 +
 +
=== Closing NielsenAppSDKJSHandler ===
 +
NielsenAppSDKJSHandler should be closed or cleaned up in below scenarios
 +
* Before WebView is getting destructed
 +
* Before loading new page
 +
* Before closing application
 +
NielsenAppSDKJSHandler provides a public interface with name "close()" and this function should be called on NielsenAppSDKJSHandler's instance in all above scenarios.
  
 +
<syntaxhighlight lang=java>
 +
// get your webview
 +
WebView webView = findViewById(R.id.webView);
 +
 +
//Added JS Handler instance as java script interface for ggpm api type
 +
NielsenAppSDKJSHandler jshandler = new NielsenAppSDKJSHandler(getApplicationContext(), "");
 +
webView.addJavascriptInterface(jshandler, "NielsenAppSDK");
 +
 +
//Close JS Handler before making webview as null
 +
jshandler.close();
 +
webView = null;
 +
</syntaxhighlight>
  
 
== Interruptions during playback ==
 
== 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:
+
As part of integrating Nielsen App SDK with the player application, the Video app developer needs to handle the following possible interruption scenarios:
 
* Pause / Play
 
* Pause / Play
 
* Network Loss (Wi-Fi / Airplane / Cellular)
 
* Network Loss (Wi-Fi / Airplane / Cellular)
Line 590: Line 568:
 
* Alarm Interrupt
 
* Alarm Interrupt
 
* Content Buffering
 
* Content Buffering
* Device Lock / Unlock (Video players only, not for Audio players)
+
* Device Lock / Unlock  
* App going in the Background/Foreground (Video players only, not for Audio players)
+
* App going in the Background/Foreground
 
* Channel / Station Change Scenario
 
* Channel / Station Change Scenario
 
* Unplugging of headphone
 
* Unplugging of headphone
 
In case of encountering one of the above interruptions, the player application needs to
 
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.
+
* Call [[stop()]] immediately (except when content is buffering) and withhold sending playhead position.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
+
* Start sending pings – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details
+
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details
  
== Handling Foreground and Background states ==
+
== 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 currently 3 flavors of the Nielsen SDK:
 +
# '''[[#Global_Android_SDK_Opt-out|Global Android SDK Opt-out]]''' - managed by ''Opt out of Ads Personalization'' setting on device ('''preferred approach''').
 +
# '''[[#Global_Android_SDK_No_Ad_Framework_Optout|Global Android SDK No Ad Framework Optout]]''' - Direct call to SDK. Can be used without Google Play Services or when using the noAd version of the SDK.
 +
# '''[[#Global_Android_SDK_No_ID_Optout_.28Kids_Category.29|Global Android SDK No ID Optout]]''' - Direct call to SDK. Should be used for Kids Category.
 +
 
 +
=== Global Android SDK Opt-out ===
 +
''OS-level Opt-out'' method available on Nielsen Android when the [https://developers.google.com/android/guides/setup Google Play services APIs] have been setup in your project.
 +
 
 +
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.
 +
 
 +
==== Webview Element ====
 +
It is a requirement to display a WebView element whose loadUrl is set to the value obtained from optOutURL.
 +
If using the Global Android SDK, this optOutURL informs the user how to deactivate/activate “Out of Ads Personalization”.
  
Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation. It may be implemented in multiple ways for Android. This includes
+
In addition, The following text must be included in your app store description.
* Enable the Nielsen SDK to measure background/foreground state by making the relevant update to the AndroidManifest.
+
<blockquote>"'''Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s Digital Content Ratings. Please see https://www.nielsen.com/th/en/legal/privacy-statement/digital-measurement/ for more information'''"</blockquote>
* Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
 
* Custom implementation of the required methods within your application.
 
  
=== ForeGround/Background Measurement via AndroidManifest ===
+
=== Global Android SDK No Ad Framework Optout ===
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.
+
The ''No Ad Framework Optout'' can be used when the host application does not leverage Google Play Services such as when using the noAd version or the NoID version.
<syntaxhighlight lang="java">
+
<blockquote>
<application android:name="com.nielsen.app.sdk.AppSdkApplication">
+
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.</blockquote>
</syntaxhighlight>
 
  
=== Using the Android SdkBgFbDetectionUtility Class ===
+
==== The No Ad Framework Optout method works as follows: ====
For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The  [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] is compatible with Android 4+ and has been made available to Nielsen clients.
+
* 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>
  
=== Manual Background/ForeGround State Management ===
+
=== Global Android SDK No ID Optout (Kids_Category) ===
In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided  [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.
+
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>
  
The SDK is informed about app state using the below methods.
+
== OptOut Example Code ==
 +
Below you will find some sample code for the:
 +
* [[#Global OptOut Example|Global Android SDK]] - managed by Opt out of Ads Personalization setting on device '''(preferred approach)'''.
 +
* [[#No_Ad_Framework_Optout_Sample_Code|Global Android noAd Framework]] - Use if Google Play APIs are unavailable or running noAd version.
 +
*  It is currently not required to display an OptOut page for the NoID/Kids Build of the SDK.
 +
===<span id="Global OptOut Example"></span>Global OptOut Example ===
 +
The below code is an AndroidX example of displaying the Nielsen Privacy page to the user. Please see the next section if using the No Ad Framework build
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
AppLaunchMeasurementManager.appInForeground(getApplicationContext());
+
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {
AppLaunchMeasurementManager.appInBackground(getApplicationContext());
 
</syntaxhighlight>
 
Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.
 
  
 +
    WebView webView;
 +
    AppSdk appSdk;
  
Correct measurement of the foreground/background state is crucial to App measurement within Nielsen Digital Content Ratings (DCR).
+
    @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);
  
== Privacy and Opt-Out ==
+
        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());
 +
            }
  
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.
+
        });
 
+
        String url = appSdk.userOptOutURLString();  // Request Optout URL from NielsenSDK
* URL to this web page should be called from SDK by invoking  userOptOutURLString() and opened in 'WebView' / External browser.
+
        webView.loadUrl(url);                        //Display to the user in a Webview
* If the App SDK returns NULL as Opt-Out URL, handle the exception gracefully and retry later.
+
    }
* To retrieve the current Opt-Out status of a device, use the userOptOutURLString() method.  
+
    @Override
<syntaxhighlight lang ="java">
+
    public void onBackPressed() {
public String userOptOutURLString()
+
        super.onBackPressed();
public boolean getOptOutStatus()
+
        mSdkInterface.getSDK(appSdk);
 +
    }
 +
    @Override
 +
    protected void onDestroy() {
 +
        super.onDestroy();
 +
        if (appSdk != null)
 +
        {
 +
            appSdk.close();
 +
            appSdk = null;
 +
        }
 +
    }
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 
<br>
 
<br>
Users can opt out or opt back into Nielsen Measurement. Opt-Out feature relies on the system setting – "Limit Ad Tracking". The setting can be accessed in the Settings application on any device. User is opted out of Nielsen online measurement research when the "Limit Ad Tracking" setting is enabled.
 
  
In addition, the following text must be included in your app store description.
+
===<span id="No Ad Framework Optout Sample Code"></span>No Ad Framework Optout Sample Code ===
 +
The below code is an AndroidX example of displaying the Nielsen Privacy page to the user with the No Ad Framework SDK Build.
 +
<syntaxhighlight lang="java">
 +
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {
 +
 
 +
    WebView webView;
 +
    AppSdk appSdk;
  
'''"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research. Please see
+
    @Override
http://priv-policy.imrworldwide.com/priv/mobile/th/en/optout.html for more information"'''
+
    public void onCreate(@Nullable Bundle savedInstanceState) {
 +
        super.onCreate(savedInstanceState);
 +
        setContentView(R.layout.activity_optout);
 +
        webView = (WebView) findViewById(R.id.webView);
 +
        webView.getSettings().setJavaScriptEnabled(true);
  
== Going Live ==
+
        webView.setWebViewClient(new WebViewClient() {
Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.
+
            @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());
 +
            }
  
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
+
 
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:
+
            @Override
 +
            public boolean shouldOverrideUrlLoading(WebView view, String url) {
  
'''<big>Android Example:</big>'''
+
                if(url.contains("nielsen")){
<syntaxhighlight lang="java"
+
                    // If url value = "nielsenappsdk://1 it means the user selected Opt Out
try
+
                    // If url value = "nielsenappsdk://0" it means the user selected Opt-In
{
+
                    appSdk.userOptOut(url);
  // Prepare AppSdk configuration object (JSONObject)
+
                }
  JSONObject appSdkConfig = new JSONObject()
+
                return true;
          .put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
+
             }
          .put("sfcode", "dcr")
 
             // Remove Flag:  "nol_devDebug": "DEBUG"
 
  
// Pass appSdkConfig to the AppSdk constructor
+
        });
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
+
        String url = appSdk.userOptOutURLString();  // Request Optout URL from NielsenSDK
}
+
        webView.loadUrl(url);                        //Display to the user in a Webview
catch (JSONException e)
+
    }
{
+
    @Override
  Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
+
    public void onBackPressed() {
 +
        super.onBackPressed();
 +
        mSdkInterface.getSDK(appSdk);
 +
    }
 +
    @Override
 +
    protected void onDestroy() {
 +
        super.onDestroy();
 +
        if (appSdk != null)
 +
        {
 +
            appSdk.close();
 +
            appSdk = null;
 +
        }
 +
    }
 
}
 
}
 
</syntaxhighlight>
 
</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 Digital Content Ratings. Please see https://www.nielsen.com/th/en/legal/privacy-statement/digital-measurement/ for more information"'''</blockquote>
 +
 +
== 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 [[getOptOutStatus()]] property in the Nielsen Android SDK API. <code>appSdk.getOptOutStatus()</code>
 +
 +
== 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 ==
 +
The below sample applications have been designed to show the API's functionality and are broken into two distinct categories:
 +
* '''Basic''' - To show the functionality of the Nielsen  API using a standard no-frills player.
 +
** [[Android Basic example|Android Studio Example]]
  
'''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.
+
* '''Advanced''' - Nielsen API integrated into a custom video player is bundled with the SDK.

Latest revision as of 05:02, 25 November 2021

Engineering Portal breadcrumbArrow.png Digital breadcrumbArrow.png International_DCR breadcrumbArrow.png DCR Thailand Video Android SDK

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. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:

  • Application launch events and how long app was running
  • Time of viewing a sub section / page in the application.

Prerequisites

Before you start the integration, you will need:

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 Download

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.

Implementation

This guide covers implementation steps for Android Studio utilizing the Nielsen SDK for DCR.

SDK Flavor Description
Android Ad Version * Opt-In and Opt-Out functionality managed by Opt out of Ads Personlization setting on device. (Preferred approach)
* The Nielsen SDK will collect the 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 Ad Framework, the Nielsen SDK cannot read the Google Advertising ID, so will retrieve the AndroidID.
* The AndroidID 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 Opt-out.
Android SDK noID * This version of the Nielsen SDK is perfect for Kid apps, or where no ID is required.
* Please review the Opt Out Requirement.

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.

Contents

Setting up your Development Environment

Configuring Android Development Environment

  • The Nielsen App SDK (located in the 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 as a Artifact Repository. If implemented this way, you do not need to download the appsdk from the Nielsen Portal.

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

Manifest File

  • Add the following permissions on the project’s AndroidManifest.xml file.
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>

For more details to handle runtime permissions in Android versions, please visit [1].

  • In AndroidManifest.xml under <application> node add the following metadata
<manifest>
    <application>
        <!-- Sample AdMob app ID: ca-app-pub-3940256099942544~3347511713 -->
        <meta-data
            android:name="com.google.android.gms.ads.APPLICATION_ID"
            android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
    </application>
</manifest>>
  • 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.

dependencies {
  implementation 'com.google.android.gms:play-services-ads:xx.x.x'
}

Classes/package

import com.google.android.gms.ads.identifier.AdvertisingIdClient;
import com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
import com.google.android.gms.common.ConnectionResult;
import com.google.android.gms.common.GooglePlayServicesUtil;
import com.google.android.gms.common.GooglePlayServicesRepairableException;
import 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.

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
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 @"nol_devDebug":@"INFO", 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.

Note: DO NOT activate the Debug flag in a production environment.

Sample SDK Initialization Code

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

Initialization of App SDK object through a JSON object

try
{
  // Prepare AppSdk configuration object (JSONObject)
  JSONObject appSdkConfig = new JSONObject()
          .put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
          .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);
}

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

The integration of Nielsen App SDK will depend on type of client app.

  • Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).

APP SDK Error & Event Codes

To view the Error and Event codes for iOS and Android, please review the App SDK Event 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.
JSONObject contentMetadata = new JSONObject()
//SDK Metadata
    .put("type", "content")
    .put("assetid", "vid345-67483")
    .put("program", "Program Name")
    .put("title", "Program S3, EP1")
    .put("length", "3600")
    .put("isfullepisode", "y") 
    .put("adloadtype", "2")
    .put("segB", "CustomSegmentValueB")  //optional
    .put("segC", "CustomSegmentValueC")  //optional

Content metadata

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

Key Description Values Required
clientid

parent ID – value is automatically populated through provided App ID.
In order to override the brand configured to the App ID, pass parent
value here and the sub-brand ID associated to that brand in the subbrand
key (e.g. multiple brands in App)

Nielsen provided

subbrand sub-brand ID – value is automatically populated through provided

App ID. In order to override the sub-brand configured to the App ID, value can
be passed here (e.g. multiple sub-brands in App)

Nielsen provided

type type of asset "content"
assetid unique ID assigned to asset custom
(no Special Characters). The Content ID should be populated here which should correspond to the same value in the post transmission logs.
program name of program custom
title episode name custom
length length of content in seconds seconds (86400 for live stream)
segB custom segment B. Custom segments can be used to aggregate content however you choose. Some examples include genre, category, or platform. custom
segC For VOD: Populate TVContent ID, For livestream: leave blank custom Required for VOD only
isfullepisode full episode flag
  • 'y', 'yes', or 'lf' – full episode
  • 'n', 'no', or 'sf' – non full episode

Note: For livestream content with Dynamic Ad Insertion (DAI), the isfullepisode value should be set to 'y'.

adloadtype type of Ad load:
  • 1) Linear – matches TV Ad load. Content with linear Ad Load is not eligible for DCR measurement and will not be included in DCR reporting.
  • 2) Dynamic – Dynamic Ad Insertion (DAI)
  • "1" – content with linear Ads. Note: Content with linear Ad load is not included in DCR measurement.
  • "2" – content with dynamic Ads

Ad Metadata

The Ad Metadata (if applicable) should be passed for each individual ad.

Keys Description Values Required
type type of Ad 'preroll', 'midroll', 'postroll'
'ad' - If specific type can not be identified.
assetid unique ID assigned to Ad custom
(no Special Characters)

Example Ad Object

// create ad object
"ad": {
  "type": "preroll",
  "assetid": "AD-ID123"
}

Sequence of Calls

play

Use play to pass the channel descriptor information through channelName parameter when the user taps the Play button on the player.

    public void play(JSONObject channelInfo);

loadMetadata

public void loadMetadata(JSONObject contentMetadata);

playheadPosition

public void setPlayheadPosition(long position)

stop

public void stop()

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

public void end()

Configure API Calls

Sample API Sequence

A Sample API sequence could follow this flow:

Type Sample code Description
Start of stream [nielsenMeter play]; // call at start of each new stream
[nielsenMeter loadMetadata: contentMetadataObject]; // contentMetadataObject contains the JSON metadata for the content being played
Content [nielsenMeter setplayheadPosition: position]; // playheadPosition is position of the playhead while the content is being played
End of Stream [nielsenMeter end]; // Content playback is completed.

SDK Events

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
'setPlayheadPosition' playhead position as integer

VOD: || current position in seconds
Live: current Unix timestamp (seconds since Jan-1-1970 UTC)
Note: 'setPlayheadPosition' 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 browser is refreshed or closed.

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 stop, end or loadmetadata,.

Life cycle of SDK instance

Life cycle of SDK instance includes four general states:

  1. 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.
  2. 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.
  3. Processing state – The SDK instance is processing playing information. The play and loadMetadata calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
    1. setplayheadPosition – Call this API every one second when playhead position timer is fired. If a LIVE event, use the current Unix timestamp (seconds since Jan-1-1970 UTC).
    2. stop – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
    3. end – Call when content completes. When called, the SDK instance exits from Processing state.
  4. 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.
    1. Initialization fails
    2. appDisableApi is set to true

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, loadMetadata and playheadPosition

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.

{
  "type": "content",
  "assetid": "vid345-67483",
  "program": "ProgramName",
  "title": "Program S3, EP1",
  "length": "3600",
  ...
}

Call setPlayheadPosition() every one second until a pause / stop. Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.

Type Sample code Description
Start of stream mAppSdk.play(); // Call at start of each new stream
mAppSdk.loadMetadata(contentMetaDataObject); // contentMetadataObject contains the JSON metadata for the content being played
Content mAppSdk.setPlayheadPosition(playheadPosition); // position is position of the playhead while the content is being played
Interruption mAppSdk.stop(); // call stop when content playback is interrupted
Resume Content mAppSdk.loadMetadata(contentMetaDataObject); // Call loadMetadata and pass content metadata object when content resumes
mAppSdk.setPlayheadPosition(playheadPosition); // continue pasing playhead position every second starting from position where content is resumed
End of Stream mAppSdk.end(); // Content playback is completed.

Use Case 2: Content has Advertisements

Call play()

Call loadMetadata() with JSON metadata for ad as below.

{
   "type": "preroll",
   "assetid": "ad-123"
}

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

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

Ad Content

    long pos = mAdPlayer.videoPosition() / 1000;
   if (mAppSdk != null)
   {
     mAppSdk.setPlayheadPosition(pos);
   }

Note: The playhead positions for ad and content should be maintained separately.

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.

Type Sample code Description
Start of stream mAppSdk.play(); // stream starts
mAppSdk.loadMetadata(contentMetaDataObject); // contentMetadataObject contains the JSON metadata for the content being played
Preroll mAppSdk.loadMetadata(prerollMetadataObject); // prerollMetadataObject contains the JSON metadata for the preroll ad
mAppSdk.setPlayheadPosition(playheadPosition); // position is position of the playhead while the preroll ad is being played
mAppSdk.stop(); // Call stop after preroll occurs
Content mAppSdk.loadMetadata(contentMetaDataObject); // contentMetadataObject contains the JSON metadata for the content being played
mAppSdk.setPlayheadPosition(playheadPosition); // position is position of the playhead while the content is being played
Midroll mAppSdk.loadMetadata(midrollMetaDataObject); // midrollMetadataObject contains the JSON metadata for the midroll ad
mAppSdk.setPlayheadPosition(playheadPosition); // position is position of the playhead while the midroll ad is being played
mAppSdk.stop(); // Call stop after midroll occurs
Content Resumes mAppSdk.loadMetadata(contentMetaDataObject); // contentMetadataObject contains the JSON metadata for the content being played
mAppSdk.setPlayheadPosition(playheadPosition); // position is position of the playhead while the content is being played
End of Stream mAppSdk.end(); // Call end() at the end of content
Postroll mAppSdk.loadMetadata(postrollMetaDataObject); // postrollMetadataObject contains the JSON metadata for the postroll ad
mAppSdk.setPlayheadPosition(playheadPosition); // position is position of the playhead while the postroll ad is being played
mAppSdk.stop(); // Call stop after postroll occurs

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.

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.

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.

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 - appInForeground() and appInBackground() 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:

implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"

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 :

public static void registerLifeCycleObserver(Context applicationContext)

Log messages for the new auto detection

When the AppSdk app successfully registers for the LifeCycleObserver : Registered LifeCycleObserver for App Background/Foreground auto-detection

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

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.

<application android:name="com.nielsen.app.sdk.AppSdkApplication">

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 SdkBgFgDetectionUtility class. The 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 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.

AppLaunchMeasurementManager.appInForeground(getApplicationContext());
AppLaunchMeasurementManager.appInBackground(getApplicationContext());

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

Using the NielsenAppSDKJSHandler

There could be a scenario in which a browser page, that is already tagged with the Nielsen BSDK, needs to be loaded via a webview. In this situation it is recommended to use the NielsenAppSDKJSHandler which will allow communication between the AppSDK and the BSDK.

This feature is supported in versions 7.2 and above.

Implementation

  • Make sure you have the latest AppSdk.jar from Nielsen
  • Enable the javascript on webview using below lines


WebSettings webSetting = webView.getSettings();
webSetting.setJavaScriptEnabled(true);


  • Add NielsenAppSDKJSHandler instance as javascript interface to webview with name “NielsenAppSDK” like below snippet


webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext()), "NielsenAppSDK");


This will enable listening to BSDK api calls within the APPSDK. Please make sure your Technical Account Manager is aware that you wish to implement this method so a configuration file can be modified on the Nielsen servers; however, there are no changes required to the Browser page.

Example:

The below is an example of opening a webview with the NielsenAppSDKJSHandler

      WebSettings webSetting = webView.getSettings();
      webView.getSettings().setDomStorageEnabled(true); 
      webSetting.setJavaScriptEnabled(true);
      webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext(), ""), "NielsenAppSDK");
      String url = "https://nielsen.com.index.htm";
      webView.loadUrl(url);


AndroidManifest.xml may need the following permissions set:

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />


Closing NielsenAppSDKJSHandler

NielsenAppSDKJSHandler should be closed or cleaned up in below scenarios

  • Before WebView is getting destructed
  • Before loading new page
  • Before closing application

NielsenAppSDKJSHandler provides a public interface with name "close()" and this function should be called on NielsenAppSDKJSHandler's instance in all above scenarios.

// get your webview
WebView webView = findViewById(R.id.webView);
 
//Added JS Handler instance as java script interface for ggpm api type
NielsenAppSDKJSHandler jshandler = new NielsenAppSDKJSHandler(getApplicationContext(), "");
webView.addJavascriptInterface(jshandler, "NielsenAppSDK");
 
//Close JS Handler before making webview as null
jshandler.close();
webView = null;

Interruptions during playback

As part of integrating Nielsen App SDK with the player application, the 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 pings – 'loadMetadata' and 'playheadPosition' for the new viewing session, once the playback resumes.

Please see the 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 currently 3 flavors of the Nielsen SDK:

  1. Global Android SDK Opt-out - managed by Opt out of Ads Personalization setting on device (preferred approach).
  2. Global Android SDK No Ad Framework Optout - Direct call to SDK. Can be used without Google Play Services or when using the noAd version of the SDK.
  3. Global Android SDK No ID Optout - Direct call to SDK. Should be used for Kids Category.

Global Android SDK Opt-out

OS-level Opt-out method available on Nielsen Android when the Google Play services APIs have been setup in your project.

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.

Webview Element

It is a requirement to display a WebView element whose loadUrl is set to the value obtained from optOutURL. If using the Global Android SDK, this optOutURL informs the user how to deactivate/activate “Out of Ads Personalization”.

In addition, The following text must be included in your app store description.

"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s Digital Content Ratings. Please see https://www.nielsen.com/th/en/legal/privacy-statement/digital-measurement/ for more information"

Global Android SDK No Ad Framework Optout

The No Ad Framework Optout can be used when the host application does not leverage Google Play Services such as when using the noAd version or the NoID version.

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 No Ad Framework Optout 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 = nielsenappsdk://1
    • Opt-in if the WebView URL = nielsenappsdk://0
  • Pass the detected URL to the userOptOut() function
    • Example:
      appSdk.userOptOut("nielsenappsdk://1");  // User opt-out
      

Global Android SDK No ID Optout (Kids_Category)

If you are building an app that will be listed in the Kids Category:

  1. Ensure that you are using the NoID version of the Nielsen SDK Framework.
  2. Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
appSdk.userOptOut("nielsenappsdk://1");  // User opt-out

OptOut Example Code

Below you will find some sample code for the:

  • Global Android SDK - managed by Opt out of Ads Personalization setting on device (preferred approach).
  • Global Android noAd Framework - Use if Google Play APIs are unavailable or running noAd version.
  • It is currently not required to display an OptOut page for the NoID/Kids Build of the SDK.

Global OptOut Example

The below code is an AndroidX example of displaying the Nielsen Privacy page to the user. Please see the next section if using the No Ad Framework build

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

        });
        String url = appSdk.userOptOutURLString();   // Request Optout URL from NielsenSDK
        webView.loadUrl(url);                         //Display to the user in a Webview
    }
    @Override
    public void onBackPressed() {
        super.onBackPressed();
        mSdkInterface.getSDK(appSdk);
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (appSdk != null)
        {
            appSdk.close();
            appSdk = null;
        }
    }
}


No Ad Framework Optout Sample Code

The below code is an AndroidX example of displaying the Nielsen Privacy page to the user with the No Ad Framework SDK Build.

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

  
            @Override
            public boolean shouldOverrideUrlLoading(WebView view, String url) {

                if(url.contains("nielsen")){
                    // If url value = "nielsenappsdk://1 it means the user selected Opt Out
                    // If url value = "nielsenappsdk://0" it means the user selected Opt-In
                    appSdk.userOptOut(url);
                }
                return true;
            }

        });
        String url = appSdk.userOptOutURLString();   // Request Optout URL from NielsenSDK
        webView.loadUrl(url);                         //Display to the user in a Webview
    }
    @Override
    public void onBackPressed() {
        super.onBackPressed();
        mSdkInterface.getSDK(appSdk);
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (appSdk != null)
        {
            appSdk.close();
            appSdk = null;
        }
    }
}

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.

"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s Digital Content Ratings. Please see https://www.nielsen.com/th/en/legal/privacy-statement/digital-measurement/ for more information"

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 getOptOutStatus() property in the Nielsen Android SDK API. appSdk.getOptOutStatus()

Going Live

Following Nielsen testing, you will need to:

  1. Disable Debug Logging: Disable logging by deleting {nol_devDebug: 'DEBUG'} from initialization call.
  2. 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

The below sample applications have been designed to show the API's functionality and are broken into two distinct categories:

  • Basic - To show the functionality of the Nielsen API using a standard no-frills player.
  • Advanced - Nielsen API integrated into a custom video player is bundled with the SDK.