Engineering Client Portal - User contributions [en]

DCR & DTVR Flutter Integration

2025-10-17T15:04:25Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]
= Integrate Nielsen SDK Api in Flutter App =

== Overview ==

The Nielsen Flutter Plugin provides a Dart API that bridges into the native Nielsen App SDKs (iOS and Android) using Flutter’s platform channels.

Flow: Dart → Platform Channel → iOS/Android Plugin → Nielsen App SDK

Supports SDK flavors: Global, GlobalAd, GlobalNoAd, AGF, AGFNoAd, AGFNoId

Each flavor corresponds to a different Nielsen SDK package. You select the one required by your business case in the pubspec.yaml.
<p style="color:#C70039;">Note : Support for Flutter in Nielsen SDK is available from version 10.1.0.0</p>

== 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.

== Setting up your Environment ==
* '''Add dependency in pubspec.yaml'''
<syntaxhighlight>
dependencies:
nielsen_flutter_plugin:
git:
url: https://github.com/NielsenDigitalSDK/flutter.git
# The path below is for the 'Global' flavor.
# See the table below to select the path for other flavors.
path: Flutter/FlutterPlugin/Global/nielsen_flutter_plugin/nielsen_flutter_plugin
ref: main // or lock to specific tag like 10.1.0

</syntaxhighlight>

* '''Select Your SDK Flavor Path'''

Use the following path values to select the appropriate Nielsen SDK flavor:

{| class="wikitable"
|-
! Flavor !! Flavor path in pubspec.yaml
|-
|Global||Flutter/FlutterPlugin/Global/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|GlobalAd||Flutter/FlutterPlugin/GlobalAd/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|GlobalNoAd||Flutter/FlutterPlugin/GlobalNoAd/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|AGF||Flutter/FlutterPlugin/AGF/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|AGFNoAd||Flutter/FlutterPlugin/AGFNoAd/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|AGFNoId||Flutter/FlutterPlugin/AGFNoId/nielsen_flutter_plugin/nielsen_flutter_plugin
|}

* '''Import the plugin in your Dart code'''
<syntaxhighlight>
import 'package:nielsen_flutter_plugin/nielsen_flutter_plugin.dart';
</syntaxhighlight>

== Public API's ==

All API methods are static and require the sdkId that is returned by createInstance.

<syntaxhighlight>

import 'dart:convert';
import 'package:flutter/foundation.dart';
import 'package:nielsen_flutter_plugin_platform_interface/nielsen_flutter_plugin_platform_interface.dart';

/// Nielsen App SDK – Flutter Public APIs.
class NielsenFlutterPlugin {
NielsenFlutterPlugin._();
static final NielsenFlutterPlugin instance = NielsenFlutterPlugin._();

NielsenFlutterPluginPlatform get _p => NielsenFlutterPluginPlatform.instance;

bool _debugLogging = false;

/// Enable/disable debug logging of raw native responses.
void enableDebugLogs(bool enable) {
_debugLogging = enable;
}

void _logDebug(String api, String? res) {
if (_debugLogging) {
debugPrint('[NielsenFlutterPlugin] $api → $res');
}
}

// ----------------------------------------------------------------------
// Instance lifecycle
// ----------------------------------------------------------------------

/// Creates a Nielsen SDK instance with the provided app info.
/// Returns the generated sdkId string.
Future<String?> createInstance(Map<String, dynamic> appInfo) async {
final res = await _p.createInstance(jsonEncode(appInfo));
_logDebug('createInstance', res);
return res;
}

/// Releases a previously created Nielsen SDK instance.
Future<void> free(String sdkId) async {
final res = await _p.free(jsonEncode({'sdkId': sdkId}));
_logDebug('free', res);
}

// ----------------------------------------------------------------------
// Playback lifecycle and metadata
// ----------------------------------------------------------------------

/// Signals playback start and passes play metadata.
Future<void> play(String sdkId, Map<String, dynamic> playData) async {
final res =
await _p.play(jsonEncode({'sdkId': sdkId, 'playdata': playData}));
_logDebug('play', res);
}

/// Loads content/ad/static metadata into the active measurement session.
Future<void> loadMetadata(String sdkId, Map<String, dynamic> metadata) async {
final res = await _p
.loadMetadata(jsonEncode({'sdkId': sdkId, 'metadata': metadata}));
_logDebug('loadMetadata', res);
}

/// Notifies a temporary stop/pause/interruption in playback.
Future<void> stop(String sdkId) async {
final res = await _p.stop(jsonEncode({'sdkId': sdkId}));
_logDebug('stop', res);
}

/// Ends the playback measurement session.
Future<void> end(String sdkId) async {
final res = await _p.end(jsonEncode({'sdkId': sdkId}));
_logDebug('end', res);
}

/// Ends a static content session (if used in your workflow).
Future<void> staticEnd(String sdkId) async {
final res = await _p.staticEnd(jsonEncode({'sdkId': sdkId}));
_logDebug('staticEnd', res);
}

/// Updates the playhead position (in seconds).
Future<void> setPlayheadPosition(String sdkId, int positionSeconds) async {
final res = await _p.setPlayheadPosition(
jsonEncode({'sdkId': sdkId, 'position': '$positionSeconds'}),
);
_logDebug('setPlayheadPosition', res);
}

/// Reporting OTT update event to the SDK.
Future<void> updateOTT(String sdkId, Map<String, dynamic> ottData) async {
final res =
await _p.updateOTT(jsonEncode({'sdkId': sdkId, 'ottData': ottData}));
_logDebug('updateOTT', res);
}

// ----------------------------------------------------------------------
// Timed metadata (ID3)
// ----------------------------------------------------------------------

/// Sends ID3 timed metadata to the SDK.
Future<void> sendID3(String sdkId, String id3) async {
final res = await _p.sendID3(jsonEncode({'sdkId': sdkId, 'sendID3': id3}));
_logDebug('sendID3', res);
}

// ----------------------------------------------------------------------
// Information / getters
// ----------------------------------------------------------------------

/// Returns opt-out status as a string ("true"/"false").
Future<String?> getOptOutStatus(String sdkId) async {
final res = await _p.getOptOutStatus(jsonEncode({'sdkId': sdkId}));
_logDebug('getOptOutStatus', res);
return res;
}

/// Returns the user opt-out URL string.
Future<String?> userOptOutURLString(String sdkId) async {
final res = await _p.userOptOutURLString(jsonEncode({'sdkId': sdkId}));
_logDebug('userOptOutURLString', res);
return res;
}

/// Returns Disable metering for the app due to user opt out.
Future<String?> userOptOut(String sdkId, String url) async {
final res = await _p.userOptOut(jsonEncode({'sdkId': sdkId, 'url': url}));
_logDebug('userOptOut', res);
return res;
}

/// Returns the meter version string.
Future<String?> getMeterVersion(String sdkId) async {
final res = await _p.getMeterVersion(jsonEncode({'sdkId': sdkId}));
_logDebug('getMeterVersion', res);
return res;
}

/// Returns the demographicId string.
Future<String?> getDemographicId(String sdkId) async {
final res = await _p.getDemographicId(jsonEncode({'sdkId': sdkId}));
_logDebug('getDemographicId', res);
return res;
}

/// Returns the deviceId string.
Future<String?> getDeviceId(String sdkId) async {
final res = await _p.getDeviceId(jsonEncode({'sdkId': sdkId}));
_logDebug('getDeviceId', res);
return res;
}

/// Returns the vendorId string (if implemented natively).
Future<String?> getVendorId(String sdkId) async {
final res = await _p.getVendorId(jsonEncode({'sdkId': sdkId}));
_logDebug('getVendorId', res);
return res;
}

/// Returns the FPID string (if implemented natively).
Future<String?> getFpId(String sdkId) async {
final res = await _p.getFpId(jsonEncode({'sdkId': sdkId}));
_logDebug('getFpid', res);
return res;
}
}

</syntaxhighlight>

== API Reference & Examples ==

* '''createInstance'''

Creates a new Nielsen SDK instance and returns a unique sdkId string for future calls.
<syntaxhighlight>
final sdkId = await NielsenFlutterPlugin.instance.createInstance({
"appid": "PXXXX-XXXX-XXXX",
"sfcode": "us",
"nol_devDebug": "DEBUG",
});
</syntaxhighlight>

* '''free'''

Releases the Nielsen SDK instance associated with the sdkId. Should be called when the session ends.
<syntaxhighlight>
await NielsenFlutterPlugin.instance.free(sdkId);
</syntaxhighlight>

* '''loadMetadata'''

Loads content metadata for the current session.
<syntaxhighlight>
await NielsenFlutterPlugin.instance.loadMetadata(sdkId, {
"type": "content",
"assetid": "video123",
"program": "Example Show",
});
</syntaxhighlight>

* '''play'''

Signals the start of content playback.
<syntaxhighlight>
await NielsenFlutterPlugin.instance.play(sdkId);
</syntaxhighlight>

* '''stop'''

Signals that playback has been paused or stopped.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.stop(sdkId);
</syntaxhighlight>

* '''end'''

Signals the end of content playback.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.end(sdkId);

</syntaxhighlight>

* '''staticEnd'''

Signals the end of a static (non-video) content view.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.staticEnd(sdkId);

</syntaxhighlight>

* '''setPlayheadPosition'''

Updates the SDK with the current playhead position in seconds.
<syntaxhighlight>

await NielsenFlutterPlugin.instance.setPlayheadPosition(sdkId, 120);

</syntaxhighlight>

* '''Identifiers & Info'''

Retrieve various IDs and version information from the SDK.

<syntaxhighlight>

final versionNumber = await NielsenFlutterPlugin.instance.getMeterVersion(sdkId);
final fpid = await NielsenFlutterPlugin.instance.getFpid(sdkId);
final vendorId = await NielsenFlutterPlugin.instance.getVendorId(sdkId);
final deviceId = await NielsenFlutterPlugin.instance.getDeviceId(sdkId);
final version = await NielsenFlutterPlugin.instance.getMeterVersion(sdkId);

</syntaxhighlight>

* '''Opt-Out'''

Check the user's opt-out status and get the URL for the opt-out web page.
<syntaxhighlight>

final status = await NielsenFlutterPlugin.instance.getOptOutStatus(sdkId);
final url = await NielsenFlutterPlugin.instance.userOptOutURLString(sdkId);
</syntaxhighlight>

* '''UserOptOut'''

Disable metering for the app due to user opt out.
<syntaxhighlight>

final userOptOut = await NielsenFlutterPlugin.instance.userOptOut(sdkId, url);
</syntaxhighlight>

* '''sendID3'''

Passes raw ID3 tags to the SDK for live/linear content measurement.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.sendID3(sdkId, rawId3Tag);
</syntaxhighlight>

* '''enableDebugLogs'''

Call this one before you create any Nielsen instance. It enables debug logs from the Nielsen Flutter plugin.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.enableDebugLogs(true);

</syntaxhighlight>

== Error Handling (iOS Specific) ==

The plugin surfaces descriptive error codes if an API is called incorrectly or in an invalid state. Errors are logged to the console but are designed not to crash the application.

{| class="wikitable"
|-
! Error Code !! Error Description
|-
|NLS_JSON_INVALID||The JSON passed to the API is invalid or cannot be parsed
|-
|NLS_ARGS_MISSING||One or more required arguments are missing
|-
|NLS_SDK_NOT_FOUND||No active SDK instance was found for the given sdkId
|-
|NLS_INIT_FAILED||Nielsen SDK initialization failed
|-
|NLS_METHOD_UNSUPPORTED||The requested API method is not supported in this context
|-
|NLS_PLAYHEAD_INVALID||Playhead position is missing or not valid (expected seconds)
|}
Example Log:
[NielsenFlutterPlugin][ERROR] NLS_SDK_NOT_FOUND: No active SDK instance was found for the given sdkId - Unknown sdkId: 12345

Android SDK Release Notes

2025-10-17T11:17:34Z

AnkitAgrawal:

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}
== Release 10.1.0.0 (10-17-2025) ==
*Support for FPID multi-instance integrations.
*Support for Flutter cross-platform plugin.
*Other bug fixes and enhancements.

== Release 10.0.0.0 (04-04-2025) ==
*Support for DTVR Subminute product.
*Support for DCR video playhead bridging.
*Support for Ethernet network connection for TV platforms.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.

== Release 9.4.0.0 (07-09-2024) ==
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Upgraded SDK to use Java 11 and Kotlin 1.8.0.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for capturing user opt-out during initialization.
== Release 9.2.0.0 (9-27-2023) ==
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF)
*Viewability: allow enabling by product (DCR, DTVR)
*Other bug fixes and enhancements

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* Kotlin-Java interoperability implementation in SDK.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Support for EMM AGF AdID-less solution.
* Enabled SDK to capture network availability changes.
* Removed the usage of deprecated network classes.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for SDK build variants - AD/NoAD/NoID.
* Support to indicate ID used for AD build variant - AD ID vs Android ID.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* FPID and VendorID support.
* Support for Android apps running on ChromeOS.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==

* Application background/foreground state auto-detection (AndroidX)
* Fixed forward rewind evdata containing negative values
* Offline viewing measurement enhancements
* Revisited precedence logic for sfcode parameter
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==

* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Removal of Location Module from SDK Code.
* Fixed the getOptoutStatus() api, so that client can call it in main thread.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other enhancements and fixes.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Bug fixes and improvements

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.26 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value is reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping
*Fix for last playhead call that is not processed (when there is no time-gap between the last playhead and end call)

