DCR Poland Video Android SDK - Revision history

WilsonQuispe: /* First Party ID (FPID) */

2023-05-27T11:06:52Z

First Party ID (FPID)

← Older revision		Revision as of 11:06, 27 May 2023
Line 531:		Line 531:
	.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")		.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
	.put("sfcode", "pl") //sfcode for Poland		.put("sfcode", "pl") //sfcode for Poland
	.put("enableFpid", "false"); // false is disabled, true is enabled.		.put("enableFpid", "false"); // false = the FPID is disabled, true = the FPID is enabled.
	.put("nol_devDebug", "DEBUG"); // only for debug and see the Nielsen logs		.put("nol_devDebug", "DEBUG"); // only for debug and see the Nielsen logs
	</syntaxhighlight>		</syntaxhighlight>

WilsonQuispe: /* First Party ID (FPID) */

2023-05-27T11:05:44Z

First Party ID (FPID)

← Older revision		Revision as of 11:05, 27 May 2023
Line 524:		Line 524:

	- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated.<br>		- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated.<br>

			- Example: disable the fpid during init call:
			<syntaxhighlight lang="java">
			// Prepare AppSdk configuration object (JSONObject)
			JSONObject appSdkConfig = new JSONObject()
			.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
			.put("sfcode", "pl") //sfcode for Poland
			.put("enableFpid", "false"); // false is disabled, true is enabled.
			.put("nol_devDebug", "DEBUG"); // only for debug and see the Nielsen logs
			</syntaxhighlight>

	=== Required Privacy Links ===		=== Required Privacy Links ===

WilsonQuispe: /* Privacy and Opt-Out */

2023-05-27T10:24:47Z

Privacy and Opt-Out

← Older revision		Revision as of 10:24, 27 May 2023
Line 515:		Line 515:
	=== Retrieve current Opt-Out preference ===		=== Retrieve current Opt-Out preference ===
	Whether the user is opted out viaOS-level Opt-out or via App-level Opt-out, the current Opt-Out status as detected by the SDK is available via the [[getOptOutStatus()]] property in the Nielsen Android SDK API,		Whether the user is opted out viaOS-level Opt-out or via App-level Opt-out, the current Opt-Out status as detected by the SDK is available via the [[getOptOutStatus()]] property in the Nielsen Android SDK API,

			=== First Party ID (FPID)===
			- The broadcaster must enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>

			- The <code>enableFpid</code> 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 FPID parameter in all the pings.<br>

			- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device, when FPID is wiped out, or when it is expired.<br>

			- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated.<br>

	=== Required Privacy Links ===		=== Required Privacy Links ===

NickParrucci: /* Required Privacy Links */

2023-02-23T20:41:29Z

Required Privacy Links

← Older revision		Revision as of 20:41, 23 February 2023
Line 521:		Line 521:
	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/pl/pl/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/pl/pl/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.

WilsonQuispe: /* Ad Metadata */

2022-12-02T09:56:56Z

Ad Metadata

← Older revision		Revision as of 09:56, 2 December 2022
Line 253:		Line 253:
	\| type \|\| type of ad \|\| 'preroll', 'midroll', or 'postroll' \|\| ✓		\| type \|\| type of ad \|\| 'preroll', 'midroll', or 'postroll' \|\| ✓
	\|-		\|-
	\| assetid \|\| unique ID assigned to ad \|\| custom \|\| ✓		\| assetid \|\| unique ID assigned to ad \|\| custom <br>(no [[Special Characters]]) \|\| ✓
	\|}		\|}

WilsonQuispe: /* Configuring Android Development Environment */

2022-03-31T16:29:52Z

Configuring Android Development Environment

← Older revision		Revision as of 16:29, 31 March 2022
Line 28:		Line 28:
	*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) class is the primary application interface to the Nielsen App SDK on Android.		*The Nielsen App SDK (located in the [https://engineeringportal.nielsen.com/docs/Special:Downloads Downloads section] of the website) class is the primary application interface to the Nielsen App SDK on Android.
	*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.		*The Nielsen App SDK class is defined as the only public class belonging to the com.nielsen.app.sdk package.
			*The Nielsen App SDK can also be added via [https://engineeringportal.nielsen.com/docs/Digital_Measurement_Android_Artifactory_Guide Artifact Repository].

	'''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.'''		'''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.'''
Line 35:		Line 36:
	** The Android OS hosting the App SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively).		** 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.		** 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.
	Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.		Once SDK is downloaded ensure to unzip the Nielsen SDK and copy the AppSdk.jar in your app (Android Studio) libs folder, then right click the AppSdk.jar and select '''Add As Library'''.
	Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.		Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
Line 43:		Line 43:
	==== Google Play Services ====		==== Google Play Services ====
	Add the Google Play Services in the project,		Add the Google Play Services in the project,
	Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click "+" button and ~~select~~ <code>"~~com.google.android.gms:~~play-services"</code>.		Steps: Android Studio -> File -> Project Structure ->(In module selection) select App -> Dependencies (tab) -> Click "+" button and search for <code>"play-services"</code>. Then select the most recent version of the play-services Artifact.
	Ensure it is added in build.gradle (App level) file		Ensure it is added in build.gradle (App level) file

			==== Google AD ID Permissions ====
			The following is required if target API level is set to 31 (Android 12) with the Ad Version of the Nielsen SDK.

			<syntaxhighlight lang="java">
			<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
			</syntaxhighlight>
			</br>

	==== Manifest File ====		==== Manifest File ====
Line 53:		Line 61:
	For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html].		For more details to handle runtime permissions in Android versions, please visit [https://developer.android.com/training/permissions/requesting.html].

	* In <code>AndroidManifest.xml </code>under <application> ~~node~~ add the following metadata		* In <code>AndroidManifest.xml </code>under <code><application></code> add the following metadata

	<syntaxhighlight lang="java"><meta-data		<syntaxhighlight lang="java"><meta-data

ColinBrown at 01:45, 10 September 2020

2020-09-10T01:45:35Z

← Older revision		Revision as of 01:45, 10 September 2020
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|International}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|International DCR}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

