Category:iOS SDK API Reference - Revision history

Admin: Redirected page to iOS SDK API Reference

2017-05-23T07:44:26Z

Redirected page to iOS SDK API Reference

Admin at 01:42, 23 May 2017

2017-05-23T01:42:37Z

← Older revision		Revision as of 01:42, 23 May 2017
Line 423:		Line 423:
	*Method for users to opt-out of Nielsen measurement, any time while using the application		*Method for users to opt-out of Nielsen measurement, any time while using the application

	~~== Event and Error Handling ==~~
	== Event and Error Handling ==		== Event and Error Handling ==
	=== Constants / Enumerations ===		=== Constants / Enumerations ===

Admin: /* Event and Error Handling */

2017-05-23T01:42:09Z

Event and Error Handling

← Older revision		Revision as of 01:42, 23 May 2017
Line 424:		Line 424:

	== Event and Error Handling ==		== Event and Error Handling ==
			== Event and Error Handling ==
			=== Constants / Enumerations ===
			The following are the details of Delegate Implementation:

			<syntaxhighlight lang="objective-c">
			-(void)nielsenAppApi:(NielsenAppApi )appApi eventOccurred:(NSDictionary )event
			{
			NSLog(@"Sample player is Notified by a Event: %@", event);
			}
			– (void)nielsenAppApi:(NielsenAppApi )appApi errorOccurred:(NSDictionary )error
			{
			NSLog(@"Sample player is Notified by an Error: %@", error);
			}
			</syntaxhighlight>

			=== AppApiEventCode ===
			An enumeration with predefined App SDK event state transition codes.
			<syntaxhighlight lang="objective-c">
			typedef NS_ENUM(unsigned int, AppApiEventCode)
			{
			AppApiStartup = 2001,
			AppApiShutdown = 2002,
			}AppApiEventCode;
			</syntaxhighlight>

			=== App SDK Event Codes ===
			{\| class="wikitable"
			\|-
			! Event Code !! Event Name !! Event Description
			\|-
			\| 2001 \|\| AppApiStartup \|\| App SDK has initialized successfully. It will happen only after App SDK has received a valid config file
			\|-
			\| 2002 \|\| AppApiShutdown \|\| App SDK is shutting down. It will happen just before App SDK is destroyed
			\|}

			=== AppApiErrorCode ===
			An enumeration with predefined error codes which the App SDK object can generate.
			<syntaxhighlight lang="objective-c">
			typedef NS_ENUM(unsigned int, AppApiErrorCode)
			{
			AppApiNetworkConnectionFailure = 1001,
			AppApiFileWriteFailure = 1002,
			AppApiFileReadFailure = 1003,
			AppApiEmptyValue = 1004,
			AppApiEmptyAppName = 1005,
			AppApiEmptyAppVersion = 1006,
			AppApiEmptyAppId = 1007,
			AppApiAnExceptionOccured = 1008,
			AppApiUnknownExceptionOccured = 1009
			};
			</syntaxhighlight>

			=== App SDK Error Codes ===
			{\| class="wikitable"
			\|-
			! Event Code !! Event Name !! Event Description
			\|-
			\| 1001 \|\| AppApiNetworkConnectionFailure \|\| App SDK Could not connect to server
			\|-
			\| 1002 \|\| AppApiFileWriteFailure \|\| App SDK Could not write to file
			\|-
			\| 1003 \|\| AppApiFileReadFailure \|\| App SDK Could not read data from file
			\|-
			\| 1004 \|\| AppApiEmptyValue \|\| Empty value Found.
			\|-
			\| 1005 \|\| AppApiEmptyAppName \|\| Cannot initialize SDK Object without an AppName(Player Name)
			\|-
			\| 1006 \|\| AppApiEmptyAppVersion \|\| Cannot initialize API Object without an AppVersion
			\|-
			\| 1007 \|\| AppApiEmptyAppId \|\| Cannot initialize API Object without an AppId
			\|-
			\| 1008 \|\| AppApiAnExceptionOccured \|\| Exception occurred
			\|-
			\| 1009 \|\| AppApiUnknownExceptionOccured \|\| Unknown exception occurred
			\|}

Admin at 01:31, 23 May 2017

2017-05-23T01:31:30Z

