View source for DCR Sweden Video Cloud API

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

= DCR Integration Utilizing Cloud API =
This guide shows you how to integrate the Nielsen Cloud API to enable Digital Content Ratings (DCR), and fuel other measurement products on your over-the-top (OTT) Apps.
__TOC__
==Prerequisites==
To get started, you will need a Nielsen App ID. The App ID is a unique ID assigned to your app. This will be provided to you by your assigned Technical Account Manager upon starting the integration.

{| class="wikitable"
|-
! style="width: 15%;" | Item
! Description
! Source
|-style="background-color:#d0f6f8;"
 || '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Provided by Nielsen
|}

==Integration==
We will cover the steps for constructing the Cloud API Calls.

====URL Structure====

The Cloud API Calls are HTTP GET Requests with the URL structure:

<syntaxhighlight lang="javascript">[endpoint]/[appid]/[sessionID]/a?b=[payload]</syntaxhighlight>

The URL includes the following components:

*<code>[endpoint]</code>: location of data collection environment
*<code>[appid]</code>: provided App ID
*<code>[sessionID]</code>: unique value for each user session
*<code>[payload]</code>: metadata and events

====Endpoint====

There are endpoints for testing and production:

*Testing: <code>https://sc-eucert.imrworldwide.com/nmapi/v2/</code>
*Production: <code>https://capi-sw.imrworldwide.com/nmapi/v2/</code>
<br>

Please note that our Endpoints use TLS 1.2 and above, older devices using TLS 1.0 OR 1.1 is not compatible with the endpoints above. <br>

During testing, all calls should be pointed to the testing endpoint. We will review the update to the production endpoint during the Go Live section of this guide.

====URL Example====
As you move through the integration steps, you can reference the below URL structure with the expanded payload:

<syntaxhighlight lang="javascript">
https://sc-eucert.imrworldwide.com/nmapi/v2/[appid]/[sessionID]/a?b=
{
  "devInfo": [deviceInfo],
  "metadata": {
    "content": [content_metadata],
    "ad": [ad metadata]
  },
  "event": [event],
  "position": [playhead_position],
  "type": [asset type],
  "utc": [Unix time in ms]
}
</syntaxhighlight>

===Create Session ID and send EMM Ping===

====Create Session ID====

A unique Session ID <code>[sessionID]</code> must be created upon app launch and provided in the URL. This will allow the measurement to occur for the entire duration that a user is within the app.

