iOS SDK API Table

iOS SDK API Methods & Properties Table

Scenario	Method / Property	DTVR	DAR	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 playback is paused and when switching between ad and content or content and ad.
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	staticEnd			✔	✔	Used with DCR Static duration in between loadMetadata calls for static content when section name is the same but a new static view event and duration measurement restart is desired
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 disable the SDK.
Viewability Audibility	trackViewability	✔		✔	✔	Used to start the viewability measurement.
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)