diff --git a/libs/NielsenAppApi.framework/Headers/NielsenAppApi.h b/libs/NielsenAppApi.framework/Headers/NielsenAppApi.h index 0de9277a43d7dd28fc051446259017a83192d997..8ce303442b608973bd05bf9d2aa4e06771c893bc 100644 --- a/libs/NielsenAppApi.framework/Headers/NielsenAppApi.h +++ b/libs/NielsenAppApi.framework/Headers/NielsenAppApi.h @@ -44,9 +44,9 @@ @property (assign) BOOL debug; /** - Retrieve Nielsen ID for user opt-in or opt-out purpose. + Deprecated. NielsenId is not used by the SDK anymore */ -@property (readonly) NSString *nielsenId; +@property (readonly) NSString *nielsenId __attribute((deprecated(("nielsenId is not used by the SDK anymore")))); /** Retrieve Demographic ID @@ -87,12 +87,9 @@ - (instancetype)initWithAppInfo:(id)appInfo delegate:(id)delegate; /** - Retrieve Nielsen ID for user opt-in or opt-out purpose. - - Deprecated. Will be removed in future release. - Please use nielsenId property instead + Deprecated. NielsenId is not used by the SDK anymore */ -- (NSString *)getNielsenId __attribute((deprecated(("Please use nielsenId property instead.")))); +- (NSString *)getNielsenId __attribute((deprecated(("nielsenId is not used by the SDK anymore")))); /** Start playing a content. diff --git a/libs/NielsenAppApi.framework/Headers/NielsenEventTracker.h b/libs/NielsenAppApi.framework/Headers/NielsenEventTracker.h new file mode 100644 index 0000000000000000000000000000000000000000..c97a48b7773bd3b5412216199fc7e8d461ac0894 --- /dev/null +++ b/libs/NielsenAppApi.framework/Headers/NielsenEventTracker.h @@ -0,0 +1,177 @@ +/** +* App SDK Application +* +* Copyright (C) 2016, The Nielsen Company (US) LLC. All Rights Reserved. +* +* Software contains the Confidential Information of Nielsen and is subject to your relevant agreements with Nielsen. +* +* remarks: +* New enhanced SDK API +*/ + +#import +#import +#import + +/** + TrackEvent API parameters + JSON dict possible keys + */ + +#define TrackEventParamEvent @"event" +#define TrackEventParamType @"type" +#define TrackEventParamMetadata @"metadata" +#define TrackEventParamPlayheadPosition @"playheadPosition" +#define TrackEventParamId3Data @"id3Data" +#define TrackEventParamOttData @"ottData" +#define TrackEventParamOptout @"optout" +#define TrackEventParamBuffering @"buffering" +#define TrackEventParamButtonEvent @"buttonEvent" + +/** + TrackEvent API parameters + Event possible values + */ + +#define TrackEventParamEventPlayhead @"playhead" +#define TrackEventParamEventPause @"pause" +#define TrackEventParamEventComplete @"complete" +#define TrackEventParamEventAdStop @"adStop" + +/** + TrackEvent API parameters + Parameter type possible values + */ + +#define TrackEventParamTypeContent @"content" +#define TrackEventParamTypeAd @"ad" +#define TrackEventParamTypeStatic @"static" + +/** + TrackEvent API parameters + Possible metadata types + */ + +#define TrackEventParamMetadataContent @"content" +#define TrackEventParamMetadataAd @"ad" +#define TrackEventParamMetadataStatic @"static" +#define TrackEventParamMetadataAssetId @"assetId" + +/** + TrackEvent API parameters + Ad metadata types + */ + +#define TrackEventParamMetadataAdType @"type" +#define TrackEventParamAdTypePreroll @"preroll" +#define TrackEventParamAdTypeMidroll @"midroll" +#define TrackEventParamAdTypePostroll @"postroll" + +/** + TrackEvent API parameters + Button event possible values + */ + +#define TrackEventParamButtonPlay @"play" +#define TrackEventParamButtonPause @"pause" +#define TrackEventParamButtonResume @"resume" +#define TrackEventParamButtonStop @"stop" +#define TrackEventParamButtonForward @"forward" +#define TrackEventParamButtonRewind @"rewind" + +/** + Nielsen optout web view close command + */ + +#define kNielsenWebClose @"nielsen://close" + +@protocol NielsenEventTrackerDelegate; + +@interface NielsenEventTracker : NSObject + +/* + Queries the Nielsen App Api version information. + @returns whether user has opted out or not. +*/ +@property (readonly) BOOL optOutStatus; + +/** + Enable / Disable metering for the app. + Check the current disable status + */ +@property (assign) BOOL appDisableApi; + +/** + Enable / Disable logs for the app. + Check the current logging status + */ +@property (assign) BOOL debug; + +/** + Deprecated. NielsenId is not used by the SDK anymore + */ +@property (readonly) NSString *nielsenId __attribute((deprecated(("nielsenId is not used by the SDK anymore")))); + +/** + Retrieve Demographic ID + */ +@property (readonly) NSString *demographicId; + +/** + Get the URL of the web page that is used for giving user a chance to + opt out from the Nielsen measurements. + */ +@property (readonly) NSString *optOutURL; + +/** + Queries the Nielsen App Api version information. + @returns NSString containing the version details. + */ +@property (readonly) NSString *meterVersion; + +/** + Queries the Nielsen App Api framework for the last event that occurred. + @returns an NSDictionary object with the event information: + */ +@property (readonly) NSDictionary *lastEventDict; + +/** + Queries the Nielsen App Api framework for the last error that occurred. + @returns an NSDictionary object with the error information: + */ +@property (readonly) NSDictionary *lastErrorDict; + +/** + Initializes the ID3Meter metering framework. + @param appInfo - a JSON formatted NSString object or NSDictionary object that includes identifications of the app. Check documentation for proper key naming and values. + @param delegate - object of a class that implements NielsenEventTrackerDelegate protocol + @returns returns (id) pointer to object of a Meter object; nil if error occurred. + */ +- (instancetype)initWithAppInfo:(id)appInfo delegate:(id)delegate; + +/** + Main SDK API method for integration + @param data - NSDictionary object that includes all the parameters required for reporting player updates to the SDK. Check documentation for proper key naming and values. + */ +- (void)trackEvent:(NSDictionary *)data; + +@end + +@protocol NielsenEventTrackerDelegate + +@optional + +/** + Notifies about the last event that occurred in the Nielsen App Api framework. + Provides a NSDictionary object with the event information. + */ +- (void)nielsenEventTracker:(NielsenEventTracker *)api eventOccurred:(NSDictionary *)event; + +/** + Notifies about the last error that occurred in the Nielsen App Api framework. + Provides a NSDictionary object with the error information. + */ +- (void)nielsenEventTracker:(NielsenEventTracker *)api errorOccurred:(NSDictionary *)error; + +@end + diff --git a/libs/NielsenAppApi.framework/Modules/module.modulemap b/libs/NielsenAppApi.framework/Modules/module.modulemap index acef9e7983b6b2f53a3c2ddd22c29af821c8faab..71496bdec7d7236359bd8883ca7a052a29d87c15 100644 --- a/libs/NielsenAppApi.framework/Modules/module.modulemap +++ b/libs/NielsenAppApi.framework/Modules/module.modulemap @@ -1,5 +1,5 @@ framework module NielsenAppApi { - umbrella header "NielsenAppApi.h" + header "NielsenEventTracker.h" + header "NielsenAppApi.h" export * - module * { export * } } diff --git a/libs/NielsenAppApi.framework/NielsenAppApi b/libs/NielsenAppApi.framework/NielsenAppApi index 4952e2d4a980f3222e34b93319b90ef50e317ebe..55811a47357e54a395bcba58d1a0c14fe725a772 100644 Binary files a/libs/NielsenAppApi.framework/NielsenAppApi and b/libs/NielsenAppApi.framework/NielsenAppApi differ diff --git a/libs/NielsenAppApi.framework/Resources/Info.plist b/libs/NielsenAppApi.framework/Resources/Info.plist index baf09d110cdc332d00034260790cd998ae685180..27779db6aef5c6bc621beecd654eb11be1f2ca52 100644 Binary files a/libs/NielsenAppApi.framework/Resources/Info.plist and b/libs/NielsenAppApi.framework/Resources/Info.plist differ diff --git a/libs/appsdk.jar b/libs/appsdk.jar index fc4cdda551641597b6f901c504c3b74ad2476ef8..86aedb4d6c378b9e5b2d55d36c1c681727e856be 100755 Binary files a/libs/appsdk.jar and b/libs/appsdk.jar differ diff --git a/plugin.xml b/plugin.xml index 22fcb17f12ad44a3d79609be467bbb198be4d340..554dcd79a1f2d5986a893c7a913a04df79b2ac9d 100644 --- a/plugin.xml +++ b/plugin.xml @@ -1,5 +1,5 @@ - + NielsenPlugin @@ -28,9 +28,12 @@ - + + + +