== Release 5.1.1.24 (6-2-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for metadata carry over between channels after a channel change

== Release 5.1.1.18 (1-24-2017) ==
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance through encryption process change
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.14 (12-10-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Collection of additional device information
*Opt-out pages based on locale and country
*Opt-out based on the ‘Limit Ad Tracking’ flag
*Issue a warning in client developer’s console when an ad is being played for more than 5 minutes
*Reduced load time of Android SDK, caused due to encryption.
*Limit the duration reported for App launch
*Modification to accept non-JSON strings
*Fixed
**Incorrect DRM placement ID
**DRM pings sent in bursts in case of time change

== Release 5.1.1.10 (10-19-2016) ==
*Fixed an issue where SDK will send a burst of data pings in Android.

== Release 5.1.1.7 (9-1-2016) ==
*Support for Android N
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.4 (8-1-2016) ==
*Support for Pause timeout (from 30 minutes to 5 minutes)

== Release 5.1.1.3 (7-7-2016) ==
*Sending event level (button press data) data to census collections.
*Changes in OTT when switching from mobile to Chromecast
*General bug fix and performance improvements

== Release 5.1.0.4 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
*All the products should be migrated to the latest SDK.
*This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for Android 6.0 Marshmallow
*General bug fix and performance improvements

== Release 1.2.3.8 (1-10-2015) ==

TVOS SDK Release Notes

2025-10-17T11:15:34Z

AnkitAgrawal:

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
== Release 10.1.0.0 (10-17-2025) ==
*Support for FPID multi-instance integrations.
*Support for Flutter cross-platform plugin.
*Support for Apple's iOS26/tvOS26 Log Visibility Changes.
*Other bug fixes and enhancements.
==Release 10.0.0.0 (04-04-2025)==
* Support for DTVR Subminute product.
*Support for DCR video playhead bridging.
*Support for VisionOS platform.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.
== Release 9.4.0.0 (07-09-2024) ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
==Release 9.3.0.0 (05-10-2024)==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (9-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Nielsen SDK support for Xcode 10 and tvOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.17 (1-23-2017) ==
*Added "seconds" place to the launch ping
*Ability to opt-out using "Limit Ad Tracking" feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the "Limit Ad Tracking" flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.7 (9-13-2016) ==
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Includes a sample TVOS application used to assist during integration.
*Support for TVML based optout pages
*General bug fix and performance improvements

== Release 5.1.0.7 (6-15-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Support for Pause timeout
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature

iOS SDK Release Notes

2025-10-17T11:14:31Z

AnkitAgrawal:

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}

== Release 10.1.0.0 (10-17-2025) ==
*Support for FPID multi-instance integrations.
*Support for Flutter cross-platform plugin.
*Support for Apple's iOS26/tvOS26 Log Visibility Changes.
*Other bug fixes and enhancements.

== Release 10.0.0.0 (04-04-2025) ==
*Support for DTVR Subminute product.
*Support for DCR video playhead bridging.
*Support for VisionOS platform.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.

== '''Release 9.4.0.0 (07-09-2024)''' ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (09-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (03-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Support for Xcode 10 and iOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.29 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 (5-31-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 (5-5-2017) ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 (4-3-2017) ==
*Fix for muting background music apps

== Release 5.1.1.18 (2-3-2017) ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 (1-23-2017) ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 (10-18-2016) ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 (9-13-2016) ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

== Release 3.2.1.26 (1-10-2015) ==

Digital Measurement Android Suffix Guide

2025-10-17T11:02:01Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{Breadcrumb|Digital_Measurement_Android_Artifactory_Guide}} {{CurrentBreadcrumb}}
[[Category:Digital]]

= Android app sdk version suffix=
We have added an extra third character in the build version of appsdk to represent the android-x support in appsdk.

From onwards now you will see meter version of app sdk ending with 5 characters suffix as <code>aa.8.2.0.0_{suffix}</code> .

Below are details of possible suffix characters with description

{| class="wikitable"
|-
! Character Index in suffix !! Possible Values!! Description
|-
|0 (first character in suffix)||g,a and v||<code>g</code> means it's the GLOBAL flavored sdk (Default).<br><code>a</code> means the build was designed for AGF.<br><code>v</code> identifies the VRI flavoured sdk.
|-
|1 (second character in suffix)||a,s and l ||<code>a</code> means the sdk is coming from github as a gradle dependency.<br><code>s</code> sdk is integrated as jar.<br> <code>l</code> sdk is coming from adobe launch.
|-
|2 (third character in suffix)||a and x ||<code>a</code> means the sdk is built for non androidx apps.<br><code>x</code> means the sdk is built for '''androidx''' apps.<br>
|-
|3 (fourth character in suffix)||a, n and k||<code>a</code> means AdSupport included. (Default)<br><code>n</code> no AdSupport included.<br><code>k</code> No IDFA or IDFV (kids framework).<br>
|-
|4 (fifth character in suffix)||o and t||<code>o</code> means the sdk is getting instantiated using the AppSdk class. (Default)<br><code>t</code> means sdk is using NielsenEventTracker class.<br>
|-
|5 (sixth character in suffix)||h,w,r,f and n||<code>h</code> then sdk supports Hybrid Webviews.<br> <code>w</code> identifies React Native Webview support.<br><code>r</code> sdk supports React Native standard bridge.
<code>f</code> sdk supports Flutter plugin.<br><code>n</code> means sdk supports Native apps.
|-
|6 (seventh character in suffix)||g,s and n||<code>g</code> the sdk will request the Google Advertising ID.<br> <code>s</code> the sdk will request the Secure Android ID.<br><code>n</code> the sdk will not request any ID. (EG: Not Applicable)
|}
Below are few examples of possible suffix in app sdk meter version

* '''aa.8.2.0.0_gaxaohg'''
** Sdk version 8.2.0.0
** '''GLOBAL flavour'''
** integrated as '''gradle dependency'''
** '''android x'''
** AdSupport
** using AppSdk class to instantiate
** Hybrid Webview support
** Google Ad ID
<br>
* '''aa.8.2.0.0_vaxkons'''
**Sdk version 8.2.0.0
** '''VRI flavour'''
** integrated as '''gradle dependency'''
** supporting '''android x'''
** Kids framework
** using AppSdk class to instantiate
** native app.
** Secure Android ID
<br>

DCR & DTVR Flutter Integration

2025-10-15T19:35:42Z

AnkitAgrawal: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}} Category:Digital = Integrate Nielsen SDK Api in Flutter App = == Overview == The Nielsen Flutter Plugin provides a Dart API that bridges into the native Nielsen App SDKs (iOS and Android) using Flutter’s platform channels. Flow: Dart → Platform Channel → iOS/Android Plugin → Nielsen App SDK Supports SDK flavors: Global, GlobalAd, GlobalNoAd, AGF, AGFNoAd, AGFNoId Each..."

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]
= Integrate Nielsen SDK Api in Flutter App =

== Overview ==

The Nielsen Flutter Plugin provides a Dart API that bridges into the native Nielsen App SDKs (iOS and Android) using Flutter’s platform channels.

Flow: Dart → Platform Channel → iOS/Android Plugin → Nielsen App SDK

Supports SDK flavors: Global, GlobalAd, GlobalNoAd, AGF, AGFNoAd, AGFNoId

Each flavor corresponds to a different Nielsen SDK package. You select the one required by your business case in the pubspec.yaml.
<p style="color:#C70039;">Note : Support for Flutter in Nielsen SDK is available from version 10.1.0.0</p>

== 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.

== Setting up your Environment ==
* '''Add dependency in pubspec.yaml'''
<syntaxhighlight>
dependencies:
nielsen_flutter_plugin:
git:
url: https://github.com/NielsenDigitalSDK/flutter.git
# The path below is for the 'Global' flavor.
# See the table below to select the path for other flavors.
path: Flutter/FlutterPlugin/Global/nielsen_flutter_plugin/nielsen_flutter_plugin
ref: main

</syntaxhighlight>

* '''Select Your SDK Flavor Path'''

Use the following path values to select the appropriate Nielsen SDK flavor:

{| class="wikitable"
|-
! Flavor !! Flavor path in pubspec.yaml
|-
|Global||Flutter/FlutterPlugin/Global/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|GlobalAd||Flutter/FlutterPlugin/GlobalAd/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|GlobalNoAd||Flutter/FlutterPlugin/GlobalNoAd/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|AGF||Flutter/FlutterPlugin/AGF/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|AGFNoAd||Flutter/FlutterPlugin/AGFNoAd/nielsen_flutter_plugin/nielsen_flutter_plugin
|-
|AGFNoId||Flutter/FlutterPlugin/AGFNoId/nielsen_flutter_plugin/nielsen_flutter_plugin
|}

* '''Import the plugin in your Dart code'''
<syntaxhighlight>
import 'package:nielsen_flutter_plugin/nielsen_flutter_plugin.dart';
</syntaxhighlight>

== Public API's ==

All API methods are static and require the sdkId that is returned by createInstance.

<syntaxhighlight>

import 'dart:convert';
import 'package:flutter/foundation.dart';
import 'package:nielsen_flutter_plugin_platform_interface/nielsen_flutter_plugin_platform_interface.dart';

/// Nielsen App SDK – Flutter Public APIs.
class NielsenFlutterPlugin {
NielsenFlutterPlugin._();
static final NielsenFlutterPlugin instance = NielsenFlutterPlugin._();

NielsenFlutterPluginPlatform get _p => NielsenFlutterPluginPlatform.instance;

bool _debugLogging = false;

/// Enable/disable debug logging of raw native responses.
void enableDebugLogs(bool enable) {
_debugLogging = enable;
}

void _logDebug(String api, String? res) {
if (_debugLogging) {
debugPrint('[NielsenFlutterPlugin] $api → $res');
}
}

// ----------------------------------------------------------------------
// Instance lifecycle
// ----------------------------------------------------------------------

/// Creates a Nielsen SDK instance with the provided app info.
/// Returns the generated sdkId string.
Future<String?> createInstance(Map<String, dynamic> appInfo) async {
final res = await _p.createInstance(jsonEncode(appInfo));
_logDebug('createInstance', res);
return res;
}

/// Releases a previously created Nielsen SDK instance.
Future<void> free(String sdkId) async {
final res = await _p.free(jsonEncode({'sdkId': sdkId}));
_logDebug('free', res);
}

// ----------------------------------------------------------------------
// Playback lifecycle and metadata
// ----------------------------------------------------------------------

/// Signals playback start and passes play metadata.
Future<void> play(String sdkId, Map<String, dynamic> playData) async {
final res =
await _p.play(jsonEncode({'sdkId': sdkId, 'playdata': playData}));
_logDebug('play', res);
}

/// Loads content/ad/static metadata into the active measurement session.
Future<void> loadMetadata(String sdkId, Map<String, dynamic> metadata) async {
final res = await _p
.loadMetadata(jsonEncode({'sdkId': sdkId, 'metadata': metadata}));
_logDebug('loadMetadata', res);
}

/// Notifies a temporary stop/pause/interruption in playback.
Future<void> stop(String sdkId) async {
final res = await _p.stop(jsonEncode({'sdkId': sdkId}));
_logDebug('stop', res);
}

/// Ends the playback measurement session.
Future<void> end(String sdkId) async {
final res = await _p.end(jsonEncode({'sdkId': sdkId}));
_logDebug('end', res);
}

/// Ends a static content session (if used in your workflow).
Future<void> staticEnd(String sdkId) async {
final res = await _p.staticEnd(jsonEncode({'sdkId': sdkId}));
_logDebug('staticEnd', res);
}

/// Updates the playhead position (in seconds).
Future<void> setPlayheadPosition(String sdkId, int positionSeconds) async {
final res = await _p.setPlayheadPosition(
jsonEncode({'sdkId': sdkId, 'position': '$positionSeconds'}),
);
_logDebug('setPlayheadPosition', res);
}

/// Reporting OTT update event to the SDK.
Future<void> updateOTT(String sdkId, Map<String, dynamic> ottData) async {
final res =
await _p.updateOTT(jsonEncode({'sdkId': sdkId, 'ottData': ottData}));
_logDebug('updateOTT', res);
}

// ----------------------------------------------------------------------
// Timed metadata (ID3)
// ----------------------------------------------------------------------

/// Sends ID3 timed metadata to the SDK.
Future<void> sendID3(String sdkId, String id3) async {
final res = await _p.sendID3(jsonEncode({'sdkId': sdkId, 'sendID3': id3}));
_logDebug('sendID3', res);
}

// ----------------------------------------------------------------------
// Information / getters
// ----------------------------------------------------------------------

/// Returns opt-out status as a string ("true"/"false").
Future<String?> getOptOutStatus(String sdkId) async {
final res = await _p.getOptOutStatus(jsonEncode({'sdkId': sdkId}));
_logDebug('getOptOutStatus', res);
return res;
}

/// Returns the user opt-out URL string.
Future<String?> userOptOutURLString(String sdkId) async {
final res = await _p.userOptOutURLString(jsonEncode({'sdkId': sdkId}));
_logDebug('userOptOutURLString', res);
return res;
}

/// Returns Disable metering for the app due to user opt out.
Future<String?> userOptOut(String sdkId, String url) async {
final res = await _p.userOptOut(jsonEncode({'sdkId': sdkId, 'url': url}));
_logDebug('userOptOut', res);
return res;
}

/// Returns the meter version string.
Future<String?> getMeterVersion(String sdkId) async {
final res = await _p.getMeterVersion(jsonEncode({'sdkId': sdkId}));
_logDebug('getMeterVersion', res);
return res;
}

/// Returns the demographicId string.
Future<String?> getDemographicId(String sdkId) async {
final res = await _p.getDemographicId(jsonEncode({'sdkId': sdkId}));
_logDebug('getDemographicId', res);
return res;
}

/// Returns the deviceId string.
Future<String?> getDeviceId(String sdkId) async {
final res = await _p.getDeviceId(jsonEncode({'sdkId': sdkId}));
_logDebug('getDeviceId', res);
return res;
}

/// Returns the vendorId string (if implemented natively).
Future<String?> getVendorId(String sdkId) async {
final res = await _p.getVendorId(jsonEncode({'sdkId': sdkId}));
_logDebug('getVendorId', res);
return res;
}

/// Returns the FPID string (if implemented natively).
Future<String?> getFpId(String sdkId) async {
final res = await _p.getFpId(jsonEncode({'sdkId': sdkId}));
_logDebug('getFpid', res);
return res;
}
}

</syntaxhighlight>

== API Reference & Examples ==

* '''createInstance'''

Creates a new Nielsen SDK instance and returns a unique sdkId string for future calls.
<syntaxhighlight>
final sdkId = await NielsenFlutterPlugin.instance.createInstance({
"appid": "PXXXX-XXXX-XXXX",
"sfcode": "us",
"nol_devDebug": "DEBUG",
});
</syntaxhighlight>

* '''free'''

Releases the Nielsen SDK instance associated with the sdkId. Should be called when the session ends.
<syntaxhighlight>
await NielsenFlutterPlugin.instance.free(sdkId);
</syntaxhighlight>

* '''loadMetadata'''

Loads content metadata for the current session.
<syntaxhighlight>
await NielsenFlutterPlugin.instance.loadMetadata(sdkId, {
"type": "content",
"assetid": "video123",
"program": "Example Show",
});
</syntaxhighlight>

* '''play'''

Signals the start of content playback.
<syntaxhighlight>
await NielsenFlutterPlugin.instance.play(sdkId);
</syntaxhighlight>

* '''stop'''

Signals that playback has been paused or stopped.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.stop(sdkId);
</syntaxhighlight>

* '''end'''

Signals the end of content playback.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.end(sdkId);

</syntaxhighlight>

* '''staticEnd'''

Signals the end of a static (non-video) content view.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.staticEnd(sdkId);

</syntaxhighlight>

* '''setPlayheadPosition'''

Updates the SDK with the current playhead position in seconds.
<syntaxhighlight>

await NielsenFlutterPlugin.instance.setPlayheadPosition(sdkId, 120);

</syntaxhighlight>

* '''Identifiers & Info'''

Retrieve various IDs and version information from the SDK.

<syntaxhighlight>

final versionNumber = await NielsenFlutterPlugin.instance.getMeterVersion(sdkId);
final fpid = await NielsenFlutterPlugin.instance.getFpid(sdkId);
final vendorId = await NielsenFlutterPlugin.instance.getVendorId(sdkId);
final deviceId = await NielsenFlutterPlugin.instance.getDeviceId(sdkId);
final version = await NielsenFlutterPlugin.instance.getMeterVersion(sdkId);

</syntaxhighlight>

* '''Opt-Out'''

Check the user's opt-out status and get the URL for the opt-out web page.
<syntaxhighlight>

final status = await NielsenFlutterPlugin.instance.getOptOutStatus(sdkId);
final url = await NielsenFlutterPlugin.instance.userOptOutURLString(sdkId);
</syntaxhighlight>

* '''UserOptOut'''

Disable metering for the app due to user opt out.
<syntaxhighlight>

final userOptOut = await NielsenFlutterPlugin.instance.userOptOut(sdkId, url);
</syntaxhighlight>

* '''sendID3'''

Passes raw ID3 tags to the SDK for live/linear content measurement.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.sendID3(sdkId, rawId3Tag);
</syntaxhighlight>

* '''enableDebugLogs'''

Call this one before you create any Nielsen instance. It enables debug logs from the Nielsen Flutter plugin.

<syntaxhighlight>

await NielsenFlutterPlugin.instance.enableDebugLogs(true);

</syntaxhighlight>

== Error Handling (iOS Specific) ==

The plugin surfaces descriptive error codes if an API is called incorrectly or in an invalid state. Errors are logged to the console but are designed not to crash the application.

{| class="wikitable"
|-
! Error Code !! Error Description
|-
|NLS_JSON_INVALID||The JSON passed to the API is invalid or cannot be parsed
|-
|NLS_ARGS_MISSING||One or more required arguments are missing
|-
|NLS_SDK_NOT_FOUND||No active SDK instance was found for the given sdkId
|-
|NLS_INIT_FAILED||Nielsen SDK initialization failed
|-
|NLS_METHOD_UNSUPPORTED||The requested API method is not supported in this context
|-
|NLS_PLAYHEAD_INVALID||Playhead position is missing or not valid (expected seconds)
|}
Example Log:
[NielsenFlutterPlugin][ERROR] NLS_SDK_NOT_FOUND: No active SDK instance was found for the given sdkId - Unknown sdkId: 12345

US DCR & DTVR

2025-10-15T15:47:32Z

AnkitAgrawal: /* AppSDK Flutter Plugin */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== AppSDK Flutter Plugin ==
{| class="wikitable"
| colspan="6" | Flutter Integration Guides (Flutter support is part of [[Special:Downloads|Nielsen's AppSDK V10.1.0]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Flutter_Integration|DCR & DTVR Flutter Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
<br><br>
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

US DCR & DTVR

2025-10-15T15:39:34Z

AnkitAgrawal: /* AppSDK Flutter Plugin */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== AppSDK Flutter Plugin ==
{| class="wikitable"
| colspan="6" | Flutter Integration Guides (flutter support is part of [[Special:Downloads|Nielsen's AppSDK V10.1.0]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Flutter_Integration|DCR & DTVR Flutter Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
<br><br>
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

US DCR & DTVR

2025-10-15T15:28:37Z

AnkitAgrawal: /* AppSDK f Plugin */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== AppSDK f Plugin ==
{| class="wikitable"
| colspan="6" | F Integration Guides (f support is part of [[Special:Downloads|Nielsen's AppSDK V10.1.0]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR F Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
<br><br>
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

US DCR & DTVR

2025-10-15T15:27:50Z

AnkitAgrawal: /* AppSDK Flutter Plugin */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== AppSDK f Plugin ==
{| class="wikitable"
| colspan="6" | F Integration Guides (Flutter support is part of [[Special:Downloads|Nielsen's AppSDK V10.1.0]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR F Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
<br><br>
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

US DCR & DTVR

2025-10-15T15:10:03Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
{{CategoryIcon|DCR.png|US Digital Content Ratings (DCR) & Digital in TV Ratings (DTVR)}}

__NOTOC__

{| class="wikitable"
! colspan="3"| Start Here
|-
| rowspan="7" |
| '''Step-By-Step SDK Integration Guides ([[BSDK Step By Step|Browser]], [[Android Step By Step|Android]], [[iOS Step By Step|iOS]])'''
| '''API Reference Tables ([[Browser_SDK_API_Table|Browser]], [[Android_SDK_API_Table|Android]], [[iOS_SDK_API_Table|iOS]])'''
|-
| '''[[DCR_vs_DTVR|DCR vs. DTVR Implementation - Key Differences]]'''
| '''Product Information - [https://markets.nielsen.com/us/en/solutions/capabilities/digital-content-ratings/ DCR], [https://www.nielsen.com/solutions/audience-measurement/national-tv/ DTVR]'''
|}

{| class="wikitable"
! colspan="3"| General Reference
|-
| '''[[Digital Measurement Onboarding]]'''
| '''[[Digital Measurement Metadata]]'''
| '''[[Digital Measurement Testing]]'''
|-
| '''[[Digital Measurement Interruption Scenarios]]'''
| '''[[Digital Measurement FAQ]]'''
| '''SDK Release Notes - [[Browser_SDK_Release_Notes|Browser]], [[Android_SDK_Release_Notes|Android]], [[iOS_SDK_Release_Notes|iOS]], [[TVOS_SDK_Release_Notes|TVOS]], [[DOMless SDK Release Notes|DOMless]]'''
|-
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Measurement Persistent Identifiers]]'''
|-
|[[Dual Instances of SDK|'''Dual Instances of SDK''']]
|
|
|}

== SDK - Video ==
{| class="wikitable"
| colspan="6" | Maintaining an existing ''DCR'' or ''DTVR'' App integration? Continue to reference the API you're already using with the guides below.
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="4" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Video Browser SDK]]'''
| '''[[DTVR Browser SDK]]'''
| [[Browser SDK API Reference]]
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Video Domless SDK]]'''
|'''[[DTVR Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== SDK - Static ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 55%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="9" | {{SmallIcon|SDKIcon.png|alt=SDK}}
| rowspan="9" | {{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Static iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Static Android SDK]]'''
| [[Android SDK API Reference]]
|-
| rowspan="2" | {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR Static Browser SDK]]'''
| rowspan="5" | [[Browser SDK API Reference]]
|-
| '''[[DCR Static Lite Browser SDK]]'''
|-
| {{OSIcon|GoogleTagManagerIcon.png|alt=Google Tag Manager}}
| '''[[DCR Static Google Tag Manager]]'''
|-
| {{OSIcon|FacebookIcon.png|alt=Facebook Instant Articles}}
| '''[[DCR Static Facebook Instant Articles Browser SDK]]'''
|-
| {{OSIcon|Tealium_Icon.png|alt=Tealium}}
| '''[[DCR Static Tealium]]'''
|-
| {{OSIcon|AMPIcon.png|alt=Google AMP}}
| '''[[DCR Static Google AMP Cloud API]]'''
|
|-
|{{OSIcon|BrowserIcon.png|alt=Browser}}
|'''[[DCR Static Domless SDK]]'''
|[[Domless SDK API Reference]]
|}

== Xamarin ==
{| class="wikitable"
| colspan="6" | Xamarin Integration Guides (Xamarin support is part of [[Special:Downloads|Nielsen's AppSDK V8]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Xamarin Integration]]'''
|}

== AppSDK Flutter Plugin ==
{| class="wikitable"
| colspan="6" | Flutter Integration Guides (Flutter support is part of [[Special:Downloads|Nielsen's AppSDK V10.1.0]] and above.)
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|APIIcon.png|alt=Xamarin}}
| colspan="2" | '''[[DCR_%26_DTVR_Xamarin_Integration|DCR & DTVR Flutter Integration]]'''
|}

== Cloud API ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| DCR Implementation Guide
|-
| rowspan="3" | {{SmallIcon|CloudAPIIcon.png|alt=Cloud API}}
| rowspan="3" |
{{OSIcon|VideoIcon.png|alt=Video}}
<br><br>
{{OSIcon|StaticIcon.png|alt=Static Content}}
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Cloud API ]]'''
|-
| {{OSIcon|APIIcon.png|alt=Cloud API}}
| '''[[DCR Video & Static Mobile Cloud API ]]'''
|-
| {{OSIcon|RokuIcon.png|alt=Roku}}
| '''[[DCR Video & Static Roku Cloud API]]'''
|}

== Adobe Launch Extensions ==
{| class="wikitable"
| colspan="6" | Leverage Launch by Adobe? The guides below describe how to integrate DCR and DTVR with Nielsen's Adobe Launch extension
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
!| Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
|
|
| colspan="2" | '''[[Digital Measurement Onboarding Adobe ]]'''
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR & DTVR iOS Adobe Launch Extension]]'''
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR & DTVR Android Adobe Launch Extension]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[DCR & DTVR Browser Adobe Launch Extension]]'''
|}

== SDK - Connected TV ==
{| class="wikitable"
| colspan="6" | The guides below describe how to integrate DCR and DTVR with Smart tv's
|-
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! | Implementation Guide
|-
| rowspan="8" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video TizenTv]]'''
|-
| {{OSIcon|BrowserIcon.png|alt=Browser}}
| '''[[Digital Measurement Video webOS]]'''
|}

TVOS SDK Release Notes

2025-05-08T02:53:40Z

AnkitAgrawal:

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
==Release 10.0.0.0 (04-04-2025)==
* Support for DTVR Subminute product.
*Support for DCR video playhead bridging.
*Support for VisionOS platform.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.
== Release 9.4.0.0 (07-09-2024) ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
==Release 9.3.0.0 (05-10-2024)==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (9-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Nielsen SDK support for Xcode 10 and tvOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.17 (1-23-2017) ==
*Added "seconds" place to the launch ping
*Ability to opt-out using "Limit Ad Tracking" feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the "Limit Ad Tracking" flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.7 (9-13-2016) ==
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Includes a sample TVOS application used to assist during integration.
*Support for TVML based optout pages
*General bug fix and performance improvements

== Release 5.1.0.7 (6-15-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Support for Pause timeout
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature

DCR Video Android SDK

2025-04-04T21:58:35Z

AnkitAgrawal: /* Interruptions during playback */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of 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 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.

{{Android_Prerequisites_and_Implementation_Overview}}

__TOC__

{{Android_Setting_Up_Development_Environment}}

{{Android_SDK_Initialization}}

== 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.

== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles 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 unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* 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, 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.
<syntaxhighlight lang="java">
JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "The Big Bang Theory")
.put("title", "The Pants Alternative S03E18")
.put("crossId1", "EP009311820061") //optional
.put("crossId2", "Content Originator") //optional
.put("length", "3600")
.put("isfullepisode", "yes")
.put("airdate", "2022-03-21T10:05:00")
.put("adloadtype", "2")
.put("segB", "CustomSegmentValueB") //optional
.put("segC", "CustomSegmentValueC") //optional

</syntaxhighlight>

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{{DCR Content Metadata}}

=== 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> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to Ad || custom <br>(no [[Special Characters]]) || ✓
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== Sequence of Calls ==
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
<syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>

=== loadMetadata ===
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>

=== playheadPosition ===
<syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>

=== stop ===
<syntaxhighlight lang="java">public void stop()</syntaxhighlight>

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
<syntaxhighlight lang="java">public void end()</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play];</code> || // call at start of each new stream
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter setplayheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer<br/>
VOD: || current position in seconds <br/>
Live: current Unix timestamp (seconds since Jan-1-1970 UTC) <br/>
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. <br/>
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
<blockquote>Note: For livestream, send the Unix timestamp; for VOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''setplayheadPosition'''</code> – Call this API every one second when playhead position timer is fired. If a LIVE event, use the current Unix timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''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 set to <code>true</code>

<blockquote>'''Note:''' For API Version 5.1 and above, 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, <code>'''loadMetadata''' </code> and <code>'''playheadPosition'''</code> </blockquote>

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
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 / 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.
{| 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
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<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 Advertisements ====
Call [[play()]]

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 / 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()]].

'''Ad Content'''
<syntaxhighlight lang="java"> long pos = mAdPlayer.videoPosition() / 1000;
if (mAppSdk != null)
{
mAppSdk.setPlayheadPosition(pos);
}</syntaxhighlight>
<blockquote>Note: The playhead positions for ad and content should be maintained separately.</blockquote>

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(); </code> || // stream starts
|-
| <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="3" | 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> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <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="1" | 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 [[DCR_Video_Android_SDK#The_SdkBgFgDetectionUtility_class|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 [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/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 [https://engineeringportal.nielsen.com/docs/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());
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).
== Using the NielsenAppSDKJSHandler ==
There could be a scenario in which a browser page, that is already tagged with the Nielsen BSDK, needs to be loaded via a webview. In this situation it is recommended to use the '''NielsenAppSDKJSHandler''' which will allow communication between the AppSDK and the BSDK.
<br>

'''This feature is supported in versions 7.2 and above.'''
<br>

=== Implementation ===
* Make sure you have the latest AppSdk.jar from Nielsen
* Enable the javascript on webview using below lines
<br>
<syntaxhighlight lang=java>
WebSettings webSetting = webView.getSettings();
webSetting.setJavaScriptEnabled(true);
</syntaxhighlight>
<br>
* Add NielsenAppSDKJSHandler instance as javascript interface to webview with name “NielsenAppSDK” like below snippet
<br>
<syntaxhighlight lang=java>
webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext()), "NielsenAppSDK");
</syntaxhighlight>
<br>
This will enable listening to BSDK api calls within the APPSDK. Please make sure your Technical Account Manager is aware that you wish to implement this method so a configuration file can be modified on the Nielsen servers; however, there are '''no changes required to the Browser page'''.

==== Example:====
The below is an example of opening a webview with the NielsenAppSDKJSHandler
<syntaxhighlight lang=java>
WebSettings webSetting = webView.getSettings();
webView.getSettings().setDomStorageEnabled(true);
webSetting.setJavaScriptEnabled(true);
webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext(), ""), "NielsenAppSDK");
String url = "https://nielsen.com.index.htm";
webView.loadUrl(url);
</syntaxhighlight>
<br>
<code>AndroidManifest.xml</code> may need the following permissions set:
<syntaxhighlight lang=java>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
</syntaxhighlight>
<br>

=== Closing NielsenAppSDKJSHandler ===
NielsenAppSDKJSHandler should be closed or cleaned up in below scenarios
* Before WebView is getting destructed
* Before loading new page
* Before closing application
NielsenAppSDKJSHandler provides a public interface with name "close()" and this function should be called on NielsenAppSDKJSHandler's instance in all above scenarios.

<syntaxhighlight lang=java>
// get your webview
WebView webView = findViewById(R.id.webView);

//Added JS Handler instance as java script interface for ggpm api type
NielsenAppSDKJSHandler jshandler = new NielsenAppSDKJSHandler(getApplicationContext(), "");
webView.addJavascriptInterface(jshandler, "NielsenAppSDK");

//Close JS Handler before making webview as null
jshandler.close();
webView = null;
</syntaxhighlight>

== Interruptions during playback ==
As part of integrating Nielsen App SDK with the player application, the 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
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 API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> to resume the viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Pre-Certification Checklists ==
After the application is ready to be sent for Nielsen Certification, please go through the [[Digital Pre-Certification Checklist App SDK]] and ensure the app behaves as expected, before submitting to Nielsen.

{{Template:Android_Privacy_and_Opt-Out}}
== 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.

== Sample Applications ==
The below sample applications have been designed to show the API's functionality and are broken into two distinct categories:
* '''Basic''' - To show the functionality of the Nielsen API using a standard no-frills player.
** [[Android Basic example|Android Studio Example]]

* '''Advanced''' - Nielsen API integrated into a custom video player is bundled with the SDK.

Template:iOS Interuptions during Playback

2025-04-04T21:50:23Z

AnkitAgrawal: /* Interruptions during playback */

== 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
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 API calls – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> to resume the viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

DCR Video Android SDK

2025-04-04T21:47:56Z

AnkitAgrawal: /* Interruptions during playback */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Overview ==
The Nielsen SDK is one of 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 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.

{{Android_Prerequisites_and_Implementation_Overview}}

__TOC__

{{Android_Setting_Up_Development_Environment}}

{{Android_SDK_Initialization}}

== 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.

== Configure Payload ==
=== Handling JSON Metadata ===
All the SDK methods handles 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 unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* 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, 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.
<syntaxhighlight lang="java">
JSONObject contentMetadata = new JSONObject()
//SDK Metadata
.put("type", "content")
.put("assetid", "vid345-67483")
.put("program", "The Big Bang Theory")
.put("title", "The Pants Alternative S03E18")
.put("crossId1", "EP009311820061") //optional
.put("crossId2", "Content Originator") //optional
.put("length", "3600")
.put("isfullepisode", "yes")
.put("airdate", "2022-03-21T10:05:00")
.put("adloadtype", "2")
.put("segB", "CustomSegmentValueB") //optional
.put("segC", "CustomSegmentValueC") //optional

</syntaxhighlight>

=== Content metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{{DCR Content Metadata}}

=== 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> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to Ad || custom <br>(no [[Special Characters]]) || ✓
|}

=== Example Ad Object ===
<syntaxhighlight lang="javascript">
// create ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

== Sequence of Calls ==
=== play ===
Use [[DCR_Video_APP_SDK#play|play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
<syntaxhighlight lang="java"> public void play(JSONObject channelInfo);</syntaxhighlight>

=== loadMetadata ===
<syntaxhighlight lang="java">public void loadMetadata(JSONObject contentMetadata);</syntaxhighlight>

=== playheadPosition ===
<syntaxhighlight lang="java">
public void setPlayheadPosition(long position)
</syntaxhighlight>

=== stop ===
<syntaxhighlight lang="java">public void stop()</syntaxhighlight>

=== end ===
When content stop is initiated and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
<syntaxhighlight lang="java">public void end()</syntaxhighlight>

== Configure API Calls ==

=== Sample API Sequence ===
A Sample API sequence could follow this flow:
{| class="wikitable"
|-
! Type !! Sample code !! Description
|-
|On App Start||<code>[nielsenMeter loadMetadata: contentMetadata];</code> || // contentMetadata Object contains the JSON metadata for the impression
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play];</code> || // call at start of each new stream
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
| Content || <code>[nielsenMeter setplayheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'play' || || Call at start of each new stream
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer<br/>
VOD: || current position in seconds <br/>
Live: current Unix timestamp (seconds since Jan-1-1970 UTC) <br/>
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position || Call during any interruption to content or Ad playback and at the end of each Ad.
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. <br/>
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}
<blockquote>Note: For livestream, send the Unix timestamp; for VOD send the time in seconds as integer. The final playhead position must be sent for the current asset being played before calling <code>'''stop'''</code>, <code>'''end'''</code> or<code> '''loadmetadata'''</code>,.</blockquote>

=== 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. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''setplayheadPosition'''</code> – Call this API every one second when playhead position timer is fired. If a LIVE event, use the current Unix timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – Call when content completes. When called, the SDK instance exits from Processing state.
# '''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 set to <code>true</code>

<blockquote>'''Note:''' For API Version 5.1 and above, 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, <code>'''loadMetadata''' </code> and <code>'''playheadPosition'''</code> </blockquote>

=== API Call Sequence ===
==== Use Case 1: Content has no Advertisements ====
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 / 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.
{| 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
|-
| rowspan="2" | Resume Content || <code>mAppSdk.loadMetadata(contentMetaDataObject);</code> || // Call loadMetadata and pass content metadata object when content resumes
|-
|<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 Advertisements ====
Call [[play()]]

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 / 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()]].

'''Ad Content'''
<syntaxhighlight lang="java"> long pos = mAdPlayer.videoPosition() / 1000;
if (mAppSdk != null)
{
mAppSdk.setPlayheadPosition(pos);
}</syntaxhighlight>
<blockquote>Note: The playhead positions for ad and content should be maintained separately.</blockquote>

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(); </code> || // stream starts
|-
| <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="3" | 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> || // Call stop after midroll occurs
|-
| rowspan="2" | Content Resumes || <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="1" | 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 [[DCR_Video_Android_SDK#The_SdkBgFgDetectionUtility_class|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 [https://engineeringportal.nielsen.com/docs/Android_Background_Foreground SdkBgFgDetectionUtility class]. The [https://engineeringportal.nielsen.com/docs/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 [https://engineeringportal.nielsen.com/docs/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());
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).
== Using the NielsenAppSDKJSHandler ==
There could be a scenario in which a browser page, that is already tagged with the Nielsen BSDK, needs to be loaded via a webview. In this situation it is recommended to use the '''NielsenAppSDKJSHandler''' which will allow communication between the AppSDK and the BSDK.
<br>

'''This feature is supported in versions 7.2 and above.'''
<br>

=== Implementation ===
* Make sure you have the latest AppSdk.jar from Nielsen
* Enable the javascript on webview using below lines
<br>
<syntaxhighlight lang=java>
WebSettings webSetting = webView.getSettings();
webSetting.setJavaScriptEnabled(true);
</syntaxhighlight>
<br>
* Add NielsenAppSDKJSHandler instance as javascript interface to webview with name “NielsenAppSDK” like below snippet
<br>
<syntaxhighlight lang=java>
webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext()), "NielsenAppSDK");
</syntaxhighlight>
<br>
This will enable listening to BSDK api calls within the APPSDK. Please make sure your Technical Account Manager is aware that you wish to implement this method so a configuration file can be modified on the Nielsen servers; however, there are '''no changes required to the Browser page'''.

==== Example:====
The below is an example of opening a webview with the NielsenAppSDKJSHandler
<syntaxhighlight lang=java>
WebSettings webSetting = webView.getSettings();
webView.getSettings().setDomStorageEnabled(true);
webSetting.setJavaScriptEnabled(true);
webView.addJavascriptInterface(new NielsenAppSDKJSHandler(getApplicationContext(), ""), "NielsenAppSDK");
String url = "https://nielsen.com.index.htm";
webView.loadUrl(url);
</syntaxhighlight>
<br>
<code>AndroidManifest.xml</code> may need the following permissions set:
<syntaxhighlight lang=java>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
</syntaxhighlight>
<br>

=== Closing NielsenAppSDKJSHandler ===
NielsenAppSDKJSHandler should be closed or cleaned up in below scenarios
* Before WebView is getting destructed
* Before loading new page
* Before closing application
NielsenAppSDKJSHandler provides a public interface with name "close()" and this function should be called on NielsenAppSDKJSHandler's instance in all above scenarios.

<syntaxhighlight lang=java>
// get your webview
WebView webView = findViewById(R.id.webView);

//Added JS Handler instance as java script interface for ggpm api type
NielsenAppSDKJSHandler jshandler = new NielsenAppSDKJSHandler(getApplicationContext(), "");
webView.addJavascriptInterface(jshandler, "NielsenAppSDK");

//Close JS Handler before making webview as null
jshandler.close();
webView = null;
</syntaxhighlight>

== Interruptions during playback ==
As part of integrating Nielsen App SDK with the player application, the 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
* App going in the Background/Foreground
* Channel / Station Change Scenario
* Unplugging of headphone
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 – <code>'loadMetadata'</code> and <code>'playheadPosition'</code> to resume the viewing session, once the playback resumes.
Please see the [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Interruption_Scenarios Interruption Scenarios Page] for more details

== Pre-Certification Checklists ==
After the application is ready to be sent for Nielsen Certification, please go through the [[Digital Pre-Certification Checklist App SDK]] and ensure the app behaves as expected, before submitting to Nielsen.

{{Template:Android_Privacy_and_Opt-Out}}
== 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.

== Sample Applications ==
The below sample applications have been designed to show the API's functionality and are broken into two distinct categories:
* '''Basic''' - To show the functionality of the Nielsen API using a standard no-frills player.
** [[Android Basic example|Android Studio Example]]

* '''Advanced''' - Nielsen API integrated into a custom video player is bundled with the SDK.

demographicId

2025-04-04T11:22:04Z

AnkitAgrawal: v10.0.0.0 Changes

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}}

Retrieves SDK generated UAID(v10.0.0.0+) or Demographic ID (Device ID) of the current device for legacy versions.
[[Category:Digital]]
[[Category:iOS SDK API Reference]]
== Syntax ==
<syntaxhighlight lang="objective-c">
@property (readonly) NSString *demographicId;
</syntaxhighlight>

== Input Parameters ==
{| class="wikitable"
|-
! Parameter !! Description
|-
| None ||
|}

== Output Parameters ==
{| class="wikitable"
|-
! Output Parameters (Return value) !! Description
|-
| demographicId || Returns a NSString object containing SDK generated UAID(v10.0.0.0+) or Demographic ID (Device ID) of the current device for legacy versions
|}

iOS SDK API Reference

2025-04-04T11:20:57Z

AnkitAgrawal: v10.0.0.0 Changes

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
== Overview ==
The Nielsen SDK is one of 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 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
== Prerequisites ==
To start using the App SDK, the following items are required:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''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 frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|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 information on how to get a Nielsen App SDK and appid.
==SDK Implementation==
Information on how to obtain, how to configure your development environment, and how to Initialize the Nielsen SDK is located in either the [[DCR Video iOS SDK|DCR Implementation Guide,]] or the [[DTVR iOS SDK|DTVR Implementation Guide]] depending on your requirements.
___TOC___

== Nielsen iOS App SDK Application Life Cycle ==

[[File:initialization_appcycle.png|center|link=]]

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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

<blockquote>'''Note:''' For API Version 5.1 and above, 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 <code>'''play'''</code>, <code>'''loadMetadata''' </code> and <code>'''playheadPosition'''</code> </blockquote>

[[File:appsdkTimeline-DCR.png|icon|link=]]
=== Finite-state machine table ===
This table provides the possible changes of state for the SDK instance, when it is in a specific state and receives an API call.
{| class="wikitable"
|-
! API call received !! Initial State !! Idle State !! Processing State !! Disabled State
|-
| <code>[[initWithAppInfo:delegate:]]</code> || IDLE STATE (OR)

DISABLED STATE
|| IDLE STATE || - || -
|-
| <code>[[play]]</code> & <code>[[loadMetadata]]</code>|| - || PROCESSING

STATE
|| - || -
|-
| <code>[[playheadPosition]]</code> || - || - || PROCESSING

STATE
|| -
|-
| <code>[[sendID3]]</code> || - || - || PROCESSING

STATE
|| -
|-
| <code>[[stop]]</code> || - || - || IDLE STATE || -
|-
| <code>[[end]]</code> || - || - || IDLE STATE || -
|-
| <code>[[appDisableApi]]</code>: YES || - || DISABLED

STATE
|| - || -
|-
| <code>[[appDisableApi]]</code>: NO || - || - || - || IDLE STATE (OR)

DISABLED STATE
|-
| <code>[[userOptOut]]</code>: YES || - || - || IDLE STATE || -
|-
| <code>[[userOptOut]]</code>: NO || - || PROCESSING

STATE
| -
| -
|-
| colspan = 5 | '-' indicates that no API call is expected.
|}

=== Handling JSON Metadata ===
All the SDK methods handles 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 unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* 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, 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.
The below is a sample - detailed information on the '''metadata requirements''' are located in either the [[DCR Video iOS SDK|DCR Implementation Guide,]] or the [[DTVR iOS SDK|DTVR Implementation Guide]]
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let contentMetadata = [
"type": "content",
"assetid": "C77664",
"title": "Program S2, E3",
"isfullepisode": "Yes",
"program": "Program Name",
"length": "3600",
"airdate": "20171020 10:05:00",
"adloadtype": "2",
"segB": "CustomSegmentValueB", //optional
"segC": "CustomSegmentValueC", //optional
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "C77664",
@ "title": @ "S2,E3",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20180120 10:00:00",
@ "adloadtype": @ "2",
@ "segB": @ "CustomSegmentValueB", //optional
@ "segC": @ "CustomSegmentValueC", //optional
}
</syntaxhighlight>
}}

== Retrieving ID3 Tags ==
'''Only required for DTVR clients'''<br>
'''Not applicable for German Clients'''<br>

ID3 tags have a payload of about 249 characters and start with "www.nielsen.com".

ID3 tags are extracted by observing a property called timedMetadata on the iOS player item. Now this is done via a concept called KVO (Key Value Observing), where you register interest in a property, and the runtime will let you know when it has changed.

Both the iOS native players have the ability to extract ID3 tags, If any other player apart from iOS native players (AVPlayer, MPMoviePlayer) is used, check and ensure that the player has the capability to extract ID3 tags.

=== Examples of extracting ID3 tags from the iOS Native Player ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
//Setting observer to track timedMetadata
[player addObserver:self
forKeyPath: timedMetadataKey
options: (NSKeyValueObservingOptionNew)
context: &TimedMetadataObserverContext];
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if(keyPath == timedMetadataKey){
if(context == &TimedMetadataObserverContext){

id newMetadataArray = [change objectForKey:NSKeyValueChangeNewKey];
if (newMetadataArray != [NSNull null])
{
array = newMetadataArray;
for (AVMetadataItem *metadataItem in array)
{
//Handling TimedMetadata
[self handleTimedMetadata: metadataItem];
}
}

}
}
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
- (void)handleTimedMetadata:(AVMetadataItem *)timedMetadata
{
// We expect the content to contain plists encoded as timed metadata
// AVPlayer turns these into NSDictionaries

id extraAttributeType = [timedMetadata extraAttributes];
NSString *extraString = nil;
if ([extraAttributeType isKindOfClass:[NSDictionary class]])
{
extraString = [extraAttributeType valueForKey:@"info"];
}
else if ([extraAttributeType isKindOfClass:[NSString class]])
{
extraString = extraAttributeType;
}

NSString *key = [NSString stringWithFormat:@"%@", [timedMetadata key]];

//If tag starts with "www.nielsen.com", then only sending to SDK
if ([key isEqualToString:@"PRIV"] && [extraString rangeOfString:@"www.nielsen.com"].length > 0)
{

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
[nielsenApi sendID3:extraString];
});
}
}
</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">
//Setting observer to track timedMetadata
player.addObserver(self, forKeyPath: timedMetadataKey, options: NSKeyValueObservingOptions.new, context: &TimedMetadataObserverContext)</syntaxhighlight>
------------------------------------------------------
<syntaxhighlight lang="swift">
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {

if keyPath == timedMetadataKey {
if(context == &TimedMetadataObserverContext){
if change != nil {
let timedMetadataArray = change![.newKey]
if timedMetadataArray != nil && (timedMetadataArray! as AnyObject) is Array<Any> {
for item in timedMetadataArray as! [AVMetadataItem] {
//Handling TimedMetadata
self.handleTimedMetadata(metadataItem: item)
}
}
}
}
}
</syntaxhighlight>
------------------------------------------------------
<syntaxhighlight lang="swift">
func handleTimedMetadata(metadataItem: AVMetadataItem) {
guard let extraAttributeType = metadataItem.extraAttributes else {
return
}
let info : AVMetadataExtraAttributeKey = AVMetadataExtraAttributeKey(rawValue: "info")
let extraString = extraAttributeType[info] as AnyObject
let key = metadataItem.key as! String

//If tag starts with "www.nielsen.com", then only sending to SDK
if key == "PRIV" && extraString.range(of: "www.nielsen.com").length > 0 {

DispatchQueue.global(qos: .default).async { () -> Void in
self.nielsenApi?.sendID3(extraString as! String)
}
}
}

</syntaxhighlight>
}}

<blockquote>'''Note:''' ID3 tags are not applicable for International (Germany)</blockquote>

== IOS SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Scenario !! Method / Property !! DTVR !! DAR !! DCR !! International (Germany) !! Description
|-
| Initialize || [[initWithAppInfo:delegate:]] || ✔ || ✔ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| Measurement || [[play]] || ✔ || ✔ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. If this is not called then the “channel name” value populated will be the default value of “defaultChannelName”.
|-
| Measurement || [[loadMetadata]] || ✔ || ✔ || ✔ || ✔ || Used to send ad or content metadata to the SDK in the form of JSON string. Application constructs a JSON hashmap and calls this API.
|-
| Measurement || [[sendID3]] || ✔ || || || || Used to send the ID3 metadata.
|-
| Measurement || [[playheadPosition]] || || || ✔ || ✔ || Used to send the playhead position.
|-
| Measurement || [[stop]] || ✔ || || ✔ || ✔ || Used when playback is paused and when switching between ad and content or content and ad.
|-
| Measurement || [[end]] || ✔ || ✔ || ✔ || ✔ || Used when content playback is complete. This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content
|-
| Measurement || [[staticEnd]] || || || ✔ || ✔ || Used with DCR Static duration in between loadMetadata calls for static content when section name is the same but a new static view event and duration measurement restart is desired
|-
| Measurement || [[updateOTT]] || || || || ✔ || Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| Opt-out || [[optOutURL]] || ✔ || ✔ || ✔ || ✔ || Used to fetch the Nielsen opt-out web page URL.
|-
| Opt-out || [[userOptOut]] || ✔ || ✔ || ✔ || ✔ || Used to supply the response message from opt-out webpage to the SDK.
|-
| Opt-out || [[optOutStatus]] || ✔ || ✔ || ✔ || ✔ || Call this API to retrieve the Opt-Out or Opt-In state.
|-
| Opt-out
| [[appDisableApi]]
(kill switch)
|| ✔ || ✔ || ✔ || ✔ || Used to disable the SDK.
|-
| Viewability<br/>Audibility
| [[trackViewability]]
|| ✔ || || ✔ || ✔ || Used to start the viewability measurement.
|-
| Log || [[lastErrorDict]] || ✔ || ✔ || ✔ || ✔ || Returns SDK error in the form of dictionary if any error has occurred.
|-
| Log || [[lastEventDict]] || ✔ || ✔ || ✔ || ✔ || Returns SDK event in the form of dictionary if any event has occurred.
|-
| Log || [[meterVersion]] || ✔ || ✔ || ✔ || ✔ || Returns the current SDK version.
|-
| Log || [[nielsenId]] || ✔ || ✔ || ✔ || ✔ || Used to get a string defining the Nielsen ID (NUID) number for the device.
|-
| Log || [[demographicId]] || ✔ || ✔ || ✔ || ✔ || Used to retrieve SDK generated UAID(v10.0.0.0+) or Demographic ID (Device ID) of the current device for legacy versions.
|-
| Log || [[deviceId]] || ✔ || ✔ || ✔ || ✔ || Used to get a Device ID of the current device(Introduced in v10.0.0.0).
|-
| Log || [[debug]] || ✔ || ✔ || ✔ || ✔ || Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
|}

== NielsenAppApi Class Description ==
The NielsenAppApi class is the primary application interface to the Nielsen App SDK. For example, after an instance object of the NielsenAppApi class is created and initialized, it can be used by the calling application to collect HLS timed metadata using the SDK’s [[sendID3]]: method. These are the public methods and properties exposed by the NielsenAppApi class:
<syntaxhighlight lang="objective-c">
@interface NielsenAppApi: NSObject

@property (readonly) BOOL optOutStatus;
@property (assign) BOOL appDisableApi;
@property (assign) BOOL debug;
@property (readonly, nonnull) NSString *nielsenId;
@property (readonly, nonnull) NSString *demographicId;
@property (readonly, nonnull) NSString *deviceId;
@property (readonly, nonnull) NSString *firstPartyId;
@property (readonly, nonnull) NSString *vendorId;
@property (readonly, nonnull) NSString *optOutURL;
@property (readonly, nullable) NSString *meterVersion;
@property (readonly, nullable) NSDictionary *lastEventDict;
@property (readonly, nullable) NSDictionary *lastErrorDict;

- (nullable instancetype)initWithAppInfo:(nonnull id)appInfo delegate:(nullable id<NielsenAppApiDelegate>)delegate

- (void)play:(nullable id)channelInfo;
- (void)loadMetadata:(nullable id)metadata;
– (void)stop;
– (void)end;
- (void)playheadPosition:(long long)playheadPos;
- (void)sendID3:(nonnull NSString *)data;
- (void)updateOTT:(nonnull id)ottInfo;
- (BOOL)userOptOut:(nonnull NSString *)optOut;
- (void)trackViewability:(nonnull NSDictionary *)data;

- (nonnull NSString *)getNielsenId __attribute((deprecated(("nielsenId is not used by the SDK anymore"))));
- (nonnull NSString *)optOutURLString __attribute((deprecated(("Please use optOutURL property instead."))));
- (nullable NSString *)getMeterVersion __attribute((deprecated(("Please use meterVersion property instead."))));
- (nullable NSDictionary *)getLastEventDict __attribute((deprecated(("Please use lastEventDict property instead."))));
- (nullable NSDictionary *)getLastErrorDict __attribute((deprecated(("Please use lastErrorDict property instead."))));

@protocol NielsenAppApiDelegate <NSObject>

@optional
- (void)nielsenAppApi:(nonnull NielsenAppApi *)appApi eventOccurred:(nonnull NSDictionary *)event;
- (void)nielsenAppApi:(nonnull NielsenAppApi *)appApi errorOccurred:(nonnull NSDictionary *)error;

@end
</syntaxhighlight>
=== AppApiEventCode ===
An enumeration with predefined App SDK event state transition codes.
<syntaxhighlight lang="objective-c">
typedef NS_ENUM(unsigned int, AppApiEventCode)
{
AppApiStartup = 2001,
AppApiShutdown = 2002,
}AppApiEventCode;
</syntaxhighlight>

=== App SDK Event Codes ===
{| class="wikitable"
|-
! Event Code !! Event Name !! Event Description
|-
| 2001 || AppApiStartup || App SDK has initialized successfully. It will happen only after App SDK has received a valid config file
|-
| 2002 || AppApiShutdown || App SDK is shutting down. It will happen just before App SDK is destroyed
|}
=== AppApiErrorCode ===
iOS contains two types of error codes, 1-15 and 1001-1009.

For, 1-15, an enumeration with predefined error codes which the App SDK object can generate.
<syntaxhighlight lang="objective-c">typedef NS_ENUM(unsigned int, LogCode) {
LogCodeFailedParseStartInfo, // 1.
LogCodeFailedParseMetadata, // 2.
LogCodeFailedProcessID3, // 3.
LogCodeFailedReceiveConfig, // 4.
LogCodeFailedParseConfig, // 5.
LogCodeFailedStartProcessor, // 6.
LogCodeFailedCreateUrl, // 7.
LogCodeFailedCreateRequest, // 8.
LogCodeFailedSendHttpRequest, // 9.
LogCodeFailedSendPing, // 10.
LogCodeFailedSendTSV, // 11.
LogCodeFailedSendStationRequest, // 12.
LogCodeFailedAccessDatabase, // 13.
LogCodeException, // 14.
LogCodeInvalidPlayheadPosition, // 15.
LogCodeLongAd, // 16.
LogCodeIncorrectSfcode, // 17.
LogCodeHemUidExceedLimit, // 18.
LogCodeViewabilityUnableFindView // 19.
};</syntaxhighlight>

For, 1001-1009, an enumeration with predefined error codes which the App SDK object can generate.
<syntaxhighlight lang="objective-c">
typedef NS_ENUM(unsigned int, AppApiErrorCode)
{
AppApiNetworkConnectionFailure = 1001,
AppApiFileWriteFailure = 1002,
AppApiFileReadFailure = 1003,
AppApiEmptyValue = 1004,
AppApiEmptyAppName = 1005,
AppApiEmptyAppVersion = 1006,
AppApiEmptyAppId = 1007,
AppApiAnExceptionOccured = 1008,
AppApiUnknownExceptionOccured = 1009
};
</syntaxhighlight>

=== App SDK Error Codes ===
{| class="wikitable"
|-
! Error Code !! Error Name !! Error Description
|-
| 1 || LogCodeFailedParseStartInfo || Failed to parse the play() JSON string
|-
| 2 || LogCodeFailedParseMetadata || Failed to parse the loadMetadata() JSON string
|-
| 3 || LogCodeFailedProcessID3 || Failed to process ID3 data on a data processor
|-
| 4 || LogCodeFailedReceiveConfig || Failed to receive configuration file from Census
|-
| 5 || LogCodeFailedParseConfig || Failed to parse the config file JSON string
|-
| 6 || LogCodeFailedStartProcessor || Failed to create SDK processor
|-
| 7 || LogCodeFailedCreateUrl || Failed to generate URL due to missing mandatory parameter
|-
| 8 || LogCodeFailedCreateRequest || Failed to create request in HTTP client
|-
| 9 || LogCodeFailedSendHttpRequest || Failed sending HTTP or HTTPS request
|-
| 10 || LogCodeFailedSendPing || Failed to send ping
|-
| 11 || LogCodeFailedSendTSV || Failed to send TSV request
|-
| 12 || LogCodeFailedSendStationRequest || Failed to send StationId request
|-
| 13 || LogCodeFailedAccessDatabase || Failed to read/write from/to database table
|-
| 14 || LogCodeException || Any exception handled by SDK code
|-
| 15 || LogCodeInvalidPlayheadPosition || Invalid playhead position
|-
| 16 || LogCodeLongAd || Long ad
|-
| 17 || LogCodeIncorrectSfcode || Incorrect client supplied sfcode
|-
| 18 || LogCodeHemUidExceedLimit || Exceeded limit of chars for hem uid
|-
| 19 || LogCodeViewabilityUnableFindView || Viewability unable to find a view with the specificed tag
|}

{| class="wikitable"
|-
! Error Code !! Error Name !! Error Description
|-
| 1001 || AppApiNetworkConnectionFailure || App SDK Could not connect to server
|-
| 1002 || AppApiFileWriteFailure || App SDK Could not write to file
|-
| 1003 || AppApiFileReadFailure || App SDK Could not read data from file
|-
| 1004 || AppApiEmptyValue || Empty value Found.
|-
| 1005 || AppApiEmptyAppName || Cannot initialize SDK Object without an AppName(Player Name)
|-
| 1006 || AppApiEmptyAppVersion || Cannot initialize API Object without an AppVersion
|-
| 1007 || AppApiEmptyAppId || Cannot initialize API Object without an AppId
|-
| 1008 || AppApiAnExceptionOccured || Exception occurred
|-
| 1009 || AppApiUnknownExceptionOccured || Unknown exception occurred
|}

== Nielsen Sample Applications ==
Nielsen SDK client package contains iOS sample player applications based on native Players integrated with SDK framework. The players demonstrate all the supported functions of the SDK and show the integration details for both legacy and trackEvent API. There are players developed on Objective C and Swift. Implementation of the sample apps is based on native iOS AVPlayer.

The UI components of the iOS App SDK sample applications are common to both as shown below.
*From the Channel Selection buttons ⬇️ & ⬆️ , the user will be able select the channels to stream.
*The Info button ℹ️ displays information of the SDK version, current Nielsen ID used for the device, and the option for opt-out/opt-in.
*The Play ▶️ and Pause ⏸️ buttons will control the streaming of the selected channel.
*The area at the bottom of the window displays the current stream status.
*The Clear button 🔃 clears out the status window.
*The Email button 📧 can be used to email the tags and status in a text file to Nielsen.
If target device supports Picture-in-Picture playing, it could be activated by PIP button in the Video player window.
*Channel URLs and metadata are obtained from the JSON file named appConfig.json and stored in the application bundle.
=== Viewability testing ===
The sample applications shipped with the client package has support for viewability metrics verification. The player view can be moved using a finger-dragging gesture in the application window. This allows the tester to reduce the visible area of the player view and check the resulting data. There are additional UI buttons:
*Cover View button opens a popup with multiple UI controls which allow changing a player-view alpha and/or visibility as well to show a cover view in front of the player view.
*Alert button to open a native UI alert in the application.<br/>
[[File:PlayerView AlertView1.png|200px]]    [[File:PlayerViewDragging.png|200px]]    [[File:PlayerView CustomView.png|200px]]

== Nielsen Privacy Requirements ==
There are three primary methods for implementing user Opt-out preferences:
# [[Template:iOS_Privacy_and_Opt-Out#OS-level_Opt-out|OS-level Opt-out]] - managed by ''Limit Ad Tracking'' setting on device ('''preferred approach''').
# [[Template:iOS_Privacy_and_Opt-Out#Legacy_Opt-out|Legacy Opt-out]] - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)
# [https://engineeringportal.nielsen.com/docs/iOS_SDK_App_Level_Opt_Out App Level Opt-Out] - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged
=== Privacy Protections ===
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="10" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Device Advertiser ID (Apple IDFA or Google AdID/Android ID) || Yes || Yes
|-
| Cache Buster || Yes || Yes
|-
| App Version || Yes || No
|-
| App Name || Yes || No
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd<wbr />&placement_id=a4164b8fba9ee7c873a9c72c7091bb58<wbr />&creative_id=25280139b61a947e127a52f56c8a2fdd<wbr />&segment1=9000<wbr />&segment2=41<wbr />&segment3=iOS<wbr />&OSVer=iOS6.1<wbr />&c9=<wbr />&devgrp=tablet<wbr />&h=f5f243fe6d<wbr />&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

=== TVOS Opt-out ===
To Opt-Out, users must have access to “About Nielsen Measurement” page.

TVOS does not support creating instances of UIWebView and display web pages. Instead it makes use of a TVML page (built on TVML template) which displays information in a specific order.

Opt-Out page is built on descriptiveAlertTemplate and appears as follows:

[[File:TVOs OptOut LimitAdTracking1.png|link=]]

[[File:TVOs OptOut LimitAdTracking2.png|link=]]

=== Opt-out wording ===
<blockquote>About Nielsen Measurement

YOUR CHOICES

Television and the way we watch it have come a long way since Nielsen began measuring TV audiences in 1950. Today, the ability to watch programs at any time and on multiple devices amplifies the need for exceptionally adept and flexible audience measurement capabilities.
Consumers are changing with the times, and the same goes for Nielsen. As technology continues to evolve and media companies try new ways to attract viewers, understanding what consumers are watching — and what they're watching on — is more important than ever. Today, viewing video is a personal and mobile experience —anytime and anywhere. Our capabilities provide relevant metrics that are necessary to inform successful marketing and programming and drive continued growth.
As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. While our digital measurement products are not used to identify you in any way, 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.
Nielsen believes that you should have a choice about whether to contribute to our research and insights. To opt out of Nielsen measurement on this device, you need only to activate the “Limit Ad Tracking” option in your device's settings. If you have this app on more than one mobile device, you will need to change the settings on each device.
If, after you have opted out, you change your mind and would like to opt back in, please deactivate the “Limit Ad Tracking” option in your device's settings.
To learn more about our digital measurement products and your choices in regard to them, please visit https://www.nielsen.com/digitaIprivacy.</blockquote>

Users need to toggle the “Limit Ad Tracking” option in order to Opt-In / Opt-Out of Nielsen Measurement.

To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.

<blockquote>'''Note:''' For API Version 5.1 and above, 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.</blockquote>

== Viewability and Audibility Implementation ==
Viewability metrics allow AppSDK to track the visibility of the player and collect information about how much of the player container is visible to the end user during playback.

The viewability pings will be fired following the same rules as measurement pings. Viewability pings will be POST requests, not GET requests like other data pings. POST body for viewability requests will contain the key-value pairs in JSON format. The key parameters in the URL schemes are '''invs, inau, inss, invp''' and '''ines''' which will contain the collected viewability data. This data will be formatted according to the specific rules so that downstream it will be possible to match measurement and viewability data for a session.

Audibility metrics will capture the volume level as well as mute/unmute state of the device during playback.

=== Data Collected ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| Measured Value || Value is different for different request parameters:
{| class="wikitable"
|-
| '''invs''' || Intersection ratio for the target view in percent (from 0 to 100). Default threshold for this value is 5. Example: ['''50''',1,1528457356,10]
|-
| '''inau''' || Volume level on the device in percent (from 0 to 100), where 0 - mute, 100 - max volume level. Default threshold for this value is 1. Example: ['''30''',1,1528457356,10]
|-
| '''inss''' || Device screen size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"1024x768"''',1,1528457356,10]
|-
| '''invp''' || Current window size. This is different than the device screen size in a multiple scene mode or on a desktop. Format is "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"800x600"''',1,1528457356,10]
|-
| '''ines''' || Player view size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"300x200"''',1,1528457356,10]
|}
|-
| Start offset || Value contains the first playhead or the first id3 offset with non-null CID after start, flush or resume. Example playhead: [50,'''1''',1528457356,10]. Example id3 offset: [50,'''70100''',1528457356,10]
|-
| Start timestamp || Timestamp value when the time period related to this time series item was started. Example: [50,1,'''1528457356''',10]
|-
| Duration || Duration value is calculated as a difference between the last playhead and the first playhead for the current time series item. Example: [50,1,1528457356,'''10''']
|}

Viewability support requires additional parameters to be provided from player applications to the SDK. In order to provide these parameters and to start the viewability measurement, the following method has been added to the public SDK API (please refer to the [[trackViewability|trackViewability public API reference]] for details and usage examples):
<br/><br/>
'''Objective C'''
<syntaxhighlight lang="objective-c">
- (void)trackViewability:(nonnull NSDictionary *)data;
</syntaxhighlight>
<br/>
'''Swift'''
<syntaxhighlight lang="swift">
func trackViewability(_ data: [String : Any])
</syntaxhighlight>

<br/>
For Audibility measurement SDK uses iOS system API in order to get the volume level for the device:
<syntaxhighlight lang="swift">
AVAudioSession.sharedInstance().outputVolume
</syntaxhighlight>

getDemographicId()

2025-04-04T11:17:06Z

AnkitAgrawal: v10.0.0.0 Changes

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}}

<br>

This API gets the current SDK generated UAID for SDK v10.0.0.0+. Previous versions, it gets Demographic ID of the device.

'''Warning:''' calling getDemographicId() in main thread may cause deadlock, be sure to call in a background thread.
[[Category:Digital]]
[[Category:Android SDK API Reference]]
== Syntax ==
<syntaxhighlight lang="java">
public String getDemographicId()
</syntaxhighlight>

== Input Parameters ==
{| class="wikitable"
|-
! Parameter !! Description
|-
| None ||
|}

== Output Parameters ==
{| class="wikitable"
|-
! Output Parameters (Return value) !! Description
|-
| String || Returns SDK generated UAID or Demographic ID of the device for legacy versions.
|}

Android SDK Release Notes

2025-04-04T10:23:21Z

AnkitAgrawal: v10.0.0.0 Changes

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}

== Release 10.0.0.0 (04-04-2025) ==
*Support for DTVR Subminute product.
*Support for DCR video playhead bridging.
*Support for Ethernet network connection for TV platforms.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.

== Release 9.4.0.0 (07-09-2024) ==
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Upgraded SDK to use Java 11 and Kotlin 1.8.0.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for capturing user opt-out during initialization.
== Release 9.2.0.0 (9-27-2023) ==
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF)
*Viewability: allow enabling by product (DCR, DTVR)
*Other bug fixes and enhancements

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* Kotlin-Java interoperability implementation in SDK.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Support for EMM AGF AdID-less solution.
* Enabled SDK to capture network availability changes.
* Removed the usage of deprecated network classes.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for SDK build variants - AD/NoAD/NoID.
* Support to indicate ID used for AD build variant - AD ID vs Android ID.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* FPID and VendorID support.
* Support for Android apps running on ChromeOS.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==

* Application background/foreground state auto-detection (AndroidX)
* Fixed forward rewind evdata containing negative values
* Offline viewing measurement enhancements
* Revisited precedence logic for sfcode parameter
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==

* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Removal of Location Module from SDK Code.
* Fixed the getOptoutStatus() api, so that client can call it in main thread.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other enhancements and fixes.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Bug fixes and improvements

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.26 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value is reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping
*Fix for last playhead call that is not processed (when there is no time-gap between the last playhead and end call)

== Release 5.1.1.24 (6-2-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for metadata carry over between channels after a channel change

== Release 5.1.1.18 (1-24-2017) ==
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance through encryption process change
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.14 (12-10-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Collection of additional device information
*Opt-out pages based on locale and country
*Opt-out based on the ‘Limit Ad Tracking’ flag
*Issue a warning in client developer’s console when an ad is being played for more than 5 minutes
*Reduced load time of Android SDK, caused due to encryption.
*Limit the duration reported for App launch
*Modification to accept non-JSON strings
*Fixed
**Incorrect DRM placement ID
**DRM pings sent in bursts in case of time change

== Release 5.1.1.10 (10-19-2016) ==
*Fixed an issue where SDK will send a burst of data pings in Android.

== Release 5.1.1.7 (9-1-2016) ==
*Support for Android N
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.4 (8-1-2016) ==
*Support for Pause timeout (from 30 minutes to 5 minutes)

== Release 5.1.1.3 (7-7-2016) ==
*Sending event level (button press data) data to census collections.
*Changes in OTT when switching from mobile to Chromecast
*General bug fix and performance improvements

== Release 5.1.0.4 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
*All the products should be migrated to the latest SDK.
*This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for Android 6.0 Marshmallow
*General bug fix and performance improvements

== Release 1.2.3.8 (1-10-2015) ==

iOS SDK Release Notes

2025-04-04T10:20:27Z

AnkitAgrawal: /* Release 10.0.0.0 (04-04-2025) */

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}

== Release 10.0.0.0 (04-04-2025) ==
*Support for DTVR Subminute product.
*Support for DCR video playhead bridging.
*Support for VisionOS platform.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.

== '''Release 9.4.0.0 (07-09-2024)''' ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (09-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (03-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Support for Xcode 10 and iOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.29 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 (5-31-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 (5-5-2017) ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 (4-3-2017) ==
*Fix for muting background music apps

== Release 5.1.1.18 (2-3-2017) ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 (1-23-2017) ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 (10-18-2016) ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 (9-13-2016) ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

== Release 3.2.1.26 (1-10-2015) ==

iOS SDK Release Notes

2025-04-04T10:19:10Z

AnkitAgrawal: v10.0.0.0 Changes

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}

== Release 10.0.0.0 (04-04-2025) ==
*Support for DTVR Subminute product.
*Support for DCR Video Playhead Bridging.
*Support for VisionOS platform.
*Change in DemographicID behavior for Chromecast.
*Other bug fixes and enhancements.

== '''Release 9.4.0.0 (07-09-2024)''' ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (09-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (03-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Support for Xcode 10 and iOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.29 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 (5-31-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 (5-5-2017) ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 (4-3-2017) ==
*Fix for muting background music apps

== Release 5.1.1.18 (2-3-2017) ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 (1-23-2017) ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 (10-18-2016) ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 (9-13-2016) ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

== Release 3.2.1.26 (1-10-2015) ==

Android SDK API Reference

2025-04-03T15:34:20Z

AnkitAgrawal: /* Android SDK API Methods & Properties */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
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.
*Create and initialize an instance object of <code>AppSdk</code> class.
*The player application can use this object to collect HLS timed metadata through a [[sendID3()]] call.
The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package. It inherits from the closeable interface and exposes the public APIs the client’s app will use. Below is the declaration of the <code>AppSdk</code> class: <code>public class AppSdk implements Closeable</code>

== Setting Up Development Environment ==
'''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 Nielsen App SDK 1.2 library is composed of two parts:
* The Java AppSdk.jar library that runs on the Android’s Dalvik Virtual Machine.
* The C/C++ libAppSdk.so native library that runs directly on the device’s hardware.
<blockquote>'''Note''': App SDK 4.0.0 contains AppSDK.jar component only and does not support C/C++ libAppSdk.so components.</blockquote>

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.
* '''For Audio player applications'''
** The Android OS hosting the App SDK should be at version 2.3 and later since the SDK depends on the Google Play support to work properly.

=== Setting up in Eclipse IDE ===
Be sure to unzip the Nielsen App SDK sample app and copy the ''AppSdk.jar'' into the libs/ folder on the App’s Eclipse project. Copy the ''libAppSdk.so'' file under ''libs/armeabi/'' folder into the same Eclipse project.
* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture; the respective ''libAppSdk.so'' can be found under the ''libs/x86/'', ''libs/mips/'', and ''libs/armeabi-7a/'' folders.
Add the following permissions on the project’s ''AndroidManifest.xml'' file.
<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:required="false" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
For more details to handle run-time permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html]. Download the latest ''google-play-services_lib'' and include it in the App’s project in order to use the App SDK.

* 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.
To include the Google Play library in the media player project, copy the ''google-play-services_lib'' folder into the same location as the project
* Access '''File > Import'''.
* Select '''Existing Android Code into Workspace''' and click '''Next'''.
* Click '''Browse''' and navigate to the ''google-play-services_lib'' to include it into the projects.
* Select the exact '''Project Build Target''' for Eclipse to use from Android SDK.
** Android 4.4.2, etc. OR
** Edit ''project.properties'' file to point to Android target version e.g. target= android-19.

[[File:andr-properties-drm.jpg|link=]]

Once the google-play-services_lib is included into the App project, include the following code under the <code><application></code> node in the <code>AndroidManifest.xml</code>.

<syntaxhighlight lang="java"><meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/></syntaxhighlight>

Also, include the ''version.xml'' file that comes with the ''google-play-services_lib'' under the res/values directory of the media player project.
* Once the files are in place, import com.nielsen.app.sdk to the java source code and start accessing the public interface.
Nielsen App SDK uses the following packages/classes from the Google Play service.

'''Library''':
* 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;

=== Setting up in Android Studio IDE ===
Launch '''Android Studio''' and select '''Import project (Eclipse ADT)'''.

[[File:andr-setup-launch.jpg|link=]]

Browse for project destination directory and click '''Next'''.

[[File:andr-import-project.jpg|link=]]

Go to '''File > Project Structure > App > Dependencies'''.

[[File:andr-pro-structure.jpg|link=]]

Click '''+''' to add library dependency.

Select '''play-services''' and click '''OK'''

[[File:andr-choose-library.jpg|link=]]

For more information, refer to https://developer.android.com/google/play-services/setup.html

*For applications using ''Google Play Services 17.0.0'' and above, one of the following tags must be included within ''AndroidManifest.xml'', or the application will crash (more information https://developers.google.com/ad-manager/mobile-ads-sdk/android/quick-start#update_your_androidmanifestxml]):
**<syntaxhighlight lang="java">com.google.android.gms.ads.APPLICATION_ID</syntaxhighlight>
**<syntaxhighlight lang="java">com.google.android.gms.ads.AD_MANAGER_APP</syntaxhighlight>

== Initialization ==
=== Android Application Life Cycle with respect to Nielsen App SDK ===
[[File:andr-init-img1.jpg|link=]]

=== Step 1: App SDK initialization ===
==== For API version 4.0.0 and above ====

[[AppSDK()]] is no longer a singleton object and should be initialized as below.

==== APPSDK Kotlin/Java Interpretability ====

Starting Nielsen SDK version 9.0.0.0, all new feature/modules are written in Kotlin language, coexisting with legacy features written in Java. If you are having an app purely written in Java language, then you need to enable the Kotlin support dependency in your project as described below:

Minimum version of kotlin plugin and org.jetbrains.kotlin:kotlin-stdlib dependency supported by AppSDK is 1.4.0. <br/>
To enable kotlin support in your java based android project please add below gradle dependency in your app's build.gradle file
<syntaxhighlight lang="gradle">
implementation "org.jetbrains.kotlin:kotlin-stdlib:1.4.0"
</syntaxhighlight>
<br/><br/>

{{Initialization_of_App_SDK_object_through_a_JSON_object}}

==== Android Application Life Cycle with respect to Nielsen App SDK ====
[[File:andr-radioandvideo-app.jpg|link=]]

=== Step 2: App SDK libraries inclusion in project ===
The integration of Nielsen App SDK will depend on 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 property page of the App’s project).

=== Step 3: Nielsen App SDK Streaming Sessions ===
After ensuring that the SDK object has been initialized, link the streaming session APIs. The next steps are:
*Call [[play()]] when starting or resuming a streaming session. Use the channelName parameter to pass channel descriptor information. The channel name field is a 32-character free-form text field containing the name of the program or feed being sent (such as ESPN2, Food Network, etc.) which must be inserted on a JSON string.
*Load the CMS metadata by calling the [[loadMetadata()]] on the SDK object.
*Call [[stop()]] when ending or pausing a viewing session.
*During session playback, call the SDK [[setPlayheadPosition()]] and / or [[sendID3()]]
**Call [[setPlayheadPosition()]] every one second until the stream is stopped or paused.
**Call [[sendID3()]] if the client relies on the Nielsen ID3 tags for its measurements; this call should happen whenever a new Nielsen ID3 metadata is available for processing. Normally this happens on DTVR and ID3 measurements.
Nielsen App SDK object handles filtering of ID3 tags and CMS tags, queuing/buffering of data, and all communications with Nielsen collection facility.
*The client’s app must clearly identify the mode of operation (live vs. VOD) and stick to the type of playhead coordinates until the playback is completed. The client must reliably provide the appropriated playhead position value depending on the type of content streamed.
*If streaming live video content, the client must pass the current Unix timestamp (seconds since Jan-1-1970 UTC) as playhead position.
*If streaming VOD (video on demand), the client must stream the offset from the beginning of the file as playhead position.

== Retrieving ID3 Tags ==
ID3 tags have a payload of about 249 characters and start with "www.nielsen.com".

=== Sample ID3 tags ===
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_<wbr />JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</code>
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGhe<wbr />Fi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8<wbr />QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</code>
<blockquote>'''Note''': ID3 tags are not applicable for International (Germany)</blockquote>

=== Extracting ID3 tags from Android Players ===
==== ID3 Support Matrix ====
{| class="wikitable"
|-
! Player Name !! Minimum supported version !! Description
|-
| Android Native Media Player || Android 6 || Android 6 Media Player allows apps to register a callback to be invoked, when a selected track has the timed metadata available. Currently, only HTTP Live Streaming (HLS) data URI’s embedded with timed ID3 tags, generates TimedMetaData.
|-
| Google ExoPlayer || Android 4.1 ||
|-
| Adobe PrimeTime Player || Android 4.2 ||
|-
| Brightcove Player || Android 4.1 || Support for Android versions 2.3.3 and 4.0 is now deprecated. Learn more about why Brightcove is removing support for these versions as of January 1, 2016 in this announcement: https://support.brightcove.com/en/perform/docs/announcement-brightcove-sdk-android-version-support
|-
| VisualOn Player || Android 2.3 || Android 5 is the latest supported version
|-
| NexStream Player || Android 1.6 || Supported till Android 6
|}

==== Android Native Media Player ====
As the Android Media Player versions (prior to Android 6 / Android API 23) do not support ID3, Nielsen has created a library that becomes an extension to the media player, thus MPX. This library extracts the ID3 tags and sends them to the app. For more information on how to use the MPX component, refer to the Nielsen-supplied sample application.

Starting from '''Android 6 (Android API 23)''', Android Native Media Player allows apps to register a callback to be invoked, when a selected track has the timed metadata available. Currently, only HTTP Live Streaming (HLS) data URI’s embedded with timed ID3 tags generate TimedMetadata. Once the HLS video starts, call onTimedMetaDataAvailable() as and when the player observes a TimedMetadata (ID3 tag).

<syntaxhighlight lang="java">@Override
public void onTimedMetaDataAvailable(MediaPlayer mp, TimedMetaData data)
{
byte[] iD3PayloadArray = data.getMetaData();
String iD3Payload = new String(iD3PayloadArray, StandardCharsets.UTF_8);
if (null != iD3Payload && iD3Payload.contains("www.nielsen.com"))
{
int index = iD3Payload.indexOf("www.nielsen.com");
String id3String = iD3Payload.substring(index, (index + 249));
Log.d(TAG, "TimedMetaData ID3 Tag:" + id3String);
appProcessID3tag(id3String);
}
}</syntaxhighlight>

==== ExoPlayer ====
he SDK is designed around an event-driven architecture where components emit events to allow other components to listen and respond to state changes.

'''Player SDK Classes used:'''
<syntaxhighlight lang="java">com.google.android.exoplayer.demo.player.DemoPlayer</syntaxhighlight>

Since Nielsen App SDK is interested in extracting the Timed Metadata (ID3 Tags) in HLS and VOD on the EXO Player, trace the ID3_TAG emitted during video content played using EXOPlayer component as below.

<syntaxhighlight lang="java">DemoPlayer implements ExoPlayer.Listener
—————————————————–
/**
* A listener for receiving ID3 metadata parsed from the media stream.
*/
public interface Id3MetadataListener
{
void onId3Metadata(Map<String, Object> metadata);
}
——————————————————-
MetadataTrackRenderer.MetadataRenderer<Map<String,
Object>> getId3MetadataRenderer()
{
return new MetadataTrackRenderer.MetadataRenderer<Map<String, Object>>()
{
@Override
public void onMetadata(Map<String, Object> metadata)
{
if (id3MetadataListener != null)
{
id3MetadataListener.onId3Metadata(metadata);
}
}
};
}</syntaxhighlight>

Also in ''Player.java'' class:
<syntaxhighlight lang="java">Player implements DemoPlayer.Id3MetadataListener
—————————————————–
@SuppressWarnings("rawtypes")
@Override
public void onId3Metadata(Map<String, Object> metadata)
{
try
{
for (Object o : metadata.entrySet())
{
Map.Entry pairs = (Map.Entry) o;
if (metadata.containsKey(TxxxMetadata.TYPE))
{
TxxxMetadata txxxMetadata = (TxxxMetadata) metadata
.get(TxxxMetadata.TYPE);
}
else
{
String aStr = new String((byte[]) pairs.getValue());
MainActivity.mAppSdk.sendID3(aStr);
}
}
}
catch (Exception e)
{
e.printStackTrace();
Log.d(TAG, "onId3Metadata(): No Id3 tags");
}
}</syntaxhighlight>

[[File:andr-exo-retrievingID3tags.png|link=]]

==== Brightcove Player ====
While the Brightcove player plays the content, EventListener triggers an event when an ID3 packet is received (<code>SeamlessVideoDisplayComponent.ID3_TAG</code>). Upon receiving this event, collect the incoming ID3 tags and only pass the Nielsen payload of the PRIV frame to the App SDK for analysis.

<syntaxhighlight lang="java">brightcoveVideoView.getEventEmitter().on(SeamlessVideoDisplayComponent.ID3_TAG, new EventListener()
{
public void processEvent(Event event)
{
NlsId3Tag nlsID3 = new NlsId3Tag(event.properties.get(SeamlessVideoDisplayComponent.ID3_DATA).toString());
Log.w("ID3", nlsID3.NlsPayload);
// Sent ID3 Tags to App
appProcessID3tag(nlsID3.NlsPayload);
}
});
}</syntaxhighlight>

==== Adobe PrimeTime Player ====
While the Adobe PrimeTime player plays the content, MediaPlayer.PlaybackEventListener triggers a callback when an ID3 packet is received (onTimedMetadata). Upon receiving this event, collect the incoming ID3 tags and only pass the Nielsen payload of the PRIV frame to the App SDK for analysis.
<syntaxhighlight lang="java">public void onTimedMetadata(TimedMetadata id3Metadata)
{
NlsId3Tag nlsID3 = new NlsId3Tag(id3Metadata.getMetadata().toString());
Log.w(LOG_TAG, "ID3 Timed Data –> " + nlsID3.NlsPayload);
Log.w(LOG_TAG, "PayLoad Size –> " + nlsID3.NlsPayload.length());
appProcessID3tag(nlsID3.NlsPayload);
}</syntaxhighlight>

==== VisualOn Player ====
While the VisualOn player plays the content, <code>VOCommonPlayerListener</code> triggers an event when an ID3 packet is received (<code>VO_OSMP_SRC_CUSTOMERTAGID_TIMEDTAG</code>). Upon receiving this event, collect the incoming ID3 tags and only pass the Nielsen payload of the PRIV frame to the App SDK for analysis.

<syntaxhighlight lang="java">case VO_OSMP_SRC_CB_CUSTOMER_TAG:
{
VO_OSMP_SRC_CUSTOMERTAGID tag = VO_OSMP_SRC_CUSTOMERTAGID.valueOf(nParam1);
switch (tag)
{
case VO_OSMP_SRC_CUSTOMERTAGID_TIMEDTAG:
// do something with this tag
int time = nParam2;
byte[] b = (byte[]) obj;
String s = new String(b);
NlsId3Tag nlsID3 = new NlsId3Tag(b);
// Sent ID3 Tags to App
appProcessID3tag(nlsID3.NlsPayload);
if (appid3If != null)
appid3If.onId3(nlsID3.NlsPayload);
break;
case VO_OSMP_SRC_CUSTOMERTAGID_MAX:
// ignore this type of tag
break;
default:
break;
}
break;
}</syntaxhighlight>

==== NextStream Player ====
ID3 tags will be received in the NexStream Player through <code>onTimedMetaRenderRender(NexPlayer mp,NexID3TagInformation metadata)</code> callback API. A sample implementation for the callback is shown below:
<syntaxhighlight lang="java">public void onTimedMetaRenderRender(NexPlayer mp, NexID3TagInformation m)
{
text = m.getPrivateFrame();
if (text != null)
{
data = text.getTextData();
if (data != null)
{
// make sure to identify the beginning of the
// Nielsen ID3 tag payload by searching for the
// "www.nielsen.com" string on the ID3 tag and
// passing to the App SDK all information that
// follows. It should be:
// nlsPayload = "www.nielsen.com" + dataFollowing
nlsPayload = getDataAfterWwwNielsenCom(data);
if (nlsPayload!= NULL)
mAppSdk.sendID3(nlsPayload);
}
}
}</syntaxhighlight>

The [[sendID3()]] sends the extracted Nielsen ID3 payload to the App SDK for analysis.

== Android SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Scenario !! Method / Property !! DTVR !! DAR !! DCR !! International (Germany) !! Description
|-
| Initialize || [[AppSDK()]] || ✔ || ✔ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| Measurement || [[play()]] || ✔ || ✔ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. If this is not called then the “channel name” value populated will be the default value of “defaultChannelName”.
|-
| Measurement || [[loadMetadata()]] || ✔ || ✔ || ✔ || ✔ || Used when there is a preroll ad that needs to be associated with content metadata. The loadmetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad.
|-
| Measurement || [[sendID3()]] || ✔ || ✘ || ✘ || ✘ || Used to send the ID3 metadata.
|-
| Measurement || [[setPlayheadPosition()]] || ✘ || ✘ || ✔ || ✔ || Used to send the playhead position.
|-
| Measurement || [[stop()]] || ✔ || ✘ || ✔ || ✔ || Used when playback is paused and when switching between ad and content or content and ad.
|-
| Measurement || [[end()]] || ✔ || ✘ || ✔ || ✔ || Used when content playback is complete. This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content
|-
| Measurement || [[staticEnd()]] || || || ✔ || ✔ || Used with DCR Static duration in between loadMetadata calls for static content when section name is the same but a new static view event and duration measurement restart is desired
|-
| Measurement || [[updateOTT()]] || ✘ || ✘ || ✘ || ✔ || Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| Opt-out || [[userOptOutURLString()]] || ✔ || ✔ || ✔ || ✔ || Used to fetch the Nielsen opt-out web page URL.
|-
| Opt-out || [[userOptOut()]] || ✔ || ✔ || ✔ || ✔ || Used to supply the response message from opt-out webpage to the SDK.
|-
| Opt-out || [[getOptOutStatus()]] || ✘ || ✘ || ✘ || ✔ || Call this API to retrieve the Opt-Out or Opt-In state.
|-
| Opt-out
| [[appDisableApi()]]
(kill switch)
|| ✔ || ✔ || ✔ || ✔ || Used to disable the SDK.
|-
| Opt-out || [[getAppDisable()]] || ✔ || ✔ || ✔ || ✔ || Used to query if the SDK is disabled or not.
|-
| Log || [[getLastEvent()]] || ✔ || ✔ || ✔ || ✔ || Used to query the SDK for the last status
|-
| Log || [[getLastError()]] || ✔ || ✔ || ✔ || ✔ || Used to query the SDK for the last error
|-
| Log || [[isValid()]] || ✔ || ✔ || ✔ || ✔ || Used to check if the SDK was successfully instantiated or not.
|-
| Log || [[getMeterVersion()]] || ✘ || ✘ || ✘ || ✔ || Returns the current SDK version.
|-
| Log || [[getNielsenId()]] || ✔ || ✔ || ✔ || ✔ || Used to get a string defining the Nielsen ID (NUID) number for the device.
|-
| Log || [[getDeviceId()]] || ✔ || ✔ || ✔ || ✔ || Returns the current device id.
|-
| Log || [[getDemographicId()]] || ✔ || ✔ || ✔ || ✔ || Returns the current UAID for SDK v10.0.0.0+. Previous versions, it returns Demographic/Device ID of the device.
|-
| Log || [[appInBackground()]] || ✘ || ✘ || ✔ || ✔ || Used to capture the event of app going to background.
|-
| Log || [[appInForeground()]] || ✘ || ✘ || ✔ || ✔ || Used to capture the event of app coming to foreground
|-
| Log || [[setDebug()]] || ✘ || ✘ || ✘ || ✔ || Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
|-
| Viewability<br/>Audibility
| [[trackViewability()]]
|| ✔ || || ✔ || ✔ || Used to start the viewability measurement.
|}

== Android Opt-Out Implementation ==
To opt out, users must have access to "About Nielsen Measurement" page. User can click this page from 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.
*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.

=== Displaying Opt-Out in a WebView ===
<syntaxhighlight lang="java">
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
}
</syntaxhighlight>

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.

[[File:Privacy policy iOS.jpg|link=]]

<blockquote>'''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.</blockquote>

<blockquote>'''Note:''' App SDK manages the user’s choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

=== Sequence Diagram ===
[[File:optoutsequence-andr.jpg|link=]]

== Opt-out Android SDK Version '''5.1.1.18 or above''' ==
<blockquote>'''Note:''' If using legacy Android SDK Versions 5.1.1.14 or below, or are not using Google Play Services, skip ahead to: [[#Opt-out for legacy SDK versions prior to 5.1.1.18 or if host application does not leverage Google Play Services|Opt-out for legacy SDK versions prior to 5.1.1.18 or if host application does not leverage Google Play Services]]</blockquote>

Starting from SDK version 5.1.1.18, Opt-Out related behavior has been changed in the following ways:
*SDK will be sending the data pings to census even though SDK is opted out (In earlier releases all the traffic from SDK to census will be ceased). 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'''.
<blockquote>'''Note:''' For Amazon devices, see [[#Opt-Out Implementation for Amazon Devices|Opt-Out Implementation for Amazon Devices]] below.</blockquote>

[[File:andr-ads.jpg|link=]]

<blockquote>'''Note:''' For API Version 5.1 and above, 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.</blockquote>

== Opt-out for legacy SDK versions prior to 5.1.1.18 or if host application does not leverage Google Play Services ==
<blockquote>'''Note:''' If using Android SDK Version 5.1.1.18 or above, refer to documentation above ([[#Opt-out Android SDK Version 5.1.1.18 or above|Opt-out Android SDK Version 5.1.1.18 or above]])</blockquote>

When a user clicks the Opt-Out / Opt-In link, the application should invoke [[optOutURL]] to get the link to the Nielsen Privacy page from SDK.
=== Privacy Page ===
[[File:privacy-policy.jpg|link=]]
*There are two click here links – one for Opt-Out and one for Opt-In. Click the required link:
**Capture user’s selection
**Pass the selection back to the SDK via the [[userOptOut()]].

=== Capture and forward user selection ===
<syntaxhighlight lang="java">
private class MonitorWebView extends WebViewClient
{
private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";
private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";

@Override
public boolean shouldOverrideUrlLoading(WebView view, String url)
{
if (NIELSEN_URL_OPT_OUT.equals(url)
|| NIELSEN_URL_OPT_IN.equals(url))
{
// Get AppSdk instance from the host
AppSdk appSdk = HostApp.getAppSdk();
// Send the URL to the AppSdk instance
appSdk.userOptOut(url);
return true;
}
return false;
}
}
</syntaxhighlight>

<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app.</blockquote>
<blockquote>'''Note:''' App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>

== 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).

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 ===

<syntaxhighlight lang="java">
ContentResolver cr = getContentResolver();
int limitAdTracking = Secure.getInt(cr, "limit_ad_tracking", 2);
</syntaxhighlight>

*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).

<blockquote>'''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'''.</blockquote>

== Nielsen Sample Applications ==
<br/><br/>
=== Viewability testing ===
The sample applications shipped with client package have support for viewability metrics verification. The player view can be moved using a finger-dragging gesture or scrolling in the application window. This allows the tester to reduce the visible area of the player view and check the resulting data. Additional UI buttons:
*Cover View button opens a popup with multiple UI controls which allow changing a player view alpha and visibility as well as showing a cover view in front of the player view.
*Alert button allows for opening a native UI alert in the application.
[[File:PlayerView Zoomin.png|200px]]    [[File:PlayerView AlertView.png|200px]]    [[File:PlayerView Dragging.png|200px]]    [[File:PlayerView FriendlyViews.png|200px]]

== Nielsen Privacy Requirements ==
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="10" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Device Advertiser ID (Apple IDFA or Google AdID/Android ID) || Yes || Yes
|-
| Cache Buster || Yes || Yes
|-
| App Version || Yes || No
|-
| App Name || Yes || No
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd<wbr />&placement_id=a4164b8fba9ee7c873a9c72c7091bb58<wbr />&creative_id=25280139b61a947e127a52f56c8a2fdd<wbr />&segment1=9000<wbr />&segment2=41<wbr />&segment3=iOS<wbr />&OSVer=iOS6.1<wbr />&c9=<wbr />&devgrp=tablet<wbr />&h=f5f243fe6d<wbr />&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

=== Nielsen Measurement Opt-Out ===
In accordance with Nielsen’s SDK licensing agreement, developers are required to provide basic informational data to users about Nielsen’s Privacy Policy with a navigation to additional information on Nielsen measurement.

Nielsen currently uses Opt Out of Ads for Personalization for the latest versions of the SDK (5.1.1.18 and above). However, for older SDK versions, the app must provide a means for the user to opt out, or opt back in to Nielsen Measurement. Users can opt out of Nielsen online measurement research through this feature.
* If the user has this app running on more than one mobile device, the user will need to opt out of this measurement on each device.
<blockquote>'''Note''': Opt Out feature does NOT rely on "Opt Out of Ads for Personalization" setting since Nielsen’s systems provide measurement metrics and do not serve ads to users.</blockquote>

== Event and Error Handling ==
=== App SDK Event Codes ===
{| class="wikitable"
|-
! Event Code !! Event Name !! Event Description
|-
| 2000 || EVENT_INITIATE || App SDK is initiated. It will happen as soon as the App SDK is initialized
|-
| 2001 || EVENT_STARTUP || App SDK has started up. It will happen only after App SDK has received a valid config file. This is the location in the code to acquire the value of [[userOptOutURLString()]].
|-
| 2002 || EVENT_SHUTDOWN || App SDK is shutting down. It will happen just before App SDK is destroyed
|}

=== App SDK Error Codes ===
Constants with predefined error codes which the AppSdk object can generate.

{| class="wikitable"
|-
! Error Code !! Error Name !! Description !! Behavior
|-
| 1001 || ERROR_FAILED_CREATE_URL_STRING || Failed generating ping string due to error on parsing || Include last error message from URL parser
|-
| 1002 || ERROR_FAILED_RECEIVE_CONFIG || Failed to receive configuration file from Census || On 5th time, it will log event and keep requesting config 10 min apart
|-
| 1003 || ERROR_FAILED_PARSING_CONFIG || Failed parsing the config file JSON string || Include json error number/short message from iOS or Android
|-
| 1004 || ERROR_FAILED_PARSING_PLAY || Failed parsing the play() JSON string || Include JSON error number/short message from iOS or Android
|-
| 1005 || ERROR_FAILED_PARSING_METADATA || Failed parsing the play() JSON string || Include JSON error number/short message from iOS or Android
|-
| 1006 || ERROR_FAILED_GENERATING_PING || Failed creating ping before adding it to the UPLOAD table) || Include ping nol_url index, cadence to identify ping
|-
| 1007 || ERROR_FAILED_PROCESSOR_START || Failed starting data processor thread. Normally, that means a product || Include processor that failed to start
|-
| 1008 || ERROR_FAILED_PROCESS_ID3 || Failed processing data on a data processor. Normally, that means the input to a product || Include processor and data that failed to process (ID3 tag on a MTVR impression, for example)
|-
| 1009 || ERROR_FAILED_HTTP_SEND || Failed sending HTTP or HTTPS requests || Include HTTP error number
|-
| 1010 || ERROR_FAILED_SENDING_PING || Failed sending pings (on ANDROID, the ping on the UPLOAD table) || Include ping up to 80 char from the end
|-
| 1011 || ERROR_FAILED_SENDING_TSV || Failed sending TSV requests || Include TSV request message
|-
| 1012 || ERROR_FAILED_SENDING_STATION_ID || Failed sending Station ID requests || Include Station ID request message
|-
| 1013 || ERROR_FAILED_ACCESSING_DB || Failed read/write from/to database table || Include SQL statement and data and SQLite error number/message
|-
| 1014 || ERROR_CHANGED_DEVICE_ID || Device ID changed ||
|-
| 1015 || ERROR_CHANGED_NUID || NUID changed ||
|-
| 1016 || ERROR_SDK_NOT_INITIALIZED || App SDK initialization failed ||
|-
| 1017 || ERROR_FAILED_SDK_SUSPEND || App SDK failed to suspend activities ||
|-
| 1018 || ERROR_INVALID_PARAMETERS || App SDK invalid parameters ||
|-
| 1019 || ERROR_INVALID_STATE || App SDK called in incorrect state ||
|-
| 1020 || ERROR_FAILED_PROCESS_PLAYHEAD || App SDK failed processing playhead position ||
|-
| 1021 || ERROR_FAILED_PROCESS_METADATA || App SDK failed processing not-null, syntax valid JSON metadada ||
|-
| 1022 || ERROR_FAILED_PROCESS_STOP || App SDK failed processing stop ||
|}

== Viewability and Audibility Implementation ==
Viewability metrics will allow AppSDK to track the visibility of the player and collect information about how much the player container is visible to the end user while playback is occurring.

The viewability pings will be fired following the same rules as for measurement pings. These pings will be POST requests, not GET requests like other data pings. POST body for viewability requests will contain the key-value pairs in JSON format. The key parameters in the URL schemes are '''invs, inau, inss, invp''' and '''ines''' which will contain the collected viewability data. This data will be formatted according to the specific rules so that downstream it will be possible to match measurement and viewability data for a session.

Audibility metrics will capture the volume level as well as mute/unmute state of the device while playback is occurring.

=== Data Collected ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| Measured Value || Value is different for different request parameters:
{| class="wikitable"
|-
| '''invs''' || Intersection ratio for the target view in percent (from 0 to 100). Default threshold for this value is 5. Example: ['''50''',1,1528457356,10]
|-
| '''inau''' || Volume level on the device in percent (from 0 to 100), where 0 - mute, 100 - max volume level. Default threshold for this value is 1. Example: ['''30''',1,1528457356,10]
|-
| '''inss''' || Device screen size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"1024x768"''',1,1528457356,10]
|-
| '''invp''' || Current window size. It is different than the device screen size in a multiple scene mode or on a desktop. Format is "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"800x600"''',1,1528457356,10]
|-
| '''ines''' || Player view size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"300x200"''',1,1528457356,10]
|}
|-
| Start offset || Value contains the first playhead or the first id3 offset with non-null CID after start, flush or resume. Example playhead: [50,'''1''',1528457356,10]. Example id3 offset: [50,'''70100''',1528457356,10]
|-
| Start timestamp || Timestamp value when the time period related to this time series item was started. Example: [50,1,'''1528457356''',10]
|-
| Duration || Duration value is calculated as a difference between the last playhead and the first playhead for the current time series item. Example: [50,1,1528457356,'''10''']
|}

Viewability support requires additional parameters to be provided from player applications to the SDK. In order to provide these parameters and to start the viewability measurement the following method has been added to the public SDK API (please refer to the [[trackViewability()|trackViewability public API reference]] for the details and usage examples):
<br/><br/>

<syntaxhighlight lang="java">
void trackViewability(JSONObject);
</syntaxhighlight>

<br/>
For Audibility measurement APPSDK uses android system API in order to get an volume level for the device:
<syntaxhighlight lang="java">
AudioManager audio = (AudioManager) mContext.getSystemService(Context.AUDIO_SERVICE);
float currentVolume = audio.getStreamVolume(AudioManager.STREAM_MUSIC);
float maxVolume = audio.getStreamMaxVolume(AudioManager.STREAM_MUSIC);
int volumeLevel = (int) ((currentVolume/maxVolume) * 100);
</syntaxhighlight>

getDemographicId()

2025-04-03T15:28:25Z

AnkitAgrawal: v10.0.0.0 Changes

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}}

<br>

This API gets the current UAID for SDK v10.0.0.0+. Previous versions, it gets Demographic ID of the device.
[[Category:Digital]]
[[Category:Android SDK API Reference]]
'''Warning:''' calling getDemographicId() in main thread may cause deadlock, be sure to call in a background thread.

== Syntax ==
<syntaxhighlight lang="java">
public String getDemographicId()
</syntaxhighlight>

== Input Parameters ==
{| class="wikitable"
|-
! Parameter !! Description
|-
| None ||
|}

== Output Parameters ==
{| class="wikitable"
|-
! Output Parameters (Return value) !! Description
|-
| String || Returns Demographic ID of the device.
|}

iOS SDK API Reference

2025-04-03T15:25:30Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
== Overview ==
The Nielsen SDK is one of 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 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
== Prerequisites ==
To start using the App SDK, the following items are required:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''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 frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|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 information on how to get a Nielsen App SDK and appid.
==SDK Implementation==
Information on how to obtain, how to configure your development environment, and how to Initialize the Nielsen SDK is located in either the [[DCR Video iOS SDK|DCR Implementation Guide,]] or the [[DTVR iOS SDK|DTVR Implementation Guide]] depending on your requirements.
___TOC___

== Nielsen iOS App SDK Application Life Cycle ==

[[File:initialization_appcycle.png|center|link=]]

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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

<blockquote>'''Note:''' For API Version 5.1 and above, 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 <code>'''play'''</code>, <code>'''loadMetadata''' </code> and <code>'''playheadPosition'''</code> </blockquote>

[[File:appsdkTimeline-DCR.png|icon|link=]]
=== Finite-state machine table ===
This table provides the possible changes of state for the SDK instance, when it is in a specific state and receives an API call.
{| class="wikitable"
|-
! API call received !! Initial State !! Idle State !! Processing State !! Disabled State
|-
| <code>[[initWithAppInfo:delegate:]]</code> || IDLE STATE (OR)

DISABLED STATE
|| IDLE STATE || - || -
|-
| <code>[[play]]</code> & <code>[[loadMetadata]]</code>|| - || PROCESSING

STATE
|| - || -
|-
| <code>[[playheadPosition]]</code> || - || - || PROCESSING

STATE
|| -
|-
| <code>[[sendID3]]</code> || - || - || PROCESSING

STATE
|| -
|-
| <code>[[stop]]</code> || - || - || IDLE STATE || -
|-
| <code>[[end]]</code> || - || - || IDLE STATE || -
|-
| <code>[[appDisableApi]]</code>: YES || - || DISABLED

STATE
|| - || -
|-
| <code>[[appDisableApi]]</code>: NO || - || - || - || IDLE STATE (OR)

DISABLED STATE
|-
| <code>[[userOptOut]]</code>: YES || - || - || IDLE STATE || -
|-
| <code>[[userOptOut]]</code>: NO || - || PROCESSING

STATE
| -
| -
|-
| colspan = 5 | '-' indicates that no API call is expected.
|}

=== Handling JSON Metadata ===
All the SDK methods handles 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 unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* 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, 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.
The below is a sample - detailed information on the '''metadata requirements''' are located in either the [[DCR Video iOS SDK|DCR Implementation Guide,]] or the [[DTVR iOS SDK|DTVR Implementation Guide]]
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let contentMetadata = [
"type": "content",
"assetid": "C77664",
"title": "Program S2, E3",
"isfullepisode": "Yes",
"program": "Program Name",
"length": "3600",
"airdate": "20171020 10:05:00",
"adloadtype": "2",
"segB": "CustomSegmentValueB", //optional
"segC": "CustomSegmentValueC", //optional
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "C77664",
@ "title": @ "S2,E3",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20180120 10:00:00",
@ "adloadtype": @ "2",
@ "segB": @ "CustomSegmentValueB", //optional
@ "segC": @ "CustomSegmentValueC", //optional
}
</syntaxhighlight>
}}

== Retrieving ID3 Tags ==
'''Only required for DTVR clients'''<br>
'''Not applicable for German Clients'''<br>

ID3 tags have a payload of about 249 characters and start with "www.nielsen.com".

ID3 tags are extracted by observing a property called timedMetadata on the iOS player item. Now this is done via a concept called KVO (Key Value Observing), where you register interest in a property, and the runtime will let you know when it has changed.

Both the iOS native players have the ability to extract ID3 tags, If any other player apart from iOS native players (AVPlayer, MPMoviePlayer) is used, check and ensure that the player has the capability to extract ID3 tags.

=== Examples of extracting ID3 tags from the iOS Native Player ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
//Setting observer to track timedMetadata
[player addObserver:self
forKeyPath: timedMetadataKey
options: (NSKeyValueObservingOptionNew)
context: &TimedMetadataObserverContext];
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if(keyPath == timedMetadataKey){
if(context == &TimedMetadataObserverContext){

id newMetadataArray = [change objectForKey:NSKeyValueChangeNewKey];
if (newMetadataArray != [NSNull null])
{
array = newMetadataArray;
for (AVMetadataItem *metadataItem in array)
{
//Handling TimedMetadata
[self handleTimedMetadata: metadataItem];
}
}

}
}
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
- (void)handleTimedMetadata:(AVMetadataItem *)timedMetadata
{
// We expect the content to contain plists encoded as timed metadata
// AVPlayer turns these into NSDictionaries

id extraAttributeType = [timedMetadata extraAttributes];
NSString *extraString = nil;
if ([extraAttributeType isKindOfClass:[NSDictionary class]])
{
extraString = [extraAttributeType valueForKey:@"info"];
}
else if ([extraAttributeType isKindOfClass:[NSString class]])
{
extraString = extraAttributeType;
}

NSString *key = [NSString stringWithFormat:@"%@", [timedMetadata key]];

//If tag starts with "www.nielsen.com", then only sending to SDK
if ([key isEqualToString:@"PRIV"] && [extraString rangeOfString:@"www.nielsen.com"].length > 0)
{

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
[nielsenApi sendID3:extraString];
});
}
}
</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">
//Setting observer to track timedMetadata
player.addObserver(self, forKeyPath: timedMetadataKey, options: NSKeyValueObservingOptions.new, context: &TimedMetadataObserverContext)</syntaxhighlight>
------------------------------------------------------
<syntaxhighlight lang="swift">
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {

if keyPath == timedMetadataKey {
if(context == &TimedMetadataObserverContext){
if change != nil {
let timedMetadataArray = change![.newKey]
if timedMetadataArray != nil && (timedMetadataArray! as AnyObject) is Array<Any> {
for item in timedMetadataArray as! [AVMetadataItem] {
//Handling TimedMetadata
self.handleTimedMetadata(metadataItem: item)
}
}
}
}
}
</syntaxhighlight>
------------------------------------------------------
<syntaxhighlight lang="swift">
func handleTimedMetadata(metadataItem: AVMetadataItem) {
guard let extraAttributeType = metadataItem.extraAttributes else {
return
}
let info : AVMetadataExtraAttributeKey = AVMetadataExtraAttributeKey(rawValue: "info")
let extraString = extraAttributeType[info] as AnyObject
let key = metadataItem.key as! String

//If tag starts with "www.nielsen.com", then only sending to SDK
if key == "PRIV" && extraString.range(of: "www.nielsen.com").length > 0 {

DispatchQueue.global(qos: .default).async { () -> Void in
self.nielsenApi?.sendID3(extraString as! String)
}
}
}

</syntaxhighlight>
}}

<blockquote>'''Note:''' ID3 tags are not applicable for International (Germany)</blockquote>

== IOS SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Scenario !! Method / Property !! DTVR !! DAR !! DCR !! International (Germany) !! Description
|-
| Initialize || [[initWithAppInfo:delegate:]] || ✔ || ✔ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| Measurement || [[play]] || ✔ || ✔ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. If this is not called then the “channel name” value populated will be the default value of “defaultChannelName”.
|-
| Measurement || [[loadMetadata]] || ✔ || ✔ || ✔ || ✔ || Used to send ad or content metadata to the SDK in the form of JSON string. Application constructs a JSON hashmap and calls this API.
|-
| Measurement || [[sendID3]] || ✔ || || || || Used to send the ID3 metadata.
|-
| Measurement || [[playheadPosition]] || || || ✔ || ✔ || Used to send the playhead position.
|-
| Measurement || [[stop]] || ✔ || || ✔ || ✔ || Used when playback is paused and when switching between ad and content or content and ad.
|-
| Measurement || [[end]] || ✔ || ✔ || ✔ || ✔ || Used when content playback is complete. This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content
|-
| Measurement || [[staticEnd]] || || || ✔ || ✔ || Used with DCR Static duration in between loadMetadata calls for static content when section name is the same but a new static view event and duration measurement restart is desired
|-
| Measurement || [[updateOTT]] || || || || ✔ || Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| Opt-out || [[optOutURL]] || ✔ || ✔ || ✔ || ✔ || Used to fetch the Nielsen opt-out web page URL.
|-
| Opt-out || [[userOptOut]] || ✔ || ✔ || ✔ || ✔ || Used to supply the response message from opt-out webpage to the SDK.
|-
| Opt-out || [[optOutStatus]] || ✔ || ✔ || ✔ || ✔ || Call this API to retrieve the Opt-Out or Opt-In state.
|-
| Opt-out
| [[appDisableApi]]
(kill switch)
|| ✔ || ✔ || ✔ || ✔ || Used to disable the SDK.
|-
| Viewability<br/>Audibility
| [[trackViewability]]
|| ✔ || || ✔ || ✔ || Used to start the viewability measurement.
|-
| Log || [[lastErrorDict]] || ✔ || ✔ || ✔ || ✔ || Returns SDK error in the form of dictionary if any error has occurred.
|-
| Log || [[lastEventDict]] || ✔ || ✔ || ✔ || ✔ || Returns SDK event in the form of dictionary if any event has occurred.
|-
| Log || [[meterVersion]] || ✔ || ✔ || ✔ || ✔ || Returns the current SDK version.
|-
| Log || [[nielsenId]] || ✔ || ✔ || ✔ || ✔ || Used to get a string defining the Nielsen ID (NUID) number for the device.
|-
| Log || [[demographicId]] || ✔ || ✔ || ✔ || ✔ || Used to retrieve UAID(v10.0.0.0+)/Demographic ID (Device ID) of the current device.
|-
| Log || [[deviceId]] || ✔ || ✔ || ✔ || ✔ || Used to get a Device ID of the current device(Introduced in v10.0.0.0).
|-
| Log || [[debug]] || ✔ || ✔ || ✔ || ✔ || Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
|}

== NielsenAppApi Class Description ==
The NielsenAppApi class is the primary application interface to the Nielsen App SDK. For example, after an instance object of the NielsenAppApi class is created and initialized, it can be used by the calling application to collect HLS timed metadata using the SDK’s [[sendID3]]: method. These are the public methods and properties exposed by the NielsenAppApi class:
<syntaxhighlight lang="objective-c">
@interface NielsenAppApi: NSObject

@property (readonly) BOOL optOutStatus;
@property (assign) BOOL appDisableApi;
@property (assign) BOOL debug;
@property (readonly, nonnull) NSString *nielsenId;
@property (readonly, nonnull) NSString *demographicId;
@property (readonly, nonnull) NSString *deviceId;
@property (readonly, nonnull) NSString *firstPartyId;
@property (readonly, nonnull) NSString *vendorId;
@property (readonly, nonnull) NSString *optOutURL;
@property (readonly, nullable) NSString *meterVersion;
@property (readonly, nullable) NSDictionary *lastEventDict;
@property (readonly, nullable) NSDictionary *lastErrorDict;

- (nullable instancetype)initWithAppInfo:(nonnull id)appInfo delegate:(nullable id<NielsenAppApiDelegate>)delegate

- (void)play:(nullable id)channelInfo;
- (void)loadMetadata:(nullable id)metadata;
– (void)stop;
– (void)end;
- (void)playheadPosition:(long long)playheadPos;
- (void)sendID3:(nonnull NSString *)data;
- (void)updateOTT:(nonnull id)ottInfo;
- (BOOL)userOptOut:(nonnull NSString *)optOut;
- (void)trackViewability:(nonnull NSDictionary *)data;

- (nonnull NSString *)getNielsenId __attribute((deprecated(("nielsenId is not used by the SDK anymore"))));
- (nonnull NSString *)optOutURLString __attribute((deprecated(("Please use optOutURL property instead."))));
- (nullable NSString *)getMeterVersion __attribute((deprecated(("Please use meterVersion property instead."))));
- (nullable NSDictionary *)getLastEventDict __attribute((deprecated(("Please use lastEventDict property instead."))));
- (nullable NSDictionary *)getLastErrorDict __attribute((deprecated(("Please use lastErrorDict property instead."))));

@protocol NielsenAppApiDelegate <NSObject>

@optional
- (void)nielsenAppApi:(nonnull NielsenAppApi *)appApi eventOccurred:(nonnull NSDictionary *)event;
- (void)nielsenAppApi:(nonnull NielsenAppApi *)appApi errorOccurred:(nonnull NSDictionary *)error;

@end
</syntaxhighlight>
=== AppApiEventCode ===
An enumeration with predefined App SDK event state transition codes.
<syntaxhighlight lang="objective-c">
typedef NS_ENUM(unsigned int, AppApiEventCode)
{
AppApiStartup = 2001,
AppApiShutdown = 2002,
}AppApiEventCode;
</syntaxhighlight>

=== App SDK Event Codes ===
{| class="wikitable"
|-
! Event Code !! Event Name !! Event Description
|-
| 2001 || AppApiStartup || App SDK has initialized successfully. It will happen only after App SDK has received a valid config file
|-
| 2002 || AppApiShutdown || App SDK is shutting down. It will happen just before App SDK is destroyed
|}
=== AppApiErrorCode ===
iOS contains two types of error codes, 1-15 and 1001-1009.

For, 1-15, an enumeration with predefined error codes which the App SDK object can generate.
<syntaxhighlight lang="objective-c">typedef NS_ENUM(unsigned int, LogCode) {
LogCodeFailedParseStartInfo, // 1.
LogCodeFailedParseMetadata, // 2.
LogCodeFailedProcessID3, // 3.
LogCodeFailedReceiveConfig, // 4.
LogCodeFailedParseConfig, // 5.
LogCodeFailedStartProcessor, // 6.
LogCodeFailedCreateUrl, // 7.
LogCodeFailedCreateRequest, // 8.
LogCodeFailedSendHttpRequest, // 9.
LogCodeFailedSendPing, // 10.
LogCodeFailedSendTSV, // 11.
LogCodeFailedSendStationRequest, // 12.
LogCodeFailedAccessDatabase, // 13.
LogCodeException, // 14.
LogCodeInvalidPlayheadPosition, // 15.
LogCodeLongAd, // 16.
LogCodeIncorrectSfcode, // 17.
LogCodeHemUidExceedLimit, // 18.
LogCodeViewabilityUnableFindView // 19.
};</syntaxhighlight>

For, 1001-1009, an enumeration with predefined error codes which the App SDK object can generate.
<syntaxhighlight lang="objective-c">
typedef NS_ENUM(unsigned int, AppApiErrorCode)
{
AppApiNetworkConnectionFailure = 1001,
AppApiFileWriteFailure = 1002,
AppApiFileReadFailure = 1003,
AppApiEmptyValue = 1004,
AppApiEmptyAppName = 1005,
AppApiEmptyAppVersion = 1006,
AppApiEmptyAppId = 1007,
AppApiAnExceptionOccured = 1008,
AppApiUnknownExceptionOccured = 1009
};
</syntaxhighlight>

=== App SDK Error Codes ===
{| class="wikitable"
|-
! Error Code !! Error Name !! Error Description
|-
| 1 || LogCodeFailedParseStartInfo || Failed to parse the play() JSON string
|-
| 2 || LogCodeFailedParseMetadata || Failed to parse the loadMetadata() JSON string
|-
| 3 || LogCodeFailedProcessID3 || Failed to process ID3 data on a data processor
|-
| 4 || LogCodeFailedReceiveConfig || Failed to receive configuration file from Census
|-
| 5 || LogCodeFailedParseConfig || Failed to parse the config file JSON string
|-
| 6 || LogCodeFailedStartProcessor || Failed to create SDK processor
|-
| 7 || LogCodeFailedCreateUrl || Failed to generate URL due to missing mandatory parameter
|-
| 8 || LogCodeFailedCreateRequest || Failed to create request in HTTP client
|-
| 9 || LogCodeFailedSendHttpRequest || Failed sending HTTP or HTTPS request
|-
| 10 || LogCodeFailedSendPing || Failed to send ping
|-
| 11 || LogCodeFailedSendTSV || Failed to send TSV request
|-
| 12 || LogCodeFailedSendStationRequest || Failed to send StationId request
|-
| 13 || LogCodeFailedAccessDatabase || Failed to read/write from/to database table
|-
| 14 || LogCodeException || Any exception handled by SDK code
|-
| 15 || LogCodeInvalidPlayheadPosition || Invalid playhead position
|-
| 16 || LogCodeLongAd || Long ad
|-
| 17 || LogCodeIncorrectSfcode || Incorrect client supplied sfcode
|-
| 18 || LogCodeHemUidExceedLimit || Exceeded limit of chars for hem uid
|-
| 19 || LogCodeViewabilityUnableFindView || Viewability unable to find a view with the specificed tag
|}

{| class="wikitable"
|-
! Error Code !! Error Name !! Error Description
|-
| 1001 || AppApiNetworkConnectionFailure || App SDK Could not connect to server
|-
| 1002 || AppApiFileWriteFailure || App SDK Could not write to file
|-
| 1003 || AppApiFileReadFailure || App SDK Could not read data from file
|-
| 1004 || AppApiEmptyValue || Empty value Found.
|-
| 1005 || AppApiEmptyAppName || Cannot initialize SDK Object without an AppName(Player Name)
|-
| 1006 || AppApiEmptyAppVersion || Cannot initialize API Object without an AppVersion
|-
| 1007 || AppApiEmptyAppId || Cannot initialize API Object without an AppId
|-
| 1008 || AppApiAnExceptionOccured || Exception occurred
|-
| 1009 || AppApiUnknownExceptionOccured || Unknown exception occurred
|}

== Nielsen Sample Applications ==
Nielsen SDK client package contains iOS sample player applications based on native Players integrated with SDK framework. The players demonstrate all the supported functions of the SDK and show the integration details for both legacy and trackEvent API. There are players developed on Objective C and Swift. Implementation of the sample apps is based on native iOS AVPlayer.

The UI components of the iOS App SDK sample applications are common to both as shown below.
*From the Channel Selection buttons ⬇️ & ⬆️ , the user will be able select the channels to stream.
*The Info button ℹ️ displays information of the SDK version, current Nielsen ID used for the device, and the option for opt-out/opt-in.
*The Play ▶️ and Pause ⏸️ buttons will control the streaming of the selected channel.
*The area at the bottom of the window displays the current stream status.
*The Clear button 🔃 clears out the status window.
*The Email button 📧 can be used to email the tags and status in a text file to Nielsen.
If target device supports Picture-in-Picture playing, it could be activated by PIP button in the Video player window.
*Channel URLs and metadata are obtained from the JSON file named appConfig.json and stored in the application bundle.
=== Viewability testing ===
The sample applications shipped with the client package has support for viewability metrics verification. The player view can be moved using a finger-dragging gesture in the application window. This allows the tester to reduce the visible area of the player view and check the resulting data. There are additional UI buttons:
*Cover View button opens a popup with multiple UI controls which allow changing a player-view alpha and/or visibility as well to show a cover view in front of the player view.
*Alert button to open a native UI alert in the application.<br/>
[[File:PlayerView AlertView1.png|200px]]    [[File:PlayerViewDragging.png|200px]]    [[File:PlayerView CustomView.png|200px]]

== Nielsen Privacy Requirements ==
There are three primary methods for implementing user Opt-out preferences:
# [[Template:iOS_Privacy_and_Opt-Out#OS-level_Opt-out|OS-level Opt-out]] - managed by ''Limit Ad Tracking'' setting on device ('''preferred approach''').
# [[Template:iOS_Privacy_and_Opt-Out#Legacy_Opt-out|Legacy Opt-out]] - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)
# [https://engineeringportal.nielsen.com/docs/iOS_SDK_App_Level_Opt_Out App Level Opt-Out] - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged
=== Privacy Protections ===
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="10" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Device Advertiser ID (Apple IDFA or Google AdID/Android ID) || Yes || Yes
|-
| Cache Buster || Yes || Yes
|-
| App Version || Yes || No
|-
| App Name || Yes || No
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd<wbr />&placement_id=a4164b8fba9ee7c873a9c72c7091bb58<wbr />&creative_id=25280139b61a947e127a52f56c8a2fdd<wbr />&segment1=9000<wbr />&segment2=41<wbr />&segment3=iOS<wbr />&OSVer=iOS6.1<wbr />&c9=<wbr />&devgrp=tablet<wbr />&h=f5f243fe6d<wbr />&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

=== TVOS Opt-out ===
To Opt-Out, users must have access to “About Nielsen Measurement” page.

TVOS does not support creating instances of UIWebView and display web pages. Instead it makes use of a TVML page (built on TVML template) which displays information in a specific order.

Opt-Out page is built on descriptiveAlertTemplate and appears as follows:

[[File:TVOs OptOut LimitAdTracking1.png|link=]]

[[File:TVOs OptOut LimitAdTracking2.png|link=]]

=== Opt-out wording ===
<blockquote>About Nielsen Measurement

YOUR CHOICES

Television and the way we watch it have come a long way since Nielsen began measuring TV audiences in 1950. Today, the ability to watch programs at any time and on multiple devices amplifies the need for exceptionally adept and flexible audience measurement capabilities.
Consumers are changing with the times, and the same goes for Nielsen. As technology continues to evolve and media companies try new ways to attract viewers, understanding what consumers are watching — and what they're watching on — is more important than ever. Today, viewing video is a personal and mobile experience —anytime and anywhere. Our capabilities provide relevant metrics that are necessary to inform successful marketing and programming and drive continued growth.
As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. While our digital measurement products are not used to identify you in any way, 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.
Nielsen believes that you should have a choice about whether to contribute to our research and insights. To opt out of Nielsen measurement on this device, you need only to activate the “Limit Ad Tracking” option in your device's settings. If you have this app on more than one mobile device, you will need to change the settings on each device.
If, after you have opted out, you change your mind and would like to opt back in, please deactivate the “Limit Ad Tracking” option in your device's settings.
To learn more about our digital measurement products and your choices in regard to them, please visit https://www.nielsen.com/digitaIprivacy.</blockquote>

Users need to toggle the “Limit Ad Tracking” option in order to Opt-In / Opt-Out of Nielsen Measurement.

To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.

<blockquote>'''Note:''' For API Version 5.1 and above, 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.</blockquote>

== Viewability and Audibility Implementation ==
Viewability metrics allow AppSDK to track the visibility of the player and collect information about how much of the player container is visible to the end user during playback.

The viewability pings will be fired following the same rules as measurement pings. Viewability pings will be POST requests, not GET requests like other data pings. POST body for viewability requests will contain the key-value pairs in JSON format. The key parameters in the URL schemes are '''invs, inau, inss, invp''' and '''ines''' which will contain the collected viewability data. This data will be formatted according to the specific rules so that downstream it will be possible to match measurement and viewability data for a session.

Audibility metrics will capture the volume level as well as mute/unmute state of the device during playback.

=== Data Collected ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| Measured Value || Value is different for different request parameters:
{| class="wikitable"
|-
| '''invs''' || Intersection ratio for the target view in percent (from 0 to 100). Default threshold for this value is 5. Example: ['''50''',1,1528457356,10]
|-
| '''inau''' || Volume level on the device in percent (from 0 to 100), where 0 - mute, 100 - max volume level. Default threshold for this value is 1. Example: ['''30''',1,1528457356,10]
|-
| '''inss''' || Device screen size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"1024x768"''',1,1528457356,10]
|-
| '''invp''' || Current window size. This is different than the device screen size in a multiple scene mode or on a desktop. Format is "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"800x600"''',1,1528457356,10]
|-
| '''ines''' || Player view size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"300x200"''',1,1528457356,10]
|}
|-
| Start offset || Value contains the first playhead or the first id3 offset with non-null CID after start, flush or resume. Example playhead: [50,'''1''',1528457356,10]. Example id3 offset: [50,'''70100''',1528457356,10]
|-
| Start timestamp || Timestamp value when the time period related to this time series item was started. Example: [50,1,'''1528457356''',10]
|-
| Duration || Duration value is calculated as a difference between the last playhead and the first playhead for the current time series item. Example: [50,1,1528457356,'''10''']
|}

Viewability support requires additional parameters to be provided from player applications to the SDK. In order to provide these parameters and to start the viewability measurement, the following method has been added to the public SDK API (please refer to the [[trackViewability|trackViewability public API reference]] for details and usage examples):
<br/><br/>
'''Objective C'''
<syntaxhighlight lang="objective-c">
- (void)trackViewability:(nonnull NSDictionary *)data;
</syntaxhighlight>
<br/>
'''Swift'''
<syntaxhighlight lang="swift">
func trackViewability(_ data: [String : Any])
</syntaxhighlight>

<br/>
For Audibility measurement SDK uses iOS system API in order to get the volume level for the device:
<syntaxhighlight lang="swift">
AVAudioSession.sharedInstance().outputVolume
</syntaxhighlight>

iOS SDK API Reference

2025-04-03T15:22:41Z

AnkitAgrawal: /* IOS SDK API Methods & Properties */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
== Overview ==
The Nielsen SDK is one of 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 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
== Prerequisites ==
To start using the App SDK, the following items are required:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''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 frameworks and '''sample implementation'''; ''See [[iOS SDK Release Notes]]'' || [[Special:Downloads|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 information on how to get a Nielsen App SDK and appid.
==SDK Implementation==
Information on how to obtain, how to configure your development environment, and how to Initialize the Nielsen SDK is located in either the [[DCR Video iOS SDK|DCR Implementation Guide,]] or the [[DTVR iOS SDK|DTVR Implementation Guide]] depending on your requirements.
___TOC___

== Nielsen iOS App SDK Application Life Cycle ==

[[File:initialization_appcycle.png|center|link=]]

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 '''Idle 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 an event to occur.
# '''Processing state''' – The SDK instance is processing playing information. The <code>'''play'''</code> and <code>'''loadMetadata''' </code> calls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.
## <code>'''playheadPosition'''</code> – Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).
## <code>'''stop'''</code> – Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.
## <code>'''end'''</code> – SDK instance exits from Processing state when this API is called.
# '''Disabled state''' – The SDK instance is disabled and is not processing playing information.
## <code>'''appDisableApi'''</code> is set to <code>true</code>

<blockquote>'''Note:''' For API Version 5.1 and above, 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 <code>'''play'''</code>, <code>'''loadMetadata''' </code> and <code>'''playheadPosition'''</code> </blockquote>

[[File:appsdkTimeline-DCR.png|icon|link=]]
=== Finite-state machine table ===
This table provides the possible changes of state for the SDK instance, when it is in a specific state and receives an API call.
{| class="wikitable"
|-
! API call received !! Initial State !! Idle State !! Processing State !! Disabled State
|-
| <code>[[initWithAppInfo:delegate:]]</code> || IDLE STATE (OR)

DISABLED STATE
|| IDLE STATE || - || -
|-
| <code>[[play]]</code> & <code>[[loadMetadata]]</code>|| - || PROCESSING

STATE
|| - || -
|-
| <code>[[playheadPosition]]</code> || - || - || PROCESSING

STATE
|| -
|-
| <code>[[sendID3]]</code> || - || - || PROCESSING

STATE
|| -
|-
| <code>[[stop]]</code> || - || - || IDLE STATE || -
|-
| <code>[[end]]</code> || - || - || IDLE STATE || -
|-
| <code>[[appDisableApi]]</code>: YES || - || DISABLED

STATE
|| - || -
|-
| <code>[[appDisableApi]]</code>: NO || - || - || - || IDLE STATE (OR)

DISABLED STATE
|-
| <code>[[userOptOut]]</code>: YES || - || - || IDLE STATE || -
|-
| <code>[[userOptOut]]</code>: NO || - || PROCESSING

STATE
| -
| -
|-
| colspan = 5 | '-' indicates that no API call is expected.
|}

=== Handling JSON Metadata ===
All the SDK methods handles 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 unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* 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, 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.
The below is a sample - detailed information on the '''metadata requirements''' are located in either the [[DCR Video iOS SDK|DCR Implementation Guide,]] or the [[DTVR iOS SDK|DTVR Implementation Guide]]
{{ExampleCode|
|Swift =
<syntaxhighlight lang="swift">
let contentMetadata = [
"type": "content",
"assetid": "C77664",
"title": "Program S2, E3",
"isfullepisode": "Yes",
"program": "Program Name",
"length": "3600",
"airdate": "20171020 10:05:00",
"adloadtype": "2",
"segB": "CustomSegmentValueB", //optional
"segC": "CustomSegmentValueC", //optional
];
</syntaxhighlight>
|Objective C = <syntaxhighlight lang="objective-c">
NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "C77664",
@ "title": @ "S2,E3",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20180120 10:00:00",
@ "adloadtype": @ "2",
@ "segB": @ "CustomSegmentValueB", //optional
@ "segC": @ "CustomSegmentValueC", //optional
}
</syntaxhighlight>
}}

== Retrieving ID3 Tags ==
'''Only required for DTVR clients'''<br>
'''Not applicable for German Clients'''<br>

ID3 tags have a payload of about 249 characters and start with "www.nielsen.com".

ID3 tags are extracted by observing a property called timedMetadata on the iOS player item. Now this is done via a concept called KVO (Key Value Observing), where you register interest in a property, and the runtime will let you know when it has changed.

Both the iOS native players have the ability to extract ID3 tags, If any other player apart from iOS native players (AVPlayer, MPMoviePlayer) is used, check and ensure that the player has the capability to extract ID3 tags.

=== Examples of extracting ID3 tags from the iOS Native Player ===
{{ExampleCode|
|Objective C = <syntaxhighlight lang="objective-c">
//Adding observer to player to track play,pause and reverse
[player addObserver:self
forKeyPath:@"rate"
options:(NSKeyValueObservingOptionNew)
context:nil];
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
//Setting observer to track timedMetadata
[player addObserver:self
forKeyPath: timedMetadataKey
options: (NSKeyValueObservingOptionNew)
context: &TimedMetadataObserverContext];
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
- (void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context
{
if(keyPath == timedMetadataKey){
if(context == &TimedMetadataObserverContext){

id newMetadataArray = [change objectForKey:NSKeyValueChangeNewKey];
if (newMetadataArray != [NSNull null])
{
array = newMetadataArray;
for (AVMetadataItem *metadataItem in array)
{
//Handling TimedMetadata
[self handleTimedMetadata: metadataItem];
}
}

}
}
</syntaxhighlight>
------------------------------
<syntaxhighlight lang="objective-c">
- (void)handleTimedMetadata:(AVMetadataItem *)timedMetadata
{
// We expect the content to contain plists encoded as timed metadata
// AVPlayer turns these into NSDictionaries

id extraAttributeType = [timedMetadata extraAttributes];
NSString *extraString = nil;
if ([extraAttributeType isKindOfClass:[NSDictionary class]])
{
extraString = [extraAttributeType valueForKey:@"info"];
}
else if ([extraAttributeType isKindOfClass:[NSString class]])
{
extraString = extraAttributeType;
}

NSString *key = [NSString stringWithFormat:@"%@", [timedMetadata key]];

//If tag starts with "www.nielsen.com", then only sending to SDK
if ([key isEqualToString:@"PRIV"] && [extraString rangeOfString:@"www.nielsen.com"].length > 0)
{

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
[nielsenApi sendID3:extraString];
});
}
}
</syntaxhighlight>
|Swift = <syntaxhighlight lang="swift">
//Setting observer to track timedMetadata
player.addObserver(self, forKeyPath: timedMetadataKey, options: NSKeyValueObservingOptions.new, context: &TimedMetadataObserverContext)</syntaxhighlight>
------------------------------------------------------
<syntaxhighlight lang="swift">
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {

if keyPath == timedMetadataKey {
if(context == &TimedMetadataObserverContext){
if change != nil {
let timedMetadataArray = change![.newKey]
if timedMetadataArray != nil && (timedMetadataArray! as AnyObject) is Array<Any> {
for item in timedMetadataArray as! [AVMetadataItem] {
//Handling TimedMetadata
self.handleTimedMetadata(metadataItem: item)
}
}
}
}
}
</syntaxhighlight>
------------------------------------------------------
<syntaxhighlight lang="swift">
func handleTimedMetadata(metadataItem: AVMetadataItem) {
guard let extraAttributeType = metadataItem.extraAttributes else {
return
}
let info : AVMetadataExtraAttributeKey = AVMetadataExtraAttributeKey(rawValue: "info")
let extraString = extraAttributeType[info] as AnyObject
let key = metadataItem.key as! String

//If tag starts with "www.nielsen.com", then only sending to SDK
if key == "PRIV" && extraString.range(of: "www.nielsen.com").length > 0 {

DispatchQueue.global(qos: .default).async { () -> Void in
self.nielsenApi?.sendID3(extraString as! String)
}
}
}

</syntaxhighlight>
}}

<blockquote>'''Note:''' ID3 tags are not applicable for International (Germany)</blockquote>

== IOS SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Scenario !! Method / Property !! DTVR !! DAR !! DCR !! International (Germany) !! Description
|-
| Initialize || [[initWithAppInfo:delegate:]] || ✔ || ✔ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| Measurement || [[play]] || ✔ || ✔ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. If this is not called then the “channel name” value populated will be the default value of “defaultChannelName”.
|-
| Measurement || [[loadMetadata]] || ✔ || ✔ || ✔ || ✔ || Used to send ad or content metadata to the SDK in the form of JSON string. Application constructs a JSON hashmap and calls this API.
|-
| Measurement || [[sendID3]] || ✔ || || || || Used to send the ID3 metadata.
|-
| Measurement || [[playheadPosition]] || || || ✔ || ✔ || Used to send the playhead position.
|-
| Measurement || [[stop]] || ✔ || || ✔ || ✔ || Used when playback is paused and when switching between ad and content or content and ad.
|-
| Measurement || [[end]] || ✔ || ✔ || ✔ || ✔ || Used when content playback is complete. This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content
|-
| Measurement || [[staticEnd]] || || || ✔ || ✔ || Used with DCR Static duration in between loadMetadata calls for static content when section name is the same but a new static view event and duration measurement restart is desired
|-
| Measurement || [[updateOTT]] || || || || ✔ || Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| Opt-out || [[optOutURL]] || ✔ || ✔ || ✔ || ✔ || Used to fetch the Nielsen opt-out web page URL.
|-
| Opt-out || [[userOptOut]] || ✔ || ✔ || ✔ || ✔ || Used to supply the response message from opt-out webpage to the SDK.
|-
| Opt-out || [[optOutStatus]] || ✔ || ✔ || ✔ || ✔ || Call this API to retrieve the Opt-Out or Opt-In state.
|-
| Opt-out
| [[appDisableApi]]
(kill switch)
|| ✔ || ✔ || ✔ || ✔ || Used to disable the SDK.
|-
| Viewability<br/>Audibility
| [[trackViewability]]
|| ✔ || || ✔ || ✔ || Used to start the viewability measurement.
|-
| Log || [[lastErrorDict]] || ✔ || ✔ || ✔ || ✔ || Returns SDK error in the form of dictionary if any error has occurred.
|-
| Log || [[lastEventDict]] || ✔ || ✔ || ✔ || ✔ || Returns SDK event in the form of dictionary if any event has occurred.
|-
| Log || [[meterVersion]] || ✔ || ✔ || ✔ || ✔ || Returns the current SDK version.
|-
| Log || [[nielsenId]] || ✔ || ✔ || ✔ || ✔ || Used to get a string defining the Nielsen ID (NUID) number for the device.
|-
| Log || [[demographicId]] || ✔ || ✔ || ✔ || ✔ || Used to retrieve UAID(v10.0.0.0+)/Demographic ID (Device ID) of the current device.
|-
| Log || [[deviceId]] || ✔ || ✔ || ✔ || ✔ || Used to get a Device ID of the current device(Introduced in v10.0.0.0).
|-
| Log || [[debug]] || ✔ || ✔ || ✔ || ✔ || Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
|}

== NielsenAppApi Class Description ==
The NielsenAppApi class is the primary application interface to the Nielsen App SDK. For example, after an instance object of the NielsenAppApi class is created and initialized, it can be used by the calling application to collect HLS timed metadata using the SDK’s [[sendID3]]: method. These are the public methods and properties exposed by the NielsenAppApi class:
<syntaxhighlight lang="objective-c">
@interface NielsenAppApi: NSObject

@property (readonly) BOOL optOutStatus;
@property (assign) BOOL appDisableApi;
@property (assign) BOOL debug;
@property (readonly, nonnull) NSString *nielsenId;
@property (readonly, nonnull) NSString *demographicId;
@property (readonly, nonnull) NSString *firstPartyId;
@property (readonly, nonnull) NSString *vendorId;
@property (readonly, nonnull) NSString *optOutURL;
@property (readonly, nullable) NSString *meterVersion;
@property (readonly, nullable) NSDictionary *lastEventDict;
@property (readonly, nullable) NSDictionary *lastErrorDict;

- (nullable instancetype)initWithAppInfo:(nonnull id)appInfo delegate:(nullable id<NielsenAppApiDelegate>)delegate

- (void)play:(nullable id)channelInfo;
- (void)loadMetadata:(nullable id)metadata;
– (void)stop;
– (void)end;
- (void)playheadPosition:(long long)playheadPos;
- (void)sendID3:(nonnull NSString *)data;
- (void)updateOTT:(nonnull id)ottInfo;
- (BOOL)userOptOut:(nonnull NSString *)optOut;
- (void)trackViewability:(nonnull NSDictionary *)data;

- (nonnull NSString *)getNielsenId __attribute((deprecated(("nielsenId is not used by the SDK anymore"))));
- (nonnull NSString *)optOutURLString __attribute((deprecated(("Please use optOutURL property instead."))));
- (nullable NSString *)getMeterVersion __attribute((deprecated(("Please use meterVersion property instead."))));
- (nullable NSDictionary *)getLastEventDict __attribute((deprecated(("Please use lastEventDict property instead."))));
- (nullable NSDictionary *)getLastErrorDict __attribute((deprecated(("Please use lastErrorDict property instead."))));

@protocol NielsenAppApiDelegate <NSObject>

@optional
- (void)nielsenAppApi:(nonnull NielsenAppApi *)appApi eventOccurred:(nonnull NSDictionary *)event;
- (void)nielsenAppApi:(nonnull NielsenAppApi *)appApi errorOccurred:(nonnull NSDictionary *)error;

@end
</syntaxhighlight>
=== AppApiEventCode ===
An enumeration with predefined App SDK event state transition codes.
<syntaxhighlight lang="objective-c">
typedef NS_ENUM(unsigned int, AppApiEventCode)
{
AppApiStartup = 2001,
AppApiShutdown = 2002,
}AppApiEventCode;
</syntaxhighlight>

=== App SDK Event Codes ===
{| class="wikitable"
|-
! Event Code !! Event Name !! Event Description
|-
| 2001 || AppApiStartup || App SDK has initialized successfully. It will happen only after App SDK has received a valid config file
|-
| 2002 || AppApiShutdown || App SDK is shutting down. It will happen just before App SDK is destroyed
|}
=== AppApiErrorCode ===
iOS contains two types of error codes, 1-15 and 1001-1009.

For, 1-15, an enumeration with predefined error codes which the App SDK object can generate.
<syntaxhighlight lang="objective-c">typedef NS_ENUM(unsigned int, LogCode) {
LogCodeFailedParseStartInfo, // 1.
LogCodeFailedParseMetadata, // 2.
LogCodeFailedProcessID3, // 3.
LogCodeFailedReceiveConfig, // 4.
LogCodeFailedParseConfig, // 5.
LogCodeFailedStartProcessor, // 6.
LogCodeFailedCreateUrl, // 7.
LogCodeFailedCreateRequest, // 8.
LogCodeFailedSendHttpRequest, // 9.
LogCodeFailedSendPing, // 10.
LogCodeFailedSendTSV, // 11.
LogCodeFailedSendStationRequest, // 12.
LogCodeFailedAccessDatabase, // 13.
LogCodeException, // 14.
LogCodeInvalidPlayheadPosition, // 15.
LogCodeLongAd, // 16.
LogCodeIncorrectSfcode, // 17.
LogCodeHemUidExceedLimit, // 18.
LogCodeViewabilityUnableFindView // 19.
};</syntaxhighlight>

For, 1001-1009, an enumeration with predefined error codes which the App SDK object can generate.
<syntaxhighlight lang="objective-c">
typedef NS_ENUM(unsigned int, AppApiErrorCode)
{
AppApiNetworkConnectionFailure = 1001,
AppApiFileWriteFailure = 1002,
AppApiFileReadFailure = 1003,
AppApiEmptyValue = 1004,
AppApiEmptyAppName = 1005,
AppApiEmptyAppVersion = 1006,
AppApiEmptyAppId = 1007,
AppApiAnExceptionOccured = 1008,
AppApiUnknownExceptionOccured = 1009
};
</syntaxhighlight>

=== App SDK Error Codes ===
{| class="wikitable"
|-
! Error Code !! Error Name !! Error Description
|-
| 1 || LogCodeFailedParseStartInfo || Failed to parse the play() JSON string
|-
| 2 || LogCodeFailedParseMetadata || Failed to parse the loadMetadata() JSON string
|-
| 3 || LogCodeFailedProcessID3 || Failed to process ID3 data on a data processor
|-
| 4 || LogCodeFailedReceiveConfig || Failed to receive configuration file from Census
|-
| 5 || LogCodeFailedParseConfig || Failed to parse the config file JSON string
|-
| 6 || LogCodeFailedStartProcessor || Failed to create SDK processor
|-
| 7 || LogCodeFailedCreateUrl || Failed to generate URL due to missing mandatory parameter
|-
| 8 || LogCodeFailedCreateRequest || Failed to create request in HTTP client
|-
| 9 || LogCodeFailedSendHttpRequest || Failed sending HTTP or HTTPS request
|-
| 10 || LogCodeFailedSendPing || Failed to send ping
|-
| 11 || LogCodeFailedSendTSV || Failed to send TSV request
|-
| 12 || LogCodeFailedSendStationRequest || Failed to send StationId request
|-
| 13 || LogCodeFailedAccessDatabase || Failed to read/write from/to database table
|-
| 14 || LogCodeException || Any exception handled by SDK code
|-
| 15 || LogCodeInvalidPlayheadPosition || Invalid playhead position
|-
| 16 || LogCodeLongAd || Long ad
|-
| 17 || LogCodeIncorrectSfcode || Incorrect client supplied sfcode
|-
| 18 || LogCodeHemUidExceedLimit || Exceeded limit of chars for hem uid
|-
| 19 || LogCodeViewabilityUnableFindView || Viewability unable to find a view with the specificed tag
|}

{| class="wikitable"
|-
! Error Code !! Error Name !! Error Description
|-
| 1001 || AppApiNetworkConnectionFailure || App SDK Could not connect to server
|-
| 1002 || AppApiFileWriteFailure || App SDK Could not write to file
|-
| 1003 || AppApiFileReadFailure || App SDK Could not read data from file
|-
| 1004 || AppApiEmptyValue || Empty value Found.
|-
| 1005 || AppApiEmptyAppName || Cannot initialize SDK Object without an AppName(Player Name)
|-
| 1006 || AppApiEmptyAppVersion || Cannot initialize API Object without an AppVersion
|-
| 1007 || AppApiEmptyAppId || Cannot initialize API Object without an AppId
|-
| 1008 || AppApiAnExceptionOccured || Exception occurred
|-
| 1009 || AppApiUnknownExceptionOccured || Unknown exception occurred
|}

== Nielsen Sample Applications ==
Nielsen SDK client package contains iOS sample player applications based on native Players integrated with SDK framework. The players demonstrate all the supported functions of the SDK and show the integration details for both legacy and trackEvent API. There are players developed on Objective C and Swift. Implementation of the sample apps is based on native iOS AVPlayer.

The UI components of the iOS App SDK sample applications are common to both as shown below.
*From the Channel Selection buttons ⬇️ & ⬆️ , the user will be able select the channels to stream.
*The Info button ℹ️ displays information of the SDK version, current Nielsen ID used for the device, and the option for opt-out/opt-in.
*The Play ▶️ and Pause ⏸️ buttons will control the streaming of the selected channel.
*The area at the bottom of the window displays the current stream status.
*The Clear button 🔃 clears out the status window.
*The Email button 📧 can be used to email the tags and status in a text file to Nielsen.
If target device supports Picture-in-Picture playing, it could be activated by PIP button in the Video player window.
*Channel URLs and metadata are obtained from the JSON file named appConfig.json and stored in the application bundle.
=== Viewability testing ===
The sample applications shipped with the client package has support for viewability metrics verification. The player view can be moved using a finger-dragging gesture in the application window. This allows the tester to reduce the visible area of the player view and check the resulting data. There are additional UI buttons:
*Cover View button opens a popup with multiple UI controls which allow changing a player-view alpha and/or visibility as well to show a cover view in front of the player view.
*Alert button to open a native UI alert in the application.<br/>
[[File:PlayerView AlertView1.png|200px]]    [[File:PlayerViewDragging.png|200px]]    [[File:PlayerView CustomView.png|200px]]

== Nielsen Privacy Requirements ==
There are three primary methods for implementing user Opt-out preferences:
# [[Template:iOS_Privacy_and_Opt-Out#OS-level_Opt-out|OS-level Opt-out]] - managed by ''Limit Ad Tracking'' setting on device ('''preferred approach''').
# [[Template:iOS_Privacy_and_Opt-Out#Legacy_Opt-out|Legacy Opt-out]] - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)
# [https://engineeringportal.nielsen.com/docs/iOS_SDK_App_Level_Opt_Out App Level Opt-Out] - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged
=== Privacy Protections ===
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="10" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Device Advertiser ID (Apple IDFA or Google AdID/Android ID) || Yes || Yes
|-
| Cache Buster || Yes || Yes
|-
| App Version || Yes || No
|-
| App Name || Yes || No
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd<wbr />&placement_id=a4164b8fba9ee7c873a9c72c7091bb58<wbr />&creative_id=25280139b61a947e127a52f56c8a2fdd<wbr />&segment1=9000<wbr />&segment2=41<wbr />&segment3=iOS<wbr />&OSVer=iOS6.1<wbr />&c9=<wbr />&devgrp=tablet<wbr />&h=f5f243fe6d<wbr />&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

=== TVOS Opt-out ===
To Opt-Out, users must have access to “About Nielsen Measurement” page.

TVOS does not support creating instances of UIWebView and display web pages. Instead it makes use of a TVML page (built on TVML template) which displays information in a specific order.

Opt-Out page is built on descriptiveAlertTemplate and appears as follows:

[[File:TVOs OptOut LimitAdTracking1.png|link=]]

[[File:TVOs OptOut LimitAdTracking2.png|link=]]

=== Opt-out wording ===
<blockquote>About Nielsen Measurement

YOUR CHOICES

Television and the way we watch it have come a long way since Nielsen began measuring TV audiences in 1950. Today, the ability to watch programs at any time and on multiple devices amplifies the need for exceptionally adept and flexible audience measurement capabilities.
Consumers are changing with the times, and the same goes for Nielsen. As technology continues to evolve and media companies try new ways to attract viewers, understanding what consumers are watching — and what they're watching on — is more important than ever. Today, viewing video is a personal and mobile experience —anytime and anywhere. Our capabilities provide relevant metrics that are necessary to inform successful marketing and programming and drive continued growth.
As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. While our digital measurement products are not used to identify you in any way, 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.
Nielsen believes that you should have a choice about whether to contribute to our research and insights. To opt out of Nielsen measurement on this device, you need only to activate the “Limit Ad Tracking” option in your device's settings. If you have this app on more than one mobile device, you will need to change the settings on each device.
If, after you have opted out, you change your mind and would like to opt back in, please deactivate the “Limit Ad Tracking” option in your device's settings.
To learn more about our digital measurement products and your choices in regard to them, please visit https://www.nielsen.com/digitaIprivacy.</blockquote>

Users need to toggle the “Limit Ad Tracking” option in order to Opt-In / Opt-Out of Nielsen Measurement.

To retrieve the current Opt-Out status of a device, use the [[optOutStatus]] method.

<blockquote>'''Note:''' For API Version 5.1 and above, 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.</blockquote>

== Viewability and Audibility Implementation ==
Viewability metrics allow AppSDK to track the visibility of the player and collect information about how much of the player container is visible to the end user during playback.

The viewability pings will be fired following the same rules as measurement pings. Viewability pings will be POST requests, not GET requests like other data pings. POST body for viewability requests will contain the key-value pairs in JSON format. The key parameters in the URL schemes are '''invs, inau, inss, invp''' and '''ines''' which will contain the collected viewability data. This data will be formatted according to the specific rules so that downstream it will be possible to match measurement and viewability data for a session.

Audibility metrics will capture the volume level as well as mute/unmute state of the device during playback.

=== Data Collected ===
{| class="wikitable"
|-
! Parameter !! Description
|-
| Measured Value || Value is different for different request parameters:
{| class="wikitable"
|-
| '''invs''' || Intersection ratio for the target view in percent (from 0 to 100). Default threshold for this value is 5. Example: ['''50''',1,1528457356,10]
|-
| '''inau''' || Volume level on the device in percent (from 0 to 100), where 0 - mute, 100 - max volume level. Default threshold for this value is 1. Example: ['''30''',1,1528457356,10]
|-
| '''inss''' || Device screen size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"1024x768"''',1,1528457356,10]
|-
| '''invp''' || Current window size. This is different than the device screen size in a multiple scene mode or on a desktop. Format is "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"800x600"''',1,1528457356,10]
|-
| '''ines''' || Player view size as "WxH", where W - is width in pixels, H - is height in pixels. Example: ['''"300x200"''',1,1528457356,10]
|}
|-
| Start offset || Value contains the first playhead or the first id3 offset with non-null CID after start, flush or resume. Example playhead: [50,'''1''',1528457356,10]. Example id3 offset: [50,'''70100''',1528457356,10]
|-
| Start timestamp || Timestamp value when the time period related to this time series item was started. Example: [50,1,'''1528457356''',10]
|-
| Duration || Duration value is calculated as a difference between the last playhead and the first playhead for the current time series item. Example: [50,1,1528457356,'''10''']
|}

