Engineering Portal / Digital / International DCR / DCR Denmark Video Cloud API

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.

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.

Item	Description	Source
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:

[endpoint]/[appid]/[sessionID]/a?b=[payload]

The URL includes the following components:

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

Endpoint

There are endpoints for testing and production:

Testing: https://sandbox-cloudapi.imrworldwide.com/nmapi/v2/
Production: https://cloudapi.imrworldwide.com/nmapi/v2/

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:

https://sandbox-cloudapi.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]
}

Create Session ID

A unique Session ID must be created upon app launch and provided in the URL. This will allow 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 a version 4 UUID or another method of your choosing to guarantee there are no repeats.

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

Define URL Structure

Define the URL structure using your provided [appid] and a unique [sessionID].

https://sandbox-cloudapi.imrworldwide.com/nmapi/v2/[appid]/[sessionID]/a?b=[payload]

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.

// 3.1 Configure Payload: devInfo 
payload = {
    "devInfo": {
        "devId": "AD-ID", 
        "apn": "AppName",
        "apv": "1.0",
        "uoo": "false"
    },
    
    // 3.2 Configure Payload: metadata
    "metadata": {
        "content": { // object for measuring video content
            "type": "content", // "content" for video
            "assetid": "VIDEO-ID123", // unique ID for video
            "isfullepisode": "y", // full episode flag
            "program": "Program Name", // program name
            "title": "Episode Title S3 - EP1", // episode name
            "length": "1800", // content duration in seconds
            "airdate": "20161013 20:00:00", // airdate
            "adloadtype": "2" //ad load flag
        },
        "ad": {
            "type": "preroll", // type of ad
            "assetid": "AD-ID123" // unique ID for ad
        }
    },
    
    // 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 
}

Configure Payload: devInfo

An object "devInfo" will need to be created to capture App and Device information.

Keys	Description	Values	Required
devId	unique ID to identify user (e.g. Advertising ID, Roku Device ID)	custom	Yes
apn	app name	custom	Yes
apv	app build version	custom	Yes
uoo	device opt-out status	`"true"` or `"false"`	Yes

Example devInfo Object

// create devInfo object
"devInfo": {
  "devId": "AD-ID",
  "apn": "AppName",
  "apv": "1.0",
  "uoo": "false"
},

3.2 Configure Payload: metadata

Asset metadata can be passed through "metadata". There are two asset types: "content" for video and "ad" for ads. The metadata received for each asset is used for classification and reporting.

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

Content Metadata

Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.

Keys	Description	Values	Required
type	type of asset	`"content"`	Yes
assetid	unique ID assigned to asset	custom (no Special Characters)	Yes
program	name of program (25 character limit)	custom	Yes
title	name of program (25 character limit)	custom	Yes
length	length of content in seconds	`seconds` (0 for live stream)	Yes
airdate	the airdate in the linear TV	YYYYMMDD HH24:MI:SS	Yes
isfullepisode	full episode flag	`"y"`- full episode, `"n"`- non full episode	Yes
adloadtype	type of ad load	`"1"` Linear – matches TV ad load `"2"` Dynamic – Dynamic Ad Insertion (DAI)	Yes
subbrand	sub brand override	Provided by Nielsen	No
progen	program genre abbreviation - see DCR OTT Genre List for accepted values	`"CV"` for Comedy Variety	Yes

Example Content Object

// create content object
"content": {
    "type": "content",
    "assetid": "VIDEO-ID123",
    "isfullepisode": "y",
    "program": "Program Name",
    "title": "Episode Title S3 - EP1",
    "length": "1800",
    "airdate": "20161013 20:00:00",
    "adloadtype": "2",
    "subbrand": "c05",
    "progen": "CV"
}

Ad Metadata

The ad metadata should be passed for each individual ad.

Keys	Description	Values	Required
type	type of ad	`"preroll"`, `"midroll"`, or `"postroll"`	Yes
assetid	unique ID assigned to ad	custom	Yes

Example Ad Object

// create ad object
"ad": {
  "type": "preroll",
  "assetid": "AD-ID123"
}

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:

Event	Description
`"playhead"`	Playhead position in seconds, must be passed as a whole number every 10 seconds. The final playhead position should be sent before an asset has changed to properly capture full duration. When content is paused, stop passing playhead position until content is resumed. On playhead scrubbing, send current playhead position, followed by the playhead position the user scrubs to. For Live streams, you may use Unix Time (in seconds) as the playhead position. Note that ad playheads must also use Unix Time if Unix Time is used for content playheads.
`"complete"`	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.
`"delete"`	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:

Parameter	Description	Value	Required
`"event"`	event type	`"playhead"`, `"complete"`, or `"delete"`	Yes
`"position"`	playhead position in seconds or Unix time in seconds	`"300"`	Yes
`"type"`	asset type	`"content"`, `"ad"`	Yes
`"utc"`	Unix timestamp in milliseconds. Must be passed every 10 seconds.	`"1472760000000"`	Yes

