View source for thePlatform Plugin Android

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
'''Supported Ad Frameworks'''
* FreeWheel
'''Nielsen App SDK Plugin for thePlatform''' interacts with Nielsen App SDK to provide with necessary data for streaming measurement based on the SDK events received from thePlatform Player SDK.

==Plugin Implementation ==
'''Pre-requisites'''
* '''Nielsen SDK Configuration Form''': Complete this form to receive the appid(s). The information on this form is required to set up the Content Management System (CMS) mapping for the app.
* '''Nielsen App ID (appid)''': A unique ID that Nielsen assigns to the site / player.
* '''Nielsen App SDK Plugin for thePlatform''': The download link for the Plugin Packages are provided with the Nielsen appid(s).
* '''thePlatform Player SDK for Android'''
* '''VideoView''': Before moving the app into production, Nielsen must validate the Plugin’s integration in a test environment.

=== Initial Configuration ===
Before integrating the Plugin, make sure to download the following:

*'''thePlatform Player ADK for Android'''
**Download thePlatform ADK from http://help.theplatform.com/display/adk/ADK+for+Android+download.

*'''Nielsen App SDK Plugin for thePlatform Package,''' which includes
** Plugin Implementation Guide (this document)
** The Nielsen App SDK Plugin for thePlatform source code and
** The sample application source code which supports thePlatform’s FreeWheel ad Plugin.

*'''Nielsen App SDK'''
** Download the Nielsen App SDK jar file from [[Downloads]].

*'''Build the Nielsen Plugin and sample app''' from the player application project is accomplished by doing the following:
** Unzip the NielsenAppSDKPlugintPlatform.zip file.
** Build the Plugin’s aar file as follows.
** Import the module NielsenthePlatformPlugin into the project.
** Create a /libs directory in NielsenthePlatformPlugin.
** Copy the Nielsen AppSDK and thePlatform’s jar files into this /libs directory.
** Build the NielsenthePlatformPlugin module and this should produce the NielsenthePlatformPlugin.aar file.
** Build the SampleApp with the Plugin

*'''Nielsen SampleApp'''
** Import the module NielsenSampleAppForthePlatform into the project.
** Include the following in the build.gradle to compile with the NielsenthePlatformPlugin
<syntaxhighlight lang="java">compile project(‘:NielsenthePlatformPlugin’)</syntaxhighlight>
** Build the NielsenSampleAppForthePlatformPlugin module and this should produce the NielsenSampleAppForthePlatform.apk file (Sample App with Plugin).

== Initialization with Global Parameters ==
To create the Plugin that initializes the AppSDK, pass the global parameters in a JSON string format. Some of the global parameters are
* Nielsen App ID (appid)
* app version
* app name
* sfcode
* dma
* ccode
* CMS Metadata
For more details refer to the Nielsen [[Android SDK API Reference]].

== Setup ==
The steps for setting up the Nielsen App SDK Plugin for thePlatform Player are as follows
=== Nielsen App SDK Plugin Creation ===
The Nielsen App SDK Plugin for thePlatform integrates with thePlatform ADK by listening for events from the player and emits events for the player. It is also a wrapper for the Nielsen App SDK.

The App creates the Plugin as mentioned below.
<syntaxhighlight lang="java">plugin = new Plugin(this, tpPlayer, config, player, this);</syntaxhighlight>

where
* ''this'' refers to the current object,
* ''config'' contains the parameters to initialize the App SDK in the JSON format.<blockquote>'''Note''': The debug mode parameter has been changed to “nol_devDebug” and the permitted values are DEBUG/INFO/WARNING/ERROR.</blockquote>
* ''player'' is thePlatform player reference
Refer to the Nielsen SDK Documentation for more details on the App SDK configuration parameters.
For more details refer to the Nielsen [[Android SDK API Reference]].

=== Passing Metadata ===
The Plugin contains three interface methods that the client needs to implement to provide the necessary metadata for content and ad and also the metadata required for play.

This data is returned in a map container.
<syntaxhighlight lang="java">Map<String, String> getMetaData(MediaUnPauseEvent event, Player player);
Map<String, String> getMetaData(MediaLoadStartEvent event, Player player);
Map<String, String> getMetaData(ReleaseStartEvent event, Player player);</syntaxhighlight>

The data returned by the ''getMetaData()'' for content contains
* Assetid : unique id assigned to asset
* Program : program name
* Title : episode title – only applicable to video content
* Length – length of content in seconds
* segA – segment A will be episode title for video content
* segB – Segment B
* segC – Segment C
The data returned by the getPlayData() contains the “channelName”.
For more details refer to the Nielsen [[Android SDK API Reference]].

=== Calling the methods ===
The Plugin provides the following methods for the application to communicate with the plugin.
{| class="wikitable"
|-
! Function !! Name
|-
| AppDisable || <code>Void appDisable(boolean value)</code>
|-
| Config Settings Change || <code>void appIntializeAppSdk(Object config*)</code>

*config is a JSONObject
|-
| OptIn/OptOut || <code>void sendOptInOutEvent(String optResult)</code>
|-
| Static Content || <code>void sendStaticContent(Object content*)</code>

*content is a JSONObject
|}

== Releases ==
{| class="wikitable"
|-
! Name !! Version # !! Date !! Comments
|-
| Nielsen AppSDK Plugin for thePlatform (FreeWheel) || 1.0.0 || 01/11/2016 || Initial version of the Nielsen App SDK Plugin for thePlatform (Android) with support for FreeWheel ads.
|-
| Nielsen AppSDK Plugin for thePlatform || 1.1.0 || 04/26/2016 || Nielsen App SDK Plugin for thePlatform (Android) is compatible with App SDK build for US and International (Germany) clients and was tested with AppSdk 5.1.0.4 build.
|-
| Nielsen AppSDK Plugin for thePlatform || 1.2.0 || 05/18/2017 || Nielsen App SDK Plugin for thePlatform player with DCR and DTVR support. It was tested with AppSdk 5.1.1.18 build and Player version 1.8.7.1
|}