Viewability support requires additional parameters to be provided from player applications to the SDK. In order to provide these parameters and to start the viewability measurement, the following method has been added to the public SDK API (please refer to the [[trackViewability|trackViewability public API reference]] for details and usage examples):
<br/><br/>
'''Objective C'''
<syntaxhighlight lang="objective-c">
- (void)trackViewability:(nonnull NSDictionary *)data;
</syntaxhighlight>
<br/>
'''Swift'''
<syntaxhighlight lang="swift">
func trackViewability(_ data: [String : Any])
</syntaxhighlight>

<br/>
For Audibility measurement SDK uses iOS system API in order to get the volume level for the device:
<syntaxhighlight lang="swift">
AVAudioSession.sharedInstance().outputVolume
</syntaxhighlight>

deviceId

2025-04-03T15:22:13Z

AnkitAgrawal: v10.0.0.0 Changes

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Retrieves Device ID of the current device. Introduced in SDK v10.0.0.0.
==Syntax==
<syntaxhighlight lang="objective-c">
@property (readonly) NSString *deviceId;
</syntaxhighlight>
==Input Parameters==
{| class="wikitable"
|-
!Parameter!!Description
|-
|None||
|}
==Output Parameters==
{| class="wikitable"
|-
!Output Parameters (Return value)!!Description
|-
|deviceId||Returns a NSString object containing the Device ID.
|}

