API Version 5.1.1 (Current)
Step 1: Prerequisites
To start using App SDK, the following details are required.
- App ID (appid): Unique ID assigned to the player/site and configured by product.
- Nielsen SDK and Sample Player: A part of the downloaded package.
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
Step 2: Import Library
Refer to 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.
The latest version of App SDK contains only appsdk.jar file and does not feature any native shared libraries like libAppSdk.so.
Step 3: Initialize SDK
Initialize App SDK as soon as the application is launched. Refer to Initialization
for more details on initializing an AppSDK object and the parameters required.
Step 4: Configure and fire API Calls
Configure API calls – play
when starting or resuming a streaming session to pass the channel descriptor information through channelName
parameter when the user taps the Play
button on the player.
- channelName is a 32-character free-form text field containing the name of the program or feed being sent (such as ESPN2, Food Network, etc.)
JSON as below.
Configure API calls – loadMetadata
Load the CMS metadata by calling loadMetadata()
on the SDK object.
Refer to Metadata section for the parameters to be passed in the JSON object.
Call loadMetadata() for the content after the first play() call.
with JSON metadata for the active content as below.
Configure API calls – sendID3
sendID3() is a receiver for HLS timed metadata events (ID3 tags) provided through the notification system. This API filters out Nielsen-specific ID3 tags from the system and buffers the data for transfer to Nielsen’s collection facility. Call sendID3() whenever a new Nielsen ID3 metadata is available for processing, during session playback.
Sample ID3 tags
Refer to the Retrieving ID3 tags
section to know more details.
Configure API calls – stop
only at the end of ad and when the stream playback is stopped by a user or an interruption from another event. Common events are; network loss, power / standby, incoming call, alarm, etc. Call stop()
only when buffering continues for 30 seconds (not when it starts). Call play()
when resuming a stream (previously stopped) or starting playback of a new stream.
Configure API calls – end
Call end() only at the end of playback.
API Call sequence
Use Case 1: Content has no Advertisements
Call play() with channelName JSON as below.
Use Case 2: Content has Advertisements
Call play() (for the first ad) with channelName JSON as below.
Call loadMetadata() with JSON metadata for the active content.
Step 5: Handling Foreground and Background states of App
There are two ways of handling the foreground and background states of the client application.
- Let App SDK handle the app states information (foreground / background) and use it, as necessary. Click here for more information.
- Capture app states through the application and trigger the corresponding API (appInForeground() or appInBackground()) upon every change of state. This allows Nielsen App SDK to know the app state. Click here for more information.
New devices (Android 4.0 and later versions)
Add application tag to Manifest XML file
When client’s app supports only new devices (Android 4.0 and above) and the client has not implemented a custom Application class for some other purpose,
- Add the following entry (application tag) into the Manifest XML file to use SDK’s state detection feature.
This is the custom Application class where the whole background detection implementation is done.
No new permissions are required to change the properties in Manifest XML file.
Older devices (Android 4.0 or earlier version)
Identify the change of state through the application and call the respective API (appInForeground()
) upon every change of state (foreground / background). The SDK will use this information to pass the app launch times, etc. to Collection facility.
Step 6: 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
- Wi-Fi OFF / ON
- Airplane Mode ON / OFF
- Alarm Interrupt
- 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 Background / Foreground (Video players only, not for Audio players)
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 for the new viewing session – loadMetadata() and sendID3() in that order, once the playback resumes.
for more details.
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 userOptOutURLString()) should be displayed.
- 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 Opt-Out Implementation and Nielsen Digital Privacy.
The SDK will continue measurement even after the user has opted out from Nielsen measurement.
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.