PRODUCT
Follow

AdAdditionalAsset

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image
name String Mandatory Name of the additional asset

AdAsset

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image

AdAssetFolder

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image
name String Read Only Name of the folder
assets Array of Object (Asset) Read Only Flat list of the assets in the folder

AdAssignmentData

Field Data Type Limitation Description
accountId Long Read Only ID of the creative manager the ad is assign to
accountName String Read Only Name of the creative manager the ad is assign to
advertiserId Long Read Only ID of the advertiser the ad is assign to
advertiserName string Read Only Name of the advertiser the ad is assign to
brandId Long Read Only ID of the brand the ad is assign to
brandName String Read Only Name of the brand the ad is assign to
campaignId Long Read Only ID of the brand the campaign is assign to
campaignName String Read Only Name of the brand the campaign is assign to

AdAutomaticEventInteraction

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset in which the custom interaction was defined
name String Mandatory Name of the custom interaction as defined in the asset
reportingName String Mandatory Name of the custom interaction that will show in the reports
assetName String Read Only Name of the asset in which the custom interaction was defined
closeAdParts Boolean Mandatory Control whether to close the ad’s Flash elements when the interaction is triggered
redirectURL String Optional The exit URL to which the user will be redirected to when triggering the interaction

AdClickthroughInteraction

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset in which the custom interaction was defined
name String Mandatory Name of the custom interaction as defined in the asset
reportingName String Mandatory Name of the custom interaction that will show in the reports
assetName String Read Only Name of the asset in which the custom interaction was defined
closeAdParts Boolean Mandatory Control whether to close the ad’s Flash elements when the interaction is triggered
redirectURL String Optional The exit URL to which the user will be redirected to when triggering the interaction

AdSmartElement

Field Data Type Limitation Description
id Long Read Only Random value
svKey String Mandatory Identifier of a smart element
value

Object (AdSmartElementValue Class)

Derived:

AdSmartElementSimpleStringValue

Mandatory Value of the smart element

AdSmartElementAssetReferenceValue

Field Data Type Limitation Description
stringValue String Read Only Simple text value
name String Read Only Represents the related asset name
contentTypeCode Integer Read Only  
publishPath String Read Only The location of the asset
width String Read Only The asset's width
height String Read Only The asset's height
enableFS Integer Read Only  
bitRate String Read Only The asset's bit rate
assetId String Read Only The asset's id

AdSmartElementSimpleStringValue

Field Data Type Limitation Description
stringValue String Mandatory Simple text value

AdSmartVersionSchema

Field Data Type Limitation Description
smartElements Array of Object (AdSmartElement class) Optional List of the smart elements of the ad

AdTimerInteraction

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset in which the custom interaction was defined
name String Mandatory Name of the custom interaction as defined in the asset
reportingName String Mandatory Name of the custom interaction that will show in the reports
assetName String Read Only Name of the asset in which the custom interaction was defined

AdUserActionInteraction

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset in which the custom interaction was defined
name String Mandatory Name of the custom interaction as defined in the asset
reportingName String Mandatory Name of the custom interaction that will show in the reports
assetName String Read Only Name of the asset in which the custom interaction was defined
closeAdParts Boolean Mandatory Control whether to close the ad’s Flash elements when the interaction is triggered
redirectURL String Optional The exit URL to which the user will be redirected to when triggering the interaction
includeInInteractionRate Boolean Optional Control whether to include the interaction in the interaction rate, and to influence
the Interaction Rate metric in reports

AdvancedCompanion

Field Data Type Limitation Description
companionId Long Mandatory ID of the asset to be used
companionResourceType String (InstreamCompanionResourceType Enum) Unchangeable  
companionName String Unchangeable Name of the companion ad
width Long Unchangeable Width of the companion ad
height Long Unchangeable Height of the companion ad
size Long Unchangeable Size (in KB) of the companion ad
clickthrough String Optional Clickthrough URL to navigate to when clicking on companion ad
alternateText String Optional Text to be shown in case companion ad failed to load
placementId Long Unchangeable The id of the placement the ad is attached to
campaignId Long Unchangeable The id of the campaign the ad is assign to
companionFormat String (AdFormat Enum) Unchangeable The ad format of the companion ad