Digital Measurement iOS Suffix Guide

2025-04-03T14:20:56Z

AnkitAgrawal: Support for VisionOS v10.0.0.0

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{Breadcrumb|Digital Measurement iOS Artifactory Guide}} {{CurrentBreadcrumb}}
[[Category:Digital]]

The Nielsen AppSDK has various configurations per market and distribution type, which can be determined by reviewing the sdk suffix. The first part will be the SDK version: 3 digits for the major SDK version and 1 digit for the minor SDK version. EG: <code>ai.8.1.0.0_abc</code>

= iOS app sdk version suffix=
Below are details of possible suffix characters with description.

{| class="wikitable"
|-
! Character Index in suffix !! Possible Values!! Description
|-
|0 (first character in suffix)||g,a and v||<code>g</code> means it's the GLOBAL flavored sdk (Default).<br><code>a</code> means the build was designed for AGF.<br><code>v</code> identifies the VRI flavoured sdk.
|-
|1 (second character in suffix)||a,s and l ||<code>a</code> means Artifactory Cocoapods/SPM/Carthage<br><code>s</code> Standard Framework.<br> <code>l</code> Adobe Launch Extension.
|-
|2 (third character in suffix)||s,d,c or x ||<code>s</code> means Static Linking.<br><code>d</code> means Dynamic Linking.<br><code>c</code> means Static xcframework.<br><code>x</code> means Dynamic xcframework.<br>
|-
|3 (fourth character in suffix)||a,n or k||<code>a</code> means AdSupport is included. <br><code>n</code> AdSupport is NOT included<br> <code>k</code> No IDFA or IDFV (kids framework).
|-
|4 (fifth character in suffix)||t and o||<code>t</code>instantiated using NielsenEventTracker class.<br><code>o</code> means sdk is getting instantiated using AppSdk class (Default).
|-
|5 (sixth character in suffix)||h,w,r and n||<code>h</code> then sdk supports Hybrid Webviews.<br> <code>w</code> identifies React Native Webview support.<br><code>r</code> sdk supports React Native standard bridge.<br><code>n</code> means sdk supports Native apps.
|-
|6 (seventh character in suffix)||t,i,m,c and v||<code>t</code> then sdk running on tvOS.<br> <code>i</code> sdk running on iOS App on iPhone or iPad.<br><code>m</code> sdk running on iOS App on Mac M1.<br><code>c</code> means sdk running on Catalyst App.
<code>v</code> means sdk running on VisionOS App.
|}
Here is an example of a possible suffix in app sdk meter version

