iOS SDK API Reference - Revision history

NickParrucci: /* Privacy Protections */

2023-04-04T18:38:25Z

Privacy Protections

← Older revision		Revision as of 18:38, 4 April 2023
Line 514:		Line 514:
	=== Privacy Protections ===		=== Privacy Protections ===
	Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.		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		*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		*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

NickParrucci: /* IOS SDK API Methods & Properties */

2023-03-30T21:09:34Z

IOS SDK API Methods & Properties

← Older revision		Revision as of 21:09, 30 March 2023
Line 284:		Line 284:
	\|-		\|-
	\| 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 \|\| [[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).		\| 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).

NickParrucci: /* Opt-out wording */

2023-02-23T20:30:14Z

Opt-out wording

← Older revision		Revision as of 20:30, 23 February 2023
Line 629:		Line 629:
	Nielsen believes that you should have a choice about whether to contribute to our research and insights. To opt out of Nielsen measurement on this device, you need only to activate the “Limit Ad Tracking” option in your device's settings. If you have this app on more than one mobile device, you will need to change the settings on each device.		Nielsen believes that you should have a choice about whether to contribute to our research and insights. To opt out of Nielsen measurement on this device, you need only to activate the “Limit Ad Tracking” option in your device's settings. If you have this app on more than one mobile device, you will need to change the settings on each device.
	If, after you have opted out, you change your mind and would like to opt back in, please deactivate the “Limit Ad Tracking” option in your device's settings.		If, after you have opted out, you change your mind and would like to opt back in, please deactivate the “Limit Ad Tracking” option in your device's settings.
	To learn more about our digital measurement products and your choices in regard to them, please visit ~~http~~://www.nielsen.com/digitaIprivacy.</blockquote>		To learn more about our digital measurement products and your choices in regard to them, please visit https://www.nielsen.com/digitaIprivacy.</blockquote>

	Users need to toggle the “Limit Ad Tracking” option in order to Opt-In / Opt-Out of Nielsen Measurement.		Users need to toggle the “Limit Ad Tracking” option in order to Opt-In / Opt-Out of Nielsen Measurement.

NickParrucci at 20:17, 5 October 2022

2022-10-05T20:17:12Z

Show changes

ColinBrown: /* Nielsen Privacy Requirements */

2020-10-07T22:14:12Z

Nielsen Privacy Requirements

@@ Line 486: / Line 486: @@
 **Channels starting from 3 are configured in specific JSON file. URLs to this JSON config file can be changed from the Settings application.
-== Nielsen Privacy Requirements ==
+{{Template:iOS_Privacy_and_Opt-Out}}
 === Privacy Protections ===

ColinBrown: /* Nielsen Privacy Requirements */

2020-10-02T20:22:05Z

Nielsen Privacy Requirements

@@ Line 488: / Line 488: @@
 == Nielsen Privacy Requirements ==
 There are three primary methods for implementing user Opt-out preferences:
-# [[Template:iOS_Privacy_and_Opt-Out#OS-level_Opt-out|OS-level Opt-out]] - managed by ''Limit Ad Tracking'' setting on device ('''preferred approach''').
+# '''[[#OS-level_Opt-out|OS-level Opt-out]]''' - managed by ''AppTracking'' or ''Limit Ad Tracking'' setting on device ('''preferred approach''').
 # [[Template:iOS_Privacy_and_Opt-Out#Legacy_Opt-out|Legacy Opt-out]] - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)
 # [[iOS SDK App Level Opt Out|App Level Opt-Out]] - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged
 === Privacy Protections ===
 Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.

ColinBrown: /* Nielsen Privacy Requirements */

2019-12-04T20:47:24Z

Nielsen Privacy Requirements

← Older revision		Revision as of 20:47, 4 December 2019
Line 490:		Line 490:
	# [[Template:iOS_Privacy_and_Opt-Out#OS-level_Opt-out\|OS-level Opt-out]] - managed by ''Limit Ad Tracking'' setting on device ('''preferred approach''').		# [[Template:iOS_Privacy_and_Opt-Out#OS-level_Opt-out\|OS-level Opt-out]] - managed by ''Limit Ad Tracking'' setting on device ('''preferred approach''').
	# [[Template:iOS_Privacy_and_Opt-Out#Legacy_Opt-out\|Legacy Opt-out]] - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)		# [[Template:iOS_Privacy_and_Opt-Out#Legacy_Opt-out\|Legacy Opt-out]] - Direct call to SDK; used only for older versions of Nielsen iOS SDK (< 5.1.1.18)
	# [[~~Template:iOS_Privacy_and_Opt-~~Out~~#App_Level_Opt_Out~~\|App Level Opt-Out]] - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged		# [[iOS SDK App Level Opt Out\|App Level Opt-Out]] - Where [https://developer.apple.com/documentation/adsupport Ad Framework] cannot be leveraged
	=== Privacy Protections ===		=== Privacy Protections ===
	Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.		Privacy protections that Nielsen ensures to have with each App SDK integration are as follows.

ColinBrown at 20:38, 4 December 2019

2019-12-04T20:38:54Z

