Simplified SDK API: Difference between revisions
From Engineering Client Portal
No edit summary |
ColinBrown (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
[[Category:Digital]] | [[Category:Digital]] | ||
__NOTOC__ | __NOTOC__ | ||
{{Simplified_API_Overview}} | |||
== Simplified Implementation == | == Simplified Implementation == | ||
Only 4 events with the Simplified SDK. Order of calls no longer important. | Only 4 events with the Simplified SDK. Order of calls no longer important. | ||
Revision as of 03:16, 6 April 2022
Overview
This guide is for the Simplified SDK which has now been replaced by our Global App SDK. As of Sept 21, 2021 the Nielsen Global App SDK was moved to a public repository. Details can be found on the Software Download Page.
This document outlines the features of the Simplified Nielsen SDK, which is available for use within your APP or online video site, for Digital Content Ratings or DTVR measurement. You are only required to execute one of 4 events. Tell the SDK if you want to track 'content', an 'ad', or a 'static' page load. If an event is sent out of sequence, this new API will put it in the correct order for processing. All of the Standard SDK calls can be replaced with one API call, and one dictionary object, where any value could be another complex dictionary object.
Simplified Implementation
Only 4 events with the Simplified SDK. Order of calls no longer important.
| Key | Description |
|---|---|
| playhead |
It is used to pass content, ad or static metadata, the current playhead value, UTC timestamp or id3 payload, ott information to the SDK. |
| pause |
This event should be used to in the following cases: application enters background, any application interruptions, content playback is paused. (Pause is detected by SDK automatically only if time gap between commands in more than 30 minutes.) |
| complete |
It is called when session is completed or ends. |
| adStop |
Should be called at the end of each ad. This event type is required to handle the case when advertisements could not be distinguished, as its assetId is the same. |
Single object holds all the data
All the data provided in the older API in separate calls will be provided in one single call. Format of input object is the following:
{
"event": <event identifier>,
"type": <type of metadata>,
"metadata":{
"content": <content metadata object>,
"ad": <ad metadata object>,
"static": <static metadata object>
},
"playheadPosition":<playhead value | UTC>,
"id3Data": <id3 payload>,
}
