AppSDK() - Revision history

AmySockanathan: Add LUID to the Global Parameters table

2024-06-27T15:07:10Z

Add LUID to the Global Parameters table

← Older revision		Revision as of 15:07, 27 June 2024
Line 86:		Line 86:
	QI1mp015jsNnpX5/xGgXldcgVz+gFnyh3T8/3agMwRmyrhC		QI1mp015jsNnpX5/xGgXldcgVz+gFnyh3T8/3agMwRmyrhC
	xG4oH2C7fc48AQk2eotE7FW0ZDEYM8fD9ZxDaxFUC/OV3OuZA&		xG4oH2C7fc48AQk2eotE7FW0ZDEYM8fD9ZxDaxFUC/OV3OuZA&
			\|-
			\|luid
			\|Living Unit ID - Experian Household ID
			'''Note: This parameter is applicable only for CTV and First Party Livestream data'''
			\|Client-defined
			\|No
			\|B0EOFEDgD
	\|}		\|}

NickParrucci: /* JSON string format for appInfo */

2023-05-08T21:29:15Z

JSON string format for appInfo

← Older revision		Revision as of 21:29, 8 May 2023
Line 102:		Line 102:

	=== JSON string format for appInfo ===		=== JSON string format for appInfo ===
	The required items are ~~application name (appName),~~ application ID (appid), designated market area (dma), Nielsen-assigned data node (sfcode), and the country code (ccode).		The required items are application ID (appid), designated market area (dma), Nielsen-assigned data node (sfcode), and the country code (ccode).
	<blockquote>'''Note:''' Notice that all quotes inside the string are escaped with a backslash (\).</blockquote>		<blockquote>'''Note:''' Notice that all quotes inside the string are escaped with a backslash (\).</blockquote>
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	"{~~"appName":"PlayerApp",~~"appid":"PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,"sfcode":"us"}"		"{"appid":"PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,"sfcode":"us"}"
	</syntaxhighlight>		</syntaxhighlight>

NickParrucci: /* JSON object format for appInfo */

2023-05-08T21:28:24Z

JSON object format for appInfo

@@ Line 46: / Line 46: @@
 == Notes ==
-=== JSON object format for appInfo ===
+=== JSON object for appInfo ===
 <syntaxhighlight lang="java">
    JSONObject appSdkConfig = new JSONObject()
            .put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
            .put("sfcode", "uat-cert")
            .put("custom_key1", "custom_value1")
            .put("custom_key2", "custom_value2");
 </syntaxhighlight>

AlexGutierrez at 17:02, 23 May 2018

2018-05-23T17:02:08Z

← Older revision		Revision as of 17:02, 23 May 2018
Line 64:		Line 64:

	=== iAppNotifier ===		=== iAppNotifier ===
	Client apps subscribe to the App SDK event listener to be notified about App SDK events. To implement, ~~please~~ create a plain old java object (POJO) that implements the interface <code>com.nielsen.app.sdk.IAppNotifier</code>. Do not implement with the main activity class as this creates a strong reference and interferes with memory release.		Client apps can subscribe to the App SDK event listener to be notified about App SDK events. To implement this feature, create a plain old java object (POJO) that implements the interface <code>com.nielsen.app.sdk.IAppNotifier</code>. Do not implement with the main activity class as this creates a strong reference and interferes with memory release.

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Line 78:		Line 78:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			Note that implementing the event listener is '''optional'''.

	==== AppSdk events ====		==== AppSdk events ====

Admin at 13:15, 25 October 2017

2017-10-25T13:15:17Z

← Older revision		Revision as of 13:15, 25 October 2017
Line 49:		Line 49:
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	JSONObject appSdkConfig = new JSONObject()		JSONObject appSdkConfig = new JSONObject()
	.put("appid", "~~TXXXXXXXX~~-XXXX-XXXX-XXXX-XXXXXXXXXXXX")		.put("appid", "PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
	.put("appname", "Sample App Name")		.put("appname", "Sample App Name")
	.put("sfcode", "uat-cert")		.put("sfcode", "uat-cert")
Line 60:		Line 60:
	<blockquote>'''Note:''' Notice that all quotes inside the string are escaped with a backslash (\).</blockquote>		<blockquote>'''Note:''' Notice that all quotes inside the string are escaped with a backslash (\).</blockquote>
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	"{"appName":"PlayerApp","appid":"~~TXXXXXXXX~~-XXXX-XXXX-XXXX-XXXXXXXXXXXX,"sfcode":"us"}"		"{"appName":"PlayerApp","appid":"PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,"sfcode":"us"}"
	</syntaxhighlight>		</syntaxhighlight>

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference `AppSdk..."`


2017-05-21T07:26:06Z
Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference  <code>AppSdk..."
New page
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}}

