Android SDK Initialization: Difference between revisions
From Engineering Client Portal
ColinBrown (talk | contribs) (Created page with "== SDK Initialization == The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issu...") |
ColinBrown (talk | contribs) |
||
| Line 12: | Line 12: | ||
|| Nielsen-specified || Optional || "DEBUG" | || Nielsen-specified || Optional || "DEBUG" | ||
|} | |} | ||
== 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":@"INFO"</code>, in the JSON string . The permitted values are: | |||
* '''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. | |||
* '''WARN''': Indicates potential integration / configuration errors or SDK issues. | |||
* '''ERROR''': Indicates important integration errors or non-recoverable SDK issues. | |||
* '''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 a production environment.</blockquote> | |||
==== Sample SDK Initialization Code ==== | |||
[[AppSDK()]] is no longer a singleton object and should be initialized as below. | |||
'''Initialization of App SDK object through a JSON object''' | |||
<syntaxhighlight lang="java">try | |||
{ | |||
// Prepare AppSdk configuration object (JSONObject) | |||
JSONObject appSdkConfig = new JSONObject() | |||
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA") | |||
.put("nol_devDebug", "DEBUG"); // only for debug builds | |||
// Pass appSdkConfig to the AppSdk constructor | |||
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener); | |||
} | |||
catch (JSONException e) | |||
{ | |||
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e); | |||
} | |||
</syntaxhighlight> | |||
Here, <code>appContext</code> is the App context object and <code>appSdkConfig</code> is JSON object for holding the parameters (<code>appid</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. | |||
The integration of Nielsen App SDK will depend on type of client app.<br /> | |||
* Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project). | |||
<!-- == Initializing the Nielsen AppSDK to measure the Viewability == | |||
The integrator to support the viewability metrics in the application has to provide a tag value of the player view to let Nielsen AppSDK know that there is a player that needs to be tracked. It’s called the ‘containerId’ and it should be passed in application info dictionary as string while initializing the Nielsen AppSDK. | |||
==== Android ==== | |||
{| class="wikitable" | |||
|- | |||
! # !! Parameter Name !! Description !! Supported Values !! Example | |||
|- | |||
| 1 || containerId ||View ID of the UI element used as player view in application. getId() method of View class can be used to get this value. ||A positive integer used to identify the view. || 2131558561 | |||
|} | |||
==== iOS ==== | |||
{| class="wikitable" | |||
|- | |||
! # !! Parameter Name !! Description !! Supported Values !! Example | |||
|- | |||
| 1 || containerId ||The tag of the UIView that represents the Player View ||The string value representing the NSInteger value with maximum value of NSIntegerMax that is related on 32- or 64-bit applications. || "100" <br> "2131558561" | |||
|} | |||
For iOS it is required to link additional frameworks that are needed for viewability engine:<br> | |||
<code>JavaScriptCore.framework</code> <br> | |||
<code>WebKit.framework</code> | |||
The Nielsen AppSDK uses a tracking WebView (TWV) approach. For more information on Viewability, please refer to [https://engineeringportal.nielsen.com/docs/Implementing_Viewability_with_AppSDK Implementing Viewability with AppSDK.] | |||
--> | |||
Revision as of 19:57, 28 March 2022
SDK Initialization
The latest version of the Nielsen App SDK allows instantiating multiple instances of the SDK object, which can be used simultaneously without any issue. The sharedInstance API that creates a singleton object was deprecated prior to version 5.1.1. (Version 4.0 for Android)
The following table contains the list of arguments that can be passed via the AppInfo JSON schema.
| Parameter / Argument | Description | Source | Required? | Example |
|---|---|---|---|---|
| appid | Unique Nielsen ID for the application. The ID is a GUID data type. If you did not receive your App ID, let us know and we will provide you. | Nielsen-specified | Yes | PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
| nol_devDebug | Enables Nielsen console logging. Only required for testing | Nielsen-specified | Optional | "DEBUG" |
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 @"nol_devDebug":@"INFO", in the JSON string . The permitted values are:
- 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.
- WARN: Indicates potential integration / configuration errors or SDK issues.
- ERROR: Indicates important integration errors or non-recoverable SDK issues.
- 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.
Note: DO NOT activate the Debug flag in a production environment.
Sample SDK Initialization Code
AppSDK() is no longer a singleton object and should be initialized as below.
Initialization of App SDK object through a JSON object
try
{
// Prepare AppSdk configuration object (JSONObject)
JSONObject appSdkConfig = new JSONObject()
.put("appid", "PDA7D5EE6-B1B8-XXXX-XXXX-2A788BCXXXCA")
.put("nol_devDebug", "DEBUG"); // only for debug builds
// Pass appSdkConfig to the AppSdk constructor
mAppSdk = new AppSdk(appContext, appSdkConfig, appSdkListener);
}
catch (JSONException e)
{
Log.e(TAG, "Couldn’t prepare JSONObject for appSdkConfig", e);
}
Here, appContext is the App context object and appSdkConfig is JSON object for holding the parameters (appid) 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.
The integration of Nielsen App SDK will depend on type of client app.
- Ensure that SDK files (AppSdk.jar and libAppSdk.so [App SDK 1.2 Only]) are included under the App’s project and the App SDK is linked to the App (the setting to link App SDK to the App can be found on property page of the App’s project).