View source for DTVR iOS SDK

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital in TV Ratings}}  {{CurrentBreadcrumb}}
[[Category:Digital]]

== Prerequisites ==
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK''' and '''Sample Player''': A part of the downloaded package
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] for more information on how to get a Nielsen App SDK and appid.

== Import Library ==
Refer to [[iOS SDK API Reference#Importing Frameworks|Importing Frameworks]] for information on importing libraries.
* The latest version of App SDK allows instantiating multiple instances of App SDK object and can be used simultaneously without any issues.

== Initialize SDK ==
Initialize App SDK as soon as the application is launched. Refer to [[iOS SDK API Reference#Initialization|Initialization]] for details on initializing an AppSDK object and the parameters required.

== Configure and fire API calls ==
=== Configure API calls - play ===
Use [[play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
* <code>channelName</code> is a 32-character free-form text field containing the name of the program or feed being sent (such as ESPN2, Food Network, etc.)
Call [[play]] with <code>channelName</code> JSON as below.
<syntaxhighlight lang="json">    {
      "channelName": "TheMovieTitle"
    }</syntaxhighlight>

=== Configure API calls - loadMetadata ===
Use [[loadMetadata]] to pass ‘content’ and ‘ad’ [[DTVR Metadata]]. The CMS data must be passed as a JSON object.
<syntaxhighlight lang="swift">    – (void) loadMetadata :(id)metadata;</syntaxhighlight>
Refer to [[loadMetadata]] for the list of parameters to be passed in the JSON object.
Call [[loadMetadata]] after the first play call. Call [[loadMetadata]] with JSON metadata for the active content as below.
<syntaxhighlight lang="json">    {
      "adModel": "1"
    }</syntaxhighlight>

=== Configure API calls - sendID3 ===
[[sendID3]] API is a receiver for HLS timed metadata events (ID3 tags) provided through iOS’s NSNotificationCenter notification system. This API filters out Nielsen-specific ID3 tags from the system and buffers the data for transfer to Nielsen’s collection facility.
'''Sample ID3 tags'''
* www.nielsen.com/<wbr />X100zdCIGeIlgZnkYj6UvQ==/<wbr />X100zdCIGeIlgZnkYj6UvQ==/<wbr />AAAB2Jz2<wbr />_k74GXSzx4npHuI<wbr />_JwJd3QSUpW30rDkGTcbHEzIMWleCzM<wbr />-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI<wbr />-lL1fXTTN0IgZ4iWBmeRiPpS9<wbr />AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=<wbr />/00000/00000/00
* www.nielsen.com<wbr />/X100zdCIGeIlgZnkYj6UvQ==<wbr />/R8WHe7pEBeqBhu8jTeXydg==<wbr />/AAICoyitYqlxT7n6aZ0oMCGheFi4CXFp46AMUPZz1lMr<wbr />_M9tr3<wbr />_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs<wbr />_J0R25IHpvOc1HS8QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=<wbr />/00000/46016/00
Refer to [[iOS SDK API Reference#Retrieving ID3 Tags|Retrieving ID3 Tags]] section to know more details.

===Configure API calls - stop ===
Call [[stop]] in case of interruptions during playback like flight mode, Wi-Fi toggle, etc. Call [[play]] when resuming the stream / starting the new stream.

===Configure API calls - end ===
Call [[end]] only at the end of playback.

== Interruptions during playback ==
As part of integrating Nielsen App SDK with the player application, the Audio / Video app developer needs to handle the following possible interruption scenarios:
* Pause / Play
* Network Loss (Wi-Fi / Airplane / Cellular)
* Call Interrupt (SIM or Third party Skype / Hangout call)
* Alarm Interrupt
* Content Buffering
* Device Lock / Unlock (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call [[stop]] immediately (except when content is buffering) and withhold sending playhead position.
* Start sending pings – [[loadMetadata]] and [[sendID3]] for the new viewing session, once the playback resumes.
Please see the [[Digital FAQ]] for more details

== Nielsen Measurement Opt-Out Implementation ==
As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. Our digital measurement products are not used to identify the consumer in any way, but they help us and our clients measure and analyze how consumers engage with media across online, mobile and emerging technologies, and offer insights into consumer behavior.
* When the app user wants to opt in or opt out of Nielsen measurement, a new dynamic page (with content string obtained from [[optOutURL]]) should be displayed.
* Use [[optOutStatus]] to retrieve the device’s Opt-Out status.
* This Opt-out page should be displayed in a webview (within the app) and not in any external browser.
* Capture the user’s selection in this page and pass it to the SDK through [[userOptOut]] for Nielsen to save the user’s preference.
* For more details, refer to [[Opt-Out Implementation]] and Nielsen Digital Privacy.
For TVOS-based measurement, see [[TVOS Opt-Out]].

== Testing an Implementation - App ==
[[Testing App Implementation | Click here]] for information on Testing the App Implementation.