* '''ai.8.1.0.0_gadaoni'''
** Sdk version 8.1.0.0 with '''Global flavor'''
** integrated as a '''cocoapod'''
** supporting '''Dynamic Framework'''
** '''Adsupport'''
** '''AppSdk class''' to instantiate
** supporting '''native apps'''
** running on '''iOS App on iPhone or iPad'''.
<br>
.

Digital Measurement Android Artifactory Guide

2024-12-02T16:48:22Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}
[[Category:Digital]]
__NOTOC__
The Nielsen AppSDK can either be downloaded directly from the [http://engineeringportal.nielsen.com Engineering Portal], or can be integrated directly within an application through the use of a CocoaPod or Gradle.

= How to install the Nielsen AppSDK using Gradle for Android =
Below are the steps which need to be performed by app developers to integrate the Nielsen App SDK within an Android application.

== Add Nielsen Maven Repository ==

Please add the Nielsen maven repository inside the repositories section of your app's module build.gradle file like below:
<br>
<source lang="android">
repositories {
//Copy below code inside repository section of app’s build.gradle file
maven { url 'https://raw.githubusercontent.com/NielsenDigitalSDK/nielsenappsdk-android/master/'
}
</source>
<br>
<blockquote>
[[Image:AlertIcon.png|left|60px|link=|class=smallIcon]] Starting on Sept 21, 2021 the Nielsen SDK has moved to a public repository. Credentials are no longer required.
</blockquote>
<br>

== Add gradle dependency ==

Please add Nielsen app SDK as compile time dependency inside build.gradle file as below
=== grade 4.x and above ===
For gradle version starting with 4.x add the following line inside dependencies section of build.gradle file.<br>
<source lang="html">implementation 'com.nielsenappsdk.${market}:${flavor}:${version}'</source>
<br>
<source lang="html">
dependencies { ....
implementation 'com.nielsenappsdk.global:ad:+' // Using + will provide the latest version
}
</source>

=== grade prior to 4.x ===
For gradle version previous to 4.x add below line inside dependencies section of build.gradle file.
<source lang="html">compile 'com.nielsenappsdk.${market}:${flavor}:${version}'</source>
<br>
<source lang="html">
dependencies { ....
compile 'com.nielsenappsdk.global:ad:+' // Using + will provide the latest version
}
</source>

== Version and Flavor Control ==
With version 8.1.0.0+ of the Nielsen appSDK, it is possible to request a specific '''${flavor}''' that reads the '''Google Ad ID''', '''Android ID''', or is '''Kid app''' friendly (noID). For example:<br>
<source lang="html">implementation 'com.nielsenappsdk.${market}:${flavor}:${version}'</source>
* if the flavor selected is equal to <code>ad</code> the Nielsen SDK will try to obtain the googleAdID if the user has not opted out.
* If the flavor is <code>noad</code> then the Nielsen SDK will attempt to obtain the AndroidID.
* If the flavor selected is <code>noid</code> then the Nielsen SDK will not request any identifier which is required for many kid apps.
<blockquote>To ensure backward compatability, <code> implementation 'com.nielsenappsdk:${market}:${version}'</code> will continue to be supported.</blockquote>
{| class="wikitable"
|-
! SDK Version
! ${market}
! ${flavor}
! ${version}
! Examples
|-
| Appsdk 8.1.0.0+
|<code>global</code><br /><code>agf</code>
|<code>ad</code><br /><code>noad</code><br /><code>noid</code>
| + is most recent version<br /><code>8.1.0.0</code>
|<code>'com.nielsenappsdk.global:ad:+'<br />'com.nielsenappsdk.global:noad:+'<br />'com.nielsenappsdk.global:noad:8.1.0.0'</code>
|-
| AppSDK 7 to 8.0.0.0
|<code>globalx</code><br /><code>global</code><br /><code>agf</code><br /><code>agfx</code>
|not used
| + is most recent version<br /><code>7.1.0.0</code><br /><code>8.0.0.0</code>
|<code>'com.nielsenappsdk:globalx:+'<br />'com.nielsenappsdk:global:8.0.0.0'<br />'com.nielsenappsdk:agf:8.0.0.0'</code><br /><br />
|}
<blockquote>If using version control, a warning message will be displayed within the console trace during the build of your app,
and it will show all sdk versions released to-date, allowing a developer to select a more recent build if desired. </blockquote> Starting with Version 8.x, the Nielsen SDK will only support Androidx.

== Ensuring you have the latest release information ==
It is recommended to use <code>+</code> for <code>${version}</code> to ensure you receive the most recent version of the NielsenSDK; however, if you are specifying the exact version of the SDK, please use only the first 3 digits. EG: 8.1.0<br>

A sample if using AppSDK 8.1.0.0 + would be:
<source lang="html">
dependencies { ....
implementation 'com.nielsenappsdk.global:ad:+'
}
</source>
<br>
If using AppSDK 7 to 8.0.0.0
<source lang="html">
dependencies { ....
implementation 'com.nielsenappsdk:globalx:8.0.0'
}
</source>

In addition, please add below gradle task inside your <code> build.gradle (Module:app)</code> or <code>build.gradle(Project:My-app)</code> file to fetch latest release details of nielsen app sdk as below:

<blockquote>Please note: The <code> build.gradle (Module:app)</code> can overwrite the <code>build.gradle(Project:My-app)</code>.</blockquote>

<source lang="java">task NielsenSdkReleaseCheck {
def p = ['curl',"https://raw.githubusercontent.com/NielsenDigitalSDK/" +
"nielsenappsdk-android/master/com/nielsenappsdk/global/" +
"NielsenAppSdk-ReadMe.md"].execute().text
project.logger.log(LogLevel.ERROR,p)
}
preBuild.dependsOn('NielsenSdkReleaseCheck')
</source>

=== App Suffix Reference ===
The Nielsen AppSDK has various configurations per market and distribution type, which can be determined by reviewing the [[Digital Measurement Android Suffix Guide|sdk suffix]]. The first part will be the SDK version: 3 digits for the major SDK version and 1 digit for the minor SDK version. EG: <code>aa.8.1.0.0_abc</code>

== Proguard Obfuscation ==

AppSDK internally obfuscate all non-public classes during the build process using Proguard. Please use the below filter to avoid further obfuscation of AppSDK classes if Client app is also using proguard tool

"''-keep class com.nielsen.app.sdk.** { *; }''"

== Sync ==

If you are finished with all previous steps then you can sync your build.gradle and after successful build you are ready to use Nielsen App SDK library in your code.

== Sample file ==
The below is an example of a very basic app build.gradle file
<syntaxhighlight lang=Java>
plugins {
id 'com.android.application'
}

android {
compileSdkVersion 30
buildToolsVersion "30.0.3"

defaultConfig {
applicationId "com.nielsen.simplestandardandroidart"
minSdkVersion 23
targetSdkVersion 30
versionCode 1
versionName "1.0"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}

buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
repositories {
//Copy below code inside repository section of app’s build.gradle file
maven { url 'https://raw.githubusercontent.com/NielsenDigitalSDK/nielsenappsdk-android/master/'
}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}

dependencies {

implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'com.google.android.material:material:1.1.0'
implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
testImplementation 'junit:junit:4.+'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
implementation 'com.google.android.gms:play-services-ads:20.3.0'
implementation 'com.nielsenappsdk.global:ad:+'
}

task NielsenSdkReleaseCheck {
def p = ['curl',"https://raw.githubusercontent.com/NielsenDigitalSDK/" +
"nielsenappsdk-android/master/com/nielsenappsdk/global/" +
"NielsenAppSdk-ReadMe.md"].execute().text
project.logger.log(LogLevel.ERROR,p)
}
preBuild.dependsOn('NielsenSdkReleaseCheck')
</syntaxhighlight>

Digital Measurement Android Artifactory Guide

2024-12-02T16:46:57Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}
[[Category:Digital]]
__NOTOC__
The Nielsen AppSDK can either be downloaded directly from the [http://engineeringportal.nielsen.com Engineering Portal], or can be integrated directly within an application through the use of a CocoaPod or Gradle.

= How to install the Nielsen AppSDK using Gradle for Android =
Below are the steps which need to be performed by app developers to integrate the Nielsen App SDK within an Android application.

== Add Nielsen Maven Repository ==

Please add the Nielsen maven repository inside the repositories section of your app's module build.gradle file like below:
<br>
<source lang="android">
repositories {
//Copy below code inside repository section of app’s build.gradle file
maven { url 'https://raw.githubusercontent.com/NielsenDigitalSDK/nielsenappsdk-android/master/'
}
</source>
<br>
<blockquote>
[[Image:AlertIcon.png|left|60px|link=|class=smallIcon]] Starting on Sept 21, 2021 the Nielsen SDK has moved to a public repository. Credentials are no longer required.
</blockquote>
<br>

== Add gradle dependency ==

Please add Nielsen app SDK as compile time dependency inside build.gradle file as below
=== grade 4.x and above ===
For gradle version starting with 4.x add the following line inside dependencies section of build.gradle file.<br>
<source lang="html">implementation 'com.nielsenappsdk.${market}:${flavor}:${version}'</source>
<br>
<source lang="html">
dependencies { ....
implementation 'com.nielsenappsdk.global:ad:+' // Using + will provide the latest version
}
</source>

=== grade prior to 4.x ===
For gradle version previous to 4.x add below line inside dependencies section of build.gradle file.
<source lang="html">compile 'com.nielsenappsdk.${market}:${flavor}:${version}'</source>
<br>
<source lang="html">
dependencies { ....
compile 'com.nielsenappsdk.global:ad:+' // Using + will provide the latest version
}
</source>

== Version and Flavor Control ==
With version 8.1.0.0+ of the Nielsen appSDK, it is possible to request a specific '''${flavor}''' that reads the '''Google Ad ID''', '''Android ID''', or is '''Kid app''' friendly (noID). For example:<br>
<source lang="html">implementation 'com.nielsenappsdk.${market}:${flavor}:${version}'</source>
* if the flavor selected is equal to <code>ad</code> the Nielsen SDK will try to obtain the googleAdID if the user has not opted out.
* If the flavor is <code>noad</code> then the Nielsen SDK will attempt to obtain the AndroidID.
* If the flavor selected is <code>noid</code> then the Nielsen SDK will not request any identifier which is required for many kid apps.
<blockquote>To ensure backward compatability, <code> implementation 'com.nielsenappsdk:${market}:${version}'</code> will continue to be supported.</blockquote>
{| class="wikitable"
|-
! SDK Version
! ${market}
! ${flavor}
! ${version}
! Examples
|-
| Appsdk 8.1.0.0+
|<code>global</code><br /><code>agf</code>
|<code>ad</code><br /><code>noad</code><br /><code>noid</code>
| + is most recent version<br /><code>8.1.0.0</code>
|<code>'com.nielsenappsdk.global:ad:+'<br />'com.nielsenappsdk.global:noad:+'<br />'com.nielsenappsdk.global:noad:8.1.0.0'</code>
|-
| AppSDK 7 to 8.0.0.0
|<code>globalx</code><br /><code>global</code><br /><code>agf</code><br /><code>agfx</code>
|not used
| + is most recent version<br /><code>7.1.0.0</code><br /><code>8.0.0.0</code>
|<code>'com.nielsenappsdk:globalx:+'<br />'com.nielsenappsdk:global:8.0.0.0'<br />'com.nielsenappsdk:agf:8.0.0.0'</code><br /><br />
|}
<blockquote>If using version control, a warning message will be displayed within the console trace during the build of your app,
and it will show all sdk versions released to-date, allowing a developer to select a more recent build if desired. </blockquote> Starting with Version 8.x, the Nielsen SDK will only support Androidx.

== Ensuring you have the latest release information ==
It is recommended to use <code>+</code> for <code>${version}</code> to ensure you receive the most recent version of the NielsenSDK; however, if you are specifying the exact version of the SDK, please use only the first 3 digits. EG: 8.1.0<br>

A sample if using AppSDK 8.1.0.0 + would be:
<source lang="html">
dependencies { ....
implementation 'com.nielsenappsdk.global:ad:+'
}
</source>
<br>
If using AppSDK 7 to 8.0.0.0
<source lang="html">
dependencies { ....
implementation 'com.nielsenappsdk:globalx:8.0.0'
}
</source>

In addition, please add below gradle task inside your <code> build.gradle (Module:app)</code> or <code>build.gradle(Project:My-app)</code> file to fetch latest release details of nielsen app sdk as below:

<blockquote>Please note: The <code> build.gradle (Module:app)</code> can overwrite the <code>build.gradle(Project:My-app)</code>.</blockquote>

<source lang="java">task NielsenSdkReleaseCheck {
def p = ['curl',"https://raw.githubusercontent.com/NielsenDigitalSDK/" +
"nielsenappsdk-android/master/com/nielsenappsdk/global/" +
"NielsenAppSdk-ReadMe.md"].execute().text
project.logger.log(LogLevel.ERROR,p)
}
preBuild.dependsOn('NielsenSdkReleaseCheck')
</source>

=== App Suffix Reference ===
The Nielsen AppSDK has various configurations per market and distribution type, which can be determined by reviewing the [[Digital Measurement Android Suffix Guide|sdk suffix]]. The first part will be the SDK version: 3 digits for the major SDK version and 1 digit for the minor SDK version. EG: <code>aa.8.1.0.0_abc</code>

== Proguard Obfuscation ==

AppSDK internally obfuscate all non-public classes during the build process using Proguard. Please use the below filter to avoid obfuscation of AppSDK classes if Client app is also using proguard tool

"''-keep class com.nielsen.app.sdk.** { *; }''"

== Sync ==

If you are finished with all previous steps then you can sync your build.gradle and after successful build you are ready to use Nielsen App SDK library in your code.

== Sample file ==
The below is an example of a very basic app build.gradle file
<syntaxhighlight lang=Java>
plugins {
id 'com.android.application'
}

android {
compileSdkVersion 30
buildToolsVersion "30.0.3"

defaultConfig {
applicationId "com.nielsen.simplestandardandroidart"
minSdkVersion 23
targetSdkVersion 30
versionCode 1
versionName "1.0"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}

buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
repositories {
//Copy below code inside repository section of app’s build.gradle file
maven { url 'https://raw.githubusercontent.com/NielsenDigitalSDK/nielsenappsdk-android/master/'
}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}

dependencies {

implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'com.google.android.material:material:1.1.0'
implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
testImplementation 'junit:junit:4.+'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
implementation 'com.google.android.gms:play-services-ads:20.3.0'
implementation 'com.nielsenappsdk.global:ad:+'
}

task NielsenSdkReleaseCheck {
def p = ['curl',"https://raw.githubusercontent.com/NielsenDigitalSDK/" +
"nielsenappsdk-android/master/com/nielsenappsdk/global/" +
"NielsenAppSdk-ReadMe.md"].execute().text
project.logger.log(LogLevel.ERROR,p)
}
preBuild.dependsOn('NielsenSdkReleaseCheck')
</syntaxhighlight>

Browser SDK API Reference

2024-09-03T20:26:18Z

AnkitAgrawal: /* Configure Browser SDK */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Setting up Development Environment ==
=== Step 1: Configure Content Management System (CMS) ===
Configure CMS to send the required values (see table below). Any internal CMS_variable names can be used for passing the data.

Ensure to capture these CMS_variable names in the SDK Configuration Form.

For more information on setting variable names, see the SDK Configuration Form included within the SDK package.

{| class="wikitable"
|-
! Required Data !! Description !! Value
|-
| dataSrc || Used when both CMS metadata and ID3 data are present in the player. Setting this field tells the SDK whether to use the CMS metadata or the ID3 payload to derive the pings || cms
|-
| type || Type of asset: ad or content || preroll, midroll, postroll, or content
|-
| assetid || unique ID assigned to asset || custom <br>(no [[Special Characters]])
|-
| OCR Tag || OCR tag provided by Nielsen for implementation on the ad unit || Complete OCR URL
|-
| program || Name of program (25 character limit) || custom
|-
| title || Episode title (40 character limit) || custom
|-
| length || Length of content in seconds || Length in seconds, 0 for live stream
|-
| adloadtype || Type of ad load || "1" - Linear "2" - Dynamic(default)
|-
| hasAds || Identify if content includes Ads || "0" - no ads "1" - includes ads "2" - unknown(default)
|-
| isfullepisode || Full episode flag || "y" - full episode "n" - non full episode
|-
| segA || Segment A (this is not available for video reporting as the episode title is reported) || custom value
|-
| segB || Custom segment B || custom value
|-
| segC || Custom segment C || custom value
|-
| crossId1 || Standard episode ID || custom value
|-
| crossId2 || Content originator (required only for distributors) || custom value
|-
| airdate || Original air date and time in Eastern Time. For non-US countries, it should be local time. || YYYYMMDD HH24:MI:SS
|-
| containerId || HTML DOM element of the Player container (for Viewability&Audibility feature only) || custom value
|}

=== Step 2: Complete the Nielsen SDK Configuration Form ===
The SDK is designed to map the <code>CMS_variable names</code>. To support the custom mapping, the developer is required to complete the SDK Configuration Form. The form will be provided during onboarding along with this guide.

== Initialization ==
=== Obtain the Nielsen Application ID (apid) and Browser SDK URLs ===
The Nielsen <code>apid</code> is required to enable SDK functionality. Technical Account Manager will provide an apid for each player configuration.
Browser SDK can support URLs that use any of the protocols – HTTPS and HTTP.

=== Configure Browser SDK ===
There are two steps required for configuring the SDK:

'''Add Static Queue Snippet'''

*Add Static Queue Snippet
*Create SDK Instance

Add the following script tag to the website:
<syntaxhighlight lang="javascript">

<script type="text/javascript">
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");
</script>

</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

'''Create SDK Instance'''

To initialize the SDK, create an SDK instance by making the initialization call:

'''Initialization API Call'''
<syntaxhighlight lang="javascript">

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})

</syntaxhighlight>

When creating an instance, pass the following three values:

=== SDK Initialization – Global Parameters ===
{| class="wikitable"
|-
! Parameters !! Description !! Value
|-
| apid || UniqueID assigned to player/site. || 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
| instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging. Only required for testing || "{nol_sdkDebug: "debug"})"
|-
| containerId || HTML DOM element id of the player container. Only for Viewability & Audibility feature. || {containerId: "playerId1"}
|-
| hem_sha256 || SHA256-hashed email address (client-supplied unique 32-character hexadecimal string) || "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
|-
| hem_sha1 || SHA1-hashed email address (client-supplied unique 32-character hexadecimal string) || "XvBniTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
|-
| hem_md5 || MD5-hashed email address (client-supplied unique 32-character hexadecimal string) || "JnIbdTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
|-
| uid2 || An identifier based on a user’s verifiable PII (e.g. hashed email). UID2.0 was initially created by The Trade Desk (TTD) and is now managed by Prebid. || "MTKVpUAzwYAPnHrtfE0wlINOMzhU7UUEjjVdCdRu63k="
|-
| uid2_token || Encrypted Unified ID 2.0 || "AgAAAAPFR0zA5ogv/yaAPiUsAdZPsfqS8Ql
DSGxAB+rr8yekFs3AjLYVk5qqqiyV2XHbSuwzHmxSlLeQeK
QI1mp015jsNnpX5/xGgXldcgVz+gFnyh3T8/3agMwRmyrhC
xG4oH2C7fc48AQk2eotE7FW0ZDEYM8fD9ZxDaxFUC/OV3OuZA&"
|-
|luid
|Living Unit ID - Experian Household ID
'''Note: This parameter is applicable only for CTV and First Party Livestream data'''
|"B0EOFEDgD"
|}

{{example_bsdk_init}}

'''Example SDK Configuration'''

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

<script type="text/javascript">
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");
// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>

</syntaxhighlight>

=== SDK Initialization to measure the Viewability & Audibility ===
To support viewability metrics in the web page the integrator has to provide a tag value of the player view to let Nielsen SDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in the as string while initializing the Nielsen browser SDK.

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{containerId: <playerElementID>, nol_sdkDebug: "debug"})

'''Example SDK Initialization for Viewability'''

Your configuration should include the Static Queue Snippet and an SDK Instance for your unique App ID as shown in the example:
<syntaxhighlight lang="javascript">
//Add Static Queue Snippet
<script>
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

//Create SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {containerId: “player1”, nol_sdkDebug: "debug"});
</script>

</syntaxhighlight>

== Browser SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Method / Property !! Event # !! DTVR !! DAR !! DCR !! Description
|-
| [[loadMetadata (Browser)|loadMetadata]] || 15 || ✔ || ✔ || ✔ || Used when there is a preroll ad that needs to be associated with content metadata. The loadMetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad.
|-
| [[play (Browser)|play]] || 5 || ✔ || ✘ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. When the client passes in the channelName, they can change the CMS data stored by passing new values. If this event is not called then the “channel name” value populated will be the default value of “defaultChannelName”.
|-
| [[sendID3 (Browser)|sendID3]] || 55 || ✔ || ✘ || ✘ || Used to send the ID3 metadata.
|-
| [[setPlayheadPosition (Browser)|setPlayheadPosition]] || 49 || ✘ || ✘ || ✔ || Used to send the playhead position.
|-
| [[stop (Browser)|stop]] || 7 || ✘ || ✘ || ✔ || Used when switching between ad and content or content and ad.
|-
| [[end (Browser)|end]] || 57 || ✔ || ✘ || ✔ || This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content 3) when the browser is refreshed or closed
|-
| [[staticstart (Browser)|staticstart]] || 14 || ✘ || ✘ || ✔ || Used to send the metadata for the static page.
|-
| [[StaticEnd (Browser)|staticend]] || 56 || ✘ || ✘ || ✔ || In Single Page Application (SPA) it is imperative that staticend is called prior to the loading of new metadata. This allows the Browser SDK to properly credit the previous section/content being viewed before measuring the new one.
|-
| [[updateOTT (Browser)|updateOTT]] || - || ✘ || ✘ || ✔ || Used to notify Browser SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| [[ onPaginate (Browser)|onPaginate]] || 30 || ✘ || ✘ || ✔ || Used to create a new instance of the SDK object
|-
| [[updateMetadata (Browser)|updateMetadata]] || 35 || ✔ || ✔ || ✔ || This event is used for updating metadata parameters for the content or ad that is being played.
|-
| [[setVolume_(Browser)|setVolume]] || 61 || ✔ || ✘ || ✔ || Used to pass in the player volume levels in %. Default value is -1.
|}

