AVPlayer Plugin iOS - Revision history

Admin at 21:52, 20 October 2017

2017-10-20T21:52:49Z

← Older revision		Revision as of 21:52, 20 October 2017
Line 10:		Line 10:
	\|SDKVersion=5.1.0.5		\|SDKVersion=5.1.0.5
	\|supportedAdFrameworks=FreeWheel and Google IMA		\|supportedAdFrameworks=FreeWheel and Google IMA
			\|downloadLink=https://engineeringportal.nielsen.com/w/downloads/digital/plugins/native/avplayer/Nielsen-App-SDK-Native-Plugin-iOS-1.0.0.zip
	}}		}}

Admin at 21:07, 31 August 2017

2017-08-31T21:07:35Z

← Older revision		Revision as of 21:07, 31 August 2017
Line 5:		Line 5:

	{{PluginInfobox		{{PluginInfobox
	\|pluginImage=~~thePlatformIcon~~		\|pluginImage=AppleLogoIcon
	\|osImage=macOSIcon		\|osImage=macOSIcon
	\|playerVersion=Xcode 8.2.1		\|playerVersion=Xcode 8.2.1

Admin at 21:04, 31 August 2017

2017-08-31T21:04:18Z

← Older revision		Revision as of 21:04, 31 August 2017
Line 4:		Line 4:
	'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.		'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.

	~~'''Supported Ad Frameworks'''~~		{{PluginInfobox
	* FreeWheel		\|pluginImage=thePlatformIcon
	* Google IMA		\|osImage=macOSIcon
			\|playerVersion=Xcode 8.2.1
			\|SDKVersion=5.1.0.5
			\|supportedAdFrameworks=FreeWheel and Google IMA
			}}

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

Admin at 07:48, 25 May 2017

2017-05-25T07:48:10Z

← Older revision		Revision as of 07:48, 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 Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.		'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.

Admin at 07:42, 25 May 2017

2017-05-25T07:42:01Z

← Older revision		Revision as of 07:42, 25 May 2017
Line 71:		Line 71:
	Plugin calls this method to fetch content metadata for the video.		Plugin calls this method to fetch content metadata for the video.

	Refer to the [[Onboarding ~~Process~~]] in the Nielsen SDK Documentation on the exact format of this dictionary. Set any key-value pair from the content metadata with an exception of ‘length’, ‘type’ and ‘title’, which are pre-set already.		Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation on the exact format of this dictionary. Set any key-value pair from the content metadata with an exception of ‘length’, ‘type’ and ‘title’, which are pre-set already.

	Add the following line of code (optional):		Add the following line of code (optional):
Line 78:		Line 78:
	Plugin calls this method to request for channel information associated with the video.		Plugin calls this method to request for channel information associated with the video.

	Refer to the [[Onboarding ~~Process~~]] in the Nielsen SDK Documentation on the exact format of this dictionary.		Refer to the [[Digital Measurement Onboarding ]] in the Nielsen SDK Documentation on the exact format of this dictionary.

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

Admin at 07:41, 25 May 2017

2017-05-25T07:41:10Z

← Older revision		Revision as of 07:41, 25 May 2017
Line 12:		Line 12:
	* '''Nielsen App ID (appid)''': A unique ID that Nielsen assigns to the site / player.		* '''Nielsen App ID (appid)''': A unique ID that Nielsen assigns to the site / player.
	* '''Nielsen App SDK Plugin''': The download link for the Plugin Packages are provided with the Nielsen appid(s).		* '''Nielsen App SDK Plugin''': The download link for the Plugin Packages are provided with the Nielsen appid(s).
	* '''Nielsen App SDK''': Please see [[Downloads]] for the latest Nielsen App SDK.		* '''Nielsen App SDK''': Please see [[Digital Downloads]] for the latest Nielsen App SDK.
	* '''Test Environment Validation''': Before moving the app into production, Nielsen must validate the Plugin’s integration in a test environment.		* '''Test Environment Validation''': Before moving the app into production, Nielsen must validate the Plugin’s integration in a test environment.

Admin at 21:11, 22 May 2017

2017-05-22T21:11:50Z

← Older revision		Revision as of 21:11, 22 May 2017
Line 1:		Line 1:
			{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{CurrentBreadcrumb}}
			[[Category:Digital]]
	'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.		'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.

Admin: Created page with "'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform. '''Supported Ad Frameworks''' * FreeWheel * Google IMA ==Plugi..."

2017-05-22T21:11:04Z

Created page with "'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform. '''Supported Ad Frameworks''' * FreeWheel * Google IMA ==Plugi..."

New page

'''Nielsen App SDK Plugin for Native Player''' brings Nielsen metering in to AVPlayer player for iOS platform.

'''Supported Ad Frameworks'''
* FreeWheel
* Google IMA

==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''': The download link for the Plugin Packages are provided with the Nielsen appid(s).
* '''Nielsen App SDK''': Please see [[Downloads]] for the latest Nielsen App 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:

*'''Nielsen Plugin Package''', which includes:
** Plugin Implementation Guide (this document)
** The Nielsen App SDK Plugin for Native AVPlayer source code and
** The sample application source code which supports FreeWheel and Google IMA ad Plugin.

=== 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 ==

=== Nielsen App SDK Plugin Package Installation ===
==== For FreeWheel ad support ====
* Unzip the NielsenAVPLayerPluginForiOS.zip.
* Copy “NielsenAppApi.Framework” to the NielsenAVPLayerPluginForiOS/NielsenSampleApp folder.
* Import AVFoundation framework to the NielsenAVPLayerPluginForiOS/NielsenSampleApp folder
* The FreeWheel SDK is not included in this pod. The FreeWheel SDK AdManager.framework must be added manually to the project. The pod will however add all the libraries required by AdManager.framework.
* Drag and drop both “NielsenAppApi.Framework” and “AVPLayerPlugin” to NielsenSampleApp project. Make sure frameworks are linked under Build Phases → Link Binary with Libraries.
* Click ‘+’ sign and add “NielsenAppApiFramework” and “AdManagerSupport.framework”.
* Build the app within the plugin.

==== For Google IMA ad support ====
* Unzip the NielsenAVPLayerPluginForiOS.zip and import the AVPLayer Plugin folder.
* Copy “NielsenAppApi.Framework” to the project or sample app.
* Download IMA iOS SDK from Google webpage (https://developers.google.com/interactive-media-ads/docs/sdks/ios/download). The plugin has been tested with version 3.
* Copy “GoogleInteractiveMediaAds.framework” to the “NielsenAVPLayerPluginForiOS/NielsenSampleAppGoogleIMA” folder
* Copy “AVFoundation framework” to the “NielsenAVPLayerPluginForiOS” folder
* Drag and drop “NielsenAppApi.Framework”, “AVPLayerPlugin” and “GoogleInteractiveMediaAds.framework” to NielsenSampleApp project. Make sure frameworks are linked under Build Phases → Link Binary with Libraries.
* Click ‘+’ sign and add “NielsenAppApi.Framework” and “GoogleInteractiveMediaAds.framework”.
* Build the app within the plugin.

=== Nielsen App SDK Plugin Creation ===
The Nielsen App SDK Plugin for AVPLayer integrates with the AVPLayer SDK by listening for and emitting events. It listens to events from the player and from other plugins and emits events for the player. It is also a wrapper for the Nielsen App SDK. It is registered with the Brightcove SDK when it is instantiated by the application.

Perform the following in the app view controller, where the player is initialized.
* Import plugin<syntaxhighlight lang="objective-c">#import <NielsenAVPLayerPlugin/NielsenAVPLayerPlugin.h></syntaxhighlight>
* Add property<syntaxhighlight lang="objective-c">@property (nonatomic, strong) NielsenAVPLayerPlugin *avPLayerPlugin;</syntaxhighlight>Instantiate the plugin and register it with an instance of ‘AVPLayerPlaybackController’ based on the app information provided by Nielsen.<syntaxhighlight lang="objective-c">self.avPLayerPlugin = [[NielsenAVPLayerPlugin alloc]
initWithAppInfo:@{@”appid”: @”MY_APP_ID”,
@”appversion”: @”MY_APP_VERSION”,
@”appname”: @”MY_APP_NAME”,
@”sfcode”: @”MY_SFCODE”};</syntaxhighlight>
* Implement ‘NielsenAVPLayerDataSource’ delegate by adding the methods mentioned below:<syntaxhighlight lang="objective-c">-(NSDictionary*)contentMetadataForPlayerItem:(AVPlayerItem *)playerItem;
-(NSMutableDictionary *)adMetadata;</syntaxhighlight>

Plugin calls this method to fetch content metadata for the video.

Refer to the [[Onboarding Process]] in the Nielsen SDK Documentation on the exact format of this dictionary. Set any key-value pair from the content metadata with an exception of ‘length’, ‘type’ and ‘title’, which are pre-set already.

Add the following line of code (optional):
<syntaxhighlight lang="objective-c">– (NSDictionary*)channelInfoForPlayerItem:(AVPlayerItem *)playerItem;</syntaxhighlight>

Plugin calls this method to request for channel information associated with the video.

Refer to the [[Onboarding Process]] in the Nielsen SDK Documentation on the exact format of this dictionary.

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

=== SampleApp ===
Check NielsenAVPLayerSampleApp to know about the usage of plugin and the Opt-Out page.

== Releases ==
{| class="wikitable"
|-
! Name !! Version # !! Date !! Comments
|-
| Nielsen AppSDK Plugin for AVPLayer (FreeWheel & Google IMA) || 1.0.0 || 07/16/2016 || Initial version of the Nielsen App SDK Plugin for AVPLayer (iOS) with Nielsen App SDK version v5.1.0.5 and support for FreeWheel & Google IMA ads.
|}