← Older revision		Revision as of 01:31, 23 May 2017
Line 417:		Line 417:

	== Nielsen Privacy Requirements ==		== Nielsen Privacy Requirements ==
			Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.
			*Disclosure of viewership data collection in app store description
			*Disclosure of viewership data collection in EULA / Privacy Policy
			*A link in the EULA/Privacy policy, or in another conspicuous location within the App, to a Nielsen-hosted web page outlining what Nielsen is collecting and how it is being used
			*Method for users to opt-out of Nielsen measurement, any time while using the application

	== Event and Error Handling ==		== Event and Error Handling ==

Admin at 01:30, 23 May 2017

2017-05-23T01:30:23Z

@@ Line 399: / Line 399: @@
 == Nielsen Sample Applications ==
 == Nielsen Privacy Requirements ==
 == Event and Error Handling ==

Admin at 01:20, 23 May 2017

2017-05-23T01:20:57Z

Show changes

Admin at 04:42, 21 May 2017

2017-05-21T04:42:55Z

← Older revision		Revision as of 04:42, 21 May 2017
Line 32:		Line 32:
	\| [[appDisableApi]]		\| [[appDisableApi]]
	(kill switch)		(kill switch)
	\|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to ~~enable /~~ disable the SDK.		\|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to disable the SDK.
	\|-		\|-
	\| Log \|\| [[lastErrorDict]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns SDK error in the form of dictionary if any error has occurred.		\| Log \|\| [[lastErrorDict]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns SDK error in the form of dictionary if any error has occurred.

Admin at 04:37, 21 May 2017

2017-05-21T04:37:22Z

← Older revision		Revision as of 04:37, 21 May 2017
Line 17:		Line 17:
	\| Measurement \|\| [[playheadPosition]] \|\| ✘ \|\| ✘ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to send the playhead position.		\| Measurement \|\| [[playheadPosition]] \|\| ✘ \|\| ✘ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to send the playhead position.
	\|-		\|-
	\| Measurement \|\| [[stop]] \|\| ✔ \|\| ✘ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used when ~~content~~ playback is ~~complete. This is triggered 1) at the end of the~~ content ~~stream, 2) if the user switches to another piece of~~ content		\| Measurement \|\| [[stop]] \|\| ✔ \|\| ✘ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used when playback is paused and when switching between ad and content or content and ad.
	\|-		\|-
	\| Measurement \|\| [[end]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used ~~to notify App SDK that~~ the ~~remote OTT device (like Google ChromeCast~~, ~~Roku, Amazon FireTV, etc.~~) ~~is connected / disconnected (change~~ of ~~OTT status).~~		\| Measurement \|\| [[end]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used when content playback is complete. This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content
	\|-		\|-
	\| Measurement \|\| [[updateOTT]] \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✔ \|\| Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).		\| Measurement \|\| [[updateOTT]] \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✘ \|\| ✔ \|\| Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).

Admin at 04:17, 21 May 2017

2017-05-21T04:17:57Z