== Retrieving ID3 Tags ==
The video player must have the ability to extract ID3 tags and supply them to the Browser SDK, based on the HLS standard.
*An ID3 tag spans two PES packets.
**In the first PES packet, look for www.nielsen.com, this is the start of the ID3 tag. Continue to parse the first PES packet until the undefined char "\ufffd" is found. This forms the first half of the ID3 tag
**In the second PES packet, identify the end pattern – a regEx of /(\/\d+){3}/ and look to remove the lowest index of either "\x00" and/or "\ufffd". Now the second packet has been appended and the demarcation of the Nielsen-specific data has been defined.

Follow the procedure below, to extract Nielsen ID3 tags from an MPEG-2 transport stream (including HLS streams).
#Parse the Program Map Table (PMT) to find the PID of the metadata stream. Confirm the presence of the metadata descriptor described in section 2.3.3 of Apple’s “HTTP Live Streaming Metadata Spec.pdf”. Only private streams with metadata descriptor present should be considered as ID3-tag metadata streams.
#Parse the HLS/Transport stream for any '''PES header''' with the PID found in step 1.
#Follow standard MPEG-2 parsing procedures to locate the start of the payload of the PES packet.
#Copy the PES payload into a buffer.
#The ID3 tag spans 2 PES packets. Parse the stream for the next packet whose PID is set to the PID found in step 1. Typically the ID3 Tag is of 249 bytes. The steps below guide towards extraction of the ID3 tag
##In the first PES packet, look for "www.nielsen.com" , this is the start of the ID3 tag. Keep on parsing the first PES packet until the undefined char "\ufffd" is found. This forms the first half of the ID3 tag
##In the second PES packet, identify the end pattern, a regEx of /(\/\d+){3}/ and look to remove the lowest index of either “\x00” and/or “\ufffd”. Now the second packet has been appended and the demarcation of the Nielsen specific data has been defined. This segment can be simply substringed.
##Concatenate this substringed segment with the payload derived from the first packet get the ID3 payload.
#Check the length of the contents in the buffer to make sure that it is equal to the size of a Nielsen ID3 tag.
#Ensure that the ID3 byte array is converted into the string and escape it, so that the SDK can consume it.
Repeat steps 2 through 7 for all ID3 tags in the stream.

'''References'''
*[http://www.iso.org/iso/catalogue_detail?csnumber=44169. ISO/IEC 13818-1:2007] Information technology – Generic coding of moving pictures and associated audio information: Systems
*https://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/HTTP_Live_Streaming_Metadata_Spec/

=== Sample ID3 tags ===
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_<wbr />JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</code>
* <code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGhe<wbr />Fi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8<wbr />QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</code>
<blockquote>'''Note''': ID3 tags are not applicable for International (Germany)</blockquote>

== Browser Opt-Out Implementation ==
The site in which video content is being measure via Nielsen methodology must provide the means for the user to opt-out of, or opt back into Nielsen Measurement.

For Browser-based applications, opt-out setting is stored via Nielsen cookie. Therefore, it is only necessary that users be made aware of measurement opt-out by incorporating the template below in the user interface.

=== Sample Opt Out Template ===
Our properties may feature Nielsen’s proprietary measurement software which will allow to contribute to market research, like Nielsen’s TV Ratings. To learn more about this information, see https://www.nielsen.com/digitalprivacy. Nielsen’s software may collect your choices with regards to it.

== Nielsen Privacy Requirements ==
Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
*Disclosure of viewership data collection in EULA / Privacy Policy
*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
*Method for users to opt-out of Nielsen measurement, any time while using the application

=== Ratings Data Flow ===
Every view of creditable and watermarked content is measured by Nielsen.
[[File:RatingsDataFlow.png]]

'''Information NOT Shared'''
* '''With Nielsen'''
** User's Identity
* '''With Data Provider'''
** Content information
** Whether user is viewing an ad or video content
** Player used to play the streaming (audio / video, etc.)
** Values being de-duped / aggregating for

Nielsen collects only what it needs for audience measurement. Every view of creditable, watermarked content will be measured by Nielsen.

=== Data Collected ===
{| class="wikitable"
|-
! Type of Information !! Parameter !! Transmitted to Nielsen? !! Sent to Provider?
|-
| rowspan="8" | Nielsen ID3 Watermark
|-
| FinalDistributor Timestamp || Yes || No
|-
| Program Content Timestamp || Yes || No
|-
| Mobile Breakout Code || Yes || No
|-
| Commercial Credit Code – Linear or Dynamic || Yes || No
|-
| Time ShiftedViewing Code || Yes || No
|-
| Segment Number || Yes || No
|-
| Segment View Pattern || Yes || No
|-
| rowspan="7" | Device/App Info
|-
| Device OSVersion || Yes || Yes
|-
| Device Model || Yes || No
|-
| Cache Buster || Yes || Yes
|-
| SDKDisabled Flag || Yes || No
|-
| ServerCode || Yes || No
|-
| Channel or URL || Yes || No
|-
| rowspan="9" | Nielsen Identifiers
|-
| Client ID || Yes || No
|-
| Campaign ID || Yes || Yes
|-
| Nielsen Unique Device ID || Yes || No
|-
| Application ID || Yes || No
|-
| DeviceGroup (ex. Tablet, Smartphone, Desktop) || Yes || Yes
|-
| OS Group (ex. Android, iOS, Windows) || Yes || Yes
|-
| SDKVersion || Yes || No
|-
| IP Address for DMA, Country Code || Yes || Yes
|}
<blockquote>'''Note''': Data is hashed, and encrypted using AES 128 before transmission to data provider.</blockquote>

{{Viewability_Data_Collected}}

==== Example ping sent to provider ====
* <code><nowiki>https://provider.com/cgi-bin/brandlift.php</nowiki>?campaign_id=ff12725d724fac7934cf6003f096b4cd<wbr />&placement_id=a4164b8fba9ee7c873a9c72c7091bb58<wbr />&creative_id=25280139b61a947e127a52f56c8a2fdd<wbr />&segment1=9000<wbr />&segment2=41<wbr />&segment3=iOS<wbr />&OSVer=iOS6.1<wbr />&c9=<wbr />&devgrp=tablet<wbr />&h=f5f243fe6d<wbr />&rnd=1376971827360</code>

This ping passes the following parameters to the provider:
* Campaign ID – (campaign, placement, creative)
* Country Code
* DMA
* OS Group (ex. iOS, Android)
* DeviceOS Version
* Device Advertiser ID
* DeviceGroup (ex. Tablet, Smartphone, Desktop)
* Cache Buster

{{Template:Browser_Privacy_and_Opt-Out}}

=== Opt-Out Implementation ===
The site must provide the means for the user to opt-out of, or opt back into Nielsen Measurement.

'''Sample Opt Out Template'''

Our properties may feature Nielsen’s proprietary measurement software which will allow to contribute to market research, like Nielsen’s TV Ratings. To learn more about this information, please [http://priv-policy.imrworldwide.com/priv/mobile/us/en/optout.html| click here]. Nielsen’s software may collect your choices with regards to it.

== Testing ==
See [[Digital Measurement Testing#Testing Browser Implementation|Digital Measurement Testing - Testing Browser Implementation]].

DCR Static Browser SDK (6.0.0)

2024-09-03T20:23:47Z

AnkitAgrawal: /* Add Tracking Code */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Prerequisites ==
To start using the App SDK, the following items are required:
{| 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
|}

== Release Notes ==
The release notes on the Browser SDK can be located here: '''[[Browser SDK Release Notes|Release Notes]]'''

== Implementation Steps ==
=== Add Tracking Code ===
The Nielsen DCR Tracking Code must be added to each page.
<syntaxhighlight lang="javascript"><script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "nlsnInstance", {
nol_sdkDebug: "debug"
});

// Content Metadata
var nielsenMetadata = {
type: 'static',
assetid: 'HHF887465-9486', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: 'SPORTS', // *DYNAMIC METADATA*: section of site **REQUIRED**
segA: 'HDVIDEOS', // *DYNAMIC METADATA*: custom segment
segB: '', // *DYNAMIC METADATA*: custom segment
segC: '' // *DYNAMIC METADATA*: custom segment
};

// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</script></syntaxhighlight>
<blockquote>For DCR static, BSDK cannot be run in an iframe because the blur/focus events of the parent page may not propagate to the iframe. The iframe events typically trigger when the iframe itself is clicked. The BSDK is dependent on the blur/focus events of the browser to detect active viewing of the page. Because the root page events do not propagate to the iframe, this would impact incorrect DCR static crediting.</blockquote>

=== Tracking Code Components ===
The tracking code includes
* Static Queue Snippet
* SDK Initialization
* Content Metadata
* staticstart Event

'''Static Queue Snippet'''

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.
<syntaxhighlight lang="javascript">
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");
</script>
</syntaxhighlight>

'''SDK Initialization'''

While creating an SDK instance, initialize the SDK by calling:

'''Initialization API Call'''

<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "",{nol_sdkDebug: "debug"})</syntaxhighlight>

When the initialization call is made, a unique static config file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and cached by the client-side browser(s).

Once the static config file is downloaded, the SDK will be fully downloaded and initialized. All SDK modules are included in one file:
"nlsSDK600.bundle.min.js".

'''Content Metadata'''

Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values.

Pass dynamic metadata for the keys with the <code><metadataPlaceholder></code> value (e.g. <code>section: ''</code>).

'''staticstart Event'''

There is only one event call required:
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>

The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[DCR_Static_Browser_SDK_(6.0.0)#Configure_Metadata|Configure Metadata]].

=== Pass App ID in Initialization Call ===
Pass the unique App ID in the first parameter of the initialization call, <code><apid></code>.

'''Example SDK Initialization'''

<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});</syntaxhighlight>

The initialization call has three parameters:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site. || <code>PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX</code>
|-
| instanceName || Name of SDK instance || Any string value
|-
| nol_sdkDebug: "debug" || Enables Nielsen console logging. Only required for testing || <code>{nol_sdkDebug: "debug"}</code>
|}

Update <code><apid></code> with the AppID provided. Refer to the [[#Going_Live|Going Live]] section to know about updating the AppID to production after testing is completed.

{{Template:Browser_Metadata}}

{{Template:Browser_Privacy_and_Opt-Out}}

== Infinite Scrolling ==

<code>onPaginate</code> will refire the view ping with the existing/original metadata.

<source lang="javascript">nSdkInstance.ggPM("onPaginate", scrolloffset);</source>
<br>
{|
!width="23%"| Parameter
!width="19%"| Description
|-
| event
| <code>onPaginate</code>
|-
| scrolloffset
| The <code>scrolloffset</code> value should be the y-scroll position:
|}

=== onPaginate ===

<code>onPageinate</code> is a slightly modified version of <code>staticstart</code> to enable tracking of user’s focus in pages with continuous scrolling. <code>onPaginate</code> event provides the same behavior as <code>staticstart</code> keeping it local to only clients who wish to implement continuous scrolling. (Note: This event <code>onPaginate</code> will not reset the page duration timer.)

* The maximum number of static View pings allowed per session is ‘1’. This is enforced via the <code>nol_maxPingCount</code> parameter in the tag and the cadence of impression.
* When an <code>onPaginate</code> event is called at the end of section / a focus shift (within the same page), this filter will reset the current ping count to ‘0’ for the static View ping. This change of value will cause a new View ping when the Browser SDK receives the next <code>staticPosition</code> event (at the section end). This sequence continues through the end of scrolling or till the close of static page session.
*One of the following must occur before an onPaginate event should be sent : user-initiated action, more than 50% of the content has changed or an ad, or the potential for an ad, is being loaded

[[File:StaticPageEvent35.jpg|center|link=]]

== Going Live ==
Once the DCR Tracking Code is added, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>

DCR Video Browser SDK

2024-09-03T20:22:27Z

AnkitAgrawal: /* Example SDK Configuration */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== 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
|}

== Release Notes ==
The release notes on the Browser SDK can be located here: '''[[Browser SDK Release Notes|Release Notes]]'''

== Configure SDK ==
There are two steps required for configuring the SDK:
*Add Static Queue Snippet
*Create SDK Instance

=== Static Queue Snippet ===
Add the following script tag to the website:
<syntaxhighlight lang="javascript">
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {
nol_sdkDebug: "debug",
optout: "false"
});

</script>
</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

<blockquote>For DCR static, BSDK cannot be run in an iframe because the blur/focus events of the parent page may not propagate to the iframe. The iframe events typically trigger when the iframe itself is clicked. The BSDK is dependent on the blur/focus events of the browser to detect active viewing of the page. Because the root page events do not propagate to the iframe, this would impact incorrect DCR static crediting.</blockquote>

===Create SDK Instance===
To initialize the SDK, create an SDK instance by making the initialization call:

==== Initialization API Call ====
<syntaxhighlight lang="javascript">
NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"});
</syntaxhighlight>
<br>
When creating an instance, pass the following values: (<code>nol_sdkDebug</code> and <code>optout</code> are optional)
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging if desired. || <syntaxhighlight lang="javascript">
{nol_sdkDebug: "debug"}
{nol_sdkDebug: "info"}
{nol_sdkDebug: "warn"}
{nol_sdkDebug: "true"}
</syntaxhighlight>
|-
|optout || Optional: OptOut global parameter. || <code>1/0</code> or <code>true/false</code>
|}

==== Example SDK Initialization ====
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.

More information on OptOut Parameter under [[DCR Video Browser SDK#Privacy_and_Opt-Out|Privacy and Opt-Out.]]


=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</script></syntaxhighlight>

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

==== Content Metadata ====
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{{DCR Content Metadata}}

==== Example Content Object ====
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2',
segB: 'custom segment B', // optional
segC: 'custom segment C', // optional
crossId1: 'Standard Episode ID', // optional
crossId2: 'Content Originator' //optional
};
</syntaxhighlight>

=== 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> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to Ad || custom <br>(no [[Special Characters]]) || ✓
|}

==== Example Ad Object ====
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
type: 'preroll',
assetid: 'AD-1'
};
</syntaxhighlight>
<br/>
<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>

==== Call Nielsen APIs ====
The method for calling events is ggPM().

<syntaxhighlight lang="javascript">
nSdkInstance.ggPM('event', parameter, ...);
</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===
The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===
The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
* Network Loss

There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>

<blockquote>'''Note:''' User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer<br/>
VOD: || current position in seconds <br/>
Live: current Unix timestamp (seconds since Jan-1-1970 UTC) <br/>
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position in seconds || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. <br/>
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}

== SDK Playhead Event Sequence ==
The sample event lifecycles can be used as a reference for identifying the order for calling events.

=== Content Playback ===
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// CONTENT PLAYS
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// END OF STREAM
nSdkInstance.ggPM('end', playheadPosition);
</syntaxhighlight>

=== Content Playback with Ads ===
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT RESUMES
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// END OF STREAM
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

{{Template:Browser_Privacy_and_Opt-Out}}

== Going Live ==
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.

'''Example Production Initialization Call'''

<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", { optout: "false"});
</syntaxhighlight>

DTVR Browser SDK

2024-09-03T20:21:02Z

