Digital Measurement Android Simplified API - Revision history

NickParrucci: /* Event Types */

2023-04-21T20:11:32Z

Event Types

← Older revision		Revision as of 20:11, 21 April 2023
Line 195:		Line 195:
	\|-		\|-
	\|'''complete'''\|\|		\|'''complete'''\|\|
	This event should be called when the session is completed, ends~~, or the user initiates a stop~~. It should also be used with DCR Static measurement when a new view event is desired even though previous static metaData had the same section parameter.		This event should be called when the session is completed/ends. It should also be used with DCR Static measurement when a new view event is desired even though previous static metaData had the same section parameter.
	\|-		\|-
	\|'''adStop'''\|\|		\|'''adStop'''\|\|

NickParrucci: /* Required Privacy Links */

2023-04-04T18:39:09Z

Required Privacy Links

← Older revision		Revision as of 18:39, 4 April 2023
Line 994:		Line 994:
	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.		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.~~
	~~<blockquote>~~
	'''"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/us/en/optout.html for more information"'''</blockquote>
	==== Webview Example ====		==== Webview Example ====
	The below code is an example of displaying the Nielsen Privacy page to the user.		The below code is an example of displaying the Nielsen Privacy page to the user.

NickParrucci: /* Event Types */

2023-03-30T21:30:30Z

Event Types

← Older revision		Revision as of 21:30, 30 March 2023
Line 195:		Line 195:
	\|-		\|-
	\|'''complete'''\|\|		\|'''complete'''\|\|
	This event should be called when the session is completed, ends, or the user initiates a stop.		This event should be called when the session is completed, ends, or the user initiates a stop. It should also be used with DCR Static measurement when a new view event is desired even though previous static metaData had the same section parameter.
	\|-		\|-
	\|'''adStop'''\|\|		\|'''adStop'''\|\|

NickParrucci: /* Privacy and Opt-Out */

2023-03-01T22:21:47Z

Privacy and Opt-Out

← Older revision		Revision as of 22:21, 1 March 2023
Line 921:		Line 921:

	== Privacy and Opt-Out ==		== Privacy and Opt-Out ==
	There are two ~~primary~~ methods for implementing user Opt-out preferences:		There are two methods for implementing user Opt-out preferences in event tracker implementations:
	# '''[[#OS-level_Opt-out\|OS-level Opt-out]]''' - managed by ''Opt out of Ads Personalization'' setting on device ('''preferred approach''').		# '''[[#OS-level_Opt-out\|OS-level Opt-out]]''' - managed by ''Opt out of Ads Personalization'' setting on device ('''preferred approach''').
	# '''[[#~~Legacy_Opt~~-out\|~~Legacy~~ Opt-out]]''' - ~~Direct call to~~ SDK; used ~~only for older versions of Nielsen Android SDK versions (< 5.1.1.18)~~		# '''[[#Event Tracker Opt-out\|Event Tracker Opt-out]]''' - Tell SDK directly of opt-out status via event tracker; used when device-level setting is not available

	=== OS-level Opt-out ===		=== OS-level Opt-out ===
Line 930:		Line 930:
	The Nielsen SDK automatically leverages the Android's ''Opt out of Ads Personalization'' setting. The user is opted out of demographic measurement if the OS-level ''"Opt out of Ads Personalization"'' ("Limit Ad Tracking" for iOS) setting is ''enabled''. As a publisher, you cannot override this setting.		The Nielsen SDK automatically leverages the Android's ''Opt out of Ads Personalization'' setting. The user is opted out of demographic measurement if the OS-level ''"Opt out of Ads Personalization"'' ("Limit Ad Tracking" for iOS) setting is ''enabled''. As a publisher, you cannot override this setting.

	=== ~~Legacy~~ Opt-out ===		=== Event Tracker Opt-out ===
	The ''~~Legacy opt~~-out'' method is ~~only necessary for Nielsen Android '''SDK versions less than 5.1.1.18'''~~.		The ''Event Tracker Opt-out'' method is used when the application cannot rely on OS-level opt-out status.

	Nielsen Android SDK 5.1.1.18 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.		Nielsen Android SDK 5.1.1.18 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 via track event call.

	==== The ~~legacy~~ opt-out method works as follows: ====		==== The Event Tracker opt-out method works as follows: ====
	* Get the current Nielsen opt-out URL via [[userOptOutURLString()]]		* Get the current Nielsen opt-out URL via [[userOptOutURLString()]]
	* Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()]]		* Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()]]
