DTVR Android SDK - Revision history

NickParrucci at 19:19, 9 June 2023

2023-06-09T19:19:11Z

← Older revision		Revision as of 19:19, 9 June 2023
Line 37:		Line 37:
	{{Android_SDK_Initialization}}		{{Android_SDK_Initialization}}

	~~==== 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 <code>@"nol_devDebug":@"INFO"</code>, 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.~~
	~~<blockquote>'''Note''': DO NOT activate the Debug flag in a production environment.</blockquote>~~

	~~==== Sample SDK Initialization Code ====~~
	~~[[AppSDK()]] is no longer a singleton object and should be initialized as below.~~

	~~'''Initialization of App SDK object through a JSON object'''~~
	~~<syntaxhighlight lang="java">try~~
	{
	~~// Prepare AppSdk configuration object (JSONObject)~~
	~~JSONObject appSdkConfig = new JSONObject()~~
	~~.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")~~
	~~.put("nol_devDebug", "DEBUG"); // only for debug builds~~

	~~// Pass appSdkConfig to the AppSdk constructor~~
	~~mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);~~
	}
	~~catch (JSONException e)~~
	{
	~~Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);~~
	}
	~~</syntaxhighlight>~~
	Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>) the App passes to the Nielsen App SDK via a JSON string. The appid is obtained from Nielsen operational support and is unique to the app.

	*The integration of Nielsen App SDK will depend on 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).
	~~<!--~~
	~~== Initializing the Nielsen AppSDK to measure the Viewability ==~~
	The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK.

	~~==== Android ====~~
	~~{\| class="wikitable"~~
	\|-
	~~! # !! Parameter Name !! Description !! Supported Values !! Example~~
	\|-
	\| 1 \|\| containerId \|\|View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. \|\|A positive integer used to identify the view. \|\| 2131558561
	\|}

	~~==== iOS ====~~
	~~{\| class="wikitable"~~
	\|-
	~~! # !! Parameter Name !! Description !! Supported Values !! Example~~
	\|-
	\| 1 \|\| containerId \|\|The tag of the UIView that represents the Player View \|\|The string value representing the NSInteger value with maximum value of NSIntegerMax that is related on 32- or 64-bit applications. \|\| "100" <br> "2131558561"
	\|}

	~~For iOS it is required to link additional frameworks that are needed for viewability engine:<br>~~
	~~<code>JavaScriptCore.framework</code> <br>~~
	~~<code>WebKit.framework</code>~~

	The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.]
	~~-->~~

	== APP SDK Error & Event Codes ==		== APP SDK Error & Event Codes ==

NickParrucci at 19:14, 9 June 2023

2023-06-09T19:14:03Z

← Older revision		Revision as of 19:14, 9 June 2023
Line 29:		Line 29:
	Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.		Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.

	~~== Implementation ==~~
	~~This guide covers implementation steps for Android Studio utilizing the Nielsen SDK for DTVR.~~

	{{Android_Implementation}}		{{Android_Implementation}}

ColinBrown at 05:54, 18 March 2022

2022-03-18T05:54:04Z

@@ Line 32: / Line 32: @@
 This guide covers implementation steps for Android Studio utilizing the Nielsen SDK for DTVR.
-{| class="wikitable"
+{{Android_Implementation}}
 __TOC__
-== Setting up your  Development Environment  ==
+{{Android_Setting_Up_Development_Envrionment}}
-The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
+{{Android_SDK_Initialization}}
 ==== Debug flag for development environment ====

ColinBrown at 21:34, 8 July 2021

2021-07-08T21:34:18Z

← Older revision		Revision as of 21:34, 8 July 2021
Line 20:		Line 20:
	! Description		! Description
	! Source		! Source
	\|-		\|-style="background-color:#d0f6f8;"
	\|\| '''App ID (appid)''' \|\| Unique ID assigned to the player/site and configured by product. \|\| Provided by Nielsen		\|\| '''App ID (appid)''' \|\| Unique ID assigned to the player/site and configured by product. \|\| Provided by Nielsen
	\|-		\|-style="background-color:#d0f6f8;"
	\|\| '''Nielsen SDK''' \|\| Includes SDK frameworks and '''sample implementation'''; ''See [[Android SDK Release Notes]]'' \|\| [[Special:Downloads\|Download]]		\|\| '''Nielsen SDK''' \|\| Includes SDK frameworks and '''sample implementation'''; ''See [[Android SDK Release Notes]]'' \|\| [[Special:Downloads\|Download]]
	\|}		\|}