Example Event

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

"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
}

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

Sample Event Lifecycle

The sample event lifecycle can be used as a reference for identifying the order for calling events and values to pass.

// 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"}

Sample Event Lifecycle - Detailed Storyline This detailed event sequence provides additional insight for the correct events to call when handling certain playback scenarios.

// 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"}

Handling Playhead

Calling "playhead" 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.

Playhead: General

Playhead position must start at 0 for each new asset, and be passed at least every 10 seconds.
Final postion must be sent at the end of content or an ad
Playheads should be sent in seconds only, not milliseconds

Playhead: Ads

The final position must be sent when switching from content to ad, or ad to content.
Each ad playhead position should be 0 at ad start.
For Ad Pods, playhead must be called, and reset to 0 for each individual ad.
The last content position before an Ad should be sent before switching to Ads.
When content has resumed following an ad break, the playhead position update must continue where the previous content segment left off.

Playhead: User Actions

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.
On pause, send the current position and then discontinue sending playhead event updates.
If a user exits a stream early, the last current position must be sent in a playhead update to receive accurate duration.

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.

// 1. Create Session ID
sessionID = dfc7dc6a-66a7-4705-9fba-adaaf7e3d5e0  // Example sessionID created using a UUID Generator

// 2. Define URL Structure with App ID and Session ID
sessionURL = https://sandbox-cloudapi.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"
  },
  
  // 3.2 Configure Payload: metadata
  "metadata": {
    "content": { // object for measuring video content
      "type": "content", // "content" for video
      "assetid": "VIDEO-ID123", // unique ID for video
      "isfullepisode": "y", // full episode flag
      "program": "Program Name", // program name
      "title": "Episode Title S3 - EP1", // episode name
      "length": "1800", // content duration in seconds
      "airdate": "20161013 20:00:00", // airdate
      "adloadtype": "2", // ad load flag
      "progen": "CV" // program genre abbreviation
    },
    "ad": {
      "type": "preroll", // type of ad
      "assetid": "AD-ID123" // unique ID for ad
    }
  },
    
  // 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 
}

// Append payload to URL
var image = new Image()
image.onerror = function() {
  // wait and send again
}
(new Image).src = sessionURL+encodeURIComponent(JSON.stringify(payload));

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).

console.log("Event", image);

Payload

Output payload to identify required metadata and events.

console.log("Event Payload", payload);

HTTP Response Code

Confirm request was completed by viewing HTTP response code.

code = msg.GetResponseCode();
console.log("Response Code", code);

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

Status Code	Status Text	Description
`200`	OK	request received
`403`	Forbidden	invalid App ID
`404`	Not Found	JSON issue

Opt-Out

This section will be added soon.

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
Opt-Out status

Player Events

Review event calls:

playhead

Playhead position updates every 10 seconds starting at position '0' for each new asset.
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 Endpoint and Disable Logging.

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

Testing: https://sandbox-cloudapi.imrworldwide.com/nmapi/v2/
Production: https://cloudapi.imrworldwide.com/nmapi/v2/

Your production URL structure should now be: https://cloudapi.imrworldwide.com/nmapi/v2/[appid]/[sessionID]/a?b=[payload]

Disable Logging: You can now disable debug logging

DCR Denmark Video Cloud API

From Engineering Client Portal

Revision as of 14:43, 9 April 2021 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

DCR Integration Utilizing Cloud API

Prerequisites

Integration

URL Structure

Endpoint

URL Example

Create Session ID

Define URL Structure

Configure Payload

Configure Payload: devInfo

3.2 Configure Payload: metadata

Content Metadata

Ad Metadata

Example Ad Object

Configure Payload: Events

Event Types

Event Parameters

Example Event

Sample Event Lifecycle

Handling Playhead

Interruption Scenarios

Example Request

Enable Debug Logging

GET Request

Payload

HTTP Response Code

Opt-Out

Testing

Payload Validation

Player Events

playhead

complete

delete

GET Request Format

HTTP Response

Opt-Out

Go Live

DCR Denmark Video Cloud API

From Engineering Client Portal

Revision as of 14:43, 9 April 2021 by Admin (talk | contribs)(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

DCR Integration Utilizing Cloud API

Prerequisites

Integration

URL Structure

Endpoint

URL Example

Create Session ID

Define URL Structure

Configure Payload

Configure Payload: devInfo

3.2 Configure Payload: metadata

Content Metadata

Ad Metadata

Example Ad Object

Configure Payload: Events

Event Types

Event Parameters

Example Event

Sample Event Lifecycle

Handling Playhead

Interruption Scenarios

Example Request

Enable Debug Logging

GET Request

Payload

HTTP Response Code

Opt-Out

Testing

Payload Validation

Player Events

playhead

complete

delete

GET Request Format

HTTP Response

Opt-Out

Go Live

Revision as of 14:43, 9 April 2021 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)