A Session ID needs to be completely unique so it is recommended to use our generation method example provided below to create unique alpha-numerical 29 characters + 10 characters UTC timestamp, to guarantee there are no repeats, also see  [[#Review the Reference Implementation for VoD and Live Streams|Reference Implementation for VoD and Live Streams]] for your reference and use.

Session ID example: '''LsTYTmZQPwdchsNZkdtJp9lErjgAp1632729088'''
<br>

<syntaxhighlight lang="javascript">
'''// Create random GUID'''
function buildGUID() {
    var UAIDbase62Characters = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
    var UAIDpayloadLength = 29;

    function UAIDgetRandom62() {
        var r1;
        do {
            r1 = Math.floor(Math.random() * (16 * 62));
        } while (r1 > 61); 
        return r1;
    }

    var uid = '';
    for (var a = 0; a < UAIDpayloadLength; a++) {
        uid += UAIDbase62Characters.charAt(UAIDgetRandom62());
    }
    uid += Math.floor(new Date().getTime() / 1000);
    return uid;
}
</syntaxhighlight>
<br>

Upon exiting the app, the session will need to be terminated using the delete event. <br>
Sessions will automatically expire after 30 minutes of cloud inactivity.

====Send EMM Ping====
An EMM Ping must be sent using the created unique Session ID <code>[sessionID]</code> upon start of the first stream playback.
<syntaxhighlight lang="javascript">
https://[sessionID].uaid.imrworldwide.com/
</syntaxhighlight>
Also see  [[#Review the Reference Implementation for VoD and Live Streams|Reference Implementation for VoD and Live Streams]] for your reference.

===Create First Party ID===
* An First Party ID  <code>[fpid]</code> must be created and stored on the device. It is re-used until the expiration date or if the user has deleted it from the device storage.
The default expiration date should be set to the equivalent of 180 days. 
* Additionally the Creation Time <code>[fpcrtm]</code> of the First Party ID should be stored as well. The same value should be used as long as the First Party ID is available on the device.

===Create View Session ID for each Video Start===
An View Session ID <code>[sessid]</code> must be created upon start of each stream playback, sessid is unique per video play.


===Define URL Structure===
Define the URL structure using your provided <code>[appid]</code> and a unique <code>[sessionID]</code>.

<syntaxhighlight lang="javascript">https://sc-eucert.imrworldwide.com/nmapi/v2/[appid]/[sessionID]/a?b=[payload]</syntaxhighlight>

===Configure Payload===

All Cloud API requests must contain the following payload data:

*''devInfo'': device and app info
*''metadata'': asset metadata
*''event metadata'': type of event

The payload can be passed through key-values using the Nielsen reserved keys. The specific keys and descriptions are highlighted in the tables included in this section.

'''Payload Example'''

The example below should be referenced when following the steps for configuring the request payload.

<syntaxhighlight lang="javascript">
// 3.1 Configure Payload: devInfo 
payload = {
    "devInfo": {
        "devId": "AD-ID", 
        "apn": "AppName",
        "apv": "1.0",
        "uoo": "false",
        "fpid": "First Party ID",
        "fpcrtm": "Creation Time (UTC) of the First Party ID (Unix Timestamp in milliseconds)"
        "hem_unknown" : "924899b875ea6767ab790bd2f4852345fcfec5d203c49be8e8..."
    },
    
    // 3.2 Configure Payload: metadata
    "metadata": {
        "content": { // object for measuring video content
            "type": "content", // "content" for video
            "assetid": "uniqueassetid_simulcast", // unique ID for video
            "userid": "fbd1a7a7d672a5fcf5cf5c55d8d9d0abbe3a4e0fa…", // SHA512 hashed userid
            "clientpassparam": "origcode=29", // Custom parameters passed
            "program": "Program Name leif-och-billy", // program name
            "title": "Episode Title S3 - EP1 en-ny-tjej-i-byn", // episode name
            "length": "3359", // content duration in seconds
            "playlisttitle": "barn", //playlist title
            "ispremiumcontent": "yes", //identify premium level content
            "isautoplay": "yes", //identify if autoplay is enabled
            "plugv": "1.0.1", //player version
            "playerv": "Sonic" // player identifier
        },
        "ad": {
            "type": "preroll", // type of ad
            "assetid": "E1UMBR1001", // unique ID for ad
            "length": "30", // ad duration in seconds
            "isprogrammatic": "yes",//identify if the ad is bought prommatic
            "isthirdpartyad": "yes",//identify if the ad is from third party ad server
            "adplatformorigin": "YuMe",//identity of ad origin 
            "adidx": "1/5" //placement in ad break
        }
    },
    
    // 3.3 Configure Payload: events
    "event": "playhead", //event name
    "position": "300", // position in seconds
    "type": "content", //"content" or "ad"
    "utc": "1456448742000" //unix timestamp in milliseconds 
}
</syntaxhighlight>

=====Configure Payload: devInfo=====
An object <code>"devInfo"</code> will need to be created to capture App and Device information.

{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| devId || unique ID to identify user (e.g. Advertising ID, Roku Device ID) || custom || ✓
|-
| apn || app name || custom || ✓
|-
| apv || app build version || custom || ✓
|-
|-
| uoo || device opt-out status || <code>"true"</code> or <code>"false"</code> || ✓
|-
|-
| hem_unknown || Hashed email using SHA512. This email is used by MMS reach model. (required if login feature) || custom || ✓
|-
|-style="background-color:#d0f6f8;"
| fpid || First Party ID || custom || ✓
|-style="background-color:#d0f6f8;"
| fpcrtm || Creation Time (UTC) of the First Party ID (Unix Timestamp in milliseconds) || custom || ✓
|-
|}

'''Example devInfo Object'''
<syntaxhighlight lang="javascript">
// create devInfo object
"devInfo": {
  "devId": "AD-ID",
  "apn": "AppName",
  "apv": "1.0",
  "uoo": "false",
  "fpid": "First Party ID",
  "fpcrtm": "Creation Time (UTC) of the First Party ID (Unix Timestamp in milliseconds)"
  "hem_unknown" : "924899b875ea6767ab790bd2f4852345fcfec5d203c49be8e8..." //SHA512 hashed value
},
</syntaxhighlight>

==== 3.2 Configure Payload: metadata ====
Asset metadata can be passed through <code>"metadata"</code>. There are two asset types: <code>"content"</code> for video and <code>"ad"</code> for ads. The metadata received for each asset is used for classification and reporting.

You will need to set up <code>"metadata"</code> objects for <code>"content"</code> and <code>"ad"</code> with the required Nielsen keys as shown in the sample code below.

===== Create Content Metadata =====
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
<br>
Please see the [[Sweden_SDK_Metadata|Metadata link]] for the full list of content and ad metadata.
<br/>
'''Note:''' program and title metadata values should be passed as UTF-8 strings.

===== Example Content Object =====
<syntaxhighlight lang='json'>// create content object
"content": {
 "type": "content",
  "assetid": "uniqueassetid",
  "length":  "2600",
  "program": "program name",
  "title":   "episode title"
}</syntaxhighlight>

===== Create Ad Metadata =====
The Ad Metadata (if applicable) should be passed for each individual ad.
<br>
Please see the [[Sweden_SDK_Metadata|Metadata link]] for the full list of content and ad metadata.<br>


'''Note:''' All metadata values should be passed as UTF-8 strings.

===== Example Ad Object =====
<syntaxhighlight lang="javascript">
// create ad object
"ad": {
  "type": "preroll",
  "assetid": "unique_preroll_ad_id"
}
</syntaxhighlight>
<br/>
<blockquote> URL Character Limit: There is a URL character limit of 2K characters due to browser limitations. Exceeding this value could impair data delivery on particular browsers. </blockquote>

=== Configure Payload: Events ===

The last part of the payload is for enabling events so content is measured correctly when viewed. The events and required parameters are included below.

==== Event Types ====

The available events are:
{| class="wikitable"
|-
! Event !! Description
|-
| <code>"playhead"</code> || 

===== Handling Playhead =====

Calling <code>"playhead"</code> is critical for accurate duration crediting. You can reference the below guidance to determine the correct playhead position to pass depending on the playback scenario.

'''General'''
* Playhead position in seconds, must be passed as a whole number every 10 seconds. 
* The final playhead position should be sent before before sending "complete" event when content playback is complete. 

'''Live Stream'''
* For Live streams, use Unix Time (in seconds) as the playhead position. Note that ad playheads must also use Unix Time for each single Ad in an Ad Pod.

'''VoD Stream'''
* For VoD stream use the player position for Content and Ad at playback start of a content or single Ad in an Ad Pod, playheads will then be 0, 10, 20, ....

'''End of an Asset'''
* Final postion must be sent at the end of Content or Ad playback

'''Ads'''
* The final playhead position must be sent when switching from content to ad, or ad to content.
* For Ad Pods, playhead must be called for each individual ad.
* When content has resumed following a mid-roll ad break, the next playhead position must continue where the previous content segment left off.

'''User Actions'''
* SCRUBBING: Upon user scrubbing, the current position must be sent before a user scrubs, and the new position should be sent where the user lands, and begin sending in the 10 second updates thereafter.
* PAUSE: When content is paused, send current playhead position and stop passing playhead position until content is resumed.
* EXIT Stream: If a user exits a stream early, the last current position must be sent in a playhead update to receive accurate duration.

|-
| <code>"complete"</code> || The complete event must be sent when the content has completed full playback. Before calling the complete event, a final playhead update with the final position is required to be sent to receive full duration credit. For Live streams, a complete event must be sent at program boundaries.
|-
| <code>"delete"</code> || The delete event is optional and can be sent when the viewing session is terminated (typically on App close). A new session ID must be generated after sending a delete event. Delete should not be sent on app interruptions or foreground/background events. All creditable duration will be summarized for all asset types when delete occurs (content and ads).
|}

===== Event Parameters =====

The following parameters need to be passed when calling events:

{| class="wikitable"
|-
! Parameter !! Description !! Value !! Required
|-
| <code>"event"</code> || event type || <code>"playhead"</code>, <code>"complete"</code>, or <code>"delete"</code> || ✓
|-
| <code>"position"</code> || playhead position in seconds or Unix time in seconds || <code>"300"</code> || ✓
|-
| <code>"type"</code> || asset type || <code>"content"</code>, <code>"ad"</code> || ✓
|-
| <code>"utc"</code> || Unix timestamp in milliseconds. Must be passed every 10 seconds. || <code>"1472760000000"</code> || ✓
|-style="background-color:#d0f6f8;"
| <code>"sessid"</code> || Unique View Session ID must be created upon start of each stream playback, sessid is unique per video play. || <code>"xxxjavd6wzirm93xb95uxjy1ac5wu1627638609"</code> || ✓
|}

===== Example Event =====
You can call events by passing values in the required parameters:

<syntaxhighlight lang="javascript">
"devInfo": [deviceInfo],
  "metadata": {
    "content": [content metadata],
    "ad": [ad metadata]
  },
  // Event Parameters
  "event": [event], // event name
  "position": [playheadPosition], //position in seconds
  "type": [asset type], // values are "content" or "ad"
  "utc": "1472760000000" //unix timestamp in milliseconds
  "sessid": "xxxjavd6wzirm93xb95uxjy1ac5wu1627638609", // unique for each video play
}
</syntaxhighlight>

'''Note:''' The full payload including "devInfo" and "metadata" must be populated in each event request.

===== Sample Event Lifecycle for VoD Stream =====
The sample event lifecycle can be used as a reference for identifying the order for calling events and values to pass.

<syntaxhighlight lang="javascript">
// Start of Session: session ID created when App is opened

// Preroll
Ad Playhead {"event": "playhead", "position": "0", "type": "ad", "utc": "1472760000000"} 
 
// Content
Content Playhead {"event": "playhead", "position": "0", "type": "content", "utc": "1472760000000"} 

// Midroll
Midroll Playhead {"event": "playhead", "position": "0", "type": "ad", "utc": "1472760000000"} 

// Content resumes at 15 minutes
Content Playhead {"event": "playhead", "position": "900", "type": "content", "utc": "1472760000000"} 

// Content completes at 30 minutes
Complete {"event": "complete", "position": "1800", "type": "content", "utc": "1472760000000"} 
 
// Postroll
Ad Playhead {"event": "playhead", "position": "0", "type": "ad", "utc": "1472760000000"} 

//End of Session: The delete event should be called when the App is exited. The values for position and type not required to be passed.
Delete { "event": "delete", "position": "", "type": "", "utc": "1472760000000"} 
</syntaxhighlight>


'''Sample Event Lifecycle for VoD Stream - Detailed Storyline'''
This detailed event sequence provides additional insight for the correct events to call when handling certain playback scenarios.
<syntaxhighlight lang='javascript'>// SESSION STARTS
// Start of Session: session ID created when App is opened

// PREROLL
// Preroll Start - Start each Ad with a position of "0", resetting to '0' for each Ad, and Ad break.
Ad Playhead {"event": "playhead", "position": "0", "type": "ad", "utc": "1472760000000"} 

// Preroll Stop - End each Ad with the final position of the Ad.
Ad Playhead {"event": "playhead", "position": "15", "type": "ad", "utc": "1472761500000"}
 
// CONTENT 
// Content Start - Start new content streams with a position of "0" incrementing the position every 10 seconds.
Content Playhead {"event": "playhead", "position": "0", "type": "content", "utc": "1472761500000"} 

// Content Stop Before Ad Break - Send a playhead update including the current content positon before an Ad break.
Content Playhead {"event": "playhead", "position": "299", "type": "content", "utc": "1472787400000"}

// MIDROLL
// Midroll Start - Start each Ad with a position of "0", resetting to '0' for each Ad, and Ad break.
Midroll Playhead {"event": "playhead", "position": "0", "type": "ad", "utc": "1472787500000"} 

// Midroll Stop - End each Ad with the final position of the Ad.
Ad Playhead {"event": "playhead", "position": "60", "type": "ad", "utc": "1472793500000"}

// CONTENT
// Content resumes at 5 minutes - Send playhead update with the current resumed position, and begin incrimenting the positon every 10 seconds.
Content Playhead {"event": "playhead", "position": "300", "type": "content", "utc": "1472799500000"} 

// Content completes at 10:12 - Make sure to send in the playhead event with the final content position before sending the complete event.
Final Content Playhead {"event": "playhead", "position": "612", "type": "content", "utc": "1472830700000"} 

Complete {"event": "complete", "position": "612", "type": "content", "utc": "1472830800000"} 

// POSTROLL
// Postroll Start - Start each Ad with a position of "0", resetting to '0' for each Ad, and Ad break.
Ad Playhead {"event": "playhead", "position": "0", "type": "ad", "utc": "1472830900000"} 

// Postroll Stop - End each Ad with the final position of the Ad.
Ad Playhead {"event": "playhead", "position": "45", "type": "ad", "utc": "1472835300000"}

// SESSION ENDS

//End of Session: The delete event should be called when the App is exited. The values for position and type not required to be passed.
Delete { "event": "delete", "position": "", "type": "", "utc": "1472835400000"} </syntaxhighlight>


===== Interruption Scenarios =====

As part of configuring events, you will need to handle all possible interruption scenarios such as:

*Wi-Fi OFF / ON
*App going Background / Foreground (Video players only, not for Audio players)
*App Crash or Exit

When playback is interrupted, the app needs to send delete immediately.

Once playback resumes, a new session will need to be created with a unique session ID. All of the required metadata and events will need to be sent.

'''Note:''' The session will automatically timeout after 30 minutes of inactivity.

=== Example Request ===

Now that we walked through the Cloud API integration steps, your requests should have the following components: Session ID, App ID, and Payload. You can reference the example below when your reviewing your integration.

<syntaxhighlight lang="javascript">
// 1. Create Session ID
sessionID = LsTYTmZQPwdchsNZkdtJp9lErjgAp1632729088  // Example sessionID created using a UUID Generator

// 2. Define URL Structure with App ID and Session ID
sessionURL = https://sc-eucert.imrworldwide.com/nmapi/v2/[appid]/[sessionID]/a?b=

// 3. Configure Payload
// 3.1 Configure Payload: devInfo 
payload = {
 "devInfo": {
   "devId": "AD-ID", 
   "apn": "AppName",
   "apv": "1.0",
   "uoo": "false",
   "fpid": "U4EDwDcpvWIbguYVyjlhzS1v0eaov1631180980",
   "fpcrtm": "1631098029000"
   "hem_unknown" : "924899b875ea6767ab790bd2f4852345fcfec5d203c49be8e8..." //SHA512 hashed value
  },
  
  // 3.2 Configure Payload: metadata
  "metadata": {
            "type": "content", // "content" for video
            "assetid": "uniqueassetid_simulcast", // unique ID for video
            "userid": "fbd1a7a7d672a5fcf5cf5c55d8d9d0abbe3a4e0fa…", // SHA512 hashed userid
            "clientpassparam": "origcode=29", // Custom parameters passed
            "program": "Program Name leif-och-billy", // program name
            "title": "Episode Title S3 - EP1 en-ny-tjej-i-byn", // episode name
            "length": "3359", // content duration in seconds
            "playlisttitle": "barn", //playlist title
            "ispremiumcontent": "yes", //identify premium level content
            "isautoplay": "yes", //identify if autoplay is enabled
            "plugv": "1.0.1", //player version
            "playerv": "Sonic" // player identifier
    },
    "ad": {
      "type": "preroll", // type of ad
      "assetid": "AD-ID123", // unique ID for ad
      "length": "3359", // ad duration in seconds
      "isprogrammatic": "yes",//identify if the ad is bought prommatic
      "isthirdpartyad": "yes",//identify if the ad is from third party ad server
      "adplatformorigin": "YuMe",//identity of ad origin 
      "adidx": "1/5" //placement in ad break
    }
  },
    
  // 3.3 Configure Payload: events
  "event": "playhead", //event name
  "position": "300", // position in seconds
  "type": "content", //"content" or "ad"
  "utc": "1456448742000" //unix timestamp in milliseconds 
  "sessid": "xxxjavd6wzirm93xb95uxjy1ac5wu1627638609", // unique for each video play
}

// Append payload to URL
function sendPayloadToNielsen() {
  var payloadStr  = JSON.stringify(payload); // payload as string
  var imgPing = new Image();
  imgPing.onload = function() {
    // onload event, payload succesfull sent
  };
  imgPing.onerror = function() {
    // handle error i.e. wait and send again
  };
  imgPing.src = sessionURL+encodeURIComponent(payloadStr);
}
</syntaxhighlight>

==== Enable Debug Logging ====

Now that you have set up the Cloud API requests, you can enable debug logging to validate your integration. Enabling debug logging is required for Nielsen certification.

==== GET Request ====

Display GET Request to console using a name to identify each event (e.g. playhead).

<syntaxhighlight lang="javascript">
console.log("Event", image); 
</syntaxhighlight>

==== Payload ====

Output payload to identify required metadata and events.

<syntaxhighlight lang="javascript">
console.log("Event Payload", payload); 
</syntaxhighlight>

==== HTTP Response Code ====

Confirm request was completed by viewing HTTP response code.

<syntaxhighlight lang="javascript">
code = msg.GetResponseCode();
console.log("Response Code", code); 
</syntaxhighlight>

You can reference the HTTP Response Code table when reviewing your requests:

{| class="wikitable"
|-
! Status Code !! Status Text !! Description
|-
| <code>200</code> || OK || request received
|-
| <code>403</code> || Forbidden || invalid App ID
|-
| <code>404</code> || Not Found || JSON issue
|}

== Opt-Out ==
Your app must provide a means for the user to Opt-Out, or Opt-In to Nielsen Measurement. This requirement can be fulfilled by checking the device OS for the user's setting of "Limit Ad Tracking" or similar option. If the device offers "Limit Ad Tracking" settings, you should set <code>uoo=true</code> or <code>uoo=false</code> depending on the user's privacy setting. Also, ensure that the <code>devId</code> is set to a blank value if the user elects to opt-out.

If the device does not have OS-level "Do Not Track" settings, you can implement opt-out by creating an Opt-Out/Opt-In button, toggle switch, or slider within the app "Settings", or "About" section to allow the user selection.

[[File:Nielsen Opt-Out.png|link=]]

You will need to store the User Opt-Out (uoo) status, so that it can be retrieved and populated in the <code>"devInfo"</code> metadata which will be sent in every Cloud API event (playhead, complete, & delete). 

{| class="wikitable"
|-
! uoo Key !! Description !! Values
|-
| uoo || Device is Opted-In to Nielsen Measurement (Recommended Default Setting) || <code>"false"</code>
|-
| uoo || Device is Opted-Out of Nielsen Measurement || <code>"true"</code>
|}

===== devInfo Opt-In JSON Payload Example =====

<syntaxhighlight lang="javascript">
"devInfo": {
    "apn": "Cloud API Sample App",
    "apv": "1",
    "devId": "7be25cf9-8c40-5cc2-871e-19bf41940288",
    "uoo": "false"
  },
</syntaxhighlight>

===== devInfo Opt-Out JSON Payload Example =====

<syntaxhighlight lang="javascript">
  "devInfo": {
    "apn": "Cloud API Sample App",
    "apv": "1",
    "devId": "", //devId must be blank when a user elects to Opt-Out.
    "uoo": "true"
  },
</syntaxhighlight>

===== Privacy Information Template To Include In Opt-Out Screen =====


Additionally, all applications must display the Nielsen privacy policy within their application, typically in the Settings/About screen of your application. The Nielsen privacy policy text is listed below.

<blockquote>
'''''ABOUT NIELSEN MEASUREMENT'''''

Television and the way we watch it have come a long way since Nielsen began measuring TV audiences in 1950. Today, the ability to watch our favorite shows at any time and on multiple devices amplifies the need for exceptionally adept and flexible audience measurement capabilities.

Consumers are changing with the times, and the same goes for us. As technology continues to evolve and media companies try new ways to attract viewers, understanding what consumers are watching — and what they're watching on — is more important than ever. Today, viewing video is a personal and mobile experience — anytime and anywhere. Our capabilities provide relevant metrics that are necessary to inform successful marketing and programming and drive continued growth. As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process, and use. While our digital measurement products are not used to identify you in any way, they help us and our client's measure and analyze how consumers engage with media across online, mobile, and emerging technologies, and offer insights into consumer behavior.

'''''YOUR CHOICES'''''

Nielsen believes that you should have a choice about whether to contribute to our research and insights. To opt-out or opt into Nielsen measurement, please toggle your "Limit Ad Tracking" (or similar setting) on your device, or make the appropriate selection within the application's settings. If you have this app on more than one device, you will need to opt-out of this app on each device. To learn more about our digital measurement products and your choices in regard to them, please visit https://sites.nielsen.com/priv/browser/se/sv/optout.html 

</blockquote>
'''''Disclosure Template'''''

Additionally, you must update the App description information from the App Distribution Store with the Nielsen Measurement disclosure below:

This app features Nielsen's proprietary measurement software which will allow you to contribute to market research, like Nielsen's TV Ratings. Please see https://sites.nielsen.com/priv/browser/se/sv/optout.html for more information.

==  Review the Reference Implementation for VoD and Live Streams ==

The Reference Implementation covers vod and Live use cases. 
It also covers DAI (Dynamic Ad Insertion) with preroll and post-roll Ads.

In order to start live stream select the checkbox "isLive" in the <code>Playback Settings</code> below the video player.

Start the Reference Implementation for Sweden [http://nielsenonlinesupport.com/michel/sdkRefImplCloudDK/index.htm RefImplCloudAPISE].
<blockquote>
Review the Nielsen CloudAPI Call Sequence below the Video Player.
</blockquote>

== Disclose Nielsen Privacy Statement ==

In order to disclose the Nielsen measurement privacy statement, please include the following items in your privacy policy:
* A notice that the player includes third-party measurement software that allows users to contribute to market research with anonymous data.
* A link to the Nielsen Digital Measurement Privacy Policy located at https://sites.nielsen.com/priv/browser/se/sv/optout.html .

== Testing ==
Before providing an app build to Nielsen for testing, it is important to run validation checks once you have enabled debug logging.

=== Payload Validation ===

Ensure that all of the required payload data is populating while testing several videos. The following areas are critical to measurement:
*devInfo
*Asset metadata for both content, and ads
*Events

=== Player Events ===
Review event calls:

==== playhead ====
*Playhead position updates every 10 seconds starting at position '0' for each new asset for VoD stream and UTC Unix Time in seconds for Live stream.
*Final playhead position is sent on content, or ad before switching between assets.
*Content metadata remains constant throughout an episode or clip play.
*Ad metadata is populated appropriately for each individual ad.
*Playhead position update resumes for content after an ad break and resets to 0 for each individual ad.
*For scrubbing, last current position should be sent while scrubbing occurs, and the new position should also be sent where the user scrubs to.
*Exiting a stream early should execute the last current position in a playhead update to receive accurate duration.
*Upon pause, the current position should be sent, and playhead updates should stop incrementing until resume play occurs.

==== complete ====
*Check that the complete event executes upon content complete after the final playhead update is sent
*Do not execute the complete event for ads

==== delete ====
*Check to see that the delete event occurs upon app exit, if the platform has the necessary exit callback events.

==== GET Request Format ====
*Ensure that the event payloads are formatted in JSON
*Check to see that each of the Cloud API GET requests are properly encoded

==== HTTP Response ====
*Make sure that each of the Cloud API Get requests are received by the Nielsen Cloud API properly through use of the HTTP Response Code outputs enabled in console.

==== Opt-Out ====
*Test the "uoo" key gets populated accurately for both Opt-In and Opt-Out selections by validating the Cloud API events called after the user Opt-Out/Opt-In selection.
*Test that the devId field is populated with a blank value if a user has elected to Opt-Out. For example: "devId": "",
*If the device supports "Limit Ad Tracking" or has device "Opt-Out" settings, test that uoo=true, and that devId is set to a blank value if enabled in the device settings.

== Go Live ==
After your integration has been certified, you will need to: Change the Endpoint and Disable Logging.

'''Change Endpoint:''' You will need to update to the production endpoint:

*Testing: <code>https://sc-eucert.imrworldwide.com/nmapi/v2/</code>
*Production: <code>https://capi-sw.imrworldwide.com/nmapi/v2/</code>

Your production URL structure should now be:
<code>https://capi-sw.imrworldwide.com/nmapi/v2/[appid]/[sessionID]/a?b=[payload]</code>

'''Disable Logging:''' You can now disable debug logging