Android SDK API Reference - Revision history

NickParrucci: /* APPSDK Kotlin/Java Interpretability */

2023-05-10T19:44:03Z

APPSDK Kotlin/Java Interpretability

@@ Line 104: / Line 104: @@
 </syntaxhighlight>
 <br/><br/>
-Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>sfcode</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.
+{{Initialization_of_App_SDK_object_through_a_JSON_object}}
 ==== Android Application Life Cycle with respect to Nielsen App SDK ====

NickParrucci: /* APPSDK Kotlin/Java Interpretability */

2023-05-08T21:23:26Z

APPSDK Kotlin/Java Interpretability

← Older revision		Revision as of 21:23, 8 May 2023
Line 113:		Line 113:
	JSONObject appSdkConfig = new JSONObject()		JSONObject appSdkConfig = new JSONObject()
	.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")		.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
	~~.put("appname", "Sample App Name")~~
	.put("sfcode", "dcr")		.put("sfcode", "dcr")
	.put("nol_devDebug", "INFO") // only for debug builds		.put("nol_devDebug", "INFO") // only for debug builds
	.put("custom_key1", "custom_value1")		.put("custom_key1", "custom_value1")
	.put("custom_key2", "custom_value2");		.put("custom_key2", "custom_value2")
			.put("uid2", "MTKVpUAzwYAPnHrtfE0wlINOMzhU7UUEjjVdCdRu63k=")
			.put("uid2_token", "AgAAAAPFR0zA5ogv/yaAPiUsAdZPsfqS8QlDSGxAB+rr8yekFs3AjLYVk5qqqiyV2XHbSuwzHmxSlLeQeKQI1mp015jsNnpX5/xGgXldcgVz+gFnyh3T8/3agMwRmyrhCxG4oH2C7fc48AQk2eotE7FW0ZDEYM8fD9ZxDaxFUC/OV3OuZA==")
			.put("hem_sha256", "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=")
			.put("hem_sha1", "")
			.put("hem_md5", "");
	// Pass appSdkConfig to the AppSdk constructor		// Pass appSdkConfig to the AppSdk constructor
	mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);		mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
Line 127:		Line 131:
	</syntaxhighlight>		</syntaxhighlight>

	Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid~~</code>, <code>appname~~</code>, <code>sfcode</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.		Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</code>, <code>sfcode</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.

	==== Android Application Life Cycle with respect to Nielsen App SDK ====		==== Android Application Life Cycle with respect to Nielsen App SDK ====

NickParrucci: /* Nielsen Measurement Opt-Out */

2023-04-04T18:32:13Z

Nielsen Measurement Opt-Out

← Older revision		Revision as of 18:32, 4 April 2023
Line 619:		Line 619:
	* 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.		* 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>		<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>

	~~In the Description of the app in Google Play Store, include a short description about Nielsen measurement, as below.~~

	~~<blockquote>'''Sample Google Play Store Disclosure'''~~
	~~This app features Nielsen proprietary measurement software which will allow you to contribute to market research, like Nielsen’s TV Ratings.~~

	~~To learn more about our digital measurement products and your choices in regard to them, please visit https://www.nielsen.com/digitalprivacy for more information.</blockquote>~~

	== Event and Error Handling ==		== Event and Error Handling ==

NickParrucci: /* Nielsen Privacy Requirements */

2023-04-04T18:31:32Z

Nielsen Privacy Requirements

← Older revision		Revision as of 18:31, 4 April 2023
Line 519:		Line 519:
	== Nielsen Privacy Requirements ==		== Nielsen Privacy Requirements ==
	Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.		Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
	*Disclosure of viewership data collection in app store description
	*Disclosure of viewership data collection in EULA / Privacy Policy		*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		*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

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

2023-03-30T21:18:11Z

Android SDK API Methods & Properties

← Older revision		Revision as of 21:18, 30 March 2023
Line 358:		Line 358:
	\|-		\|-
	\| 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 \|\| [[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).		\| 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).

NickParrucci: /* Viewability testing */

2022-10-05T20:26:38Z

Viewability testing

← Older revision		Revision as of 20:26, 5 October 2022
Line 513:		Line 513:
	*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.		*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.		*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]]		[[File:PlayerView Zoomin.png\|200px]]    [[File:PlayerView AlertView.png\|200px]]    [[File:PlayerView Dragging.png\|200px]]    [[File:PlayerView FriendlyViews.png\|200px]]

	== Nielsen Privacy Requirements ==		== Nielsen Privacy Requirements ==

NickParrucci at 20:23, 5 October 2022

2022-10-05T20:23:11Z

@@ Line 94: / Line 94: @@
 [[AppSDK()]] is no longer a singleton object and should be initialized as below.
 '''Initialization of App SDK object through a JSON object'''
 <syntaxhighlight lang="objective-c">
@@ Line 156: / Line 166: @@
 |-
 | Google ExoPlayer || Android 4.1 ||
 |-
 | Adobe PrimeTime Player || Android 4.2 ||
@@ Line 383: / Line 391: @@
 |-
 | Log || [[setDebug()]] || ✘ || ✘ || ✘ || ✔ || Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
 |}
@@ Line 496: / Line 508: @@
 == Nielsen Sample Applications ==
 == Nielsen Privacy Requirements ==
