thePlatform Plugin iOS - Revision history

Admin at 21:50, 20 October 2017

2017-10-20T21:50:31Z

← Older revision		Revision as of 21:50, 20 October 2017
Line 10:		Line 10:
	\|SDKVersion=5.1.1.19		\|SDKVersion=5.1.1.19
	\|supportedAdFrameworks=FreeWheel		\|supportedAdFrameworks=FreeWheel
			\|downloadLink=https://engineeringportal.nielsen.com/w/downloads/digital/plugins/theplatform/ios/Nielsen-App-SDK-thePlatform-Plugin-iOS-1.1.0.zip
	}}		}}

Admin at 20:45, 31 August 2017

2017-08-31T20:45:35Z

← Older revision		Revision as of 20:45, 31 August 2017
Line 4:		Line 4:
	'''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.		'''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.

	~~'''Supported Ad Frameworks'''~~		{{PluginInfobox
	* FreeWheel		\|pluginImage=thePlatformIcon
			\|osImage=macOSIcon
			\|playerVersion=1.8.9
			\|SDKVersion=5.1.1.19
			\|supportedAdFrameworks=FreeWheel
			}}

	==Plugin Implementation ==		==Plugin Implementation ==

Admin2: /* Nielsen App SDK Plugin Creation */

2017-06-15T17:30:23Z

Nielsen App SDK Plugin Creation

