DCR Static Android SDK
From Engineering Client Portal
- 1 Prerequisites
- 2 Import Library
- 3 Initialize SDK
- 4 Configure API calls - play
- 5 Configure API calls - playheadPosition
- 6 Handling Foreground and Background states of App
- 7 Nielsen Measurement Opt-Out Implementation
- 8 Pre-Certification Checklists
- 9 Testing an Implementation - App
To start using the App SDK, the following items are required:
|☑||App ID (appid)||Unique ID assigned to the player/site and configured by product.||Contact Nielsen|
|☑||sfcode||Environment that the SDK must point to||Contact Nielsen|
|☑||Nielsen SDK||Includes SDK libraries and sample implementation; See Android SDK Release Notes||Download|
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team. Refer to Digital Measurement Onboarding guide for more information on how to get a Nielsen App SDK and appid.
Refer to Android SDK API Reference - Setting Up Development Environment for information on importing libraries.
- The latest version of App SDK allows instantiating multiple instances of App SDK object and can be used simultaneously without any issues.
Note: The latest version of App SDK contains only appsdk.jar file and does not feature any native shared libraries like libAppSdk.so.
Note: The integrator should always tag the landing page on the app.
Initialize App SDK as soon as the application is launched. Refer to Initalization for details on initializing an AppSDK object and the parameters required.
Configure API calls - play
For static <App Measurement> content, play API is not required.
Configure API calls - loadMetadata
Refer to Digital Measurement Metadata for the list of parameters to be passed in the JSON object.
Note: The loadMetadata call must have ("type": "static").
Configure API calls - playheadPosition
For static <App Measurement> content, no playhead has to be supplied to the SDK.
For static <App Measurement> content, stop API is not required.
API Call sequence
Call loadMetadata with JSON metadata as below.
new JSONObject() .put("type", "static") .put("section", "siteSection") .put("assetid", "vid345-67483") .put("segA", "segmentA") .put("segB", "segmentB") .put("segC","segmentC") }
Handling Foreground and Background states of App
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:
1) ForeGround/Background Measurement via AndroidManifest - Enable the Nielsen SDK to measure background/foreground state by makingthe relevant update to the AndroidManifest.
2) Using the Android SdkBgFbDetectionUtility Class - Integrate Nielsen’s SdkBgFgDetectionUtility class within your Custom Application Class.
3) Manual Background/ForeGround State Management - Custom implementation of the required methods within your application.
1) 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.
2) 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.
3) 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.
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).
Nielsen Measurement Opt-Out Implementation
As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. Our digital measurement products are not used to identify the consumer in any way, but they help us and our clients measure and analyze how consumers engage with media across online, mobile and emerging technologies, and offer insights into consumer behavior.
- When the app user wants to opt in or opt out of Nielsen measurement, a new dynamic page (with content string obtained from optOutURL) should be displayed.
- Use optOutStatus to retrieve the device’s Opt-Out status.
- This Opt-out page should be displayed in a webview (within the app) and not in any external browser.
- Capture the user’s selection in this page and pass it to the SDK through userOptOut for Nielsen to save the user’s preference.
- For more details, refer to Android SDK API Reference - Android Opt-Out Implementation and Nielsen Digital Privacy.
After the application is ready to be sent for Nielsen Certification, please go through the Pre-Certification Checklist and ensure the app behaves as expected, before submitting to Nielsen.