@@ Line 672: / Line 690: @@
 | 1022 || ERROR_FAILED_PROCESS_STOP || App SDK failed processing stop ||
 |}

ColinBrown: /* ID3 Support Matrix */

2019-12-13T21:48:13Z

ID3 Support Matrix

← Older revision		Revision as of 21:48, 13 December 2019
Line 156:		Line 156:
	\|-		\|-
	\| Google ExoPlayer \|\| Android 4.1 \|\|		\| Google ExoPlayer \|\| Android 4.1 \|\|
			\|-
			\| Akamai AMP Player \|\| Android 4.4 \|\| Nielsen DCR Integration https://developer.akamai.com/tools/AdaptiveMediaPlayer/docs/android/amp-analytics-nielsen-dcr/ <br>ID3 Tags Support: https://developer.akamai.com/tools/AdaptiveMediaPlayer/docs/android/amp-id3-tags/
	\|-		\|-
	\| Adobe PrimeTime Player \|\| Android 4.2 \|\|		\| Adobe PrimeTime Player \|\| Android 4.2 \|\|

Admin: -Digital Audio

2019-05-29T23:56:20Z

-Digital Audio

Admin at 23:53, 29 May 2019

2019-05-29T23:53:32Z

← Older revision		Revision as of 23:53, 29 May 2019
Line 132:		Line 132:
	*Call [[stop()]] when ending or pausing a viewing session.		*Call [[stop()]] when ending or pausing a viewing session.
	*During session playback, call the SDK [[setPlayheadPosition()]] and / or [[sendID3()]]		*During session playback, call the SDK [[setPlayheadPosition()]] and / or [[sendID3()]]
	**Call [[setPlayheadPosition()]] every one second until the stream is stopped or paused~~. Normally this happens on Digital Audio measurements~~.		**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.		**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.		Nielsen App SDK object handles filtering of ID3 tags and CMS tags, queuing/buffering of data, and all communications with Nielsen collection facility.
Line 138:		Line 138:
	*If streaming live video content, the client must pass the current Unix timestamp (seconds since Jan-1-1970 UTC) as playhead position.		*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.		*If streaming VOD (video on demand), the client must stream the offset from the beginning of the file as playhead position.
	*For all Digital Audio listening, the client must pass the current Unix timestamp (seconds since Jan-1-1970 UTC) as playhead position, regardless of station type.

	== Retrieving ID3 Tags ==		== Retrieving ID3 Tags ==

← Older revision		Revision as of 23:56, 29 May 2019
Line 333:		Line 333:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	\|-		\|-
	! Scenario !! Method / Property !! DTVR !! DAR ~~!! Digital Audio~~ !! DCR !! International (Germany) !! Description		! Scenario !! Method / Property !! DTVR !! DAR !! DCR !! International (Germany) !! Description
	\|-		\|-
	\| Initialize \|\| [[AppSDK()]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to create a new instance of the SDK object		\| 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 \|\| [[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 \|\| [[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 \|\| [[sendID3()]] \|\| ✔ \|\| ✘ \|\| ✘ \|\| ✘ \|\| Used to send the ID3 metadata.
	\|-		\|-
	\| Measurement \|\| [[setPlayheadPosition()]] \|\| ✘ \|\| ✘ ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| Used to send the playhead position.		\| 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 \|\| [[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 \|\| [[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 \|\| [[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).		\| 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 \|\| [[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 \|\| [[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 \|\| [[getOptOutStatus()]] \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✔ \|\| Call this API to retrieve the Opt-Out or Opt-In state.
	\|-		\|-
	\| Opt-out		\| Opt-out
	\| [[appDisableApi()]]		\| [[appDisableApi()]]
	(kill switch)		(kill switch)
	~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to disable the SDK.		\|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to disable the SDK.
	\|-		\|-
	\| Opt-out \|\| [[getAppDisable()]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to query if the SDK is disabled or not.		\| 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 \|\| [[getLastEvent()]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to query the SDK for the last status
	\|-		\|-
	\| Log \|\| [[getLastError()]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to query the SDK for the last error		\| 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 \|\| [[isValid()]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to check if the SDK was successfully instantiated or not.
	\|-		\|-
	\| Log \|\| [[getMeterVersion()]] ~~\|\| ✘~~ \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✔ \|\| Returns the current SDK version.		\| Log \|\| [[getMeterVersion()]] \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✔ \|\| Returns the current SDK version.
	\|-		\|-
	\| Log \|\| [[getNielsenId()]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to get a string defining the Nielsen ID (NUID) number for the device.		\| Log \|\| [[getNielsenId()]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to get a string defining the Nielsen ID (NUID) number for the device.
	\|-		\|-
	\| Log \|\| [[getDeviceId()]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns the current device id.		\| Log \|\| [[getDeviceId()]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns the current device id.
	\|-		\|-
	\| Log \|\| [[appInBackground()]] ~~\|\| ✘~~ \|\| ✘ \|\| ✘ \|\| ✔ \|\| ✔ \|\| Used to capture the event of app going to background.		\| 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 \|\| [[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)		\| Log \|\| [[setDebug()]] \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✔ \|\| Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
	\|}		\|}