|
|
| Line 1: |
Line 1: |
| {{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International DCR}} {{CurrentBreadcrumb}}
| | hello |
| [[Category:Digital]]
| |
| | |
| == Overview ==
| |
| The Nielsen SDK is one of the multiple framework SDKs that Nielsen provides to enable measuring linear (live) and on-demand TV viewing using TVs, mobile devices, etc.
| |
| The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like It supports a variety of Nielsen Measurement Products like Digital in TV Ratings ([[DCR & DTVR|DTVR]]), Digital Content Ratings ([[DCR & DTVR|DCR]]), and [[Digital Ad Ratings]] (DAR). Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:
| |
| *Application launch events and how long app was running
| |
| *Time of viewing a subsection/page in the application.
| |
| <br>
| |
| This ''SDK Android integration guide'' is applicable for '''Android TV''' as well.
| |
| | |
| == Prerequisites ==
| |
| Before you start the integration, you will need:
| |
| {| class="wikitable"
| |
| |-
| |
| ! style="width: 30px;" |
| |
| ! style="width: 15%;" | Item
| |
| ! Description
| |
| ! Source
| |
| |-style="background-color:#d0f6f8;"
| |
| || ☑ || "App ID (appid)" || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
| |
| |-style="background-color:#d0f6f8;"
| |
| || ☑ || "Nielsen SDK" || Includes SDK frameworks and "sample implementation"; "See [[Android SDK Release Notes]]" || [[Special:Downloads|Download]]
| |
| |}
| |
| | |
| == Implementation ==
| |
| The Nielsen Android SDK comes in three flavors.
| |
| | |
| {| class="wikitable"
| |
| |-
| |
| ! SDK Flavor
| |
| ! Description
| |
| |-
| |
| | '''Android Ad Version'''
| |
| |* Opt-In and Opt-Out functionality managed by Opt out of Ads Personalization setting on device. <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 Google Play Services SDK, the Nielsen SDK cannot read the Google Advertising ID, so will retrieve the Android ID.<br />* The Android ID 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 [[#Global_Android_SDK_No_Ad_Framework_Opt-out|Global Android SDK No Ad Framework Opt-out]].
| |
| |-
| |
| | '''Android SDK noID'''
| |
| |* This version of the Nielsen SDK is perfect for Kid apps, or where no ID is required.<br>* For the requirement, please review the [[#Global_Android_SDK_No_ID_Opt-out|Global Android SDK No ID Opt-out]].
| |
| |}
| |
| | |
| === How to obtain the NielsenAppApi ===
| |
| The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of Gradle. We recommend using the Gradle-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
| |
| * [[Digital_Measurement_Android_Artifactory_Guide|Select to obtain Gradle implementation guide]]
| |
| * [[Special:Downloads|Select to Download Directly]]
| |
| __TOC__
| |
| | |
| == Setting up your Android Development Environment ==
| |
| <br />
| |
| 1) Ensure to unzip the Nielsen App SDK zip file and copy the "AppSdk.jar" into the app/libs folder on the App’s project. Add it as dependency.<br />
| |
| 2) Add the following permissions on the project’s "AndroidManifest.xml" file.<br />
| |
| | |
| <syntaxhighlight lang="java">
| |
| <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
| |
| <uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
| |
| 3) Add Google Play Services lib into dependencies as Nielsen AppSDK uses the following packages/classes from the Google Play service.
| |
| Libraries:
| |
| * com.google.android.gms:play-services
| |
| Requiered Google Play Service Classes and Packages :
| |
| * com.google.android.gms.ads.identifier.AdvertisingIdClient;
| |
| * com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
| |
| * com.google.android.gms.common.ConnectionResult;
| |
| * com.google.android.gms.common.GooglePlayServicesUtil;
| |
| * com.google.android.gms.common.GooglePlayServicesRepairableException;
| |
| * com.google.android.gms.common.GooglePlayServicesNotAvailableException;
| |
| | |
| 4) Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.<br />
| |
| <syntaxhighlight lang="java">import com.nielsen.app.sdk.*;</syntaxhighlight><br />
| |
| <br />
| |
| | |
| Notes:
| |
| *The Nielsen App SDK (located in the "com.nielsen.app.sdk" package) class is the primary application interface to the Nielsen App SDK on Android.
| |
| *The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.
| |
| *Nielsen App SDK is compatible with Android OS versions 2.3+.
| |
| *Clients can control / configure the protocol to be used – HTTPS or HTTP to suit their needs.
| |
| *The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 4.0 and later will support it natively).
| |
| *If the player application uses a 3rd party media player implementing its own HLS/MPEG-DASH stack, then the minimum Android version will be limited to version 2.3, since the SDK depends on Google Play support to work properly.
| |
| | |
| == Create SDK Instance ==
| |
| The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object when needed, which can then be used simultaneously. '''For the general use case where only one video is played at the same time in the App, a single instance of SDK object can then be used to play back and measure all watched streams one after another.'''
| |
| | |
| The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
| |
| {| class="wikitable"
| |
| |-
| |
| ! Parameter / Argument !! Description !! Source !! Required/Obligatory? !! Example
| |
| |-
| |
| | appid || Unique id for the application assigned by Nielsen. It is GUID data type.|| Nielsen-specified || Yes || "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
| |
| |-
| |
| | appname || Name of the application || Client-defined || Yes || "Nielsen Sample App"
| |
| |-
| |
| | appversion || Current version of the app used || Client-defined || Yes || "1.0.2"
| |
| |-
| |
| | sfcode || Nielsen collection facility to which the SDK should connect.
| |
| || Nielsen-specified || Yes || "ire"
| |
| |-
| |
| | nol_devDebug || Enables Nielsen console logging. Only required for testing
| |
| || Nielsen-specified || Optional || "DEBUG"
| |
| | |
| |}
| |
| <br />
| |
| | |
| 1) [[AppSDK()|AppSDK()]] is no longer a singleton object and should be created as below.
| |
| <syntaxhighlight lang="java">
| |
| try{
| |
| // Prepare AppSdk configuration object (JSONObject)
| |
| JSONObject appSdkConfig = new JSONObject()
| |
| .put("appid", "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
| |
| .put("appversion", "1.0.2")
| |
| .put("appname", "Nielsen Sample App")
| |
| .put("sfcode", "ire")
| |
| .put("nol_devDebug", "DEBUG"); // only for debug builds
| |
| | |
| // Pass appSdkConfig to the AppSdk constructor
| |
| mAppSdk = new AppSdk(appContext, appSdkConfig, this);
| |
| }
| |
| catch (JSONException e){
| |
| Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
| |
| }
| |
| </syntaxhighlight>
| |
| 2) implement IAppNotifier into your activity like
| |
| <syntaxhighlight lang="java">public class MainActivity extends AppCompatActivity implements IAppNotifier
| |
| </syntaxhighlight>
| |
| 3) implement callback
| |
| <syntaxhighlight lang="java">@Override
| |
| public void onAppSdkEvent(long timestamp, int code, String description){
| |
| Log.d(TAG, "SDK callback onAppSdkEvent " + description);
| |
| }
| |
| </syntaxhighlight>
| |
| | |
| So whole Activity will look like
| |
| <syntaxhighlight lang="java">
| |
| package com.example.josefvancura.nlsdemotmp;
| |
| | |
| import android.content.Context;
| |
| import android.support.v7.app.AppCompatActivity;
| |
| import android.os.Bundle;
| |
| import android.util.Log;
| |
| | |
| import com.nielsen.app.sdk.*;
| |
| | |
| import org.json.JSONException;
| |
| import org.json.JSONObject;
| |
| | |
| public class MainActivity extends AppCompatActivity implements IAppNotifier {
| |
| | |
| private AppSdk mAppSdk = null;
| |
| private String TAG = "MainActivity";
| |
| | |
| @Override
| |
| protected void onCreate(Bundle savedInstanceState) {
| |
| super.onCreate(savedInstanceState);
| |
| setContentView(R.layout.activity_main);
| |
| | |
| Context context = getApplicationContext();
| |
| | |
| try{
| |
| // Prepare AppSdk configuration object (JSONObject)
| |
| JSONObject appSdkConfig = new JSONObject()
| |
| .put("appid", "PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
| |
| .put("appversion", "1.0.2")
| |
| .put("appname", "Nielsen Sample App")
| |
| .put("sfcode", "ire")
| |
| .put("nol_devDebug", "DEBUG"); // only for debug builds
| |
| | |
| // Pass appSdkConfig to the AppSdk constructor
| |
| mAppSdk = new AppSdk(context, appSdkConfig, this ); // Notifier - activity implements IAppNotifier, callback in onAppSdkEvent()
| |
| | |
| }
| |
| catch (JSONException e){
| |
| Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
| |
| }
| |
| | |
| }
| |
| | |
| @Override
| |
| public void onAppSdkEvent(long timestamp, int code, String description) {
| |
| Log.d(TAG, "SDK callback onAppSdkEvent " + description);
| |
| }
| |
| | |
| }
| |
| </syntaxhighlight>
| |
| | |
| ==== APP SDK Error & Event Codes ====
| |
| To view the Error and Event codes for iOS and Android, please review the [[APP SDK Event Codes|App SDK Event Code]] Reference page.
| |
| | |
| ==== Life cycle of SDK instance ====
| |
| Life cycle of SDK instance includes four general states:
| |
| # '''Initial state''' – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the ""Initial state"".
| |
| # '''Idle state'''– The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
| |
| # '''Processing state''' – The SDK instance is processing playing information. API calls "play" and "loadMetadata" move the SDK instance into this state. In this state, the SDK instance will be able to process the API calls (see below)
| |
| # '''Disabled state''' – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
| |
| ## Initialization fails
| |
| ## <code>appDisableApi</code> is called
| |
| <syntaxhighlight lang="objective-c">
| |
| @property (assign) BOOL appDisableApi;
| |
| </syntaxhighlight>
| |
| | |
| == Create Metadata Objects ==
| |
| The parameters passed must be either a JSON formatted string. The JSON passed in the SDK must be well-formed.
| |
| | |
| * JSON value must be string value.
| |
| ** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
| |
| ** All the Variable Names like appid, appname, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
| |
| * JSON string can be prepared using either raw NSString or serialized NSDictionary.<br />
| |
| | |
| | |
| === Create channelName Metadata ===
| |
| channelName should remain constant throughout the completion of an episode or live stream.
| |
| <br />
| |
| {| class="wikitable"
| |
| |-
| |
| ! Key !! Description !! Values !! Required
| |
| |-
| |
| | channelName || Any string representing the channel/stream || custom || Yes
| |
| |-
| |
| |}
| |
| | |
| ==== Create Content Metadata ====
| |
| Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
| |
| {| class="wikitable"
| |
| |-
| |
| ! Keys !! Description !! Values !! Required
| |
| |-
| |
| | type || type of asset || <code>'content'</code> || Yes
| |
| |-
| |
| | assetid || unique ID assigned to asset (32 Character limit) || custom (no [[Special Characters|Special Characters]]) || Yes
| |
| |-
| |
| | program || name of program (100 character limit) || custom || Yes
| |
| |-
| |
| | title || name of program (100 character limit) || custom || Yes
| |
| |-
| |
| | length || length of content in seconds || <code>seconds</code> (0 for live stream) || Yes
| |
| |-
| |
| | airdate || the airdate in the linear TV || YYYYMMDD HH24:MI:SS || Yes
| |
| |-
| |
| | isfullepisode || full episode flag || <code>'y'</code>- full episode, <code>'n'</code>- non full episode || Yes
| |
| |-
| |
| | adloadtype || type of ad load:
| |
| *<code>'1'</code> Linear – matches TV ad load
| |
| *<code>'2'</code> Dynamic – Dynamic Ad Insertion (DAI)
| |
| || <code>'2'</code> - DCR measures content with dynamic ads
| |
| || Yes
| |
| | |
| |}
| |
| | |
| ==== Create Ad Metadata ====
| |
| The Ad Metadata (if applicable) should be passed for each individual ad.
| |
| {| class="wikitable"
| |
| |-
| |
| ! Keys !! Description !! Values !! Required
| |
| |-
| |
| | type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> || Yes
| |
| |-
| |
| | assetid || unique ID assigned to Ad || custom (no [[Special Characters|Special Characters]]) || Yes
| |
| |}
| |
| | |
| '''Note:''' All metadata values should be passed as UTF-8 strings.
| |
| | |
| <blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>
| |
| | |
| === MetaData Example ===
| |
| <syntaxhighlight lang="java">
| |
| JSONObject channelInfo = new JSONObject()
| |
| .put("channelName","My Channel Name 1")
| |
| | |
| JSONObject contentMetadata = new JSONObject()
| |
| .put("type", "content")
| |
| .put("assetid", "vid345-67483")
| |
| .put("program", "Program Name")
| |
| .put("title", "Program S3, EP1")
| |
| .put("length", "3600")
| |
| .put("isfullepisode", "y")
| |
| .put("adloadtype", "2")
| |
| .put("airdate", "20161013 20:00:00")
| |
| | |
| JSONObject adMetadata = new JSONObject()
| |
| .put("type", "postroll")
| |
| .put("assetid", "AD-ID123");
| |
| | |
| </syntaxhighlight>
| |
| | |
| == Start the Measurement ==
| |
| | |
| === Overview of SDK API Calls ===
| |
| | |
| ==== play ====
| |
| The play method prepares the SDK for reporting once an asset has loaded and playback has begun. Use play to pass the channel descriptor information through channelName parameter when the user taps the ""Play"" button on the player. Call play only when initially starting the video.
| |
| | |
| <syntaxhighlight lang="java">mAppSdk.play(JSONObject channelInfo);</syntaxhighlight>
| |
| | |
| ==== loadMetadata ====
| |
| Needs to be called at the beginning of each asset, pass JSON object for relevant content or ad. Make sure to pass as 1st loadMetadata for content at the begining of playlist - see below API call sequence examples.
| |
| <syntaxhighlight lang="java">mAppSdk.loadMetadata(JSONObject contentMetadata);</syntaxhighlight>
| |
| | |
| ==== playheadPosition ====
| |
| Pass playhead position every second during playback. for VOD: pass current position in seconds. for Live: current Unix timestamp (seconds since Jan-1-1970 UTC) - if it is possible to seek back in Live content, then pass related Unix time (not current). Pass whole number that increments only by 1 like 1,2,3..
| |
| <syntaxhighlight lang="Java">mAppSdk.setPlayheadPosition(long videoPositon);</syntaxhighlight>
| |
| | |
| ==== stop ====
| |
| Call when
| |
| * ads complete playing
| |
| * when a user pauses playback
| |
| * upon any user interruption scenario - see bellow chapter Interruption scenario
| |
| | |
| <syntaxhighlight lang="java">mAppSdk.stop();</syntaxhighlight>
| |
| | |
| ==== end ====
| |
| Call when the content asset completes playback. Stops measurement progress.
| |
| <syntaxhighlight lang="java">mAppSdk.end();</syntaxhighlight>
| |
| <br />
| |
| | |
| | |
| === API Call Sequence ===
| |
| ==== Use Case 1: Content has no Ads ====
| |
| Call [[play()]] at start of stream
| |
| | |
| Call [[loadMetadata()]] with JSON metadata for content as below.
| |
| <syntaxhighlight lang="json">{
| |
| "type": "content",
| |
| "assetid": "vid345-67483",
| |
| "program": "ProgramName",
| |
| "title": "Program S3, EP1",
| |
| "length": "3600",
| |
| ...
| |
| }</syntaxhighlight>
| |
| Call [[setPlayheadPosition()]] every one second until a pause.
| |
| Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.
| |
| {| class="wikitable"
| |
| |-
| |
| ! Type !! Sample code !! Description
| |
| |-
| |
| | rowspan="2" | Start of stream || <code>mAppSdk.play(); </code> || // Call at start of each new stream
| |
| |-
| |
| | <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
| |
| |-
| |
| | Content || <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
| |
| |-
| |
| | Interruption || <code>mAppSdk.stop();</code> || // call stop when content playback is interrupted
| |
| |-
| |
| | Resume Content || <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // continue pasing playhead position every second starting from position where content is resumed
| |
| |-
| |
| | End of Stream || <code>mAppSdk.end();</code> || // Content playback is completed.
| |
| |}
| |
| | |
| ==== Use Case 2: Content has Ads ====
| |
| Call [[play()]] with channelName JSON as below.
| |
| <syntaxhighlight lang="json">{
| |
| "channelName": "My Channel Name 1"
| |
| }</syntaxhighlight>
| |
| | |
| | |
| Call [[loadMetadata()]] with JSON metadata for ad as below.
| |
| <syntaxhighlight lang="json">{
| |
| "type": "preroll",
| |
| "assetid": "ad-123"
| |
| ...
| |
| }</syntaxhighlight>
| |
| | |
| | |
| <blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>
| |
| | |
| Call [[setPlayheadPosition()]] every one second until a pause / another [[loadMetadata()]] is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata()]].
| |
| | |
| The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.
| |
| {| class="wikitable"
| |
| |-
| |
| ! Type !! Sample code !! Description
| |
| |-
| |
| | rowspan="2" | Start of stream || <code>mAppSdk.play(channelInfo); </code> || // channelName contains JSON metadata of channel name being played
| |
| |-
| |
| | <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
| |
| |-
| |
| | rowspan="3" | Preroll || <code>mAppSdk.loadMetadata(prerollMetadataObject);</code> || // prerollMetadataObject contains the JSON metadata for the preroll ad
| |
| |-
| |
| | <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the preroll ad is being played
| |
| |-
| |
| | <code>mAppSdk.stop();</code> || // Call stop after preroll occurs
| |
| |-
| |
| | rowspan="2" | Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
| |
| |-
| |
| | <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
| |
| |-
| |
| | rowspan="6" | Midroll || <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // midrollMetadataObject contains the JSON metadata for the midroll ad
| |
| |-
| |
| | <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the midroll ad is being played
| |
| |-
| |
| | <code>mAppSdk.stop();</code> || // App moves to background(midroll pauses)
| |
| |-
| |
| | <code>mAppSdk.loadMetadata(midrollMetaDataObject);</code> || // App moves to foreground (midroll resumes)
| |
| |-
| |
| | <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // playheadPosition is position of the playhead while the midroll ad is being played
| |
| |-
| |
| | <code>mAppSdk.stop();</code> || // Call stop after midroll occurs
| |
| |-
| |
| | rowspan="2" | Content (End of stream) || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // contentMetadataObject contains the JSON metadata for the content being played
| |
| |-
| |
| | <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the content is being played
| |
| |-
| |
| | End of Stream || <code>mAppSdk.end();</code> || // Call end() at the end of content
| |
| |-
| |
| | rowspan="3" | Postroll || <code>mAppSdk.loadMetadata(postrollMetaDataObject);</code> || // postrollMetadataObject contains the JSON metadata for the postroll ad
| |
| |-
| |
| | <code>mAppSdk.setPlayheadPosition(playheadPosition);</code> || // position is position of the playhead while the postroll ad is being played
| |
| |-
| |
| | <code>mAppSdk.stop();</code> || // Call stop after postroll occurs
| |
| |}
| |
| | |
| <blockquote>Note: Each Ad playhead should reset or begin from 0 at ad start. When content has resumed following an ad break, playhead position must continue from where previous content segment was left off.</blockquote>
| |
| | |
| == Handling Foreground and Background states ==
| |
| There are a few approaches to managing the Foreground and Background states of an app available to use for state measurement.
| |
| | |
| *Utilizing the Androidx LifeCycleObserver (The recommended approach starting sdk version 7.1.0.0+)
| |
| *Utilizing the SdkBgFgDetectionUtility class
| |
| *Adding a tag to the Manifest XML
| |
| *Manual Management
| |
| === The LifeCycleObserver ===
| |
| AndroidX replaces the original support library APIs with packages in the androidx namespace, and Android Studio 3.2 and higher provides an automated migration tool. (Select '''Refactor> Migrate to AndroidX''' from the menu bar.)
| |
| | |
| Starting with version 7.1.0, with AndroidX support, an additional utility is provided in the AppSDK - application background/foreground state detection by the AppSdk leveraging the Android Architecture component "LifeCycleObserver".
| |
| | |
| The AppSdk is now capable of detecting the application UI visibility state transitions between background and foreground, without forcing the applications to register for AppSdk's AppSdkApplication class, which is responsible for handling the detection of application background/foreground state transitions at present.
| |
| | |
| <blockquote>Please note, that if you already have an app designed that utilizes the depreciated SdkBgFgDetectionUtility Class, the AppSDK will ignore any calls to these methods if it can utilize the LifeCycleObserver. LifeCycleObserver based auto detection will take precedence.</blockquote>
| |
| | |
| ==== Adding the AndroidX dependency ====
| |
| In order to make use of the app background/foreground state transition auto detection feature of AndroidX AppSdk, the app gradle file needs the androidx dependency. The AppSdk API calls - <code>appInForeground()</code> and <code>appInBackground()</code> will still be respected by AppSdk by executing the old AppSdk flow of handling "app in foreground" and "app in background" states as is.
| |
| | |
| ==== Using the LifeCycle Extension ====
| |
| The following androidx dependency is required in the app gradle file:
| |
| | |
| <syntaxhighlight lang="java">implementation "androidx.lifecycle:lifecycle-extensions:2.1.0"</syntaxhighlight>
| |
| | |
| <blockquote>If you would like to take advantage of this auto detection feature of AppSdk at the very initial stage (e.g. splash screen or at of app launch time), before the AppSdk is initialized, can do so by calling the following newly introduced AppSdk public api, passing the application context :
| |
| | |
| <syntaxhighlight lang="java">public static void registerLifeCycleObserver(Context applicationContext)</syntaxhighlight></blockquote>
| |
| | |
| ==== Log messages for the new auto detection ====
| |
| | |
| *When the AppSdk app successfully registers for the LifeCycleObserver : <code>Registered LifeCycleObserver for App Background/Foreground auto-detection</code>
| |
| *When the app enters the foreground state :<code>App is in foreground, auto detected by AppSDK</code>
| |
| *When the app enters the background state :<code>App is in background, auto detected by AppSDK</code>
| |
| *If the client app doesn't have the "androidx" gradle dependency and AppSdk fails to register LifeCycleObserver :<code>AndroidX LifecycleObserver can not be observed. Please use androidx dependency to activate SDK auto-detection of app background/foreground state.</code>
| |
| *When the appInForeground() is explicitly called while LifeCycleObserver auto detection is active :<code>Ignoring the appInBackground() call, as the App Background/Foreground auto-detection is active. The current state is - foreground</code>
| |
| *When the appInBackground() is explicitly called while LifeCycleObserver auto detection is active :<code>Ignoring the appInBackground() call, as the App Background/Foreground auto-detection is active. The current state is - background</code>
| |
| | |
| === The SdkBgFgDetectionUtility class ===
| |
| Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement. It may be implemented in multiple ways for Android. This includes
| |
| | |
| *Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
| |
| *Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
| |
| *Custom implementation of the required methods within your application.
| |
| | |
| ==== ForeGround/Background Measurement via AndroidManifest ====
| |
| The simplest way to measure the app background/foreground state is to add the following application tag to the Manifest XML. Integrating this into the Manifest XML will enable the SDK to measure app state directly. This approach is supported for Android 4.0 and up only; it requires that the application class is not in use for some other purpose.
| |
| | |
| <syntaxhighlight lang="java"> <application android:name="com.nielsen.app.sdk.AppSdkApplication"> </syntaxhighlight>
| |
| | |
| ==== Using the Android SdkBgFbDetectionUtility Class ====
| |
| For developers who are already using the application class, it is recommended that background/foreground state is implemented using the [[Android Background Foreground|SdkBgFgDetectionUtility class.]] The [[Android Background Foreground|SdkBgFgDetectionUtility class.]] is compatible with Android 4+ and has been made available to Nielsen clients. (You will need to copy/paste the code provided into a file).
| |
| | |
| ==== Manual Background/ForeGround State Management ====
| |
| In cases where the developer is not able to use the AndroidManifest.xml solution nor the Nielsen provided [[Android Background Foreground|SdkBgFgDetectionUtility class.]] the developer will need to manually identify the change of state through the application and call the respective API (appInForeground() or appInBackground()) to inform the SDK regarding the change of state from background to foreground or foreground to background.
| |
| | |
| The SDK is informed about app state using the below methods.
| |
| | |
| <syntaxhighlight lang="java">AppLaunchMeasurementManager.appInForeground(getApplicationContext());</syntaxhighlight>
| |
| <syntaxhighlight lang="java">AppLaunchMeasurementManager.appInBackground(getApplicationContext());</syntaxhighlight>
| |
| Within the lifecycle of individual activities, onResume() and onPause() are best suited to providing indication of the app state.
| |
| | |
| | |
| Correct measurement of the foreground/background state is crucial to Static App measurement within Nielsen Digital Content Ratings (DCR).
| |
| | |
| | |
| | |
| == Stop/Resume the Measurement for video Playback Interruptions ==
| |
| As part of integrating Nielsen App SDK with the player application, the Audio / Video app developer needs to handle the following possible interruption scenarios:
| |
| * Pause / Play
| |
| * Network Loss (Wi-Fi / Airplane / Cellular)
| |
| * Call Interrupt (SIM or Third party Skype / Hangout call)
| |
| * Alarm Interrupt
| |
| * Content Buffering
| |
| * Device Lock / Unlock (Video players only, not for Audio players)
| |
| * App going in the Background/Foreground (Video players only, not for Audio players)
| |
| * Channel / Station Change Scenario
| |
| * Unplugging of headphone
| |
| In case of encountering one of the above interruptions, the player application needs to
| |
| * Call <code>stop</code> immediately (except when content is buffering) and withhold sending playhead position.
| |
| * Once the playback resumes, start sending pings <code>playheadPosition</code> for the new viewing session.
| |
| Please see the [[Digital Measurement FAQ]] for more details
| |
| | |
| == Review SDK Integration Architecture Diagram ==
| |
| | |
| === For Content Playback ===
| |
| | |
| [[File:nlsn-sdk-achitecture-diagram-content-v1.png||SDK Integration Architecture Diagram - Content]]
| |
| | |
| === For Ad Playback ===
| |
| [[File:nlsn-sdk-achitecture-diagram-ad-v1.png||SDK Integration Architecture Diagram - Ad]]
| |
| | |
| == Privacy and Opt-Out ==
| |
| 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.
| |
| # '''[[#Global_Android_SDK_No_Ad_Framework_Opt-out|Global Android SDK No Ad Framework Opt-out]]''' - Direct call to SDK. Can be used without Google Play Services or when using the No Ad version of the SDK.
| |
| # '''[[#Global_Android_SDK_No_ID_Opt-out|Global Android SDK No ID Opt-out]]''' - 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”.
| |
| | |
| ==== 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>
| |
| | |
| ===<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">
| |
| 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;
| |
| }
| |
| }
| |
| }
| |
| </syntaxhighlight>
| |
| <br>
| |
| | |
| === Global Android SDK No Ad Framework Opt-out ===
| |
| The ''No Ad Framework Opt-out'' can be used when the host application does not leverage Google Play Services such as when using the No Ad version or the No ID version.
| |
| | |
| ==== The No Ad Framework Opt-out method works as follows: ====
| |
| * Get the current Nielsen opt-out URL via [[userOptOutURLString()]]
| |
| * Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()]]
| |
| * Detect if the WebView URL changes to a special URL that indicates Opt-in, or Opt-out and close the WebView
| |
| ** Opt-out if the WebView URL = <code>nielsenappsdk://1</code>
| |
| ** Opt-in if the WebView URL = <code>nielsenappsdk://0</code>
| |
| * Pass the detected URL to the [[userOptOut()]] function
| |
| ** Example: <syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>
| |
| ===<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;
| |
| | |
| @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;
| |
| }
| |
| }
| |
| }
| |
| </syntaxhighlight>
| |
| | |
| === Global Android SDK No ID Opt-out ===
| |
| If you are building an app that will be listed in the Kids Category:
| |
| # Ensure that you are using the No ID version of the Nielsen SDK Framework.
| |
| # Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt-out selection:
| |
| <syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>
| |
| | |
| === Required Privacy Links ===
| |
| Users must either have access to the "About Nielsen Measurement" page, or have similar text available within the native app. Include "About Nielsen Measurement" and "Your Choices" link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
| |
| | |
| In addition, the following text must be included in your app store description.
| |
| <blockquote>
| |
| '''"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see https://sites.nielsen.com/priv/browser/se/sv/optout.html for more information"'''</blockquote>
| |
| | |
| == Optional Step for DCR Chromecast Android SDK ==
| |
| For the implementation of Chromecast SDK architecture. Please refer to this guide: [https://engineeringportal.nielsen.com/docs/DCR_Chromecast_Android_SDK DCR Chromecast Android SDK]
| |
| | |
| == Test your player by yourself ==
| |
| === Guide ===
| |
| 1. Connect your PC and test device (tablet or phone) via same router.<br />
| |
| 2. PC side: run Proxy sw (like Charles) and get local IP<br />
| |
| 3. Test device: modify Wifi setting to pass through Proxy IP from step 2.<br />
| |
| 4. Test device: run your player, launch video<br />
| |
| 5. PC side: filter traffic by "nmrodam" and confirm presence of SDK pings<br />
| |
| | |
| === Example of SDK ping (https call) ===
| |
| <code><nowiki>https://secure-ire.nmrodam.com/cgi-bin/gn?prd=dcr&ci=se-910684&ch=se-910684_c01_P&asn=defChnAsset&fp_id=096ohdsc0jqkmct81qpxhmn19qx041630053963&fp_cr_tm=1630053963&fp_acc_tm=1630053963&fp_emm_tm=1630053963&ve_id=afc5d61a88b62672&sessionId=zc6gh3uhka7d2mtobb2b2m7sixygy1630053963&tl=Djuren%20p%C3%A5%20Djuris&prv=1&c6=vc,c01&ca=se-910684_c01_218531&cg=Hemligheter&c13=asid,T1194003B-797F-4896-A5C0-05914236146E&c32=segA,NA&c33=segB,NA&c34=segC,NA&c15=apn,&plugv=4.4.1&playerv=ExoPlayer&sup=1&segment2=&segment1=&forward=0&ad=1&cr=4_00_99_D1_10000&c9=devid,c041ec5e50722cdf8cc5b4826c24ae54c5747a6570e900006c826b37ca01ce17&enc=true&c1=nuid,c041ec5e50722cdf8cc5b4826c24ae54c5747a6570e900006c826b37ca01ce17&at=timer&rt=video&c16=sdkv,aa.8.1.0&c27=cln,34&crs=0&lat=&lon=&c29=plid,16300539624283525&c30=bldv,aa.8.1.0.0_gaxnons&st=dcr&c7=osgrp,&c8=devgrp,&c10=plt,&c40=adbid,&c14=osver,ANDROID.11&c26=dmap,1&dd=&hrd=&wkd=&c35=adrsid,&c36=cref1,&c37=cref2,&c11=agg,1&c12=apv,4.4.1.4004001&c51=adl,0&c52=noad,0&sd=578&pc=NA&c53=fef,n&c54=oad,&c55=cref3,&c57=adldf,2&ai=218531&c3=st,c&c64=starttm,1630053962&adid=218531&c58=isLive,false&c59=sesid,257f8bz854wmqa31gk3icyi7cmj131630053964&c61=createtm,1630053997&c63=pipMode,&ci_userid=&is_auto_play=no&pl_title=&is_prem=no&is_prog=&ad_origin=&adidx=&is_tpad=&ci_passthr=&c62=sendTime,1630053997&c68=bndlid,air.se.urplay.android_player.debug&nodeTM=&logTM=&c73=phtype,&c74=dvcnm,&c76=adbsnid,&c77=adsuprt,2&uoo=&evdata=PL%3A1630053964727%3A0&c71=ottflg,0&c72=otttyp,&c44=progen,&davty=1&si=&c66=mediaurl,&sdd=retry,0~~retryreason,~~devmodel,SM-G981B~~devtypid,samsung-SM-G981B~~sysname,Android~~sysversion,11~~manuf,samsung&cat_id=3398d8e4-e613-42c1-92aa-1a6fc52dcf5c&vtoff=0&rnd=1630053997971</nowiki></code>
| |
| | |
| == Step 9 : Provide your app for certification ==
| |
| Once ready please send your application to Nielsen local staff for certification.
| |
| | |
| == Step 10 : Going Live ==
| |
| After the integration has been certified by Nielsen (but not prior to that), do the following:
| |
| | |
| # '''Disable Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
| |
| # '''Notify Nielsen''': Once you are ready to go live, let us know so we can enable you for reporting. We will not be able to collect or report data prior to receiving notification from you.
| |