DCR Norway Audio Android App SDK
From Engineering Client Portal
Overview
The Nielsen software development kit (SDK) is one of the multiple frameworks that Nielsen provides to enable measuring linear (live) and on-demand audio and video viewing using desktop computers, mobile devices, OTT devices, etc. The App SDK is the framework for mobile application developers to integrate Nielsen Measurement into their media player applications. It supports a variety of Nielsen Measurement Products like Digital in TV Ratings, Digital Content Ratings (DCR & DTVR), 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.
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 you do not have any of these prerequisites or if you have any questions, please contact our SDK sales support team. Refer to Digital Measurement Onboarding guide for information on how to get a Nielsen App SDK and appID.
Implementation
This guide covers implementation steps for Android Studio utilizing the Standard Nielsen SDK for DCR.
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.
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.
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 select "com.google.android.gms:play-services"
.
Ensure it is added in build.gradle (App level) file
Google AD ID Permissions
The following is required if target API level is set to 31 (Android 12) with the Ad Version of the Nielsen SDK.
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
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
<meta-data
android:name="com.google.android.gms.version"
android:value="@integer/google_play_services_version"/>
- App SDK checks to see if there is a Google service available and updated.
- If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.
Library
Nielsen App SDK uses the following packages/classes from the Google Play service.
- google-play-services_lib
Classes/package
- com.google.android.gms.ads.identifier.AdvertisingIdClient;
- com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
- com.google.android.gms.common.ConnectionResult;
- com.google.android.gms.common.GooglePlayServicesUtil;
- com.google.android.gms.common.GooglePlayServicesRepairableException;
- com.google.android.gms.common.GooglePlayServicesNotAvailableException;
SDK Initialization
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issue. The sharedInstance API that creates a singleton object was deprecated prior to version 5.1.1. (Version 4.0 for Android)
- A maximum of four SDK instances per appid are supported. When a fifth SDK instance is launched, the SDK will return “nil” from initWithAppInfo:delegate:
- When four SDK instances exist, you must destroy an old instance before creating a new one.
The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
- The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
Parameter / Argument | Description | Source | Required/Obligatory? | Example |
---|---|---|---|---|
appid | Unique id for the application assigned by Nielsen. It is GUID data type. | Nielsen-specified | ✓ | PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
appversion | Release version of the client app. Not needed anymore. | custom | 0.1.1 | |
nol_devDebug | Enables Nielsen console logging. Only required for testing | Nielsen-specified | required until cretification/going live | "DEBUG" |
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("sfcode", "nor")
.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
, sfcode
) 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 the 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 the 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 handle 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 the unexpected type is passed to the method, the error message will be logged.
- If the string has invalid JSON format, the error message will be logged.
- JSON value must be a 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 channelInfo = new JSONObject()
.put("channelname", "My Channel Name 1")
JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("isAudio", "true")
.put("assetid", "vid345-67483")
.put("program", "Program Name")
.put("title", "Program S3, EP1")
.put("length", "3600")
.put("isfullepisode", "y")
.put("adloadtype", "2")
.put("airdate", "20161013 20:00:00")
Configure metadata
When starting a streaming session a channel info metadata object needs to be passed to the SDK containing a channelName. The name should remain constant throughout the completion of an episode or live stream.
Key | Description | Values | Required |
---|---|---|---|
channelName | Any string representing the channel/stream | custom | ✓ |
Content metadata
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
Keys | Description | Values | Required/Obligatory |
---|---|---|---|
type | type of asset | "content" |
✓ |
isAudio | indicate measurement of audio ads or audio content | "true" |
✓ |
assetid | unique ID assigned to asset (64 character limit) | custom (no Special Characters) |
✓ |
program | (string) name of program (254 character limit) | custom | ✓ |
title | (string) episode title (max 254 characters) | custom | ✓ |
length | length of content in seconds | seconds ("0" for 24/7 Livestream if only one assetid is used for the whole stream. If reporting on program level, length of the program. For Event-Livestreams planned length. For on-demand stream length) |
✓ |
airdate | the airdate in the linear over-the-air broadcast (publication date). This is required for both LIVE & VOD |
Supported formats are:
YYYY-MM-DDHH:MI:SS YYYY-MM-DDTHH:MI:SS+xx:xx YYYY-MM-DDTHH:MI:SS-xx:xx YYYYMMDDHH:MI:SS MM-DD-YYYY MM/DD/YYYY |
✓ |
scheduledEndDate | the airdate when this particular asset ended in the linear over-the-air broadcast. This is required for both LIVE & VOD. In the case of VOD, this will be the airdate + length. |
This should be the same format as airdate | ✓ |
isfullepisode | full episode flag | "y" - full episode, "n" - non full episode |
✓ |
adloadtype | type of ad load:
|
"2" - DCR measures content with dynamic ads |
✓ |
stationType | OTA station flag and/or OTA station type |
|
✓ |
stationId | (string) name of the channel | custom | ✓ |
clientid |
parent ID – value is automatically populated through provided App ID. |
provided by Nielsen |
|
subbrand | vcid/sub-brand ID – value is automatically populated through provided App ID. In order to override the sub-brand configured to the App ID, value can |
provided by Nielsen |
|
progen | (string) genre information (max 254 characters) |
custom |
Ad Metadata
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
Keys | Description | Values | Required |
---|---|---|---|
type | type of ad | 'preroll', 'midroll', or 'postroll' | ✓ |
assetid | unique ID assigned to ad | custom | ✓ |
Configure API Calls
Sample API Sequence
A Sample API sequence could follow this flow:
Type | Sample code | Description |
---|---|---|
On App Start | [nielsenMeter loadMetadata: contentMetadata]; |
// contentMetadata Object contains the JSON metadata for the impression |
Start of stream | [nielsenMeter play: channelInfo]; |
// channelInfo contains JSON metadata of channel name being played |
[nielsenMeter loadMetadata: contentMetadataObject]; |
// contentMetadataObject contains the JSON metadata for the content being played | |
Content | [nielsenMeter playheadPosition: position]; |
// playheadPosition is position of the playhead while the content is being played |
End of Stream | [nielsenMeter end]; |
// Content playback is completed. |
Life cycle of SDK instance
Life cycle of SDK instance includes four general states:
- Initial state – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the Initial state.
- Idle state – The SDK is initialized and is ready to process playing information. Once Initialized, the SDK instance is not processing any data, but is listening for the play event to occur.
- Processing state – The SDK instance is processing playing information. play and loadMetadata calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
- playheadPosition – Call this API every one second when playhead position timer is fired.
- stop – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
- end – SDK instance exits from Processing state when this API is called.
- Disabled state – The SDK instance is disabled and is not processing playing information. SDK instance moves into this state in one of the following scenarios.
- Initialization fails
appDisableApi
is called
@property (assign) BOOL appDisableApi;
Note: The App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.
Note: In case of any interruptions during playback due to alarm, calendar, call, flight mode, Wi-Fi toggle, channel change, etc., call stop to stop the measurement.
- As soon as the playback resumes, call play, loadMetadata and playheadPosition.
API Call sequence
Use Case 1: Content has no Advertisements
Call play() with channelName JSON as below.
{
"channelName": "My Channel Name 1"
}
Call loadMetadata() with JSON metadata for content as below.
{
"type": "content",
"isAudio": "true",
"assetid": "stream345-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(channelInfo); |
// channelInfo contains JSON metadata of channel name being played |
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 |
End of Stream | mAppSdk.end(); |
// Content playback is completed. |
Use Case 2: Content has Advertisements
Call play() with channelName JSON as below.
{
"channelName": "My Channel Name 1"
}
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().
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(channelInfo); |
// channelName contains JSON metadata of channel name being played |
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 | |
mAppSdk.stop(); |
// Call stop after the content is paused (ad starts) | |
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(); |
// App moves to background(midroll pauses) | |
mAppSdk.loadMetadata(midrollMetaDataObject); |
// App moves to foreground (midroll resumes) | |
mAppSdk.setPlayheadPosition(playheadPosition); |
// playheadPosition is position of the playhead while the midroll ad is being played | |
mAppSdk.stop(); |
// Call stop after midroll occurs | |
Content (End of stream) | 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 | |
mAppSdk.stop(); |
// Always call stop irrespective of postroll is followed or not | |
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.
Sequence of Calls
play
Use play to pass the channel information containing the channelName parameter when the streaming session starts.
Java
public void play(JSONObject channelInfo);
loadMetadata
The loadMetadata function is used to inform the SDK about new content. The contentMetadata object passed in should contain the values as described above.
Java
public void loadMetadata(JSONObject contentMetadata);
playheadPosition
Use playheadPosition to tell the SDK about the current position in the stream. For live content, this should be the Unix timestamp (seconds since Jan-1-1970 UTC). For on-demand content, simply the position in seconds in the stream.
Java
public void setPlayheadPosition(long position);
stop
Tell the SDK that content playback has stopped.
Java
public void stop();
end
When the content stop is initiated and content cannot be resumed from the same position. For example when the stream has reached its end or in situations where it can only be restarted from the beginning.
Java
public void end();
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).
Interruptions during playback
As part of integrating Nielsen App SDK with the player application, the Audio / Video app developer needs to handle the following possible interruption scenarios:
- Pause / Play
- Network Loss (Wi-Fi / Airplane / Cellular)
- Call Interrupt (SIM or Third-party Skype / Hangout call)
- Alarm Interrupt
- Content Buffering
- Device Lock / Unlock (For Audio players only if audio stops playing)
- App going in the Background/Foreground (For Audio players only if audio stops playing)
- Channel / Station Change Scenario
- Unplugging of headphone
In the case of encountering one of the above interruptions, the player application needs to
- Call stop immediately (except when content is buffering) and withhold sending playhead position.
- If it is Channel/station change scenario, call stop immediately followed by end
- Start sending pings – loadMetadata and playheadPosition for the new viewing session, once the playback resumes.
Please see the Digital Measurement FAQ for more details
Privacy and Opt-Out
There are two primary methods for implementing user Opt-out preferences:
- OS-level Opt-out - managed by Opt out of Ads Personalization setting on device (preferred approach).
- Legacy Opt-out - Direct call to SDK; used only for older versions of Nielsen Android SDK versions (< 5.1.1.18)
OS-level Opt-out
OS-level Opt-out method available on Nielsen Android SDK Versions 5.1.1.18 and above.
The Nielsen SDK automatically leverages the Android's Opt out of Ads Personalization setting. The user is opted out of demographic measurement if the OS-level "Opt out of Ads Personalization" ("Limit Ad Tracking" for iOS) setting is enabled. As a publisher, you cannot override this setting.
Legacy Opt-out
The Legacy opt-out method is only necessary for Nielsen Android SDK versions less than 5.1.1.18.
Nielsen Android SDK 5.1.1.18 and above will check for OS-level opt-out first, if available. The user will be opted out if indicated at the OS-level OR the App-level.
The legacy opt-out method works as follows:
- Get the current Nielsen opt-out URL via userOptOutURLString()
- Display a WebView element whose loadUrl is set to the value obtained from userOptOutURLString()
- Detect if the WebView URL changes to a special URL that indicates Opt-in, or Opt-out and close the WebView
- Opt-out if the WebView URL =
nielsenappsdk://1
- Opt-in if the WebView URL =
nielsenappsdk://0
- Opt-out if the WebView URL =
- Pass the detected URL to the userOptOut() function
- Example:
appSdk.userOptOut("nielsenappsdk://1"); // User opt-out
- Example:
Legacy Opt Out example code
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {
WebView webView;
AppSdk appSdk;
private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";
private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";
// Within your app you would provide your User the option to Opt Out.
// Perhaps via a toggle or button
// This is separate from Limit Ad Tracking
let urlStr = navigationAction.request.url?.absoluteString
if(urlStr == NIELSEN_URL_OPT_OUT || urlStr == NIELSEN_URL_OPT_IN){
let appApi = self.nielsenApi
appApi?.userOptOut(urlStr)
}
Retrieve current Opt-Out preference
Whether the user is opted out viaOS-level Opt-out or via App-level Opt-out, the current Opt-Out status as detected by the SDK is available via the getOptOutStatus() property in the Nielsen Android SDK API,
Required Privacy Links
Users must either have access to the "About Nielsen Measurement" page, or have similar text available within the native app. Include "About Nielsen Measurement" and "Your Choices" link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
In addition, the following text must be included in your app store description.
"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=en-no for more information"
Webview Example
The below code is an example of displaying the Nielsen Privacy page to the user.
public class OptOutActivity extends AppCompatActivity implements IAppNotifier {
WebView webView;
AppSdk appSdk;
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_optout);
webView = (WebView) findViewById(R.id.webView);
webView.getSettings().setJavaScriptEnabled(true);
webView.setWebViewClient(new WebViewClient() {
@SuppressWarnings("deprecation")
@Override
public void onReceivedError(WebView view, int errorCode, String description, String failingUrl) {
Toast.makeText(OptOutActivity.this, description, Toast.LENGTH_SHORT).show();
}
@TargetApi(android.os.Build.VERSION_CODES.M)
@Override
public void onReceivedError(WebView view, WebResourceRequest req, WebResourceError rerr) {
// Redirect to deprecated method, so you can use it in all SDK versions
onReceivedError(view, rerr.getErrorCode(), rerr.getDescription().toString(), req.getUrl().toString());
}
});
NielsenInit nielsenInit = new NielsenInit();
appSdk = nielsenInit.initAppSdk(getApplicationContext(), this);
//Getting the optPut URL from eventTracker
String url = appSdk.userOptOutURLString();
webView.loadUrl(url);
}
Going Live
Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.
- Debug Logging: Disable logging by deleting
{nol_devDebug: 'DEBUG'}
from initialization call.- Example Production Initialization Call - Refer to the production initialization call below:
Android Example:
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
.put("sfcode", "nor")
// Remove Flag: "nol_devDebug": "DEBUG"
// 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);
}
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.