DCR Italy Video Android SDK - Revision history

WilsonQuispe: /* Required Privacy Links */

2022-07-13T13:11:42Z

Required Privacy Links

← Older revision		Revision as of 13:11, 13 July 2022
Line 607:		Line 607:
	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.

	"Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://~~www~~.nielsen.com~~/it/it~~/legal/privacy-~~statement~~/digital-measurement/ https://~~www~~.nielsen.com~~/it/it~~/legal/privacy-~~statement~~/digital-measurement/]"		Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it https://global.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=it]

	== Going Live ==		== Going Live ==

WilsonQuispe: /* Notes for Webview Contents */

2022-05-11T12:35:15Z

Notes for Webview Contents

← Older revision		Revision as of 12:35, 11 May 2022
Line 26:		Line 26:
	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.

	=== Notes for ~~Webview~~ Contents ===		=== Notes for WebView Contents ===
	<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK\|browser static SDK]] have to inhibit from this pages.</code>		<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK\|browser static SDK]] have to inhibit from this pages.</code>

WilsonQuispe: /* Implementation */

2022-05-11T12:34:14Z

Implementation

← Older revision		Revision as of 12:34, 11 May 2022
Line 31:		Line 31:
	== Implementation ==		== Implementation ==
	This guide covers implementation steps for Android Studio utilizing the Standard Nielsen SDK for DCR.		This guide covers implementation steps for Android Studio utilizing the Standard Nielsen SDK for DCR.

	~~<code>Please note that if within your APP user can surf static contents recalled from your website the [[DCR_Italy_Static_Browser_SDK\|browser static SDK]] have to inhibit from this pages.</code>~~

	__TOC__		__TOC__

WilsonQuispe: /* Prerequisites */

2022-05-11T12:33:48Z

Prerequisites

← Older revision		Revision as of 12:33, 11 May 2022
Line 25:		Line 25:
	If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.		If need App ID(s) or our SDKs, feel free to reach out to us and we will be happy to help you get started.
	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.

			=== Notes for Webview Contents ===
			<code>Please note that if within your APP user can surf '''static contents''' recalled from your website the [[DCR_Italy_Static_Browser_SDK\|browser static SDK]] have to inhibit from this pages.</code>

	== Implementation ==		== Implementation ==

WilsonQuispe: /* Implementation */

2022-05-11T10:30:49Z

Implementation

← Older revision		Revision as of 10:30, 11 May 2022
Line 28:		Line 28:
	== Implementation ==		== Implementation ==
	This guide covers implementation steps for Android Studio utilizing the Standard Nielsen SDK for DCR.		This guide covers implementation steps for Android Studio utilizing the Standard Nielsen SDK for DCR.

			<code>Please note that if within your APP user can surf static contents recalled from your website the [[DCR_Italy_Static_Browser_SDK\|browser static SDK]] have to inhibit from this pages.</code>

	__TOC__		__TOC__

WilsonQuispe: /* Configuring Android Development Environment */

2022-03-31T16:28:15Z

Configuring Android Development Environment