MarkTufano at 17:05, 16 June 2020

2020-06-16T17:05:34Z

← Older revision		Revision as of 17:05, 16 June 2020
Line 116:		Line 116:
	'''Initialization of App SDK object through a JSON object'''		'''Initialization of App SDK object through a JSON object'''
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

	try		try
	{		{
Line 155:		Line 156:
	.put("title", "Program S3, EP1")		.put("title", "Program S3, EP1")
	.put("length", "3600")		.put("length", "3600")
			.put("adloadtype": "2")
	.put("segB", "CustomSegmentValueB") //optional		.put("segB", "CustomSegmentValueB") //optional
	.put("segC", "CustomSegmentValueC") //optional		.put("segC", "CustomSegmentValueC") //optional
Line 201:		Line 203:
	\|\| ✓		\|\| ✓
	\|-		\|-
	\| isfullepisode \|\| full episode flag \|\| "y"- full episode, "n"- non full episode \|\|		\| isfullepisode \|\| full episode flag \|\| "y"- full episode, "n"- non full episode \|\| ✓
			\|-
			\| adloadtype \|\| type of ad load:
			<code>"1"</code> Linear – matches TV ad load

			<code>"2"</code> Dynamic – Dynamic Ad Insertion (DAI)
			\|\| <code>"2"</code> - DCR measures content with dynamic ads \|\| ✓
	\|-		\|-
	\| progen \|\| program genre \|\| custom \|\|		\| progen \|\| program genre \|\| custom \|\|
Line 314:		Line 322:
	Call [[loadMetadata()]] with JSON metadata for content as below.		Call [[loadMetadata()]] with JSON metadata for content as below.
	<syntaxhighlight lang="json">{		<syntaxhighlight lang="json">{
	"type": "content",		"type": "content",
	"assetid": "~~vid345-67483~~",		"assetid": "C77664",
	"~~program~~": "~~ProgramName~~",		"title": "Program S2, E3",
	"~~title~~": "Program ~~S3, EP1~~",		"isfullepisode": "Yes",
	"length": "3600",		"program": "Program Name",
	~~...~~		"length": "3600",
			"airdate": "20171020 10:05:00",
			"adloadtype": "2",
			"segB": "CustomSegmentValueB", //optional
			"segC": "CustomSegmentValueC", //optional
	}</syntaxhighlight>		}</syntaxhighlight>
	Call [[setPlayheadPosition()]] every one second until a pause / stop.		Call [[setPlayheadPosition()]] every one second until a pause / stop.

MarkTufano at 20:38, 28 February 2020

2020-02-28T20:38:19Z

← Older revision		Revision as of 20:38, 28 February 2020
Line 116:		Line 116:
	'''Initialization of App SDK object through a JSON object'''		'''Initialization of App SDK object through a JSON object'''
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

	try		try
	{		{
Line 191:		Line 190:
	\| length \|\| (int) length of content in seconds \|\| 86400 seconds for live stream. For Event-Livestreams planned length. For VoD video length\|\| ✓		\| 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 \|\| YYYY-MM-DDTHH:MI:SS<br>		\| 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<br>
	YYYY-MM-DDHH:MI:SS<br>		YYYY-MM-DDHH:MI:SS<br>
	YYYY-MM-DDTHH:MI:SS+xx:xx<br>		YYYY-MM-DDTHH:MI:SS+xx:xx<br>
	YYYY-MM-DDTHH:MI:SS-xx:xx<br>		YYYY-MM-DDTHH:MI:SS-xx:xx<br>
	YYYYMMDDHH:MI:SS<br>		YYYYMMDDHH:MI:SS<br>
			YYYYMMDD HH:MI:SS<br>
	MM-DD-YYYY<br>		MM-DD-YYYY<br>
	MM/DD/YYYY<br>		MM/DD/YYYY<br>
	(pass beginning of epoch if unknown)		(pass beginning of epoch if unknown)
	\|\|		\|\| ✓
	\|-		\|-
	\| isfullepisode \|\| full episode flag \|\| "y"- full episode, "n"- non full episode \|\|		\| isfullepisode \|\| full episode flag \|\| "y"- full episode, "n"- non full episode \|\|

ColinBrown: /* Content Metadata */

2020-01-30T21:21:59Z

Content Metadata

← Older revision		Revision as of 21:21, 30 January 2020
Line 208:		Line 208:
	\|-		\|-
	\| segC \|\| custom segment \|\| custom \|\|		\| segC \|\| custom segment \|\| custom \|\|
			\|-
			\| crossId1 \|\| standard episode ID \|\| custom \|\|
	\|-		\|-
	\| clientid \|\|		\| clientid \|\|