AdvancedRetargeting

Field Data Type Limitation Description
advertiserId Long Mandatory in case tags not empty The id of the advertiser of the campaign
tags Array of Object (AdvancedRetargetingTag) Optional List of advanced retargeting tags

AdvancedRetargetingTag

Field Data Type Limitation Description
tagId Long Mandatory Advanced retargeting tag id
advancedRetargetingTagValue Array of Object (AdvancedRetargetingTagValue) Read Only List of tag id & tag value pairs
advancedRetargetingTagValueAsString   Mandatory List of comma seperated tag values

AdvancedRetargetingTagValue

Field Data Type Limitation Description
id Integer Read Only Tag id
value String Read Only Tag value

AnalyticsSettings

Field Data Type Limitation Description
ignoreOverDelivery Boolean Read Only Setable threshold to stop serving after a number of impressions of the placement
verificationMode String (Viewability Enum) Read Only  
viewabilityThreshold String (ViewabilityThreshold Class) Read Only  
instreamViewabilityThreshold String (ViewabilityThreshold Class) Read Only  

BaseAnalyticsData

Field Data Type Limitation Description
impressions Long Read Only Number of impression
clicks Long Read Only Number of times the was clicked
lastUpdated Long Read Only Date & Time of last time the analytics data was updated
ctr Float Read Only Clickthrough rate
actualStartDate Long Read Only Date & Time of first impression (Settled after 1000 impressions)

BasePanelsSettings

Field Data Type Limitation Description
panelFrequency String (PanelFrequency Enum) Optional Time period to 'panelFrequencyTimes' field
panelFrequencyTimes Integer Optional How many times per user to auto expand the panel
multiplePanels Boolean Optional Show single panel at a time
autoExpandDefaultPanel Boolean Optional Auto expand default panel when ad is loaded
ExpandedPanelWidth Integer Optional Expanded panel width
ExpandedPanelHeight Integer Optional Expanded panel height
PanelPixelOffsetsX Integer Optional Panel pixel offsets X
PanelPixelOffsetsY Integer Optional Panel pixel offsets Y

Clickthrough

Field Data Type Limitation Description
url String Mandatory URL to navigate to on ad click

Companion

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image
clickthrough String Optional Clickthrough URL to navigate to when clicking on companion asset

ExtendedPanelsSettings

Field Data Type Limitation Description
panelFrequency String (PanelFrequency Enum) Optional Time period to 'panelFrequencyTimes' field
panelFrequencyTimes Integer Optional How many times per user to auto expand the panel
multiplePanels Boolean Optional Show single panel at a time
autoExpandDefaultPanel Boolean Optional Auto expand default panel when ad is loaded
ExpandedPanelWidth Integer Optional Expanded panel width
ExpandedPanelHeight Integer Optional Expanded panel height
PanelPixelOffsetsX Integer Optional Panel pixel offsets X
PanelPixelOffsetsY Integer Optional Panel pixel offsets Y
preloadPanels Boolean Optional  
delayExpansion Boolean Optional Delay expansion of panel
componentPositionX Integer Optional Component position in banner asset X
componentPositionY Integer Optional Component position in banner asset Y
componentCollapsedSizeX Integer Optional Component collapsed size X
componentCollapsedSizeY Integer Optional Component collapsed size Y

Linear

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image
variants Array of Object (Asset) Unchangeable List of variants of the given assets. Generated via auto-transcoding
transcodeJobID Long Unchangeable  
sequence integer Read Only  
vpaid Boolean Unchangeable Indicates the VPAID status of the asset

LinearHtml5Folder

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image
name String Read Only Name of the folder
assets Array of Object (Asset) Read Only Flat list of the assets in the folder
sequence integer Read Only  
vpaid Boolean Unchangeable Indicates the VPAID status of the asset

LinearSettings