← Older revision		Revision as of 04:17, 21 May 2017
Line 29:		Line 29:
	\| Opt-out \|\| [[optOutStatus]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Call this API to retrieve the Opt-Out or Opt-In state.		\| Opt-out \|\| [[optOutStatus]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Call this API to retrieve the Opt-Out or Opt-In state.
	\|-		\|-
	\| Opt-out \|\| [[appDisableApi]] (kill switch) \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to enable / disable the SDK.		\| Opt-out
			\| [[appDisableApi]]
			(kill switch)
			\|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to enable / disable the SDK.
	\|-		\|-
	\| Log \|\| [[lastErrorDict]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns SDK error in the form of dictionary if any error has occurred.		\| Log \|\| [[lastErrorDict]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns SDK error in the form of dictionary if any error has occurred.

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital == IOS SDK API Methods & Properties == {| class="wikitable sortable" |- ! Scenario !! Method..."

2017-05-21T04:03:49Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital == IOS SDK API Methods & Properties == {| class="wikitable sortable" |- ! Scenario !! Method..."

New page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== IOS SDK API Methods & Properties ==
{| class="wikitable sortable"
|-
! Scenario !! Method / Property !! DTVR !! DAR !! Digital Audio !! DCR !! International (Germany) !! Description
|-
| Initialize || [[initWithAppInfo:delegate:]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to create a new instance of the SDK object
|-
| Measurement || [[play]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. If this is not called then the “channel name” value populated will be the default value of “defaultChannelName”.
|-
| Measurement || [[loadMetadata]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to send ad or content metadata to the SDK in the form of JSON string. Application constructs a JSON hashmap and calls this API.
|-
| Measurement || [[sendID3]] || ✔ || ✘ || ✘ || ✘ || ✘ || Used to send the ID3 metadata.
|-
| Measurement || [[playheadPosition]] || ✘ || ✘ || ✔ || ✔ || ✔ || Used to send the playhead position.
|-
| Measurement || [[stop]] || ✔ || ✘ || ✔ || ✔ || ✔ || Used when content playback is complete. This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content
|-
| Measurement || [[end]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| Measurement || [[updateOTT]] || ✘ || ✘ || ✘ || ✘ || ✔ || Used to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).
|-
| Opt-out || [[optOutURL]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to fetch the Nielsen opt-out web page URL.
|-
| Opt-out || [[userOptOut]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to supply the response message from opt-out webpage to the SDK.
|-
| Opt-out || [[optOutStatus]] || ✔ || ✔ || ✔ || ✔ || ✔ || Call this API to retrieve the Opt-Out or Opt-In state.
|-
| Opt-out || [[appDisableApi]] (kill switch) || ✔ || ✔ || ✔ || ✔ || ✔ || Used to enable / disable the SDK.
|-
| Log || [[lastErrorDict]] || ✔ || ✔ || ✔ || ✔ || ✔ || Returns SDK error in the form of dictionary if any error has occurred.
|-
| Log || [[lastEventDict]] || ✔ || ✔ || ✔ || ✔ || ✔ || Returns SDK event in the form of dictionary if any event has occurred.
|-
| Log || [[meterVersion]] || ✔ || ✔ || ✔ || ✔ || ✔ || Returns the current SDK version.
|-
| Log || [[nielsenId]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to get a string defining the Nielsen ID (NUID) number for the device.
|-
| Log || [[demographicId]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to retrieve Demographic ID (Device ID) of the current device.
|-
| Log || [[debug]] || ✔ || ✔ || ✔ || ✔ || ✔ || Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
|}

== NielsenAppApi Class Description ==
The NielsenAppApi class is the primary application interface to the Nielsen App SDK. For example, after an instance object of the NielsenAppApi class is created and initialized, it can be used by the calling application to collect HLS timed metadata using the SDK’s [[sendID3]]: method. These are the public methods and properties exposed by the NielsenAppApi class:
<syntaxhighlight lang="objective-c">
@interface NielsenAppApi: NSObject

@property (readonly) BOOL optOutStatus;
@property (assign) BOOL appDisableApi;
@property (assign) BOOL debug;
@property (readonly) NSString *nielsenId;
@property (readonly) NSString *demographicId;
@property (readonly) NSString *optOutURL;
@property (readonly) NSString *meterVersion;
@property (readonly) NSDictionary *lastEventDict;
@property (readonly) NSDictionary *lastErrorDict;

– (instancetype)initWithAppInfo:(id)appInfo delegate:(id)delegate;

– (void)play:(id)channelInfo;
– (void)loadMetadata:(id)metadata;
– (void)stop;
– (void)end;
– (void)playheadPosition:(long long)playheadPos;
– (void)sendID3:(NSString *)data;
– (void)updateOTT:(id)ottInfo;
– (BOOL)userOptOut:(NSString *)optOut;

– (NSString *)getNielsenId _attribute((deprecated((“Please use nielsenId property instead.”))));
– (NSString *)optOutURLString _attribute((deprecated((“Please use optOutURL property instead.”))));
– (NSString *)getMeterVersion _attribute((deprecated((“Please use meterVersion property instead.”))));
– (NSDictionary *)getLastEventDict _attribute((deprecated((“Please use lastEventDict property instead.”))));
– (NSDictionary *)getLastErrorDict _attribute((deprecated((“Please use lastErrorDict property instead.”))));

@protocol NielsenAppApiDelegate<NSObject>

@optional
– (void)nielsenAppApi:(NielsenAppApi *)appApi eventOccurred:(NSDictionary *)event;
– (void)nielsenAppApi:(NielsenAppApi *)appApi errorOccurred:(NSDictionary *)error;

@end
</syntaxhighlight>