[[Category:Digital]]

[[Category:Android SDK API Reference]]



<code>AppSdk()</code> is the public constructor used for initializing the App SDK Analytics framework.

*The reference to the App SDK object returned by the Appsdk constructor.

*App SDK supports multiple instances (max. four) to measure multiple players simultaneously.

*context, appInfo parameters are mandatory and should not be NULL values.

*The constructor should never return null.



=== 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" : "" + "I" + "",",</code> while [[initializing the App SDK object]]. The permitted values are

**'I' (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.

**'W' (WARNING): Indicates potential integration / configuration errors or SDK issues.

**'E' (ERROR): Indicates important integration errors or non-recoverable SDK issues.

**'D' (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 production evironment.</blockquote>



== Syntax ==

<syntaxhighlight lang="java">

public AppSdk(Context context, JSONObject appInfo, IAppNotifier notifier);

</syntaxhighlight>



== Input Parameters ==

{| class="wikitable"

|-

! Parameter !! Description

|-

| context || The context from the App

|-

| appInfo || JSON object that defines the application information.

|-

| notifier || Client-provided object implementing the iAppNotifier interface. Can be ‘null’ if not provided by client.

|}



== Output Parameters ==

{| class="wikitable"

|-

! Output Parameters (Return value) !! Description

|-

| A reference to the instance. Else Null object || 

|}



== Notes ==

=== JSON object format for appInfo ===

<syntaxhighlight lang="java">

  JSONObject appSdkConfig = new JSONObject()

          .put("appid", "TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")

          .put("appname", "Sample App Name")

          .put("sfcode", "uat-cert")

          .put("custom_key1", "custom_value1")

          .put("custom_key2", "custom_value2");

</syntaxhighlight>



=== JSON string format for appInfo ===

The required items are application name (appName), application ID (appid), designated market area (dma), Nielsen-assigned data node (sfcode), and the country code (ccode). 

<blockquote>'''Note:''' Notice that all quotes inside the string are escaped with a backslash (\).</blockquote>

<syntaxhighlight lang="java">

"{"appName":"PlayerApp","appid":"TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,"sfcode":"us"}"

</syntaxhighlight>



=== iAppNotifier ===

Client apps subscribe to the App SDK event listener to be notified about App SDK events. To implement, please create a plain old java object (POJO) that implements the interface <code>com.nielsen.app.sdk.IAppNotifier</code>. Do not implement with the main activity class as this creates a strong reference and interferes with memory release.



<syntaxhighlight lang="java">

//pass the implementing object to the AppSdk constructor in order to subscribe to the eventlistener:

mAppSdk = new AppSdk(context, appInfo,iappNotifierObject)

</syntaxhighlight>



Optionally, implement an object derived from the interface, as below. This object will allow listening for events within the App SDK.

<syntaxhighlight lang="java">

public interface iAppNotifier

{

public void onAppSdkEvent(long timestamp, int code, String description);

}

</syntaxhighlight>



==== AppSdk events ====

There are three events currently exposed on the App SDK.

<syntaxhighlight lang="java">

public static final int EVENT_INITIATE = 2000;

</syntaxhighlight>

*App SDK notifies that it is going to be initialized.



<syntaxhighlight lang="java">

public static final int EVENT_STARTUP = 2001;

</syntaxhighlight>

*The App SDK has just started up. It will happen only after the App SDK has received a valid config file from Nielsen. This is the location in the code to acquire value of <code>userOptOutURLString()</code>.



<syntaxhighlight lang="java">

public static final int EVENT_SHUTDOWN = 2002;

</syntaxhighlight>

*The App SDK is shutting down. It will happen only when the App SDK is destroyed.

AppSDK() - Revision history

AmySockanathan: Add LUID to the Global Parameters table

NickParrucci: /* JSON string format for appInfo */

NickParrucci: /* JSON object format for appInfo */

AlexGutierrez at 17:02, 23 May 2018

Admin at 13:15, 25 October 2017

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference AppSdk..."

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference `AppSdk..."`