← Older revision		Revision as of 16:28, 31 March 2022
Line 38:		Line 38:
	== Setting up your Development Environment ==		== Setting up your Development Environment ==
	=== Configuring Android Development Environment ===		=== Configuring Android Development Environment ===
	*The Nielsen App SDK (located in the 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.'''

	The requirement for the Java AppSdk.jar library and the libAppSdk.so native library will depend on the type of host application that will make use of them.		The requirement for the Java ''AppSdk.jar'' library and the ''libAppSdk.so'' native library will depend on the type of host application that will make use of them.
			* '''For Video player applications'''
			** 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.

	*'''~~For Video player applications~~'''		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'''.
	**The Android OS hosting the App ~~SDK should use a media player supporting HLS streaming (Android 3.0 and later will support it natively~~).		Ensure the AppSdk.jar file is added in 'build.grade (App Level) file.
	**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~~.		* App SDK 1.2 provides support for x86, mips, and armeabi-7a architecture.

	~~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.		==== Google Play Services ====
			Add the Google Play Services in the project,
			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

	*App SDK ~~1.2 provides support for x86, mips, and armeabi-7a architecture~~.		==== 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.

	=~~=== Google Play Services ====~~		<syntaxhighlight lang="java">
	~~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~~>~~. Ensure it is added in build.gradle (App level) file~~		<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
			</syntaxhighlight>
			</br>

	==== Manifest File ====		==== Manifest File ====
	*Add the following permissions on the project’s AndroidManifest.xml file.		* Add the following permissions on the project’s ''AndroidManifest.xml'' file.
	<syntaxhighlight lang="java"><uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>		<syntaxhighlight lang="java">
			<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
	<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>		<uses-permission android:name="android.permission.INTERNET"/></syntaxhighlight>
	For more details to handle runtime permissions in Android versions, please visit [~~https://developer.android.com/training/permissions/requesting.html~~ 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
	android:name="com.google.android.gms.version"		android:name="com.google.android.gms.version"
	android:value="@integer/google_play_services_version"/></syntaxhighlight>		android:value="@integer/google_play_services_version"/></syntaxhighlight>
	*App SDK checks to see if there is a Google service available and updated.
	*If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.		* App SDK checks to see if there is a Google service available and updated.
			* If not available or updated, App SDK will not use this service when executing its functions and will make reference to missing imports and the app will not be compiled.

	==== Library ====		==== Library ====
	Nielsen App SDK uses the following packages/classes from the Google Play service.		Nielsen App SDK uses the following packages/classes from the Google Play service.
	*google-play-services_lib		* google-play-services_lib

	==== Classes/package ====		==== Classes/package ====
	*com.google.android.gms.ads.identifier.AdvertisingIdClient;		* com.google.android.gms.ads.identifier.AdvertisingIdClient;
	*com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;		* com.google.android.gms.ads.identifier.AdvertisingIdClient.Info;
	*com.google.android.gms.common.ConnectionResult;		* com.google.android.gms.common.ConnectionResult;
	*com.google.android.gms.common.GooglePlayServicesUtil;		* com.google.android.gms.common.GooglePlayServicesUtil;
	*com.google.android.gms.common.GooglePlayServicesRepairableException;		* com.google.android.gms.common.GooglePlayServicesRepairableException;
	*com.google.android.gms.common.GooglePlayServicesNotAvailableException;		* com.google.android.gms.common.GooglePlayServicesNotAvailableException;

	== SDK Initialization ==		== SDK Initialization ==

WilsonQuispe: /* APP SDK Error & Event Codes */

2020-10-19T19:33:53Z

APP SDK Error & Event Codes

← Older revision		Revision as of 19:33, 19 October 2020
Line 148:		Line 148:

	== APP SDK Error & Event Codes ==		== APP SDK Error & Event Codes ==
	To view the Error and Event codes for ~~iOS~~, please review the [[APP SDK Event Codes\|App SDK Event Code]] Reference page.		To view the Error and Event codes for Android, please review the [[APP SDK Event Codes\|App SDK Event Code]] Reference page.

	== Configure Metadata ==		== Configure Metadata ==

WilsonQuispe: /* Prerequisites */

2020-10-19T19:33:10Z

Prerequisites

← Older revision		Revision as of 19:33, 19 October 2020
Line 18:		Line 18:
	\|\| '''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
	\|-		\|-
	\|\| '''Nielsen SDK''' \|\| Includes SDK frameworks and '''sample implementation'''; ''See [[~~iOS~~ SDK Release Notes]]'' \|\| [[Special:Downloads\|Download]]		\|\| '''Nielsen SDK''' \|\| Includes SDK frameworks and '''sample implementation'''; ''See [[Android SDK Release Notes]]'' \|\| [[Special:Downloads\|Download]]
	\|-		\|-
	\|\| '''sfcode''' \|\| Unique identifier for the environment that the SDK should point to \|\| Provided by Nielsen		\|\| '''sfcode''' \|\| Unique identifier for the environment that the SDK should point to \|\| Provided by Nielsen

WilsonQuispe: /* OS-level Opt-out */

2020-10-19T19:30:54Z

OS-level Opt-out

← Older revision		Revision as of 19:30, 19 October 2020
Line 499:		Line 499:

	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"'' 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"'' setting is ''enabled''. As a publisher, you cannot override this setting.

			==== Get the latest Nielsen opt-out URL ====

			*Get the current Nielsen opt-out URL via [[userOptOutURLString()\|userOptOutURLString()]]
			*Display a WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()\|userOptOutURLString()]]

	==== Webview Example ====		==== Webview Example ====

ColinBrown: /* Privacy and Opt-Out */

2020-10-14T20:49:44Z

Privacy and Opt-Out

← Older revision		Revision as of 20:49, 14 October 2020
Line 486:		Line 486:
	== Privacy and Opt-Out ==		== Privacy and Opt-Out ==
	There are two primary methods for implementing user Opt-out preferences:		There are two primary methods for implementing user Opt-out preferences:
			# '''[[#OS-level_Opt-out\|OS-level Opt-out]]''' - managed by ''Opt out of Ads Personalization'' setting on device ('''preferred approach''').
			# '''[[#User Choice\|User Choice]]''' - Direct call to SDK. Can be used without Google Play Services.

	*[[DCR_Italy_Video_Android_SDK#~~OS-level_Opt-out\|OS-level~~ Opt-out~~]] - managed by AppTracking or Limit Ad Tracking setting on device~~ (~~preferred approach~~).		=== Special Note Regarding Apps in the '''Kids Category''' ===
	*[[DCR_Italy_Video_Android_SDK#User_Choice\|User ~~Choice]]~~ - ~~Direct call to SDK. Can be used without the Ad Framework~~		If you are building an app that will be listed in the Kids Category:
			# Ensure that you are using the NoID version of the Nielsen SDK Framework.
			# Immediately following the initialization of the Nielsen SDK ensure you call the userOptOut API with Opt out selection:
			<syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>

	=== OS-level Opt-out ===		=== OS-level Opt-out ===
	OS-level Opt-out method available on Nielsen Android.		''OS-level Opt-out'' method available on Nielsen Android.

	The Nielsen SDK automatically leverages the Android's Opt out of Ads Personalization 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"'' setting is ''enabled''. As a publisher, you cannot override this setting.

	~~==== Get the current Nielsen opt-~~out ~~URL ====~~

	*Get the ~~current Nielsen opt~~-out ~~URL via [[userOptOutURLString()\|userOptOutURLString()]]~~
	*Display a ~~WebView element whose loadUrl is set to the value obtained from [[userOptOutURLString()\|userOptOutURLString()]]~~

	~~==== Webview Example ====~~
	~~The below code is an example of displaying the Nielsen Privacy page to the user~~.

			==== Webview Example ====
			The below code is an AndroidX example of displaying the Nielsen Privacy page to the user.
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	public class OptOutActivity extends AppCompatActivity implements IAppNotifier {		public class OptOutActivity extends AppCompatActivity implements IAppNotifier {
Line 531:		Line 530:
	});		});

	NielsenInit nielsenInit = new NielsenInit();		NielsenInit nielsenInit = new NielsenInit(); // Initializing the NielsenSDK
	appSdk = nielsenInit.initAppSdk(getApplicationContext(), this);		appSdk = nielsenInit.initAppSdk(getApplicationContext(), this); //Create Instance
	//~~Getting the optPut URL from eventTracker~~		String url = appSdk.userOptOutURLString(); // Request Optout URL from NielsenSDK
	String url = appSdk.userOptOutURLString();		webView.loadUrl(url); //Display to the user in a Webview
	webView.loadUrl(url);
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<br>

	=== User Choice ===		=== User Choice ===
	The User Choice method is only necessary when the host application does not leverage Google Play Services.		The ''User Choice'' method is only necessary when the host application does not leverage Google Play Services.

	~~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.
			<br>
	==== The legacy opt-out method works as follows: ====		==== The legacy opt-out method works as follows: ====
			* Get the current Nielsen opt-out URL via [[userOptOutURLString()]]
	*Get the current Nielsen opt-out URL via [[~~userOptOutURLString()\|~~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()\|~~userOptOutURLString()]]		* Detect if the WebView URL changes to a special URL that indicates Opt-in, or Opt-out and close the WebView
	*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 = <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
	*Pass the detected URL to the [[~~userOptOut()\|~~userOptOut()]] function		** Example: <syntaxhighlight lang=java>appSdk.userOptOut("nielsenappsdk://1"); // User opt-out</syntaxhighlight>
	**Example:
	<syntaxhighlight lang="java">appSdk.userOptOut("nielsenappsdk://1"); // User opt-out </syntaxhighlight>

	==== Legacy Opt Out example code ====		==== Legacy Opt Out example code ====


	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	~~public~~ class ~~OptOutActivity~~ extends ~~AppCompatActivity implements IAppNotifier~~ {		private class MonitorWebView extends WebViewClient
			{
	~~WebView webView;~~
	~~AppSdk appSdk;~~

	private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";		private static final String NIELSEN_URL_OPT_OUT = "nielsenappsdk://1";
	private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";		private static final String NIELSEN_URL_OPT_IN = "nielsenappsdk://0";

	~~// Within your app you would provide your User the option to Opt Out.~~		@Override
	~~// Perhaps via a toggle or button~~		public boolean shouldOverrideUrlLoading(WebView view, String url)
	~~// This is separate from Limit Ad Tracking~~		{
			if (NIELSEN_URL_OPT_OUT.equals(url)
	~~let urlStr = navigationAction.request.~~url~~?.absoluteString~~		\|\| NIELSEN_URL_OPT_IN.equals(url))
			{
	if(~~urlStr ==~~ NIELSEN_URL_OPT_OUT \|\| ~~urlStr ==~~ NIELSEN_URL_OPT_IN){		// Get AppSdk instance from the host
	~~let appApi~~ = ~~self~~.~~nielsenApi~~		AppSdk appSdk = HostApp.getAppSdk();
	~~appApi?~~.userOptOut(~~urlStr~~)		// Send the URL to the AppSdk instance
			appSdk.userOptOut(url);
			return true;
			}
			return false;
			}
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	=== 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()\|getOptOutStatus()]] property in the Nielsen Android SDK API,

	==== Required Privacy Links ====		==== Required Privacy Links ====
Line 589:		Line 586:

	"Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://www.nielsen.com/it/it/legal/privacy-statement/digital-measurement/ https://www.nielsen.com/it/it/legal/privacy-statement/digital-measurement/]"		"Si prega di notare che questa app include il software di misurazione proprietario di Nielsen che contribuisce alla ricerca di mercato. Per ulteriori informazioni, si prega di consultare il seguente link [https://www.nielsen.com/it/it/legal/privacy-statement/digital-measurement/ https://www.nielsen.com/it/it/legal/privacy-statement/digital-measurement/]"


	== Going Live ==		== Going Live ==