DCR Poland Video iOS SDK: Difference between revisions
From Engineering Client Portal
WilsonQuispe (talk | contribs) |
WilsonQuispe (talk | contribs) |
||
| Line 55: | Line 55: | ||
* [[ Nielsen Digital Measurement and_iOS17 or TVOS17 |Nielsen Digital Measurement and_iOS17 or TVOS17]] | * [[ Nielsen Digital Measurement and_iOS17 or TVOS17 |Nielsen Digital Measurement and_iOS17 or TVOS17]] | ||
Do not declare the Nielsen '''imrworldwide.com''' domain in the privacy manifest. | |||
== Setting up your Development Environment == | == Setting up your Development Environment == | ||
Revision as of 12:56, 13 September 2023
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:
| 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 | 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.
Implementation
This guide covers implementation steps for iOS using Xcode utilizing the Standard Nielsen SDK for DCR.
How to obtain the NielsenAppApi.Framework
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
- Select to obtain CocoaPods implementation guide
- Select to Download Directly
- Using the XCFramework bundle
Special Notes regarding iOS14
Permission to Track
Apple recently released a new policy on consent requirements, that require the user's permission, to track them using their device's advertising identifier (IDFA). To request the user's permission, use the AppTrackingTransparency framework.
For more information, see:
More detailed information on how the Nielsen SDK versions work with the AppTrackingTransparency framework is located on our DCR Video iOS14 Migration page.
Special Notes regarding iOS17
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:
Do not declare the Nielsen imrworldwide.com domain in the privacy manifest.
Setting up your Development Environment
Prior to SDK Version 6.2.0.0 the IOS framework has been distributed as a static library packaged into framework bundle format. Apple recommends to use dynamic framework, it has some benefits over static libraries like less executable file size of an app, faster startup time and native support in xCode IDE. Nielsen AppSDK has been transformed into dynamic framework in this release (static framework is still available).
If migrating from the static library to this new dynamic framework, once implemented, unless your specific application requires, you can remove the following Frameworks that were once required: [AdSupport, JavascriptCore, SystemConfiguration, Security, AVFoundation, libc++]
The Dynamic framework is created as a fat framework. It means that it contains slices required for devices (armv7, arm64) as well as slices required for simulators (i386, x86_64). Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. The example of the shell script that should be added as a Run Script phase in the application can be found below.
XCFramework is solution for the problems described above Apple recommends to use XCFrameworks. In XCFramework, we no longer build a single framework with multiple architectures. Instead, we build one small framework for each combination of architecture and target and store it in its own folder. The top-level XCFramework folder have folders like ios-arm64, ios-arm64-simulator, etc. Each of these folders is its own framework, complete with headers, modules, and binary.
Configuring Xcode Development Environment
Starting with SDK version 6.0.0.0, the Nielsen App SDK is compatible with Apple iOS versions 8.0 and above. In addition, when using the dynamic framework, all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore
Note: All communications between the SDK and the Census (Collection Facility) use HTTPS.
Special Note for Static Framework
Starting from 8.2.0.0 release framework is build from the mixed (swift + objc) source code. If static (xc)framework is integrated additional settings should be applied to fix build or runtime issues.
Download Framework
The first step is to download and copy the NielsenAppApi.framework bundle to the app project directory. (Not required if using CocaPods)
Add Framework
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (Not required if using CocaPods)
Add Path
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (Not required if using CocaPods)
Import Framework
Add NielsenAppApi.framework module in the source file of your app:
Using Swift
Add the following:
import NielsenAppApi
Using Objective-C
@import NielsenAppApi;
xCode 12 building errors
Developers who uses "fat" framework in their apps started reporting the following error that they get building the app in xCode 12.3+:
Building for iOS Simulator, but the linked and embedded framework 'MyFramework.framework' was built for iOS + iOS Simulator.
The binary framework contains different code for the same architecture in multiple places, and Xcode doesn’t know how to handle it. There is workaround that people recommend to use in such cases:
- https://stackoverflow.com/questions/63267897/building-for-ios-simulator-but-the-linked-framework-framework-was-built
- https://stackoverflow.com/questions/63932158/xcode12-issus-ld-building-for-ios-simulator-but-linking-in-object-file-built
IPA processing failure
Assertion failed: Expected 4 archs in otool output:
The error above is due to the "fat" (simulator+device) framework which will not appear if you have not enabled Bitcode. To build your app with full Bitcode support, it is recommended that you use a XCFramework to avoid the 4 archs in otool output message.
SDK Initialization
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issue. The sharedInstance API that creates a singleton object was deprecated prior to version 5.1.1. (Click here for an example of multiple instances)
The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
- The appid is provided by the Nielsen Technical Account Manager (TAM). The appid is a GUID data type and is specific to the application.
| Parameter / Argument | Description | Source | Required? | Example |
|---|---|---|---|---|
| appid | Unique id for the application assigned by Nielsen. It is GUID data type. | Nielsen-specified | Yes | PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
| appname | Name of the application | Client-defined | Optional; automatically detected in SDK 6.0.0.4 and above | Nielsen Sample App |
| sfcode | Nielsen collection facility to which the SDK should connect.
|
Nielsen-specified | Yes | pl |
| nol_devDebug | Enables Nielsen console logging. Only required for testing | Nielsen-specified | Optional | "DEBUG" |
Debug flag for development environment
Player application developers / integrators can use Debug flag to check whether an App SDK API call made is successful. To activate the Debug flag,
Pass the argument @"nol_devDebug":@"INFO", in the JSON string . The permitted values are:
- INFO: Displays the API calls and the input data from the application (validate player name, app ID, etc.). It can be used as certification Aid.
- WARN: Indicates potential integration / configuration errors or SDK issues.
- ERROR: Indicates important integration errors or non-recoverable SDK issues.
- DEBUG: Debug logs, used by the developers to debug more complex issues.
Once the flag is active, it logs each API call made and the data passed. The log created by this flag is minimal.
Note: DO NOT activate the Debug flag in a production environment.
Sample SDK Initialization Code
Swift
Swift 4.0 Example:
NielsenInit.swift
import Foundation
import NielsenAppApi
class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "pl",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
Sample code using AVPlayer.
ViewController.swift
class ViewController: UIViewController, NielsenAppApiDelegate, AVPlayerViewControllerDelegate {
// your code//
override func viewDidLoad() {
super.viewDidLoad()
//Getting the instance of NielsenApi
self.nielsenApi = NielsenInit.createNielsenApi(delegate: self)
}
}
Objective C
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenAppApi.h>
@implementation NielsenInit
+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate
{
NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"sfcode": @"pl",
@"nol_devDebug": @"DEBUG", };
return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}
@end
The following would be the NielsenInit.h file:
#import <Foundation/Foundation.h>
@class NielsenAppApi;
@protocol NielsenAppApiDelegate;
@interface NielsenInit : NSObject
+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;
@end
Sample Code:
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
//Getting the instance of Nielsen SDK
nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];
APP SDK Error & Event Codes
To view the Error and Event codes for iOS and Android, please review the App SDK Event Code Reference page.
Configure Payload
Handling JSON Metadata
All the SDK methods 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.
Swift
let channelInfo = [
"channelName": "My Channel Name 1",
];
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
];
Objective C
NSDictionary * channelInfo = @ {
@ "channelName": @ "My Channel Name 1",
}
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
}
ChannelName metadata
channelName should remain constant throughout the completion of an episode or live stream.
| Key | Description | Values | Required |
|---|---|---|---|
| channelName | ChannelInfo refers to the Channel name. This can be a free-form value
value such as a friendly name for the content being played. the SDK |
custom | No |
Content Metadata
Content metadata should remain constant throughout the entirety of an episode / clip including when ads play.
| Key | Description | Values | Required |
|---|---|---|---|
| type | type of asset | "content" | ✓ |
| assetid | unique ID assigned to asset (max 64 characters; only characters 0-9, a-z, A-Z underscore and minus are allowed - no special characters or vowel mutations) | custom (no Special Characters) | ✓ |
| program | (string) name of program (max 254 characters) | custom | ✓ |
| title | (string) episode title (max 254 characters) | custom - no backslash allowed in string (because of 3rd party data processing) | ✓ |
| length | (int) length of content in seconds | 86400 seconds for live stream. For Event-Livestreams planned length. For VoD video length | ✓ |
| airdate | The airdate in the linear TV. Original (local) air date and time (hh:mm:ss as 24h time stamp); if not known set it to eg. "19700101 00:00:00" | YYYY-MM-DDTHH:MI:SS YYYY-MM-DDHH:MI:SS (pass beginning of epoch if unknown) |
✓ |
| isfullepisode | full episode flag | "y"- full episode, "n"- non full episode | ✓ |
| adloadtype | type of ad load:
|
"2" - DCR measures content with dynamic ads |
✓ |
| progen | program genre | custom | |
| segB | custom segment | custom | |
| segC | custom segment | custom | |
| crossId1 | standard episode ID | custom | |
| clientid |
parent ID – value is automatically populated through provided AppID. |
provided by Nielsen |
|
| subbrand | vcid/sub-brand ID – value is automatically populated through provided AppID. In order to override the sub-brand configured to the AppID, value can |
provided by Nielsen |
Ad Metadata
The ad metadata (if applicable) should be passed for each individual ad, if ads are available during or before the stream begins.
| Keys | Description | Values | Required |
|---|---|---|---|
| type | type of ad | 'preroll', 'midroll', 'postroll' |
✓ |
| assetid | unique ID assigned to ad | custom (no Special Characters) |
✓ |
Example Ad Object
Swift
let adMetadata = [
"type": "preroll",
"assetid": "123456"
];
Objective C
NSDictionary * adMetadata = @ {
@ "type": @ "preroll",
@ "assetid": @ "AD-ID123"
}
Nielsen API Documentation
play
Use play to pass the channel descriptor information through channelName parameter when the user taps the Play button on the player. Pass in channelName metadata as described above.
Swift
nielsenApi?.play(channelInfo);
Objective C
[nielsenApi play:([NSDictionary *channel loadChannelInfo)];
loadMetadata
Call to inform SDK about asset being played. Pass in metadata as described here #Configure Payload, #Content Metadata
Swift
nielsenApi?.loadMetadata(contentMetadata)
Objective C
[nielsenApi loadMetadata:(contentMetadata)];
playheadPosition
Call to inform Nielsen SDK about position in video asset (for VOD pass second within video, for livestreams UTC timestamp in seconds).
Swift
nielsenApi?.playheadPosition(secondsAsInt)
Objective C
[nielsenApi playheadPosition:secondsAsInt];
stop
Call to indicate interruption during playback, e.g. pause. (more on interruption scenarios here: #Interruptions during playback )
Swift
nielsenApi?.stop()
Objective C
[nielsenApi stop];
end
Call when content finished playback and content cannot be resumed from the same position (it can only be restarted from the beginning of stream).
Swift
nielsenApi?.end()
Objective C
[nielsenApi end];
Call Nielsen APIs
Sample API Sequence
A Sample API sequence could follow this flow:
| Type | Sample code | Description |
|---|---|---|
| On App Start | nielsenApi = NielsenInit.createNielsenApi(delegate: self);
data = loadStaticMetadata();
nielsenApi.loadMetadata(self.data);
|
// Pass Static Metadata here if applicable |
| Start of stream | nielsenApi.play(channelName) |
// channelName now automatically generated by Nielsen SDK |
nielsenApi.loadMetadata(contentMetadata) |
// MetadataObject contains the JSON metadata for the content being played | |
| Content | nielsenApi.playheadPosition(pos); |
// playheadPosition is position of the playhead while the content is being played |
| End of Stream | nielsenApi.end() |
// Content playback is completed. |
Life cycle of SDK instance
Life cycle of SDK instance includes four general states:
- Initial state – The SDK is not initialized and hence, not ready to process playing information. Once the SDK is moved out of this state, it needs instantiation of the new SDK instance in order to get the instance in the 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
playandloadMetadatacalls move the SDK instance into this state. In this state, the SDK instance will be able to process the following calls.playheadPosition– Call this API every one second when playhead position is active. If a LIVE event, use the current UNIX timestamp (seconds since Jan-1-1970 UTC).stop– Call this API when the playback is paused, switches between content and ad (within the same content playback) or encounters interruptions.end– SDK instance exits from Processing state when this API is called.
- Disabled state – The SDK instance is disabled and is not processing playing information.
appDisableApiis set totrue
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
play,loadMetadataandplayheadPosition
API Call Sequence
Use Case 1: Content has no Advertisements
Call play() with channelName JSON as below.
{
"channelName": "TheMovieTitle"
}
Call loadMetadata() with JSON metadata for content as below.
{
"type": "content",
"assetid": "vid345-67483",
"program": "ProgramName",
"title": "Program S3, EP1",
"length": "3600",
...
}
Call playheadPosition() every one second until a pause / stop. Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.
| Type | Sample code | Description |
|---|---|---|
| Start of stream | nielsenApi.play(channelName); |
// channelName now automatically generated by Nielsen SDK |
nielsenApi.loadMetadata(contentMetaDataObject); |
// contentMetadataObject contains the JSON metadata for the content being played | |
| Content | nielsenApi.playheadPosition(playheadPosition); |
// position is position of the playhead while the content is being played |
| End of Stream | nielsenApi.end(); |
// Content playback is completed. |
Use Case 2: Content has Advertisements
Call play() with channelName JSON as below.
{
"channelName": "TheMovieTitle"
}
Call loadMetadata() with JSON metadata for ad as below.
{
"type": "preroll",
"assetid": "ad=123"
}
Note: In case the individual ad details are not available, send ad pod (presence) details through the loadMetadata and playhead position through playheadPosition.
Call playheadPosition() every one second until a pause / stop / another loadMetadata() is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of loadMetadata().
The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.
| Type | Sample code | Description |
|---|---|---|
| Start of stream | nielsenApi.play(channelName); |
// channelName now automatically generated by Nielsen SDK |
nielsenApi.loadMetadata(contentMetaDataObject); |
// contentMetadataObject contains the JSON metadata for the content being played | |
| Preroll | nielsenApi.loadMetadata(prerollMetadataObject); |
// prerollMetadataObject contains the JSON metadata for the preroll ad |
nielsenApi.playheadPosition(playheadPosition); |
// position is position of the playhead while the preroll ad is being played | |
nielsenApi.stop(); |
// Call stop after preroll occurs | |
| Content | nielsenApi.loadMetadata(contentMetaDataObject); |
// contentMetadataObject contains the JSON metadata for the content being played |
nielsenApi.playheadPosition(playheadPosition); |
// position is position of the playhead while the content is being played | |
nielsenApi.stop(); |
// Call stop after the content is paused (ad starts) | |
| Midroll | nielsenApi.loadMetadata(midrollMetaDataObject); |
// midrollMetadataObject contains the JSON metadata for the midroll ad |
nielsenApi.playheadPosition(playheadPosition); |
// position is position of the playhead while the midroll ad is being played | |
nielsenApi.stop(); |
// App moves to background(midroll pauses) | |
nielsenApi.loadMetadata(midrollMetaDataObject); |
// App moves to foreground (midroll resumes) | |
nielsenApi.playheadPosition(playheadPosition); |
// playheadPosition is position of the playhead while the midroll ad is being played | |
nielsenApi.stop(); |
// Call stop after midroll occurs | |
| Content (End of stream) | nielsenApi.loadMetadata(contentMetaDataObject); |
// contentMetadataObject contains the JSON metadata for the content being played |
nielsenApi.playheadPosition(playheadPosition); |
// position is position of the playhead while the content is being played | |
nielsenApi.stop(); |
// Always call stop irrespective of postroll is followed or not | |
| End of Stream | nielsenApi.end(); |
// Call end() at the end of content |
| Postroll | nielsenApi.loadMetadata(postrollMetaDataObject); |
// postrollMetadataObject contains the JSON metadata for the postroll ad |
nielsenApi.playheadPosition(playheadPosition); |
// position is position of the playhead while the postroll ad is being played | |
nielsenApi.stop(); |
// Call stop after postroll occurs |
Note: Each Ad playhead should 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.
Handling Foreground and Background states
For iOS, background/foreground detection is handled by the app lifecylce APIs which are provided by Apple:
Foreground/Background state measurement is a requirement of Nielsen AppSDK implementation which is especially crucial for static measurement.
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 (Video players only, not for Audio players)
- App going in the Background/Foreground (Video players only, not for Audio players)
- Channel / Station Change Scenario
- Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
- Call stop immediately and withhold sending playhead position.
- Start sending API calls –
'loadMetadata'and'playheadPosition'for the new viewing session, once the playback resumes.
Please see the 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.
Privacy and Opt-Out
There are three primary methods for implementing user Opt-out preferences:
- OS-level Opt-out - managed by Limit Ad Tracking setting on device (preferred approach).
- Legacy Opt-out - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)
- App Level Opt-Out - Where Ad Framework cannot be leveraged
OS-level Opt-out
OS-level Opt-out method available on Nielsen iOS SDK Versions 5.1.1.18 and above.
The Nielsen SDK automatically leverages the iOS's Limit Ad Tracking setting. The user is opted out of demographic measurement if the OS-level "Limit Ad Tracking" setting is enabled. As a publisher, you cannot override this setting.
Legacy Opt-out
The Legacy opt-out method is only necessary for Nielsen iOS SDK versions less than 5.1.1.18.
Nielsen iOS SDK 5.1.1.17 and above will check for OS-level opt-out first, if available. The user will be opted out if indicated at the OS-level OR the App-level.
The legacy opt-out method works as follows:
- Get the legacy Nielsen opt-out URL via optOutURL
- Display a WebView element whose loadUrl is set to the value obtained from optOutURL
- Detect if the WebView URL changes to a special URL that indicates Opt-in, or Opt-out and close the WebView
- Opt-out if the WebView URL =
nielsenappsdk://1 - Opt-in if the WebView URL =
nielsenappsdk://0
- Opt-out if the WebView URL =
- Pass the detected URL to the userOptOut function
- Example:
NielsenAppApi?.userOptOut("nielsenappsdk://1"); // User opt-out
- Example:
Legacy Opt-out example code
Swift
var webView: WKWebView!
var NIELSEN_URL_OPT_OUT : String = "nielsenappsdk://1"
var NIELSEN_URL_OPT_IN : String = "nielsenappsdk://0"
func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) {
let urlStr = navigationAction.request.url?.absoluteString
if(urlStr == NIELSEN_URL_OPT_OUT || urlStr == NIELSEN_URL_OPT_IN){
let appApi = self.nielsenApi
appApi?.userOptOut(urlStr)
decisionHandler(.allow)
}else{
decisionHandler(.cancel)
}
}
Objective C
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
NSURLRequest *request = [navigationAction request];
NSString *url = [[request URL]absoluteString];
if([url isEqualToString:self.NIELSEN_URL_OPT_OUT] || [url isEqualToString:self.NIELSEN_URL_OPT_IN]){
[self.nielsenApi userOptOut:url];
decisionHandler(WKNavigationActionPolicyAllow);
}else{
decisionHandler(WKNavigationActionPolicyCancel);
}
}
Retrieve current Opt-Out preference
Whether the user is opted out via OS-level Opt-out or via App-level Opt-out, the current Opt-Out status as detected by the SDK is available via the optOutStatus property in the Nielsen SDK API
First Party ID (FPID)
- The broadcaster must enableFPID in the initialization settings which is set to true or false depending on user consent. This is to be set by the broadcaster when initializing our SDK.
- The enableFpid flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is true. If this flag is changed from true to false, then the AppSDK should wipe out the stored FPID and use a blank value for the FPID parameter in all the pings.
- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.
- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated.
- Example: disable FPID during init call
class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{
let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "pl", // sfcode for Poland
"enableFpid": "false" //false = FPID is disabled, true= FPID is enabled
"nol_devDebug": "DEBUG" // only for debug builds and see the Nielsen logs
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
Required Privacy Links
Users must either have access to the "About Nielsen Measurement" page, or have similar text available within the native app. Include "About Nielsen Measurement" and "Your Choices" link in the Privacy Policy / EULA or as a button near the link to the app's Privacy Policy.
In addition, the following text must be included in your app store description.
"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see https://priv-policy.imrworldwide.com/priv/mobile/pl/pl/optout.html for more information"
Webview Example
The below code is an example of displaying the Nielsen Privacy page to the user.
Swift
import UIKit
import WebKit
import NielsenAppApi
class OptOutVC: UIViewController, NielsenAppApiDelegate, WKNavigationDelegate {
var webView: WKWebView!
var nielsenApi: NielsenAppApi!
override func loadView() {
webView = WKWebView()
webView.navigationDelegate = self
view = webView
}
override func viewDidLoad() {
super.viewDidLoad()
self.view.backgroundColor = UIColor(patternImage: UIImage(named: "new_ios_bg.png")!)
self.nielsenApi = NielsenInit.createNielsenApi(delegate: self)
if let appApi = self.nielsenApi {
//Getting the optPut URL from SDK
if let url = URL(string: appApi.optOutURL) {
webView.load(URLRequest(url: url))
webView.allowsBackForwardNavigationGestures = true
}
}
}
}
Objective C
- (void)viewDidLoad {
[super viewDidLoad];
//Setting background image
UIImage *backgroundImage = [UIImage imageNamed:@"new_ios_bg.png"];
UIImageView *backgroundImageView=[[UIImageView alloc]initWithFrame:self.view.frame];
backgroundImageView.image=backgroundImage;
[self.view insertSubview:backgroundImageView atIndex:0];
self.nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];
//Initialising the webview
WKWebViewConfiguration *theConfiguration = [[WKWebViewConfiguration alloc] init];
_wkwebView = [[WKWebView alloc] initWithFrame:self.view.frame configuration:theConfiguration];
_wkwebView.navigationDelegate = self;
//Getting the optPut URL from SDK
NSURL *nsurl=[NSURL URLWithString:[self.nielsenApi optOutURL]];
//Setting url request in webview
NSURLRequest *nsrequest=[NSURLRequest requestWithURL:nsurl];
//Setting url request in webview
[_wkwebView loadRequest:nsrequest];
//Adding webview to the controller view
[self.view addSubview:_wkwebView];
}
App Level Opt Out
This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
- Implement the UIWebView delegate method to open the Nielsen Privacy web page
- Capture user's selection
- Pass the selection back to the SDK via the
userOptOut.
Capture and forward user selection
Swift
func webView(webView: UIWebView, shouldStartLoadWithRequest request: NSURLRequest, navigationType: UIWebViewNavigationType) -> Bool {
let command = request.url?.absoluteString
if command == "kNielsenWebClose"{
self.perform(#selector(closeOptOutView), with: nil, afterDelay: 0)
return false
}
return NielsenAppApi.optOutURL
}
- The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes
userOptOutwith user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.[nAppApiObject userOptOut:command]passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
Note: When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.
Objective C
-(BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
{
NSString *command = [NSString stringWithFormat:@"%@",request.URL];
if ([command isEqualToString:kNielsenWebClose]) {
// Close the WebView
[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
return NO;
}
// Retrieve next URL if it’s not opt-in/out selection
return (![nAppApiObject userOptOut:command]);
}
- The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes
userOptOutwith user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.[nAppApiObject userOptOut:command]passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
Note: When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.
AirPlay
To implement OTT measurement, report OTT changes to the SDK using public API interface: updateOTT
In order to detect AirPlay and mirroring changes we use AVAudioSessionPortDescription properties that are different on different iOS versions. We found that on iOS versions 8 - 10 AVAudioSessionPortDescription has the following values:
AirPlay: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-airplay
Mirroring: type = AirPlay; name = Apple TV 4K; UID = DC:56:E7:53:72:85-screen
For iOS 11+ some parameters like name and UID have different values:
AirPlay: type = AirPlay; name = AirPlay; UID = 0eb63aae-5915-45f1-b0f7-0102a0e50d53
Mirroring: type = AirPlay; name = Apple TV 4K; UID = 4335E8A9-1C0A-4251-9000-28CA5FA2F3CF-192731714653291-screen
The following code snipped is suggested for AirPlay / mirroring detection on iOS devices.
Swift
nielsenSdk.updateOTT(currentStatus)
Subscribe to AVAudioSessionRouteChangeNotification
NotificationCenter.default.addObserver(self, selector: #selector(handleRouteChanged(_:)), name: NSNotification.Name.AVAudioSessionRouteChange, object: nil)
Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:
func handleRouteChanged(_ notification: Notification) {
var currentStatus: [String: String] = ["ottStatus": "0"]
let session = AVAudioSession.sharedInstance()
let currentRoute = session.currentRoute
for outputPort in currentRoute.outputs {
if outputPort.portType == AVAudioSessionPortAirPlay {
currentStatus["ottStatus"] = "1"
currentStatus["ottDeviceModel"] = outputPort.portName
currentStatus["ottDeviceID"] = outputPort.uid
if outputPort.portName == "AirPlay" {
currentStatus["ottDevice"] = "airplay"
currentStatus["ottType"] = "airplay"
}
else {
if outputPort.portName.contains("Apple TV") {
currentStatus["ottDevice"] = "appleTV"
}
else {
currentStatus["ottDevice"] = "other"
}
if outputPort.uid.hasSuffix("airplay") {
currentStatus["ottType"] = "airplay"
}
else if outputPort.uid.hasSuffix("screen") {
currentStatus["ottType"] = "mirroring"
}
else {
currentStatus["ottType"] = "other"
}
}
}
}
// report OTT status update to Nielsen SDK
self.reportOTTUpdate(currentStatus)
}
Report OTT update to the Nielsen SDK
func reportOTTUpdate(_ ottDict: [String: String]) {
if let nielsenSdk = self.nielsenAppApi {
nielsenSdk.updateOTT(currentStatus)
}
}
Objective C
– (void)updateOTT:(id)ottInfo;
Subscribe to AVAudioSessionRouteChangeNotification
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleRouteChanged:) name:AVAudioSessionRouteChangeNotification object:nil];
Handle AVAudioSessionRouteChangeNotification and prepare OTT dictionary:
- (void)handleRouteChanged:(NSNotification *)notification
{
NSMutableDictionary *ottDict = [NSMutableDictionary dictionaryWithDictionary: @{@"ottStatus": @"0"}];
AVAudioSession *audioSession = [AVAudioSession sharedInstance];
AVAudioSessionRouteDescription *currentRoute = audioSession.currentRoute;
for (AVAudioSessionPortDescription *outputPort in currentRoute.outputs) {
if ([outputPort.portType isEqualToString:AVAudioSessionPortAirPlay]) {
ottDict[@"ottStatus"] = @"1";
ottDict[@"ottDeviceModel"] = outputPort.portName;
ottDict[@"ottDeviceID"] = outputPort.UID;
if ([outputPort.portName isEqualToString:@"AirPlay"]) {
ottDict[@"ottDevice"] = @"airplay";
ottDict[@"ottType"] = @"airplay";
}
else {
if ([outputPort.portName containsString:@"Apple TV"]) {
ottDict[@"ottDevice"] = @"appleTV";
}
else {
ottDict[@"ottDevice"] = @"other";
}
if ([outputPort.UID hasSuffix:@"airplay"]) {
ottDict[@"ottType"] = @"airplay";
}
else if ([outputPort.UID hasSuffix:@"screen"]) {
ottDict[@"ottType"] = @"mirroring";
}
else {
ottDict[@"ottType"] = @"other";
}
}
}
}
// report OTT status update to Nielsen SDK
[self reportOTTWithDict:ottDict];
}
Report OTT update to the Nielsen SDK
- (void)reportOTTWithDict:(NSDictionary *)ottDict
{
[self.nielsenSDK updateOTT:ottDict];
}
Going Live
Following Nielsen testing, users need to make one update to the initialization call to ensure that the site is being measured properly.
- Debug Logging: Disable logging by deleting
{nol_sdkDebug: 'DEBUG'}from initialization call.
Note: before going live you have to inform Nielsen team - this is necessary, because Nielsen team has to adjust internal configuration parameter to enable data collection. Without that notification no data will be collected and no data will be reported.
Removing Simulators (Dynamic Framework Only)
Simulator slices are needed to let clients build and debug their app on the simulators, but they should be removed before sending the app to the AppStore. Here is an example Shell script that could be added as a Run Script phase in the application.
APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"
EXTRACTED_ARCHS=()
for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done
echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"
echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"
done
Sample Applications
The below sample applications have been designed to show the Simplified API's functionality and are broken into two distinct categories:
- Basic - To show the functionality of the Nielsen Simplified API using a standard no-frills player.
- Advanced - Nielsen Simplified API integrated into a custom video player.