← Older revision		Revision as of 17:30, 15 June 2017
Line 57:		Line 57:
	* Add property<syntaxhighlight lang="objective-c">@property (nonatomic, strong) NielsenThePlatformPlugin *thePlatformPlugin;</syntaxhighlight>		* Add property<syntaxhighlight lang="objective-c">@property (nonatomic, strong) NielsenThePlatformPlugin *thePlatformPlugin;</syntaxhighlight>
	* Instantiate the plugin and register it with instance of ‘TPPlayerView’<syntaxhighlight lang="objective-c">self.thePlatformPlugin = [[NielsenThePlatformPlugin alloc]		* Instantiate the plugin and register it with instance of ‘TPPlayerView’<syntaxhighlight lang="objective-c">self.thePlatformPlugin = [[NielsenThePlatformPlugin alloc]
	initWithAppInfo:@{@~~”appid”~~: @~~”MY_APP_ID”~~,		initWithAppInfo:@{@"appid": @"MY_APP_ID",
	@~~”appversion”~~: @~~”MY_APP_VERSION”~~,		@"appversion": @"MY_APP_VERSION",
	@~~”appname”~~: @~~”MY_APP_NAME”~~,		@"appname": @"MY_APP_NAME",
	@~~”sfcode”~~: @~~”MY_SFCODE”~~};		@"sfcode": @"MY_SFCODE"};
	self.thePlatformPlugin.dataSource = self;		self.thePlatformPlugin.dataSource = self;
	[self.player addDelegate:self.thePlatformPlugin];</syntaxhighlight>		[self.player addDelegate:self.thePlatformPlugin];</syntaxhighlight>

Admin at 07:46, 25 May 2017

2017-05-25T07:46:44Z

← Older revision		Revision as of 07:46, 25 May 2017
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|DCR & DTVR}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

	'''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.		'''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.

Admin: /* Nielsen App SDK Plugin Creation */

2017-05-25T07:44:48Z

Nielsen App SDK Plugin Creation

← Older revision		Revision as of 07:44, 25 May 2017
Line 64:		Line 64:
	* Implement ‘NielsenThePlatformDataSource’ delegate by adding the following method. The plugin will call this method to fetch content metadata for the video.<syntaxhighlight lang="objective-c">– (NSDictionary )contentMetadataForClip:(TPClip )clip</syntaxhighlight>Any key value from the content metadata can be set with an exception of ‘length’, ‘type’ and ‘title’. Plugin will call the below method to know about the channel information associated with the video.<syntaxhighlight lang="objective-c">– (NSDictionary )channelInfoForClip:(TPClip )clip</syntaxhighlight>		* Implement ‘NielsenThePlatformDataSource’ delegate by adding the following method. The plugin will call this method to fetch content metadata for the video.<syntaxhighlight lang="objective-c">– (NSDictionary )contentMetadataForClip:(TPClip )clip</syntaxhighlight>Any key value from the content metadata can be set with an exception of ‘length’, ‘type’ and ‘title’. Plugin will call the below method to know about the channel information associated with the video.<syntaxhighlight lang="objective-c">– (NSDictionary )channelInfoForClip:(TPClip )clip</syntaxhighlight>

	Refer to [[Onboarding ~~Process~~]] for more information.		Refer to [[Digital Measurement Onboarding]] for more information.

	== Opt-Out ==		== Opt-Out ==

Admin: /* Initial Configuration */

2017-05-25T07:40:02Z

Initial Configuration

← Older revision		Revision as of 07:40, 25 May 2017
Line 26:		Line 26:

	*'''Nielsen App SDK'''		*'''Nielsen App SDK'''
	** Download the Nielsen App SDK framework from [[Downloads]]		** Download the Nielsen App SDK framework from [[Digital Downloads]]

	* '''Build the Nielsen Plugin and sample app''' from the player application project is accomplished by doing the following:		* '''Build the Nielsen Plugin and sample app''' from the player application project is accomplished by doing the following:

Admin at 19:10, 22 May 2017

2017-05-22T19:10:42Z

← Older revision		Revision as of 19:10, 22 May 2017
Line 50:		Line 50:
	The steps for setting up the Nielsen App SDK Plugin for thePlatform Player are as follows.		The steps for setting up the Nielsen App SDK Plugin for thePlatform Player are as follows.

	~~'''~~Nielsen App SDK Plugin Creation~~'''~~		=== Nielsen App SDK Plugin Creation ===

	The Nielsen App SDK Plugin for thePlatform integrates with thePlatform SDK by listening for events from the player, plugins and emits events for the player. It is also a wrapper for the Nielsen App SDK.		The Nielsen App SDK Plugin for thePlatform integrates with thePlatform SDK by listening for events from the player, plugins and emits events for the player. It is also a wrapper for the Nielsen App SDK.

Admin: /* Initial Configuration */

2017-05-22T19:04:53Z

Initial Configuration

← Older revision		Revision as of 19:04, 22 May 2017
Line 28:		Line 28:
	** Download the Nielsen App SDK framework from [[Downloads]]		** Download the Nielsen App SDK framework from [[Downloads]]

	* ~~Follow the steps below, to build~~ the Nielsen Plugin and sample app from the player application project		* '''Build the Nielsen Plugin and sample app''' from the player application project is accomplished by doing the following:
	** Unzip the NielsenAppSDKPlugin Platform package.		** Unzip the NielsenAppSDKPlugin Platform package.
	** Import the Nielsen Plugin in to the sample app project		** Import the Nielsen Plugin in to the sample app project

Admin: /* Initial Configuration */

2017-05-22T19:00:03Z

Initial Configuration

← Older revision		Revision as of 19:00, 22 May 2017
Line 29:		Line 29:

	* Follow the steps below, to build the Nielsen Plugin and sample app from the player application project		* Follow the steps below, to build the Nielsen Plugin and sample app from the player application project
	* Unzip the NielsenAppSDKPlugin Platform package.		** Unzip the NielsenAppSDKPlugin Platform package.
	* Import the Nielsen Plugin in to the sample app project		** Import the Nielsen Plugin in to the sample app project
	* Import the Platform player SDK if it is not imported previously		** Import the Platform player SDK if it is not imported previously
	* Copy both “NielsenAppApi.Framework” and “thePlatformPlayerSDK.framework” in to NielsenSampleApp project. Make sure frameworks are linked: under Build Phases → Link Binary with Libraries.		** Copy both “NielsenAppApi.Framework” and “thePlatformPlayerSDK.framework” in to NielsenSampleApp project. Make sure frameworks are linked: under Build Phases → Link Binary with Libraries.
	* click ‘+’ sign and add “NielsenAppApi.Framework” and “thePlatformPlayerSDK.framework”.		** click ‘+’ sign and add “NielsenAppApi.Framework” and “thePlatformPlayerSDK.framework”.
	* Build the sample app		** Build the sample app

	=== Initialization with Global Parameters ===		=== Initialization with Global Parameters ===

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital '''Nielsen App SDK Plugin for thePlatform''' interacts with Nielsen App SDK to provide with n..."

2017-05-22T10:00:39Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital '''Nielsen App SDK Plugin for thePlatform''' interacts with Nielsen App SDK to provide with n..."

New page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
'''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.

'''Supported Ad Frameworks'''
* FreeWheel

==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).
* '''For Ad Support''': Google IMA, FreeWheel and OnceUX SDK.
* '''Test Environment Validation''': Before moving the app into production, Nielsen must validate the Plugin’s integration in a test environment.

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

* '''thePlatform Player ADK for iOS'''
** Download thePlatform ADK from thePlatform’s website http://help.theplatform.com/display/adk/ADK+for+iOS+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 framework from [[Downloads]]

* Follow the steps below, to build the Nielsen Plugin and sample app from the player application project
* Unzip the NielsenAppSDKPlugin Platform package.
* Import the Nielsen Plugin in to the sample app project
* Import the Platform player SDK if it is not imported previously
* Copy both “NielsenAppApi.Framework” and “thePlatformPlayerSDK.framework” in to NielsenSampleApp project. Make sure frameworks are linked: under Build Phases → Link Binary with Libraries.
* click ‘+’ sign and add “NielsenAppApi.Framework” and “thePlatformPlayerSDK.framework”.
* Build the sample app

=== Initialization with Global Parameters ===
To initialize the Plugin that initializes the App SDK, pass the global parameters in JSON string format. Some of the global parameters are
* Nielsen App ID (appid)
* appversion
* appname
* sfcode
* dma
* ccode
* CMS Metadata
For more details refer to the Nielsen [[iOS 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 SDK by listening for events from the player, plugins and emits events for the player. It is also a wrapper for the Nielsen App SDK.

* When the player is initialized add import_request_variables<syntaxhighlight lang="objective-c">#import <NielsenThePlatformPlugin/NielsenThePlatformPlugin.h></syntaxhighlight>
* Add property<syntaxhighlight lang="objective-c">@property (nonatomic, strong) NielsenThePlatformPlugin *thePlatformPlugin;</syntaxhighlight>
* Instantiate the plugin and register it with instance of ‘TPPlayerView’<syntaxhighlight lang="objective-c">self.thePlatformPlugin = [[NielsenThePlatformPlugin alloc]
initWithAppInfo:@{@”appid”: @”MY_APP_ID”,
@”appversion”: @”MY_APP_VERSION”,
@”appname”: @”MY_APP_NAME”,
@”sfcode”: @”MY_SFCODE”};
self.thePlatformPlugin.dataSource = self;
[self.player addDelegate:self.thePlatformPlugin];</syntaxhighlight>
* Implement ‘NielsenThePlatformDataSource’ delegate by adding the following method. The plugin will call this method to fetch content metadata for the video.<syntaxhighlight lang="objective-c">– (NSDictionary *)contentMetadataForClip:(TPClip *)clip</syntaxhighlight>Any key value from the content metadata can be set with an exception of ‘length’, ‘type’ and ‘title’. Plugin will call the below method to know about the channel information associated with the video.<syntaxhighlight lang="objective-c">– (NSDictionary *)channelInfoForClip:(TPClip *)clip</syntaxhighlight>

Refer to [[Onboarding Process]] for more information.

== Opt-Out ==
The application needs to provide a way for user to optout of metering. This is done by displaying opt-out page and passing the response from user back to Nielsen. The plugin exposes the ‘NielsenAppApi’ [[userOptOut]] and [[optOutURL]] methods to interact with opt-out page.

== Releases ==
{| class="wikitable"
|-
! Name !! Version # !! Date !! Comments
|-
| Nielsen AppSDK Plugin for thePlatform(FreeWheel) || 1.0.0 || 01/18/2016 || Initial version of the Nielsen App SDK Plugin for thePlatform (iOS) with support for FreeWheel ads.
|-
| Nielsen AppSDK Plugin for thePlatform(FreeWheel) || 1.1.0 || 04/29/2016 || Reflects changes as per latest Nielsen App SDK v5.1.0.5.
|}