Line 30:		Line 30:

	== Implementation ==		== Implementation ==
	This guide covers implementation steps for ~~Android using~~ Android Studio utilizing the ~~Standard~~ Nielsen SDK for DTVR.		This guide covers implementation steps for Android Studio utilizing the Nielsen SDK for DTVR.

			{\| class="wikitable"
			\|-
			! SDK Flavor
			! Description
			\|-
			\| '''Android Ad Version'''
			\|* Opt-In and Opt-Out functionality managed by Opt out of Ads Personlization setting on device. '''(Preferred approach)''' <br />* The Nielsen SDK will collect the [https://developer.android.com/training/articles/ad-id Google Advertising ID] unless the user Opts Out.<br>* If the Google Play Service is unavailable, (ie: Amazon and Huawei devices) the Nielsen sdk will secure the Android ID.<br> * There are 3 versions available starting with the Nielsen SDK 8.1.0.0.
			\|-
			\| '''Android No Ad Framework'''
			\|* Without the Ad Framework, the Nielsen SDK cannot read the Google Advertising ID, so will retrieve the '''AndroidID'''.<br />* The AndroidID is a 64-bit number (expressed as a hexadecimal string), unique to each combination of app-signing key, user and device.<br />* The developer is required to present the User Choice Opt Out page which is described in the [[DCR_Video_Android_SDK#User_Choice\|Privacy Section]].
			\|-
			\| '''Android SDK noID'''
			\|* This version of the Nielsen SDK is perfect for Kid apps, or where no ID is required.<br>* Please review the [https://engineeringportal.nielsen.com//docs/DCR_Video_Android_SDK#Special_Note_Regarding_Apps_in_the_Kids_Category Opt Out Requirement].
			\|}

	=== How to obtain the NielsenAppApi ===		=== How to obtain the NielsenAppApi ===
	The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of Gradle. We recommend using the Gradle-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.		The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of Gradle. We recommend using the Gradle-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
	* [[Digital_Measurement_Android_Artifactory_Guide\|Select to obtain Gradle implementation guide]]		* [[Digital_Measurement_Android_Artifactory_Guide\|Select to obtain Gradle implementation guide]]
	* [[Special:Downloads\|Select to Download Directly]]		* [[Special:Downloads\|Select to Download Directly]]
			__TOC__

	== Setting up your Development Environment ==		== Setting up your Development Environment ==

ColinBrown at 19:41, 5 October 2020

2020-10-05T19:41:58Z

@@ Line 336: / Line 336: @@
 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 ==
+{{Template:Android_Privacy_and_Opt-Out}}
 == Going Live ==

ColinBrown at 00:59, 10 September 2020

2020-09-10T00:59:58Z

← Older revision		Revision as of 00:59, 10 September 2020
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|DCR & DTVR}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|US DCR & DTVR}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

MarkTufano at 17:10, 23 June 2020

2020-06-23T17:10:21Z

Show changes

ColinBrown: /* Handling Foreground and Background states */

2019-12-10T21:21:34Z

Handling Foreground and Background states

@@ Line 306: / Line 306: @@
 == Handling Foreground and Background states ==
 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.
@@ Line 311: / Line 351: @@
 * Custom implementation of the required methods within your application.
-=== ForeGround/Background Measurement via AndroidManifest ===
+==== 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">
@@ Line 317: / Line 357: @@
 </syntaxhighlight>
-=== Using the Android SdkBgFbDetectionUtility Class ===
+==== 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.
+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 ===
+==== 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.

Admin: - Digital Audio

2019-05-14T22:15:44Z

- Digital Audio

← Older revision		Revision as of 22:15, 14 May 2019
Line 4:		Line 4:
	== Overview ==		== 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 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]]), [[Digital Ad Ratings]] (DAR)~~, and [[Digital Audio]]~~. Nielsen SDKs are also equipped to measure static content and can track key life cycle events of an application like:		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		*Application launch events and how long app was running
	*Time of viewing a sub section / page in the application.		*Time of viewing a sub section / page in the application.

AlexGutierrez at 15:46, 29 April 2019

2019-04-29T15:46:15Z

← Older revision		Revision as of 15:46, 29 April 2019
Line 24:		Line 24:
	This guide covers implementation steps for iOS using Android Studio utilizing the Standard Nielsen SDK for DTVR.		This guide covers implementation steps for iOS using Android Studio utilizing the Standard Nielsen SDK for DTVR.
	=== How to obtain the NielsenAppApi ===		=== How to obtain the NielsenAppApi ===
	The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of ~~a CocoaPod or~~ Gradle.		The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of Gradle. We recommend using the Gradle-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
			* [[Digital_Measurement_Android_Artifactory_Guide\|Select to obtain Gradle implementation guide]]
	* [[Special:Downloads\|Select to Download Directly]]		* [[Special:Downloads\|Select to Download Directly]]
	* [[Digital_Measurement_Android_Artifactory_Guide\|Select to obtain Gradle implementation guide]]

	== Setting up your Development Environment ==		== Setting up your Development Environment ==