AnkitAgrawal: /* Example SDK Initialization */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''App ID (apid)''' || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
|}

== Configure SDK ==
There are two steps required for configuring your SDK: 1. Add Static Queue Snippet and 2. Create SDK Instance.

=== Add Static Queue Snippet ===
Add the following script tag to your website:

<syntaxhighlight lang="javascript">
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");
</script>
</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. Since the queue is able to capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===
To initialize the SDK, you will need to create an SDK instance by making the initialization call:

<syntaxhighlight lang="javascript">
NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
<br />
When creating your instance, you will need to pass three parameter values. The available parameters are listed in the table below:

{| class="wikitable"
|-
! Parameters !! Description !! Value !! Required? (Y/N)
|-
| apid || UniqueID assigned to player/site.
|| "XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX" || Yes
|-
| instanceName || User-defined string value for describing the player/site. || Client specified || Yes
|-
| nol_sdkDebug:"debug" || Enables Debug Mode which allows output to be viewed in console. || "{nol_sdkDebug: "debug"}" || No
|-
| containerId || HTML DOM element id of the player container || {"containerId: "player1"} || Yes - if implementing Viewability/Audibility
|}

== SDK Initialization ==
<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>

When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on your apid and cached on the user's browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: "nlsSDK600.bundle.min.js".

=== Example SDK Initialization ===
Your configuration should include the Static Queue Snippet and an SDK Instance for your unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

//Add Static Queue Snippet
<script>
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

//Create SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== SDK Initialization to measure Viewability & Audibility ==
To support Viewability and Audibility metrics in the web page the integrator has to provide a tag value of the player view to let Nielsen SDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in as a string while initializing the Nielsen browser SDK.

<syntaxhighlight lang="javascript">

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{containerId: <playerElementID>, nol_sdkDebug: "debug"})

</syntaxhighlight>

=== Example SDK Initialization for Viewability & Audibility ===
Your configuration should include the Static Queue Snippet and an SDK Instance for your unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

//Add Static Queue Snippet
<script>
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

//Create SDK Instance with containerId
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {containerId: "player1", nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Create Metadata Objects ==
<br />
There are two types of asset metadata:
<br />
*content: identify video
*ad: identify each ad
<br />
The metadata received for each asset is used for classification and reporting.
<br />
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
<br />

=== Content Metadata Object ===
<br />
Content metadata should remain constant throughout the completion of an episode or live stream.
<br />
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| adModel || linear vs dynamic ad model || * 1) - Linear – matches TV ad load * 2) Dynamic – Dynamic Ad Insertion (DAI) || ✓
|-
|}
<br/>
'''Example Content Object'''
<syntaxhighlight lang="javascript"> var contentMetadataObject =
{
type: 'content',
adModel: '1'
};</syntaxhighlight>

=== Ad Metadata Object ===
<br/>
If Ad is not ID3 tagged, then Ad metadata should be passed for each individual Ad, if ads are available during or before the stream begins.
<br/>
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || ✓
|}
<br/>
'''Example Ad Object'''
<br/>
<syntaxhighlight lang="javascript"> var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};</syntaxhighlight>

== SDK Events ==
<br/>
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/Ad metadata object || Needs to be called at the beginning of each asset to pass type and adModel
|-
| 'sendID3' || Used to send the ID3 tag payload retrieved from the stream || Needs to be called at the beginning of playback
|-
| 'setVolume' || Used to pass in the player volume levels in % || Needs to be called when the player volume changes. This is applicable only for Audibility feature
|}

== Configure and fire API calls ==
<br />
The syntax for firing events is:
<syntaxhighlight lang="javascript"> nSdkInstance.ggPM("event", parameter object);</syntaxhighlight>
<br />
Event is passed in parameter 1 and the argument is passed in parameter 2.

=== Configure API calls - loadMetadata ===
<br />
Use [[loadMetadata (Browser)]] to pass the metadata object. The data must be passed as a JSON string.
<br />
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("loadMetadata", metadataObject);</syntaxhighlight>

=== Configure API calls - sendID3 ===
<br />
Use [[sendID3 (Browser)]] to send ID3 payload of the HLS content being played. This will allow the ID3 payload to be sent every time an ID3 packet is received (approximately, once in every 10 seconds).
<br />
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("sendID3", ID3_Payload);</syntaxhighlight>
<br />
==== Sample ID3 tags ====
<br />
<syntaxhighlight>
www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_<wbr />JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</syntaxhighlight>
<br />
<syntaxhighlight>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGhe<wbr />Fi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8<wbr />QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</syntaxhighlight>
<br />
<code>ID3_Payload</code> is the container to pass the retrieved ID3 tag from the streaming. The player should look for 'PRIV' ID3 tags and send 'owner' field (which typically starts from "www.nielsen.com") through this API. Refer to [[Browser SDK API Reference#Retrieving ID3 Tags|Browser SDK API Reference - Retrieving ID3 Tags]] for more information.
<br />
<br />
Refer to [[Browser SDK API Reference#Retrieving ID3 Tags|Browser SDK API Reference - Retrieving ID3 Tags]] section to know more details.

=== Configure API calls - setVolume ===
<br />
Use the setVolume(Browser) to send the player volume for Audibility feature. Player volume should be sent at the beginning of stream and whenever volume changes. By default the volumeLevel is set to -1. VolumeLevel is the Audibility percentage (0-100). If the player is muted, use volumeLevel of 0.

<br />
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("setVolume", volumeLevel);</syntaxhighlight>



== SDK DTVR Event Sequence ==
<br/>
The sample event lifecycle can be used as a reference for identifying the order for calling events.
<br/>
<syntaxhighlight lang="javascript">
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('sendID3', ID3_Payload); //call sendID3 every 10 seconds and stop calling during any playback interruptions
</syntaxhighlight>

{{Template:Browser_Privacy_and_Opt-Out}}

== Going Live ==
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.

'''Example Production Initialization Call'''
<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", { optout: "false"});
</syntaxhighlight>

DTVR Browser SDK

2024-09-03T20:18:56Z

AnkitAgrawal: /* Add Static Queue Snippet */

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Prerequisites ==
Before you start the integration, you will need:
{| class="wikitable"
|-
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''App ID (apid)''' || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
|}

== Configure SDK ==
There are two steps required for configuring your SDK: 1. Add Static Queue Snippet and 2. Create SDK Instance.

=== Add Static Queue Snippet ===
Add the following script tag to your website:

<syntaxhighlight lang="javascript">
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");
</script>
</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. Since the queue is able to capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

=== Create SDK Instance ===
To initialize the SDK, you will need to create an SDK instance by making the initialization call:

<syntaxhighlight lang="javascript">
NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"})
</syntaxhighlight>
<br />
When creating your instance, you will need to pass three parameter values. The available parameters are listed in the table below:

{| class="wikitable"
|-
! Parameters !! Description !! Value !! Required? (Y/N)
|-
| apid || UniqueID assigned to player/site.
|| "XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX" || Yes
|-
| instanceName || User-defined string value for describing the player/site. || Client specified || Yes
|-
| nol_sdkDebug:"debug" || Enables Debug Mode which allows output to be viewed in console. || "{nol_sdkDebug: "debug"}" || No
|-
| containerId || HTML DOM element id of the player container || {"containerId: "player1"} || Yes - if implementing Viewability/Audibility
|}

== SDK Initialization ==
<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</syntaxhighlight>

When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on your apid and cached on the user's browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: "nlsSDK600.bundle.min.js".

=== Example SDK Initialization ===
Your configuration should include the Static Queue Snippet and an SDK Instance for your unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

//Add Static Queue Snippet
<script>
! function(t, n) {
t[n] = t[n] || {
nlsQ: function(e, o, c, r, s, i) {
return s = t.document,
r = s.createElement("script"),
r.async = 1,
r.src = ("http:" === t.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + e + ".js#name=" + o + "&ns=" + n,
i = s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r, i),
t[n][o] = t[n][o] || {
g: c || {},
ggPM: function(e, c, r, s, i) {
(t[n][o].q = t[n][o].q || []).push([e, c, r, s, i])
}
}, t[n][o]
}
}
}
(window, "NOLBUNDLE");

//Create SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== SDK Initialization to measure Viewability & Audibility ==
To support Viewability and Audibility metrics in the web page the integrator has to provide a tag value of the player view to let Nielsen SDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in as a string while initializing the Nielsen browser SDK.

<syntaxhighlight lang="javascript">

NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{containerId: <playerElementID>, nol_sdkDebug: "debug"})

</syntaxhighlight>

=== Example SDK Initialization for Viewability & Audibility ===
Your configuration should include the Static Queue Snippet and an SDK Instance for your unique App ID as shown in the example:

<syntaxhighlight lang="javascript">

//Add Static Queue Snippet
<script>
! function(t, n) {
t[n] = t[n] || {
nlsQ: function(e, o, c, r, s, i) {
return s = t.document,
r = s.createElement("script"),
r.async = 1,
r.src = ("http:" === t.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + e + ".js#name=" + o + "&ns=" + n,
i = s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r, i),
t[n][o] = t[n][o] || {
g: c || {},
ggPM: function(e, c, r, s, i) {
(t[n][o].q = t[n][o].q || []).push([e, c, r, s, i])
}
}, t[n][o]
}
}
}
(window, "NOLBUNDLE");

//Create SDK Instance with containerId
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {containerId: "player1", nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Create Metadata Objects ==
<br />
There are two types of asset metadata:
<br />
*content: identify video
*ad: identify each ad
<br />
The metadata received for each asset is used for classification and reporting.
<br />
Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.
<br />

=== Content Metadata Object ===
<br />
Content metadata should remain constant throughout the completion of an episode or live stream.
<br />
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| type || type of asset || "content" || ✓
|-
| adModel || linear vs dynamic ad model || * 1) - Linear – matches TV ad load * 2) Dynamic – Dynamic Ad Insertion (DAI) || ✓
|-
|}
<br/>
'''Example Content Object'''
<syntaxhighlight lang="javascript"> var contentMetadataObject =
{
type: 'content',
adModel: '1'
};</syntaxhighlight>

=== Ad Metadata Object ===
<br/>
If Ad is not ID3 tagged, then Ad metadata should be passed for each individual Ad, if ads are available during or before the stream begins.
<br/>
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to ad || custom (no [[Special Characters]]) || ✓
|}
<br/>
'''Example Ad Object'''
<br/>
<syntaxhighlight lang="javascript"> var adMetadataObject =
{
assetid: 'AD-1',
type: 'preroll'
};</syntaxhighlight>

== SDK Events ==
<br/>
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/Ad metadata object || Needs to be called at the beginning of each asset to pass type and adModel
|-
| 'sendID3' || Used to send the ID3 tag payload retrieved from the stream || Needs to be called at the beginning of playback
|-
| 'setVolume' || Used to pass in the player volume levels in % || Needs to be called when the player volume changes. This is applicable only for Audibility feature
|}

== Configure and fire API calls ==
<br />
The syntax for firing events is:
<syntaxhighlight lang="javascript"> nSdkInstance.ggPM("event", parameter object);</syntaxhighlight>
<br />
Event is passed in parameter 1 and the argument is passed in parameter 2.

=== Configure API calls - loadMetadata ===
<br />
Use [[loadMetadata (Browser)]] to pass the metadata object. The data must be passed as a JSON string.
<br />
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("loadMetadata", metadataObject);</syntaxhighlight>

=== Configure API calls - sendID3 ===
<br />
Use [[sendID3 (Browser)]] to send ID3 payload of the HLS content being played. This will allow the ID3 payload to be sent every time an ID3 packet is received (approximately, once in every 10 seconds).
<br />
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("sendID3", ID3_Payload);</syntaxhighlight>
<br />
==== Sample ID3 tags ====
<br />
<syntaxhighlight>
www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_<wbr />JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00</syntaxhighlight>
<br />
<syntaxhighlight>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGhe<wbr />Fi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8<wbr />QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00</syntaxhighlight>
<br />
<code>ID3_Payload</code> is the container to pass the retrieved ID3 tag from the streaming. The player should look for 'PRIV' ID3 tags and send 'owner' field (which typically starts from "www.nielsen.com") through this API. Refer to [[Browser SDK API Reference#Retrieving ID3 Tags|Browser SDK API Reference - Retrieving ID3 Tags]] for more information.
<br />
<br />
Refer to [[Browser SDK API Reference#Retrieving ID3 Tags|Browser SDK API Reference - Retrieving ID3 Tags]] section to know more details.

=== Configure API calls - setVolume ===
<br />
Use the setVolume(Browser) to send the player volume for Audibility feature. Player volume should be sent at the beginning of stream and whenever volume changes. By default the volumeLevel is set to -1. VolumeLevel is the Audibility percentage (0-100). If the player is muted, use volumeLevel of 0.

<br />
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("setVolume", volumeLevel);</syntaxhighlight>



== SDK DTVR Event Sequence ==
<br/>
The sample event lifecycle can be used as a reference for identifying the order for calling events.
<br/>
<syntaxhighlight lang="javascript">
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('sendID3', ID3_Payload); //call sendID3 every 10 seconds and stop calling during any playback interruptions
</syntaxhighlight>

{{Template:Browser_Privacy_and_Opt-Out}}

== Going Live ==
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.

'''Example Production Initialization Call'''
<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", { optout: "false"});
</syntaxhighlight>

DCR Video Browser SDK

2024-09-03T20:17:47Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== 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
|}

== Release Notes ==
The release notes on the Browser SDK can be located here: '''[[Browser SDK Release Notes|Release Notes]]'''

== Configure SDK ==
There are two steps required for configuring the SDK:
*Add Static Queue Snippet
*Create SDK Instance

=== Static Queue Snippet ===
Add the following script tag to the website:
<syntaxhighlight lang="javascript">
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {
nol_sdkDebug: "debug",
optout: "false"
});

</script>
</syntaxhighlight>

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.

<blockquote>For DCR static, BSDK cannot be run in an iframe because the blur/focus events of the parent page may not propagate to the iframe. The iframe events typically trigger when the iframe itself is clicked. The BSDK is dependent on the blur/focus events of the browser to detect active viewing of the page. Because the root page events do not propagate to the iframe, this would impact incorrect DCR static crediting.</blockquote>

===Create SDK Instance===
To initialize the SDK, create an SDK instance by making the initialization call:

==== Initialization API Call ====
<syntaxhighlight lang="javascript">
NOLBUNDLE.nlsQ("<apid>", "<instanceName>",{nol_sdkDebug: "debug"});
</syntaxhighlight>
<br>
When creating an instance, pass the following values: (<code>nol_sdkDebug</code> and <code>optout</code> are optional)
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site || 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|-
|instanceName || Name of SDK instance || "any string value"
|-
| nol_sdkDebug || Enables Nielsen console logging if desired. || <syntaxhighlight lang="javascript">
{nol_sdkDebug: "debug"}
{nol_sdkDebug: "info"}
{nol_sdkDebug: "warn"}
{nol_sdkDebug: "true"}
</syntaxhighlight>
|-
|optout || Optional: OptOut global parameter. || <code>1/0</code> or <code>true/false</code>
|}

==== Example SDK Initialization ====
When the initialization call is made, a unique static configuration file, <apid>.js, will be downloaded based on the apid and will be cached on the user’s browser.

Once the configuration is downloaded, the SDK itself will be downloaded and initialized. All SDK modules are included in one file: “nlsSDK600.bundle.min.js”.

More information on OptOut Parameter under [[DCR Video Browser SDK#Privacy_and_Opt-Out|Privacy and Opt-Out.]]


=== Example SDK Configuration ===

The configuration should include the Static Queue Snippet and an SDK Instance for an unique App ID as shown in the example:
<syntaxhighlight lang="html"><script type="text/javascript">
// Add Static Queue Snippet
!function(t,n)
{
t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,
i=s.getElementsByTagName("script")[0],
i.parentNode.insertBefore(r,i),
t[n][o]=t[n][o]||{g:c||{},
ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]
}
}
}
(window,"NOLBUNDLE");

// Created SDK Instance
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});
</script></syntaxhighlight>

=== Create Metadata Objects ===
There are two types of asset metadata:
*content: identify video
*ad: identify each ad

The metadata received for each asset is used for classification and reporting.

Metadata can be passed through key-values using the Nielsen reserved keys. User will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.

==== Content Metadata ====
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
{{DCR Content Metadata}}

==== Example Content Object ====
<syntaxhighlight lang="javascript">
var contentMetadataObject =
{
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2',
segB: 'custom segment B', // optional
segC: 'custom segment C', // optional
crossId1: 'Standard Episode ID', // optional
crossId2: 'Content Originator' //optional
};
</syntaxhighlight>

=== 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> <br> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to Ad || custom <br>(no [[Special Characters]]) || ✓
|}

==== Example Ad Object ====
<syntaxhighlight lang="javascript">
var adMetadataObject =
{
type: 'preroll',
assetid: 'AD-1'
};
</syntaxhighlight>
<br/>
<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>

==== Call Nielsen APIs ====
The method for calling events is ggPM().

<syntaxhighlight lang="javascript">
nSdkInstance.ggPM('event', parameter, ...);
</syntaxhighlight>

== Interrupt Scenarios ==

=== Pause Event ===
The setPlayheadPostion event is used for handling pause. To indicate pause, stop passing the playhead position to the SDK. Once the content resumes, begin sending the playhead again with the correct playhead value.

=== Other Interrupt Scenarios ===
The following possible browser interruption scenarios must be handled:

* Browser/Tab close
* Leaving the page to another destination
* Pressing the stop button
* Network Loss

There are many cases where the player itself has the ability to detect such situations. If not, these interruption scenarios can be handled through JavaScript. The events that are called will depend on the asset being played (e.g. midroll vs. content).

<syntaxhighlight lang="javascript">
window.addEventListener('beforeunload', function(event)
{
// Only inside a midroll indicate <stop> for the ad
nSdkInstance.ggPM('stop', playheadPosition);

// Indicate <end> and <stop> for the content
nSdkInstance.ggPM('end', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
});
</syntaxhighlight>

<blockquote>'''Note:''' User may need to add code to support specific browser versions (e.g. older versions of Internet Explorer).</blockquote>

=== SDK Events ===
{| class="wikitable"
|-
! Event !! Parameter !! Description
|-
| 'loadMetadata' || content/ad metadata object || Needs to be called at the beginning of each asset
|-
| 'setPlayheadPosition' || playhead position as integer<br/>
VOD: || current position in seconds <br/>
Live: current Unix timestamp (seconds since Jan-1-1970 UTC) <br/>
Note: 'setPlayheadPosition' has to be called every second
||
Pass playhead position every second during playback
|-
| 'stop' || playhead position in seconds || Call when content or ads complete playing and pass playhead position
|-
| 'end' || playhead position in seconds || Call when the current video asset completes playback and pass the playhead position. <br/>
Example: At the end of the content stream, if the user switches to another piece of content, when the browser is refreshed or closed.
|}

== SDK Playhead Event Sequence ==
The sample event lifecycles can be used as a reference for identifying the order for calling events.

=== Content Playback ===
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// CONTENT PLAYS
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// END OF STREAM
nSdkInstance.ggPM('end', playheadPosition);
</syntaxhighlight>

=== Content Playback with Ads ===
<syntaxhighlight lang="javascript">
// START OF STREAM
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);

