DCR Norway Audio Android App SDK
From Engineering Client Portal
Overview
The Nielsen software development kit (SDK) is one of 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 sub section / page in the application.
Prerequisites
To start using the App SDK, the following details are required:
- App ID (appid): Unique ID assigned to the player/site and configured by product.
- 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.
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 using Android Studio.
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
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.xmlunder <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 | |
| sfcode | Nielsen collection facility to which the SDK should connect.
Norway RAM integrations
|
Nielsen-specified | ✓ | "nor" |
| nol_devDebug | Enables Nielsen console logging. Only required for testing | Nielsen-specified | required until cretification/going live | "DEBUG" |
Sample SDK Initialization Code
Java
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.
Java
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 | 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 | should be 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
appDisableApiis 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();
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
Java
Android Opt-Out Implementation
To opt-out, users must have access to the page referenced by the opt-out URL provided by the SDK. Users can click this page from the app settings screen.
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.
- URL to this web page should be called from SDK by invoking
userOptOutURLString()and opened in 'WebView' / External browser.
public String userOptOutURLString()
- 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
getOptOutStatus()method.
public boolean getOptOutStatus()
Displaying Opt-Out in a WebView
optOutUrl = mAppSdk.userOptOutURLString();
if(optOutUrl !=null)
{
mWebView = (WebView) findViewById(R.id.webView);
mWebView.getSettings().setJavaScriptEnabled(true);
mWebView.getSettings().setBuiltInZoomControls(true);
mWebView.getSettings().setDisplayZoomControls(false);
mWebView.getSettings().setLoadWithOverviewMode(true);
mWebView.getSettings().setUseWideViewPort(true);
mWebView.setWebViewClient(new MonitorWebView());
mWebView.setWebChromeClient(new WebChromeClient());
mWebView.loadUrl(optOutUrl);
}
else
{
//Handle it gracefully and Retry later
}
The app must provide access to "About Nielsen Measurement" page for the users. 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.
Note: When ‘WebView’ / External browser is closed, do not pass the status returned from ‘WebView’ / External browser to the SDK within the app, as the new Opt-Out page will not return any response.
Note: App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.
Note:
- SDK will be sending the data pings to census even though the user opted out. However, all the outgoing pings will have the parameter uoo=true using which backend can ignore this data.
- Current Opt-Out page is now updated to have no hyperlinks for Opt-Out / Opt-In operations. SDK Opt-Out has to be done via
Google Settings → Ads → Opt out of Ads Personalization.
Note: For Amazon devices, see Opt-Out Implementation for Amazon Devices below.
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 an opted-out ping.
Opt-Out Implementation for Amazon Devices
Amazon device users can opt-out or opt back into Nielsen Measurement, any time using the device’s setting – 'Limit Ad Tracking' (Interest-based ads).
The user is opted out of Nielsen Online Measurement when ‘Limit Ad Tracking’ is enabled.
For devices running on Fire OS 5.1 and above, retrieve the Ad tracking value.
Retrieving Ad tracking Value
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
- Returns limit_ad_tracking value "0" if enabled
- Returns limit_ad_tracking value "1" if disabled
- Returns limit_ad_tracking value "2" if ad tracking is not supported (below Fire OS 5.1).
Note: Google Play Services are not needed to retrieve ad tracking state on Amazon devices. Limit Ad Tracking can be accessed through Settings → Apps & Games → Advertising ID.
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.