Line 941:		Line 941:
	** Opt-out if the WebView URL = <code>nielsenappsdk://1</code>		** Opt-out if the WebView URL = <code>nielsenappsdk://1</code>
	** Opt-in if the WebView URL = <code>nielsenappsdk://0</code>		** Opt-in if the WebView URL = <code>nielsenappsdk://0</code>
	* ~~Pass the detected URL to the [[userOptOut()]] function~~		*OR - in case or Amazon FireTV or where a WebView cannot be used, create an opt-out button near your App's privacy policy or Nielsen verbiage
	** Example: <syntaxhighlight lang=java>~~appSdk.userOptOut~~("nielsenappsdk://1"); // User opt-out</syntaxhighlight>		*Update out-out status as shown below
			* Example (user opted out): <syntaxhighlight lang=java>trackEvent(
			{
			"optout":"nielsenappsdk://1"
			}) // User opt-out</syntaxhighlight>
			* Example (user opted in): <syntaxhighlight lang=java>trackEvent(
			{
			"optout":"nielsenappsdk://0"
			}) // User opt-in</syntaxhighlight>

	==== ~~Legacy~~ Opt ~~Out~~ example code ====		==== Event Tracker Opt-out example code ====

			===== Opt-out can be passed with other event data=====
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	~~public class OptOutActivity extends AppCompatActivity implements IAppNotifier~~ {		trackEvent(
			{
			"event": "playhead",
			"type": "content",
			"metadata":
			{
			"content":
			{
			"type":"content",
			"assetid":"assetid1",
			"isfullepisode":"y",
			"program":"MyProgram",
			"title":"S2,E3",
			"length":"3600",
			"airdate":"2016-02-20",
			"adloadtype":"1",
			...
			}
			},
			"playheadPosition": "5",
			"optout":"nielsenappsdk://1"
			})
			</syntaxhighlight>

	~~WebView webView;~~		===== Opt-out can be passed alone in separate trackEvent call=====
	~~AppSdk appSdk;~~		<syntaxhighlight lang="java">
			trackEvent(
	~~private static final String NIELSEN_URL_OPT_OUT~~ = ~~"nielsenappsdk://1";~~		{
	~~private static final String NIELSEN_URL_OPT_IN~~ = ~~"nielsenappsdk://0";~~		"optout":"nielsenappsdk://1"
			})
	~~// Within your app you would provide your User the option to~~ Opt ~~Out.~~
	~~// Perhaps via a toggle or button~~
	~~// This is~~ separate ~~from Limit Ad Tracking~~

	~~let urlStr~~ = ~~navigationAction.request.url?.absoluteString~~

	~~if(urlStr~~ == ~~NIELSEN_URL_OPT_OUT \|\| urlStr~~ == ~~NIELSEN_URL_OPT_IN){~~
	~~let appApi~~ = ~~self.nielsenApi~~
	~~appApi?.userOptOut~~(~~urlStr)~~
	}
	</syntaxhighlight>		</syntaxhighlight>

NickParrucci: /* Required Privacy Links */

2023-02-23T19:59:12Z

Required Privacy Links

← Older revision		Revision as of 19:59, 23 February 2023
Line 974:		Line 974:
	In addition, the following text must be included in your app store description.		In addition, the following text must be included in your app store description.
	<blockquote>		<blockquote>
	'''"Please note: This app features Nielsen’s proprietary measurement software which contributes to market research, like Nielsen’s TV Ratings. Please see ~~http~~://priv-policy.imrworldwide.com/priv/mobile/us/en/optout.html for more information"'''</blockquote>		'''"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/us/en/optout.html for more information"'''</blockquote>
	==== Webview Example ====		==== Webview Example ====
	The below code is an example of displaying the Nielsen Privacy page to the user.		The below code is an example of displaying the Nielsen Privacy page to the user.

NickParrucci at 18:02, 20 October 2022

2022-10-20T18:02:42Z

← Older revision		Revision as of 18:02, 20 October 2022
Line 2:		Line 2:
	[[Category:Digital]]		[[Category:Digital]]

	~~{{Simplified_API_Overview}}~~		== Introduction ==
			This document outlines the features of the new Simplified Nielsen SDK, which is available for use within your APP or online video site, which simplifies the integration of Nielsen measurement for Digital Content Ratings or DTVR. You are only required to execute one of 4 events. Tell the SDK if you want to track 'content', an 'ad', or a 'static' page load. If an event is sent out of sequence, this new API will put it in the correct order for processing. All of the Standard SDK calls can be replaced with one API call, and one dictionary object, where any value could be another complex dictionary object.<br/>
			<b>NOTE:</b> use of simplified API is not recommended for BrowserSDK implementations at this time.

	== Prerequisites ==		== Prerequisites ==

NickParrucci at 21:15, 5 October 2022

2022-10-05T21:15:35Z

@@ Line 1,011: / Line 1,011: @@
 </syntaxhighlight>
 <br>
 == Example code ==

ColinBrown at 03:23, 6 April 2022

2022-04-06T03:23:07Z

← Older revision		Revision as of 03:23, 6 April 2022
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|~~DCR & DTVR~~}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|Simplified SDK API}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

ColinBrown at 03:15, 6 April 2022

2022-04-06T03:15:59Z

← Older revision		Revision as of 03:15, 6 April 2022
Line 2:		Line 2:
	[[Category:Digital]]		[[Category:Digital]]

	~~== Overview ==~~		{{Simplified_API_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]]), [[Digital Ad Ratings]] (DAR), [[Digital Audio]]. 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.

	~~__TOC__~~

	== Prerequisites ==		== Prerequisites ==
Line 27:		Line 21:

	''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''		''For Android, a new wrapper class for AppSdk will be introduced (AppSdkTrackEvent). This class will be responsible for handling and translating new API calls into calls of the existing Nielsen App SDK API methods. A new public API will be introduced in this class, that accepts a JSONObject parameter.''

			__TOC__

	== Implementation ==		== Implementation ==

ColinBrown at 02:58, 6 April 2022

2022-04-06T02:58:11Z

Show changes