// PREROLL
nSdkInstance.ggPM('loadMetadata', prerollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// MIDROLL
nSdkInstance.ggPM('loadMetadata', midrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);

// CONTENT RESUMES
nSdkInstance.ggPM('loadMetadata', contentMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);

// END OF STREAM
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('end', playheadPosition);

// POSTROLL
nSdkInstance.ggPM('loadmetadata', postrollMetadataObject);
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
//
// pass playhead every second
//
nSdkInstance.ggPM('setPlayheadPosition', playheadPosition);
nSdkInstance.ggPM('stop', playheadPosition);
</syntaxhighlight>
<blockquote>
* 'setPlayheadPosition' is used for calculating duration and must be passed every second. The final playhead position must be sent for the current asset being played before calling 'stop', 'end', or 'loadmetadata'.

* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
</blockquote>

{{Template:Browser_Privacy_and_Opt-Out}}

== Going Live ==
After the integration has been certified, users will need to make a couple of updates to the initialization call to ensure that player will be measured properly.
Disable debug logging by deleting {nol_sdkDebug: 'DEBUG'} from initialization call.

'''Example Production Initialization Call'''

<syntaxhighlight lang="javascript">
var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX", "nlsnInstance", { optout: "false"});
</syntaxhighlight>

DCR and DTVR with iOS17 or TVOS17

2024-07-09T04:31:07Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__

== Overview ==
Summary: The latest version of Nielsen iOS/TVOS AppSDK (currently 9.4.0.0) has the below-mentioned privacy manifest entries and app tracking/opt-out behavior already included. App developers integrating the SDK will automatically have the required entries added to their app's privacy manifest when compiled with Xcode 15 or greater. '''Nielsen Client Developers do not need to make any additional changes to privacy manifest files at the application level to handle Nielsen tracking behavior.'''

Beginning with iOS/TVOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:
===App Privacy Manifest===
*App privacy manifest files must be updated before submitting apps to the App Store.
**Declare collection/use of user tracking information - app developers/third-party SDKs will be required to list domains that are used to send messages containing the user's device ID (IDFA).
***[https://developer.apple.com/documentation/bundleresources/privacy_manifest_files?changes=_4 Apple:Privacy manifest files]
**Required Reason API - Apple is requiring reasons for apps' usage of certain system APIs that retrieve information about the device or state of some system metrics.
***[https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api Apple:Describing use of required reason API]

===App Tracking Transparency (ATT) Framework===
When users select "Ask App Not to Track" from the ATT popup, the operating system will behave differently from previous iOS/tvOS versions:
</br>
*In iOS/tvOS versions lower than 17, when "Ask App Not to Track" was selected, apps were blocked from reading the device's IDFA and measurement would be transmitted with a blank device ID.
*With iOS/tvOS 17, if the user selects "Ask App Not to Track", third-party SDKs will not only be blocked from reading the IDFA, the entire app will also be blocked from sending http(s) traffic to domains declared as "tracking domains" in the SDK's privacy manifest file. This will prevent typical measurement pings from going out and will impact volumetric measurement for your apps.
</br>
A new release of the AppSDK (v9.4) aims to address this requirement through explicit distinction of tracking versus non-tracking traffic through the use of 2 domains as described below:
*When a user has opted in (Allow Tracking), measurement data pings will continue to be sent to the vtwenty.com (tracking) domain with the available IDFA.
*When a user has opted out (Ask App Not to Track) or with an unknown status, all the measurement data pings will be sent to the nmrodam.com (non-tracking) domain. These pings will not contain any IDFA tracking.
NOTE: the domain-changing above refers only Nielsen AppSDK with ad framework support. Non-ad framework flavors of AppSDK are not affected.

</br>

'''IMPORTANT NOTE:''' Nielsen iOS/TVOS SDK has the privacy manifest entries and app tracking/opt-out behavior already included. App developers integrating the SDK will automatically have the required entries added to their app's privacy manifest when compiled with Xcode 15 or greater. '''Nielsen Client Developers do not need to make any additional changes to privacy manifest files at the application level to handle Nielsen tracking behavior.''' This functionality is included in Nielsen AppSDK version 9.4.0.0 or greater. With the release of iOS/TVOS 17 in September 2023, Nielsen clients are strongly encouraged to update to AppSDK version 9.4.0.0 (release date: July, 9 2024) or greater as soon as possible to avoid disruption in measurement.

Apple is not currently mandating that SDK developers declare a tracking domain in the SDK-level privacy manifest file, and if one is provided, all traffic from all Nielsen integrations in the app will be blocked for opted-out users. To mitigate this situation, the Nielsen technical team has decided to create 2 versions of the iOS/tvOS AppSDK: one with no tracking domain declared (default) and one with it declared.

The AppSDK 9.4.0.0 build with tracking domain declared will be made available through Nielsen artifactory and/or direct download from Nielsen Engineering Portal. '''Current integrations using Nielsen artifactory distribution will receive notice to update to this version through CocoaPods/Carthage/SPM distributions automatically.'''

If you have any questions about the AppSDK version that has the tracking domain declared, please reach out to your Nielsen Client Engineer.

Nielsen Digital Measurement and iOS17 or TVOS17

2024-07-09T04:25:52Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Overview ==
Beginning with iOS/tvOS 17, Apple is adding several requirements for App developers around tracking, use of Identifier For Advertisers (IDFA), and certain system APIs as detailed below:
===App Privacy Manifest===
*App privacy manifest files must be updated before submitting apps to the App Store.
**Declare collection/use of user tracking information - app developers/third-party SDKs will be required to list domains that are used to send messages containing the user's device ID (IDFA).
***[https://developer.apple.com/documentation/bundleresources/privacy_manifest_files?changes=_4 Apple:Privacy manifest files]
**Required Reason API - Apple is requiring reasons for apps' usage of certain system APIs that retrieve information about the device or state of some system metrics.
***[https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api Apple:Describing use of required reason API]

Below is the AppSDK privacy manifest snapshot for AD flavor which showcase tracking domain used to capture the IDFA/AD ID in measurement traffic.

From Privacy accessed API perspective for all SDK flavors , it has declared

* AppSDK does use the User Defaults to cache the data, needed in kill/relaunch scenarios. The usage is as per the Apple recommendation to read/write information limited to containing app only (CA92.1).
* AppSDK does use the timestamp API to check the expiry of cached config limited to containing app only(C617.1)
* AppSDK does observe the sufficient disk space, so it can stop the Sqlite DB insertions if there is an insufficient space for the containing app only(E174.1)
[[File:NewPrivacyDomain.png|center|thumb|668x668px|AppSDK Privacy Manifest]]

===App Tracking Transparency (ATT) Framework===
When users select "Ask App Not to Track" from the ATT popup, the operating system will behave differently from previous iOS/tvOS versions:
</br>
*In iOS/tvOS versions lower than 17, when "Ask App Not to Track" was selected, apps were blocked from reading the device's IDFA and measurement would be transmitted with a blank device ID.
*With iOS/tvOS 17, if the user selects "Ask App Not to Track", third-party SDKs will not only be blocked from reading the IDFA, the SDKs will also be blocked from sending http(s) traffic to domains declared as "tracking domains" in the SDK's privacy manifest file. This will prevent typical measurement pings from going out and will impact volumetric measurement for your apps.
</br>
A new release of the AppSDK (v9.4) aims to address this requirement through explicit distinction of tracking versus non-tracking traffic through the use of 2 domains as described below:
*When a user has opted in (Allow Tracking), measurement data pings will continue to be sent to the vtwenty.com (tracking domain) with the available IDFA.
*When a user has opted out (Ask App Not to Track) or with an unknown status, all the measurement data pings will be sent to the nmrodam.com (non-tracking domain). These pings will not contain any IDFA tracking.

==Next Steps==
#Move to the latest Nielsen AppSDK release (v9.4) for builds targeting iOS 17 with Xcode 15. Upgrading to the new build of the Digital SDKs should be straightforward through your build configuration. AppSDKs remain backwards compatible and would not require any further integration changes. Please refer to the Integration guide section for further details.
#To be decided if the privacy manifest needs to be modified. For coexisting DAR pixel and Digital SDK integrations please reach out to your Nielsen Client Engineer to determine the path forward.
#Work with your Nielsen Client Engineer once implemented to ensure proper measurement.

Nielsen Digital Measurement and iOS17 or TVOS17

2024-07-09T04:24:27Z

AnkitAgrawal:

File:NewPrivacyDomain.png

2024-07-09T04:22:03Z

AnkitAgrawal:

Updated to vtwenty.com

Android SDK Release Notes

2024-07-09T04:15:35Z

AnkitAgrawal: Release 9.4.0.0 changes

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}

== Release 9.4.0.0 (07-09-2024) ==
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Upgraded SDK to use Java 11 and Kotlin 1.8.0.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for capturing user opt-out during initialization.
== Release 9.2.0.0 (9-27-2023) ==
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF)
*Viewability: allow enabling by product (DCR, DTVR)
*Other bug fixes and enhancements

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* Kotlin-Java interoperability implementation in SDK.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Support for EMM AGF AdID-less solution.
* Enabled SDK to capture network availability changes.
* Removed the usage of deprecated network classes.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for SDK build variants - AD/NoAD/NoID.
* Support to indicate ID used for AD build variant - AD ID vs Android ID.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* FPID and VendorID support.
* Support for Android apps running on ChromeOS.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==

* Application background/foreground state auto-detection (AndroidX)
* Fixed forward rewind evdata containing negative values
* Offline viewing measurement enhancements
* Revisited precedence logic for sfcode parameter
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==

* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Removal of Location Module from SDK Code.
* Fixed the getOptoutStatus() api, so that client can call it in main thread.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other enhancements and fixes.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Bug fixes and improvements

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.26 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value is reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping
*Fix for last playhead call that is not processed (when there is no time-gap between the last playhead and end call)

== Release 5.1.1.24 (6-2-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for metadata carry over between channels after a channel change

== Release 5.1.1.18 (1-24-2017) ==
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance through encryption process change
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.14 (12-10-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Collection of additional device information
*Opt-out pages based on locale and country
*Opt-out based on the ‘Limit Ad Tracking’ flag
*Issue a warning in client developer’s console when an ad is being played for more than 5 minutes
*Reduced load time of Android SDK, caused due to encryption.
*Limit the duration reported for App launch
*Modification to accept non-JSON strings
*Fixed
**Incorrect DRM placement ID
**DRM pings sent in bursts in case of time change

== Release 5.1.1.10 (10-19-2016) ==
*Fixed an issue where SDK will send a burst of data pings in Android.

== Release 5.1.1.7 (9-1-2016) ==
*Support for Android N
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.4 (8-1-2016) ==
*Support for Pause timeout (from 30 minutes to 5 minutes)

== Release 5.1.1.3 (7-7-2016) ==
*Sending event level (button press data) data to census collections.
*Changes in OTT when switching from mobile to Chromecast
*General bug fix and performance improvements

== Release 5.1.0.4 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
*All the products should be migrated to the latest SDK.
*This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for Android 6.0 Marshmallow
*General bug fix and performance improvements

== Release 1.2.3.8 (1-10-2015) ==

TVOS SDK Release Notes

2024-07-09T04:13:27Z

AnkitAgrawal: Release 9.4.0.0 changes

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}

== Release 9.4.0.0 (07-09-2024) ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
==Release 9.3.0.0 (05-10-2024)==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (9-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Nielsen SDK support for Xcode 10 and tvOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.17 (1-23-2017) ==
*Added "seconds" place to the launch ping
*Ability to opt-out using "Limit Ad Tracking" feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the "Limit Ad Tracking" flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.7 (9-13-2016) ==
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Includes a sample TVOS application used to assist during integration.
*Support for TVML based optout pages
*General bug fix and performance improvements

== Release 5.1.0.7 (6-15-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Support for Pause timeout
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature

iOS SDK Release Notes

2024-07-09T04:12:04Z

AnkitAgrawal: /* Release 9.4.0.0 (07-09-2024) */

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital Downloads}} {{CurrentBreadcrumb}}

== Release 9.4.0.0 (07-09-2024) ==
*Support for privacy manifest with content tracking domain for Ad flavors.
*Support for content tracking and no-tracking domains across sdk flavors and products.
*Other bug fixes and enhancements.
== Release 9.3.0.0 (05-10-2024) ==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (09-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (03-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Support added for Video On Demand in TV Ratings
*Support for Xcode 10 and iOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.29 (7-31-2017) ==
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
*Merged adModel and adLoadType flags
*Fix for stop event data carried to next session’s duration ping

== Release 5.1.1.25 (5-31-2017) ==
*Enhanced support for Digital Audio
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.23 (5-5-2017) ==
*Ability to pass adloadtype as “linear” or “dynamic”
*Ability to detect end of content and static material through duration pings
*Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
*Acceptance of case-insensitive JSON key values
*Configurable feature to show Ad view counts in the duration pings
*Automatic Pause Detection and Debug build detection
*Change of default ‘type’ from “ad” to “content”
*Removal of “Static” Launch Ping for Non-Static product implementations
*Fix for App crash when multiple threads are accessing the SQLite

== Release 5.1.1.19 (4-3-2017) ==
*Fix for muting background music apps

== Release 5.1.1.18 (2-3-2017) ==
*Minor bug fixes and performance improvement

== Release 5.1.1.17 (1-23-2017) ==
*Added “seconds” place to the launch ping
*Ability to opt-out using “Limit Ad Tracking” feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the ‘Limit Ad Tracking’ flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.9 (10-18-2016) ==
*Fixed Linker error duplicate symbols for Reachability notification in iOS.

== Release 5.1.1.7 (9-13-2016) ==
*Support for iOS 10
*Usage of stop API call is made optional when switching between content or advertising occurs.
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Sending event level (button press data) data to census collections.
*Support for Pause timeout (from 30 minutes to 5 minutes)
*Changes in OTT when switching from mobile to Chromecast
*Self-error Reporting for iOS SDK
*General bug fix and performance improvements

== Release 5.1.0.5 (4-25-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Changes to use of stop API
*Support for OTT measurement
*Support for Pause timeout
*Offline viewing
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature
*Introduced new API updateOTT to report current OTT status.

== Release 4.0.0.8 (6-9-2015) ==
*Support for Nielsen DCR product (Digital Content Ratings)
**All the products should be migrated to the latest SDK.
**This SDK distribution does not have a native library component or shared object.
*Support for Nielsen App static measurement
*Support for Ad measurement
*Removal of Native C++ code
*Removed singleton restriction
*Support for iOS 9 and iOS 9 PIP mode
*General bug fix and performance improvements

== Release 3.2.1.26 (1-10-2015) ==

Digital Measurement Video webOS

2024-06-10T19:00:10Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Introduction ==
The following document will highlight the steps needed to run Browser SDK (BSDK) on LG Smart TVs that are currently running webOS TV 23 on Chromium 94 web engine

The tutorial should be used in combination with the documentation at [https://webostv.developer.lge.com/develop/getting-started/build-your-first-web-app webOS TV Developer] to build an app and verify that the BSDK properly measures the video and static content. In the tutorial we will be using a [https://webostv.developer.lge.com/develop/getting-started/web-app-types#hosted-web-app hosted web app] which will host the content on the web server. We will also use the [https://webostv.developer.lge.com/develop/tools/simulator-introduction webOS TV Simulator] for app development.

== Step 1: Install the webOS TV CLI ==

Navigate [https://webostv.developer.lge.com/develop/tools/simulator-installation here] and install the webOS TV CLI

== Step 2: Install the webOS TV Simulator ==

Navigate [https://webostv.developer.lge.com/develop/tools/simulator-installation here] and install the webOS TV Simulator

== Step 3: Create App ==

# We will begin creating the app by navigating [https://webostv.developer.lge.com/develop/getting-started/web-app-types#hosted-web-app here] and following the installation steps:
# Run <syntaxhighlight lang="javascript"> ares-generate -t hosted_webapp nlsn-bsdk-webOS </syntaxhighlight> to generate the app and accept all defaults
# Open the generated folder in a text editor or IDE and and create a new folder called app
# Add the following into a video.html file and make sure to update App ID with Nielsen provided App ID while creating the SDK instance

<br>

Add the following script tag to the website:
<syntaxhighlight lang="javascript">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DCR Video webOS Sample</title>
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// INSERT CLIENT APP ID
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "videoSdkInstance", {
nol_sdkDebug: "debug",
});

var contentMetadata = {
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</script>
<style>
body {
background-color: white;
}
</style>
</head>
<body>
<h1>DCR Video webOS Sample App</h1>
<div>
<video controls src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217" width="620">
Sorry, your browser doesn't support embedded videos,
but don't worry, you can <a
href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</div>
</main>
<script>
var media = document.querySelector('video');
var playheadPosition = 0;
var metadataLoaded = false;

// Loadmetadata
// Load contentMetadata object
media.addEventListener('loadedmetadata', (event) => {
// Call SDK loadmetadata event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

media.addEventListener('play', (event) => {
// Call SDK play event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

// Player paused
media.addEventListener('pause', function (e) {
nSdkInstance.ggPM("pause", playheadPosition);
});

// Set playhead position
media.addEventListener('timeupdate', function (e) {
var currTime = Math.floor(media.currentTime);
if (playheadPosition < currTime) {
playheadPosition = currTime;
nSdkInstance.ggPM("setplayheadposition", playheadPosition);
}
});

// End
media.addEventListener('ended', function (e) {
nSdkInstance.ggPM("end", playheadPosition);
metadataLoaded = false;
playheadPosition = 0;
});
</script>
</body>
</html>
</syntaxhighlight>
<br>
Click [https://gitlab.com/nielsen-media/digital/shared/sdk/browser-sdk/misc/bsdk-client-documentation/-/wikis/DCR-Video-Quick-Start here] for more information on DCR Video implementation.

3. Navigate to <syntaxhighlight lang="javascript"> index.html </syntaxhighlight> at the root of the directory and update the <syntaxhighlight lang="javascript"> location.href </syntaxhighlight> url to point to <syntaxhighlight lang="javascript"> http://{{LOCAL_SERVER_URL}}/app/video.html </syntaxhighlight>

That is all that we need to run the app on the webOS TV Simulator. Please make sure to update the App ID for SDK initialization to view proper crediting

== Step 4: Open up webOS TV Simulator ==

Open up the webOS TV Simulator > navigate to File > Launch App > open the folder containing the app created in the previous step
<br>
[[File:WEBOS 1.png||600px|center|]]

== Step 5: Debug app ==
Click on the Inspect button on the remote to open up developer tools > navigate to the Console tab > check for BSDK initialization and measurement.
[[File:LGwebos 2.png||600px|center|]]

Note - Debug Logging: Disable logging by deleting <syntaxhighlight lang="javascript"> {nol_sdkDebug: 'debug'} </syntaxhighlight> from initialization call.

== Remote events ==
Build out the app further by including [https://webostv.developer.lge.com/develop/guides/magic-remote remote events] and attaching the player events to corresponding <syntaxhighlight lang="javascript"> keycode: </syntaxhighlight>
<syntaxhighlight lang="javascript">

var media = document.querySelector('video');
window.addEventListener("keydown", function (e) {
switch (e.keyCode) {
case 415: // Play
media.play(); // play video
nSdkInstance.ggPM("play", contentMetadata); // SDK call
break;
case 19: // Pause
media.pause(); // play video
nSdkInstance.ggPM("pause", playheadPosition); // SDK call
break;
case 461: // Back
nSdkInstance.ggPM("stop", playheadPosition); // SDK call
break;
default:
break;
}
});

</syntaxhighlight>
<br>

== Next steps ==

For further testing on webOS TV apps on the TV, refer to this [https://webostv.developer.lge.com/develop/getting-started/developer-mode-app guide]. If there are any questions or concerns then please reach out to BSDK team. Reference the following guides for product specific information:

* [[DCR_Video_Browser_SDK|DCR Video]]
* [[DCR_Static_Browser_SDK_(6.0.0)|DCR Static]]
* [[DTVR_Browser_SDK|DTVR]]

Digital Measurement Video TizenTv

2024-06-10T18:47:33Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Introduction ==
The following document will highlight the steps needed to run Browser SDK (BSDK) on Samsung Smart TV using TIzen Studio for app development.
The tutorial should be used in conjunction with the documentation at [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ Create Your First Samsung Smart TV Web Application] to build an app with BSDK integration for content measurement. In this tutorial we will create a native app and highlight the different permissions required to run the BSDK.

== Step 1: Install Tizen Studio ==

Navigate [https://developer.tizen.org/development/tizen-studio/download here] and install Tizen Studio.
During installation make sure to install the '''TV Extensions package''' from the Package Manager.

== Step 2: Generate Security Profile ==

Navigate [https://docs.tizen.org/application/tizen-studio/common-tools/certificate-registration here] and generate the security profile in order to run applications.

== Step 3: Create Basic Project ==

Follow the [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ step-by-step guide] and create the Basic Project template.
Replace the code in the<syntaxhighlight>index.html</syntaxhighlight>file with the code snippet below and update the App ID with a Nielsen provided App ID during SDK initialization.
<syntaxhighlight lang="javascript">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DCR Video Tizen Sample</title>
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// Replace (PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) with CLIENT APP ID
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "videoSdkInstance", {
nol_sdkDebug: "debug",
});

var contentMetadata = {
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</script>
<style>
body {
background-color: white;
}
</style>
</head>
<body>
<h1>DCR Video Tizen Sample App</h1>
<div>
<video controls src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217" width="620">

Sorry, your browser doesn't support embedded videos,
but don't worry, you can <a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</div>
</main>
<script>
var media = document.querySelector('video');
var playheadPosition = 0;
var metadataLoaded = false;

// Loadmetadata
// Load contentMetadata object
media.addEventListener('loadedmetadata', (event) => {
// Call SDK loadmetadata event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

media.addEventListener('play', (event) => {
// Call SDK play event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

// Player paused
media.addEventListener('pause', function (e) {
nSdkInstance.ggPM("pause", playheadPosition);
});

// Set playhead position
media.addEventListener('timeupdate', function (e) {
var currTime = Math.floor(media.currentTime);
if (playheadPosition < currTime) {
playheadPosition = currTime;
nSdkInstance.ggPM("setplayheadposition", playheadPosition);
}
});

// End
media.addEventListener('ended', function (e) {
nSdkInstance.ggPM("end", playheadPosition);
metadataLoaded = false;
playheadPosition = 0;
});
</script>
</body>
</html>
</syntaxhighlight>
<br>

==Step 4: Run Project==
<syntaxhighlight lang="javascript">Right click on the project > Run As > Tizen Web Simulator Application (Samsung TV)</syntaxhighlight>
<br>
[[File:Tizen 1 Step4.png||600px|center|]]
<br>
Extra configurations must be done to run and debug the application on a Target Device, please reference the following [[TizenTv_Debugging|guide]] for more information

== Step 5: Debug App==
Right click anywhere in the Simulator to open the Web Inspector > navigate to the Console tab > check for BSDK initialization and content measurement.
[[File:Tizen 1 Step5.png||600px|center|]]

Debug Logging: Disable logging by deleting <syntaxhighlight lang="javascript">{nol_sdkDebug: 'debug'}</syntaxhighlight> from initialization call

== Remote control events ==
Build out the app further by including [https://developer.samsung.com/smarttv/develop/guides/user-interaction/remote-control.html remote control events] and attaching the player events to corresponding <syntaxhighlight lang="javascript">keyCode </syntaxhighlight> or using Tizen registered keys:
<syntaxhighlight lang="javascript">

var media = document.querySelector('video');
window.addEventListener("keydown", function (e) {
switch (e.keyCode) {
case 10252: // MediaPlayPause
if(!media.paused) {
media.pause(); // pause video
nSdkInstance.ggPM("pause", playheadPosition); // SDK call
break;
}

media.play(); // play video
nSdkInstance.ggPM("play", contentMetadata); // SDK call
break;
case 10009: // Back
nSdkInstance.ggPM("stop", playheadPosition); // SDK call
break;
...
default:
break;
}
});

</syntaxhighlight>

== Next steps ==

For further testing Samsung Tizen TV apps, refer to this [https://docs.tizen.org/application/web/tutorials/process/run-debug-app/ guide]. If there are any questions or concerns then please reach out to the BSDK team. Reference the following guides for product specific information:

* [[DCR_Video_Browser_SDK|DCR Video]]
* [[DCR_Static_Browser_SDK_(6.0.0)|DCR Static]]
* [[DTVR_Browser_SDK|DTVR]]
<br>
For further technical details or a sample application, please contact your Technical Account Manager (TAM).

Digital Measurement Video TizenTv

2024-06-10T18:47:17Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Introduction ==
The following document will highlight the steps needed to run Browser SDK (BSDK) on Samsung Smart TV using TIzen Studio for app development.
The tutorial should be used in conjunction with the documentation at [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ Create Your First Samsung Smart TV Web Application] to build an app with BSDK integration for content measurement. In this tutorial we will create a native app and highlight the different permissions required to run the BSDK.

== Step 1: Install Tizen Studio ==

Navigate [https://developer.tizen.org/development/tizen-studio/download here] and install Tizen Studio.
During installation make sure to install the '''TV Extension's package''' from the Package Manager.

== Step 2: Generate Security Profile ==

Navigate [https://docs.tizen.org/application/tizen-studio/common-tools/certificate-registration here] and generate the security profile in order to run applications.

== Step 3: Create Basic Project ==

Follow the [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ step-by-step guide] and create the Basic Project template.
Replace the code in the<syntaxhighlight>index.html</syntaxhighlight>file with the code snippet below and update the App ID with a Nielsen provided App ID during SDK initialization.
<syntaxhighlight lang="javascript">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DCR Video Tizen Sample</title>
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// Replace (PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) with CLIENT APP ID
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "videoSdkInstance", {
nol_sdkDebug: "debug",
});

var contentMetadata = {
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</script>
<style>
body {
background-color: white;
}
</style>
</head>
<body>
<h1>DCR Video Tizen Sample App</h1>
<div>
<video controls src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217" width="620">

Sorry, your browser doesn't support embedded videos,
but don't worry, you can <a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</div>
</main>
<script>
var media = document.querySelector('video');
var playheadPosition = 0;
var metadataLoaded = false;

// Loadmetadata
// Load contentMetadata object
media.addEventListener('loadedmetadata', (event) => {
// Call SDK loadmetadata event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

media.addEventListener('play', (event) => {
// Call SDK play event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

// Player paused
media.addEventListener('pause', function (e) {
nSdkInstance.ggPM("pause", playheadPosition);
});

// Set playhead position
media.addEventListener('timeupdate', function (e) {
var currTime = Math.floor(media.currentTime);
if (playheadPosition < currTime) {
playheadPosition = currTime;
nSdkInstance.ggPM("setplayheadposition", playheadPosition);
}
});

// End
media.addEventListener('ended', function (e) {
nSdkInstance.ggPM("end", playheadPosition);
metadataLoaded = false;
playheadPosition = 0;
});
</script>
</body>
</html>
</syntaxhighlight>
<br>

==Step 4: Run Project==
<syntaxhighlight lang="javascript">Right click on the project > Run As > Tizen Web Simulator Application (Samsung TV)</syntaxhighlight>
<br>
[[File:Tizen 1 Step4.png||600px|center|]]
<br>
Extra configurations must be done to run and debug the application on a Target Device, please reference the following [[TizenTv_Debugging|guide]] for more information

== Step 5: Debug App==
Right click anywhere in the Simulator to open the Web Inspector > navigate to the Console tab > check for BSDK initialization and content measurement.
[[File:Tizen 1 Step5.png||600px|center|]]

Debug Logging: Disable logging by deleting <syntaxhighlight lang="javascript">{nol_sdkDebug: 'debug'}</syntaxhighlight> from initialization call

== Remote control events ==
Build out the app further by including [https://developer.samsung.com/smarttv/develop/guides/user-interaction/remote-control.html remote control events] and attaching the player events to corresponding <syntaxhighlight lang="javascript">keyCode </syntaxhighlight> or using Tizen registered keys:
<syntaxhighlight lang="javascript">

var media = document.querySelector('video');
window.addEventListener("keydown", function (e) {
switch (e.keyCode) {
case 10252: // MediaPlayPause
if(!media.paused) {
media.pause(); // pause video
nSdkInstance.ggPM("pause", playheadPosition); // SDK call
break;
}

media.play(); // play video
nSdkInstance.ggPM("play", contentMetadata); // SDK call
break;
case 10009: // Back
nSdkInstance.ggPM("stop", playheadPosition); // SDK call
break;
...
default:
break;
}
});

</syntaxhighlight>

== Next steps ==

For further testing Samsung Tizen TV apps, refer to this [https://docs.tizen.org/application/web/tutorials/process/run-debug-app/ guide]. If there are any questions or concerns then please reach out to the BSDK team. Reference the following guides for product specific information:

* [[DCR_Video_Browser_SDK|DCR Video]]
* [[DCR_Static_Browser_SDK_(6.0.0)|DCR Static]]
* [[DTVR_Browser_SDK|DTVR]]
<br>
For further technical details or a sample application, please contact your Technical Account Manager (TAM).

Digital Measurement Video TizenTv

2024-06-10T18:46:55Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Introduction ==
The following document will highlight the steps needed to run Browser SDK (BSDK) on Samsung Smart TV using TIzen Studio for app development.
The tutorial should be used in conjunction with the documentation at [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ Create Your First Samsung Smart TV Web Application] to build an app with BSDK integration for content measurement. In this tutorial we will create a native app and highlight the different permissions required to run the BSDK.

== Step 1: Install Tizen Studio ==

Navigate [https://developer.tizen.org/development/tizen-studio/download here] and install Tizen Studio.
During installation make sure to install the '''TV Extensions package''' from the Package Manager.

== Step 2: Generate Security Profile ==

Navigate [https://docs.tizen.org/application/tizen-studio/common-tools/certificate-registration here] and generate the security profile in order to run applications.

== Step 3: Create Basic Project ==

Follow the [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ step-by-step guide] and create the Basic Project template.
Replace the code in the<syntaxhighlight>index.html</syntaxhighlight>file with the code snippet below and update the App ID with a Nielsen provided App ID during SDK initialization.
<syntaxhighlight lang="javascript">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DCR Video Tizen Sample</title>
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// Replace (PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) with CLIENT APP ID
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "videoSdkInstance", {
nol_sdkDebug: "debug",
});

var contentMetadata = {
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</script>
<style>
body {
background-color: white;
}
</style>
</head>
<body>
<h1>DCR Video Tizen Sample App</h1>
<div>
<video controls src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217" width="620">

Sorry, your browser doesn't support embedded videos,
but don't worry, you can <a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</div>
</main>
<script>
var media = document.querySelector('video');
var playheadPosition = 0;
var metadataLoaded = false;

// Loadmetadata
// Load contentMetadata object
media.addEventListener('loadedmetadata', (event) => {
// Call SDK loadmetadata event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

media.addEventListener('play', (event) => {
// Call SDK play event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

// Player paused
media.addEventListener('pause', function (e) {
nSdkInstance.ggPM("pause", playheadPosition);
});

// Set playhead position
media.addEventListener('timeupdate', function (e) {
var currTime = Math.floor(media.currentTime);
if (playheadPosition < currTime) {
playheadPosition = currTime;
nSdkInstance.ggPM("setplayheadposition", playheadPosition);
}
});

// End
media.addEventListener('ended', function (e) {
nSdkInstance.ggPM("end", playheadPosition);
metadataLoaded = false;
playheadPosition = 0;
});
</script>
</body>
</html>
</syntaxhighlight>
<br>

==Step 4: Run Project==
<syntaxhighlight lang="javascript">Right click on the project > Run As > Tizen Web Simulator Application (Samsung TV)</syntaxhighlight>
<br>
[[File:Tizen 1 Step4.png||600px|center|]]
<br>
Extra configurations must be done to run and debug the application on a Target Device, please reference the following [[TizenTv_Debugging|guide]] for more information

== Step 5: Debug App==
Right click anywhere in the Simulator to open the Web Inspector > navigate to the Console tab > check for BSDK initialization and content measurement.
[[File:Tizen 1 Step5.png||600px|center|]]

Debug Logging: Disable logging by deleting <syntaxhighlight lang="javascript">{nol_sdkDebug: 'debug'}</syntaxhighlight> from initialization call

== Remote control events ==
Build out the app further by including [https://developer.samsung.com/smarttv/develop/guides/user-interaction/remote-control.html remote control events] and attaching the player events to corresponding <syntaxhighlight lang="javascript">keyCode </syntaxhighlight> or using Tizen registered keys:
<syntaxhighlight lang="javascript">

var media = document.querySelector('video');
window.addEventListener("keydown", function (e) {
switch (e.keyCode) {
case 10252: // MediaPlayPause
if(!media.paused) {
media.pause(); // pause video
nSdkInstance.ggPM("pause", playheadPosition); // SDK call
break;
}

media.play(); // play video
nSdkInstance.ggPM("play", contentMetadata); // SDK call
break;
case 10009: // Back
nSdkInstance.ggPM("stop", playheadPosition); // SDK call
break;
...
default:
break;
}
});

</syntaxhighlight>

== Next steps ==

For further testing Samsung Tizen TV apps, refer to this [https://docs.tizen.org/application/web/tutorials/process/run-debug-app/ guide]. If there are any questions or concerns then please reach out to the BSDK team. Reference the following guides for product specific information:

* [[DCR_Video_Browser_SDK|DCR Video]]
* [[DCR_Static_Browser_SDK_(6.0.0)|DCR Static]]
* [[DTVR_Browser_SDK|DTVR]]
<br>
For further technical details or a sample application, please contact your Technical Account Manager (TAM).

Digital Measurement Video TizenTv

2024-06-10T18:46:27Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Introduction ==
The following document will highlight the steps needed to run Browser SDK (BSDK) on Samsung Smart TV using TIzen Studio for app development.
The tutorial should be used in conjunction with the documentation at [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ Create Your First Samsung Smart TV Web Application] to build an app with BSDK integration for content measurement. In this tutorial we will create a native app and highlight the different permissions required to run the BSDK.

== Step 1: Install Tizen Studio ==

Navigate [https://developer.tizen.org/development/tizen-studio/download here] and install Tizen Studio.
During installation make sure to install the '''TV Extension package''' from the Package Manager.

== Step 2: Generate Security Profile ==

Navigate [https://docs.tizen.org/application/tizen-studio/common-tools/certificate-registration here] and generate the security profile in order to run applications.

== Step 3: Create Basic Project ==

Follow the [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ step-by-step guide] and create the Basic Project template.
Replace the code in the<syntaxhighlight>index.html</syntaxhighlight>file with the code snippet below and update the App ID with a Nielsen provided App ID during SDK initialization.
<syntaxhighlight lang="javascript">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DCR Video Tizen Sample</title>
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// Replace (PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) with CLIENT APP ID
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "videoSdkInstance", {
nol_sdkDebug: "debug",
});

var contentMetadata = {
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</script>
<style>
body {
background-color: white;
}
</style>
</head>
<body>
<h1>DCR Video Tizen Sample App</h1>
<div>
<video controls src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217" width="620">

Sorry, your browser doesn't support embedded videos,
but don't worry, you can <a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</div>
</main>
<script>
var media = document.querySelector('video');
var playheadPosition = 0;
var metadataLoaded = false;

// Loadmetadata
// Load contentMetadata object
media.addEventListener('loadedmetadata', (event) => {
// Call SDK loadmetadata event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

media.addEventListener('play', (event) => {
// Call SDK play event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

// Player paused
media.addEventListener('pause', function (e) {
nSdkInstance.ggPM("pause", playheadPosition);
});

// Set playhead position
media.addEventListener('timeupdate', function (e) {
var currTime = Math.floor(media.currentTime);
if (playheadPosition < currTime) {
playheadPosition = currTime;
nSdkInstance.ggPM("setplayheadposition", playheadPosition);
}
});

// End
media.addEventListener('ended', function (e) {
nSdkInstance.ggPM("end", playheadPosition);
metadataLoaded = false;
playheadPosition = 0;
});
</script>
</body>
</html>
</syntaxhighlight>
<br>

==Step 4: Run Project==
<syntaxhighlight lang="javascript">Right click on the project > Run As > Tizen Web Simulator Application (Samsung TV)</syntaxhighlight>
<br>
[[File:Tizen 1 Step4.png||600px|center|]]
<br>
Extra configurations must be done to run and debug the application on a Target Device, please reference the following [[TizenTv_Debugging|guide]] for more information

== Step 5: Debug App==
Right click anywhere in the Simulator to open the Web Inspector > navigate to the Console tab > check for BSDK initialization and content measurement.
[[File:Tizen 1 Step5.png||600px|center|]]

Debug Logging: Disable logging by deleting <syntaxhighlight lang="javascript">{nol_sdkDebug: 'debug'}</syntaxhighlight> from initialization call

== Remote control events ==
Build out the app further by including [https://developer.samsung.com/smarttv/develop/guides/user-interaction/remote-control.html remote control events] and attaching the player events to corresponding <syntaxhighlight lang="javascript">keyCode </syntaxhighlight> or using Tizen registered keys:
<syntaxhighlight lang="javascript">

var media = document.querySelector('video');
window.addEventListener("keydown", function (e) {
switch (e.keyCode) {
case 10252: // MediaPlayPause
if(!media.paused) {
media.pause(); // pause video
nSdkInstance.ggPM("pause", playheadPosition); // SDK call
break;
}

media.play(); // play video
nSdkInstance.ggPM("play", contentMetadata); // SDK call
break;
case 10009: // Back
nSdkInstance.ggPM("stop", playheadPosition); // SDK call
break;
...
default:
break;
}
});

</syntaxhighlight>

== Next steps ==

For further testing Samsung Tizen TV apps, refer to this [https://docs.tizen.org/application/web/tutorials/process/run-debug-app/ guide]. If there are any questions or concerns then please reach out to the BSDK team. Reference the following guides for product specific information:

* [[DCR_Video_Browser_SDK|DCR Video]]
* [[DCR_Static_Browser_SDK_(6.0.0)|DCR Static]]
* [[DTVR_Browser_SDK|DTVR]]
<br>
For further technical details or a sample application, please contact your Technical Account Manager (TAM).

Digital Measurement Video TizenTv

2024-06-10T18:45:17Z

AnkitAgrawal:

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|DCR & DTVR}} {{CurrentBreadcrumb}}
[[Category:Digital]]

__NOTOC__
== Introduction ==
The following document will highlight the steps needed to run Browser SDK (BSDK) on Samsung Smart TV using TIzen Studio for app development.
The tutorial should be used in conjunction with the documentation at [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ Create Your First Samsung Smart TV Web Application] to build an app with BSDK integration for content measurement. In this tutorial we will create a native app and highlight the different permissions required to run the BSDK.

== Step 1: Install Tizen Studio ==

Navigate [https://developer.tizen.org/development/tizen-studio/download here] and install Tizen Studio.
During installation make sure to install the '''TV Extension's package''' from the Package Manager.

== Step 2: Generate Security Profile ==

Navigate [https://docs.tizen.org/application/tizen-studio/common-tools/certificate-registration here] and generate the security profile in order to run applications.

== Step 3: Create Basic Project ==

Follow the [https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/ step-by-step guide] and create the Basic Project template.
Replace the code in the<syntaxhighlight>index.html</syntaxhighlight>file with the code snippet below and update the App ID with a Nielsen provided App ID during SDK initialization.
<syntaxhighlight lang="javascript">
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DCR Video Tizen Sample</title>
<script>
// Static Queue Snippet
!function (e, n) {
function t(e) {
return "object" == typeof e ? JSON.parse(JSON.stringify(e)) : e
}
e[n] = e[n] ||
{
nlsQ: function (o, r, c) {
var s = e.document,
a = s.createElement("script");
a.async = 1,
a.src = ("http:" === e.location.protocol ? "http:" : "https:") + "//cdn-gl.imrworldwide.com/conf/" + o + ".js#name=" + r + "&ns=" + n;
var i = s.getElementsByTagName("script")[0];
return i.parentNode.insertBefore(a, i),
e[n][r] = e[n][r] || {
g: c || {},
ggPM: function (o, c, s, a, i) { e[n][r].q = e[n][r].q || []; try { var l = t([o, c, s, a, i]); e[n][r].q.push(l) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } },
trackEvent: function (o) { e[n][r].te = e[n][r].te || []; try { var c = t(o); e[n][r].te.push(c) } catch (e) { console && console.log && console.log("Error: Cannot register event in Nielsen SDK queue.") } }
},
e[n][r]
}
}
}(window, "NOLBUNDLE");

// Replace (PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) with CLIENT APP ID
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "videoSdkInstance", {
nol_sdkDebug: "debug",
});

var contentMetadata = {
type: 'content',
assetid: 'VID-123456',
program: 'program name',
title: 'episode title with season and episode number',
length: 'length in seconds',
airdate: '20210321 09:00:00',
isfullepisode: 'y',
adloadtype: '2'
};
</script>
<style>
body {
background-color: white;
}
</style>
</head>
<body>
<h1>DCR Video Tizen Sample App</h1>
<div>
<video controls src="https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4"
poster="https://peach.blender.org/wp-content/uploads/title_anouncement.jpg?x11217" width="620">

Sorry, your browser doesn't support embedded videos,
but don't worry, you can <a href="https://archive.org/details/BigBuckBunny_124">download it</a>
and watch it with your favorite video player!
</video>
</div>
</main>
<script>
var media = document.querySelector('video');
var playheadPosition = 0;
var metadataLoaded = false;

// Loadmetadata
// Load contentMetadata object
media.addEventListener('loadedmetadata', (event) => {
// Call SDK loadmetadata event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

media.addEventListener('play', (event) => {
// Call SDK play event
if (!metadataLoaded) {
nSdkInstance.ggPM("loadmetadata", contentMetadata);
metadataLoaded = true;
}
});

// Player paused
media.addEventListener('pause', function (e) {
nSdkInstance.ggPM("pause", playheadPosition);
});

// Set playhead position
media.addEventListener('timeupdate', function (e) {
var currTime = Math.floor(media.currentTime);
if (playheadPosition < currTime) {
playheadPosition = currTime;
nSdkInstance.ggPM("setplayheadposition", playheadPosition);
}
});

// End
media.addEventListener('ended', function (e) {
nSdkInstance.ggPM("end", playheadPosition);
metadataLoaded = false;
playheadPosition = 0;
});
</script>
</body>
</html>
</syntaxhighlight>
<br>

==Step 4: Run Project==
<syntaxhighlight lang="javascript">Right click on the project > Run As > Tizen Web Simulator Application (Samsung TV)</syntaxhighlight>
<br>
[[File:Tizen 1 Step4.png||600px|center|]]
<br>
Extra configurations must be done to run and debug the application on a Target Device, please reference the following [[TizenTv_Debugging|guide]] for more information

== Step 5: Debug App==
Right click anywhere in the Simulator to open the Web Inspector > navigate to the Console tab > check for BSDK initialization and content measurement.
[[File:Tizen 1 Step5.png||600px|center|]]

Debug Logging: Disable logging by deleting <syntaxhighlight lang="javascript">{nol_sdkDebug: 'debug'}</syntaxhighlight> from initialization call

== Remote control events ==
Build out the app further by including [https://developer.samsung.com/smarttv/develop/guides/user-interaction/remote-control.html remote control events] and attaching the player events to corresponding <syntaxhighlight lang="javascript">keyCode </syntaxhighlight> or using Tizen registered keys:
<syntaxhighlight lang="javascript">

var media = document.querySelector('video');
window.addEventListener("keydown", function (e) {
switch (e.keyCode) {
case 10252: // MediaPlayPause
if(!media.paused) {
media.pause(); // pause video
nSdkInstance.ggPM("pause", playheadPosition); // SDK call
break;
}

media.play(); // play video
nSdkInstance.ggPM("play", contentMetadata); // SDK call
break;
case 10009: // Back
nSdkInstance.ggPM("stop", playheadPosition); // SDK call
break;
...
default:
break;
}
});

</syntaxhighlight>

== Next steps ==

For further testing Samsung Tizen TV apps, refer to this [https://docs.tizen.org/application/web/tutorials/process/run-debug-app/ guide]. If there are any questions or concerns then please reach out to the BSDK team. Reference the following guides for product specific information:

* [[DCR_Video_Browser_SDK|DCR Video]]
* [[DCR_Static_Browser_SDK_(6.0.0)|DCR Static]]
* [[DTVR_Browser_SDK|DTVR]]
<br>
For further technical details or a sample application, please contact your Technical Account Manager (TAM).

TVOS SDK Release Notes

2024-05-27T12:35:03Z

AnkitAgrawal: Updated TVOS notes

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
==Release 9.3.0.0 (05-10-2024)==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.
== Release 9.2.0.0 (9-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Nielsen SDK support for Xcode 10 and tvOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.17 (1-23-2017) ==
*Added "seconds" place to the launch ping
*Ability to opt-out using "Limit Ad Tracking" feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the "Limit Ad Tracking" flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.7 (9-13-2016) ==
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Includes a sample TVOS application used to assist during integration.
*Support for TVML based optout pages
*General bug fix and performance improvements

== Release 5.1.0.7 (6-15-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Support for Pause timeout
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature

TVOS SDK Release Notes

2024-05-27T12:34:08Z

AnkitAgrawal: Updated TVOS notes

[[Category:Digital]]
__NOTOC__

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
==Release 9.3.0.0 (05-10-2024)==
*Support for privacy manifest with tracking domain for Ad flavors.
*Support for capturing user opt-out during initialization.
*Other bug fixes and enhancements.

*
== Release 9.2.0.0 (9-27-2023) ==
*Support for privacy manifest and required reason API introduced in XCode 15.
*Digitally signed SDK framework per Apple recommendation
*DCR Static recognizing metadata with changed assetID for new impressions.
*Limiting ping retries during https failures.
*Other bug fixes and enhancements.

== Release 9.1.0.0 (3-31-2023) ==
*DCR Static duration measurement for AppSDK (currently only AGF).
*Removed use of iOS keychains, started using NSUserDefaults for persistent storage.
*Viewability: allow enabling by product (DCR, DTVR).
*Other bug fixes and enhancements.

== Release 9.0.0.0 (10-07-2022) ==
* Viewability measurement for DTVR, DCR Content and DCR Ad products.
* Audibility measurement for DTVR, DCR Content and DCR Ad products.
* SDK built with XCode 14.
* Other bug fixes and enhancements.

== Release 8.2.0.0 (03-21-2022) ==
* Adopting Swift language internally, built on a mixed model (Swift+Objective C).
* Support for Swift markers to help Swift developers.
* Removed the usage of deprecated iOS network reachability class.
* Disabled iCloud backup/synchronization of SDK keychain items.
* Other bug fixes and enhancements.

== Release 8.1.0.0 (06-28-2021) ==
* Support for XCFramework build distribution.
* Support for MacOS Catalyst platform framework.
* Fixed the device classification for MacOS M1 measurement.
* Support to capture Hashed email and UID.
* Support to collect SDK diagnostic data.
* Other bug fixes and enhancements.

== Release 8.0.0.0 (10-05-2020) ==
* iOS 14 App Transparency Framework support.
* FPID and VendorID support.
* Fixed the device classification for iPADOS measurement.
* Support for Xamarin cross platform framework.
* Other bug fixes and enhancements.

== Release 7.2.0.0 (05-18-2020) ==
* DTVR AQH and IVD requirements for End and pause timeout.
* Support for Hybrid app webview measurement.
* Support for Hybrid app react native webview measurement.
* Support for React Native measurement.
* Other bug fixes and enhancements

== Release 7.1.0.0 (12-09-2019) ==
* Removed usage of deprecated class UIWebView
* Offline viewing measurement enhancements
* Fixed deadlock on SDK shutdown
* Revisited precedence logic for sfcode parameter
* Fix for DCR individual ad pings parameters after channel change
* Using default value for incorrect adModel parameter
* Defaulting isLive parameter value on channel change
* Other fixes and enhancements.

== Release 7.0.0.0 (09-06-2019) ==
* Support for CDN based config.
* Support for Market based EMM UAID pings.
* Changes required for proper DCR Static measurement in multi-instance/multiple appid's case.
* Fixes for OTT synchronization issues between iOS and Android platforms.
* Fixes for EV data parameters in few scenarios.
* Fixes for DCR Static product behaviour in background app refresh and background fetch scenarios.
* DCR Ad reporting improvements.
* Fixes and improvements for the SDK console log messages.
* Other enhancements and fixes.

== Release 6.2.0.0 (02-04-2019) ==
* Introduced Dynamic framework for SDK.
* Removal of Location Module from SDK Code.
* Increased SDK log file size for Debug mode.
* Removed OTT Airplay/mirroring detection that caused crashes in AVAudioSession class.
* DCR performance improvements.
* Fixed the parsing error happening when clientid/vcid provided as empty in metadata.
* Align AppSDK for FW detection with BSDK for DCR measurement.
* Other Bug Fixes/Enhancements.

== Release 6.1.0.1 (9-13-2018) ==
*Nielsen SDK support for Xcode 10 and tvOS 12

== Release 6.0.0.4 (5-24-2018) ==
*If the SDK build target is set to AGF then SDK will send the hello ping to “eu” and “eu-uat” for debug builds. No changes to the non AGF build the default sfcode will continue to be "sdk" and "cert" for debug build.
*The C1 parameter (NUID) will now be sent as encrypted DeviceID.
*New SessionID changes. The sessionID will contain 29 length random characters appended by timestamp.
*Support for multiple SDK instance without any limit.
*New log feature for CAT tool to retrieve the API level information from client apps. This ping will contain the eventType, parameters, SDK version, appid etc.
*Removed Viewability for this release.

== Release 5.1.1.17 (1-23-2017) ==
*Added "seconds" place to the launch ping
*Ability to opt-out using "Limit Ad Tracking" feature
*Improved CPU Performance while apps are running in background
*Opt-Out pages can be served based on user’s language and locale from device

== Release 5.1.1.12 (12-14-2016) ==
*Support for Nielsen TV Brand Effect
*Ability to set CMS parameters at a more global level
*Opt-out pages based on locale and country
*Opt-out policy based on the "Limit Ad Tracking" flag
*Collection of additional device information
*Issue a warning in client developer’s console when ad is played for more than 5 minutes
*Removed the requirement for “type” parameter
*Limit the duration reported for App launch

== Release 5.1.1.7 (9-13-2016) ==
*General bug fix and performance improvements

== Release 5.1.1.5 (7-12-2016) ==
*Includes a sample TVOS application used to assist during integration.
*Support for TVML based optout pages
*General bug fix and performance improvements

== Release 5.1.0.7 (6-15-2016) ==
*Combined SDK for DCR US and International (Germany)
*API to signal end of content (end API)
*Support for Pause timeout
*Updated API to support JSON object instead of string.
*Reporting of media URL and bundle ID
*Updated ping retry logic
*Changes in OptOut process behavioral
*Enhanced Debugging and SDK logging
*Changes to API signature