Field Data Type Limitation Description
fileDuration Double Mandatory Play time duration of the linear assets
scalable Boolean Optional Control whether the linear asset should scale to fit the player
maintainAspectRatio Boolean Optional Control whether to maintain the aspect radio of the linear asset in case of scaling
clickthrough String Optional Clickthrough URL to navigate to when clicking on the linear asset
skipEnabled Boolean Optional Control whether to allow the user to skip the ad
skipDelay Double Optional Delay into the ad from which the skip button is clickable

MainClickThrough

Field Data Type Limitation Description
url String Mandatory URL to navigate to on ad click
targetWindowType String (TargetWindowType Enum) Mandatory  
showAddressBar Boolean Mandatory  
showMenuBar Boolean Mandatory  
closeAllAdParts Boolean Mandatory  

Panel

Field Data Type Limitation Description
assetId Long Mandatory ID of the asset to be used
assetName String Read Only Name of the asset to be used
source Boolean Optional  
assetStatus String (AssetStatus Enum) Read Only Status of the asset to be used
folderId Long Read Only ID of the folder the asset resides in
size Long Read Only Size (in KB) of the asset
duration Long Read Only Length of the asset (If applicable)
bitRate Long Read Only Bit rate of the asset (If applicable)
width integer Read Only Width of the asset
height Integer Read Only Height of the asset
mimeType String Read Only  
mediaType String Read Only  
thumbnailUrl String Read Only URL to the path of the asset thumbnail image
name String Mandatory Name of the panel
defaultPanel Boolean Mandatory Indicates whether the panel is set to be the default panel
positionX Float Mandatory X position of the panel
positionY Float Mandatory Y position of the panel
positionType String (PositionType Enum) Mandatory Type of positioning
autoExpand Boolean Optional  
delayedExpansion Boolean Optional  
retraction String (Retraction Enum) Mandatory  
transparent Boolean Optional  
autoGeneratedPanel Boolean Unchangeable Indicated if the panel is user defined or server generated

PanelsSettings

Field Data Type Limitation Description
panelFrequency String (PanelFrequency Enum) Optional Time period to 'panelFrequencyTimes' field
panelFrequencyTimes Integer Optional How many times per user to auto expand the panel
multiplePanels Boolean Optional Show single panel at a time
autoExpandDefaultPanel Boolean Optional Auto expand default panel when ad is loaded
ExpandedPanelWidth Integer Optional Expanded panel width
ExpandedPanelHeight Integer Optional Expanded panel height
PanelPixelOffsetsX Integer Optional Panel pixel offsets X
PanelPixelOffsetsY Integer Optional Panel pixel offsets Y
preloadPanels Boolean Optional  

TemplateData

Field Data Type Limitation Description
templateId Long Read Only ID of the In-Stream template to apply on the ad
vastVariables Array of Object (VastVariable Class) Read Only List of vast variables

ThirdPartyURL

Field Data Type Limitation Description
urlType String (ThirdPartyURLType Enum) Mandatory Type of tracking event
urlSource String (AdURLSource Enum) Mandatory The entity from which the tracking event originated
url String Mandatory URL to navigate to on ad click
enabled Boolean    

Variable

Field Data Type Limitation Description
key String Mandatory A var key is used to match between the JavaScript vars
(which is added to the CAF) and the vars settings in the platform
dataType String (VariableDataType Enum) Mandatory Data type of the variable defined
displayName String Mandatory How the variable will be showed in the UI
description String Optional A few words to describe what the vars controls and how it should be used
defaultValue String Mandatory (If 'Mandatory'
 was selected)
A default value for the var. This value will be carried to the ad when it's created
mandatory Boolean Mandatory Controls if the var is mandatory or optional
showInAdPage Boolean Mandatory Controls whether a var should be displayed on the ad page or not
variableSource String (VariableSource Enum) Read Only The source entity the variable originated from

VastVariable

Field Data Type Limitation Description
name String Read Only Name of the variable
value String Read Only Value of the variable
editLevel String (VastVariableEditLevel Enum) Read Only Maximum level where the variable can be edited
source String (VastVariableSource Enum) Read Only Source type of the variable

ViewabilityThreshold

Field Data Type Limitation Description
minimumSurface Integer    
minimumDuration Integer    
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk