Domless SDK API Reference: Difference between revisions
From Engineering Client Portal
(Created page with "Setting up Development Environment") |
No edit summary |
||
| Line 1: | Line 1: | ||
Setting up Development Environment | = Setting up Development Environment = | ||
=== Step 1: Configure Content Management System (CMS) === | |||
Configure CMS to send the required values (see table below). Any internal CMS_variable names can be used for passing the data. | |||
Ensure to capture these CMS_variable names in the SDK Configuration Form. | |||
For more information on setting variable names, see the SDK Configuration Form included within the SDK package. | |||
{| class="wikitable" | |||
|+ | |||
!Required Data | |||
!Description | |||
!Value | |||
|- | |||
|dataSrc | |||
|Used when both CMS metadata and ID3 data are present in the player. Setting this field tells the SDK whether to use the CMS metadata or the ID3 payload to derive the pings | |||
|cms | |||
|- | |||
|type | |||
|Type of asset: ad or content | |||
|preroll, midroll, postroll, or content | |||
|- | |||
|assetid | |||
|unique ID assigned to asset | |||
|custom | |||
(no [[Special Characters]]) | |||
|- | |||
|program | |||
|Name of program (25 character limit) | |||
|custom | |||
|- | |||
|title | |||
|Episode title (40 character limit) | |||
|custom | |||
|- | |||
|length | |||
|Length of content in seconds | |||
|Length in seconds, 0 for live stream | |||
|- | |||
|adloadtype | |||
|Type of ad load | |||
|"1" - Linear "2" - Dynamic(default) | |||
|- | |||
|hasAds | |||
|Identify if content includes Ads | |||
|"0" - no ads "1" - includes ads "2" - unknown(default) | |||
|- | |||
|isfullepisode | |||
|Full episode flag | |||
|"y" - full episode "n" - non full episode | |||
|- | |||
|segA | |||
|Segment A (this is not available for video reporting as the episode title is reported) | |||
|custom value | |||
|- | |||
|segB | |||
|Custom segment B | |||
|custom value | |||
|- | |||
|segC | |||
|Custom segment C | |||
|custom value | |||
|- | |||
|crossId1 | |||
|Standard episode ID | |||
|custom value | |||
|- | |||
|crossId2 | |||
|Content originator (required only for distributors) | |||
|custom value | |||
|- | |||
|airdate | |||
|Original air date and time in Eastern Time. For non-US countries, it should be local time. | |||
|YYYYMMDD HH24:MI:SS | |||
|- | |||
|containerId | |||
|HTML DOM element of the Player container (for Viewability&Audibility feature only) | |||
|custom value | |||
|} | |||
Revision as of 19:12, 2 July 2024
Setting up Development Environment
Step 1: Configure Content Management System (CMS)
Configure CMS to send the required values (see table below). Any internal CMS_variable names can be used for passing the data.
Ensure to capture these CMS_variable names in the SDK Configuration Form.
For more information on setting variable names, see the SDK Configuration Form included within the SDK package.
| Required Data | Description | Value |
|---|---|---|
| dataSrc | Used when both CMS metadata and ID3 data are present in the player. Setting this field tells the SDK whether to use the CMS metadata or the ID3 payload to derive the pings | cms |
| type | Type of asset: ad or content | preroll, midroll, postroll, or content |
| assetid | unique ID assigned to asset | custom
(no Special Characters) |
| program | Name of program (25 character limit) | custom |
| title | Episode title (40 character limit) | custom |
| length | Length of content in seconds | Length in seconds, 0 for live stream |
| adloadtype | Type of ad load | "1" - Linear "2" - Dynamic(default) |
| hasAds | Identify if content includes Ads | "0" - no ads "1" - includes ads "2" - unknown(default) |
| isfullepisode | Full episode flag | "y" - full episode "n" - non full episode |
| segA | Segment A (this is not available for video reporting as the episode title is reported) | custom value |
| segB | Custom segment B | custom value |
| segC | Custom segment C | custom value |
| crossId1 | Standard episode ID | custom value |
| crossId2 | Content originator (required only for distributors) | custom value |
| airdate | Original air date and time in Eastern Time. For non-US countries, it should be local time. | YYYYMMDD HH24:MI:SS |
| containerId | HTML DOM element of the Player container (for Viewability&Audibility feature only) | custom value |