DCR Static iOS SDK

From Engineering Client Portal

Engineering Portal breadcrumbArrow.png Digital breadcrumbArrow.png DCR & DTVR breadcrumbArrow.png DCR Static iOS SDK

Prerequisites

To start using the App SDK, the following items are required:

Item Description Source
App ID (appid) Unique ID assigned to the player/site and configured by product. Contact Nielsen
sfcode Environment that the SDK must point to Contact Nielsen
Nielsen SDK Includes SDK libraries and sample implementation; See iOS SDK Release Notes Download

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 guide for more information on how to get a Nielsen App SDK and appid.

Import Library

Refer to 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 Initalization for details on initializing an AppSDK object and the parameters required.

Configure API calls

play

For static <App Measurement> content, play API is not required.

loadMetadata

Use loadMetadata to pass ‘content’ and ‘ad’ Digital Measurement Metadata. The CMS data must be passed as a JSON object.

    loadMetadata(String jsonMetadata)

Refer to loadMetadata for the list of parameters to be passed in the JSON object.

Note: The loadMetadata call must have ("type": "static").

playheadPosition (Content)

For static <App Measurement> content, no playhead has to be supplied to the SDK.

stop

For static <App Measurement> content, stop API is not required.

API Call sequence

Call loadMetadata with JSON metadata as below.

    NSDictionary *metadata = @
    {
        "type": "static",
        "section": "siteSection",
        "segA": "segmentA",
        "segB": "segmentB",
        "segC": "segmentC"
    }

Sdk dataflow.jpg

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 iOS SDK API Reference - iOS Opt-Out Implementation and Nielsen Digital Privacy.

Pre-Certification Checklists

After the application is ready to be sent for Nielsen Certification, please go through the Pre-Certification Checklist and ensure the app behaves as expected, before submitting to Nielsen.

Testing an Implementation - App

See Digital Measurement Testing.