← Older revision		Revision as of 20:38, 4 December 2019
Line 617:		Line 617:

	<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>		<blockquote>'''Note:''' For API Version 5.1 and above, App SDK will fire data pings and continue measurement even after the user has opted out from Nielsen measurement on a device. The data ping will be marked as opted-out ping.</blockquote>

			=== App Level Opt Out ===
			This is only used if the Ad Framework is not available. The Opt-Out occurs by opening a Nielsen-defined web page and passing the user choice from the 'WebView'. In order to do this, the application needs to:
			* Implement the UIWebView delegate method to open the Nielsen Privacy web page
			* Capture user's selection
			* Pass the selection back to the SDK via the <code>userOptOut</code>.

			==== Capture and forward user selection ====
			{{ExampleCode\|
			\|Objective C = <syntaxhighlight lang="objective-c">
			-(BOOL)webView:(UIWebView )webView shouldStartLoadWithRequest:(NSURLRequest )request navigationType:(UIWebViewNavigationType)navigationType
			{
			NSString *command = [NSString stringWithFormat:@"%@",request.URL];
			if ([command isEqualToString:kNielsenWebClose]) {
			// Close the WebView
			[self performSelector:@selector(closeOptOutView) withObject:nil afterDelay:0];
			return NO;
			}
			// Retrieve next URL if it’s not opt-in/out selection
			return (![nAppApiObject userOptOut:command]);
			}</syntaxhighlight>
			*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
			**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
			<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>
			\|Swift = <syntaxhighlight lang="swift">
			func webView(webView: UIWebView, shouldStartLoadWithRequest request: NSURLRequest, navigationType: UIWebViewNavigationType) -> Bool {

			let command = request.url?.absoluteString
			if command == "kNielsenWebClose"{

			self.perform(#selector(closeOptOutView), with: nil, afterDelay: 0)

			return false
			}
			return NielsenAppApi.optOutURL
			}

			</syntaxhighlight>
			*The app gets the user selection string via webviews shouldStartLoadWithRequest and invokes <code>userOptOut</code> with user selection. The delegate method handles the 'WebView' URL requests, interprets the commands, and calls the SDK accordingly.
			**<code>[nAppApiObject userOptOut:command]</code> passes the user's selection on Nielsen Privacy page to the SDK to allow the SDK to perform the required functions.
			<blockquote>'''Note:''' When 'WebView' is closed, pass the status returned from 'WebView' to the SDK within the app. The App SDK manages the user's choice (Opt-Out / Opt-In), the app does not need to manage this status.</blockquote>
			}}

Admin: /* IOS SDK API Methods & Properties */

2019-06-11T14:39:01Z

IOS SDK API Methods & Properties

ColinBrown at 18:28, 31 May 2019

2019-05-31T18:28:53Z

← Older revision		Revision as of 18:28, 31 May 2019
Line 107:		Line 107:
	** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.		** All the Variable Names like appid, appname, sfcode, dataSrc, title, type etc. are case-sensitive. Use the correct variable name as specified in the documentation.
	* JSON string can be prepared using either raw NSString or serialized NSDictionary.		* JSON string can be prepared using either raw NSString or serialized NSDictionary.
	The below is a sample - detailed information on the metadata requirements are located in either the [[DCR Video iOS SDK\|DCR Implementation Guide,]] or the [[DTVR iOS SDK\|DTVR Implementation Guide]]		The below is a sample - detailed information on the '''metadata requirements''' are located in either the [[DCR Video iOS SDK\|DCR Implementation Guide,]] or the [[DTVR iOS SDK\|DTVR Implementation Guide]]
	{{ExampleCode\|		{{ExampleCode\|
	\|Swift =		\|Swift =

← Older revision		Revision as of 14:39, 11 June 2019
Line 269:		Line 269:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	\|-		\|-
	! Scenario !! Method / Property !! DTVR !! DAR ~~!! Digital Audio~~ !! DCR !! International (Germany) !! Description		! Scenario !! Method / Property !! DTVR !! DAR !! DCR !! International (Germany) !! Description
	\|-		\|-
	\| Initialize \|\| [[initWithAppInfo:delegate:]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to create a new instance of the SDK object		\| 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 \|\| [[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 \|\| [[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 \|\| [[sendID3]] \|\| ✔ \|\| \|\| \|\| \|\| Used to send the ID3 metadata.
	\|-		\|-
	\| Measurement \|\| [[playheadPosition]] \|\| \|\| ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| Used to send the playhead position.		\| 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 \|\| [[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 \|\| [[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).
	\|-		\|-
	\| Opt-out \|\| [[optOutURL]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to fetch the Nielsen opt-out web page URL.		\| 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 \|\| [[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 \|\| [[optOutStatus]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Call this API to retrieve the Opt-Out or Opt-In state.
	\|-		\|-
	\| Opt-out		\| Opt-out
	\| [[appDisableApi]]		\| [[appDisableApi]]
	(kill switch)		(kill switch)
	~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to 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.
	\|-		\|-
	\| Log \|\| [[lastEventDict]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns SDK event in the form of dictionary if any event 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 \|\| [[meterVersion]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Returns the current SDK version.
	\|-		\|-
	\| Log \|\| [[nielsenId]] ~~\|\| ✔~~ \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to get a string defining the Nielsen ID (NUID) number for the device.		\| 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 \|\| [[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)		\| Log \|\| [[debug]] \|\| ✔ \|\| ✔ \|\| ✔ \|\| ✔ \|\| Used to enable/disable debug flags. Newly introduced in SDK version 5.0.0 for International (Germany)
	\|}		\|}