Skip to content

class-reference.md

Latest commit

 

History

History
233 lines (186 loc) · 8.22 KB

class-reference.md

File metadata and controls

233 lines (186 loc) · 8.22 KB
Raw

Object reference

VASTResponse

This object represents a parsed VAST response.

  • ads: Array<Object> go to object
  • errorURLTemplates: Array<String>
  • version: String

Ad

This object represents a single parsed Ad

  • id: String|null
  • sequence: Number|null
  • adType: 'video' An optional string that identifies the type of ad. Default value = video
  • adServingId: String
  • categories: Array<Object> go to object
  • expires: Number|null
  • viewableImpression: Array<Object> go to object
  • system: String|null
  • title: String|null
  • description: String|null
  • advertiser: Object|null
  • pricing: String|null
  • survey: Object|null go to object
  • errorURLTemplates: Array<String>
  • impressionURLTemplates: Array<Object>
  • creatives: Array<Object> go to object
  • extensions: Array<Object> go to object
  • adVerifications: Array<Object> go to object
  • hasFailed: Boolean Indicates that the parsed node has failed to be unwrapped or parsed. Only available with the option keepFailedAdPod on ads with a sequence.

Creative

This object represents a generic Creative. It's used as a parent object for more specific creative implementations.

  • id: String|null
  • adId: String|null
  • sequence: Number|null
  • apiFramework: String|null
  • universalAdIds: Array<Object> go to object
  • creativeExtensions: Array<Object> go to object

CreativeLinear extends Creative

  • type: String
  • duration: Number
  • skipDelay: Number|null
  • mediaFiles: Array<Object> go to object
  • mezzanine: Object<Object> go to object
  • interactiveCreativeFile: Object go to object
  • closedCaptionFiles: Array<Object> go to object
  • videoClickThroughURLTemplate: String|null
  • videoClickTrackingURLTemplates: Array<String>
  • videoCustomClickURLTemplates: Array<String>
  • adParameters: Object|null go to object
  • icons: Array<Object> go to object
  • trackingEvents: Object

CreativeNonLinear extends Creative

  • type: String
  • variations: Array<Object> go to object
  • trackingEvents: Object

CreativeCompanion extends Creative

  • type: String
  • required: String|null
  • variations: Array<Object> go to object

MediaFile

  • id: String|null
  • fileURL: String|null
  • deliveryType: String
  • mimeType: String|null
  • code: String|null
  • bitrate: Number
  • minBitrate: Number
  • maxBitrate: Number
  • width: Number
  • height: Number
  • fileSize: Number|null
  • mediaType: String|null Type of media file (3D / 360 / etc). Optional. Default value = 2D
  • apiFramework: String|null
  • scalable: Boolean|null
  • maintainAspectRatio: Boolean|null

Mezzanine

  • delivery: String Either "progressive" for progressive download protocols (such as HTTP) or "streaming" for streaming protocols
  • type: String MIME type for the file container. Popular MIME types include, but are not limited to "video/mp4" for MP4, "audio/mpeg" and "audio/aac" for audio ads
  • width: Number
  • height: Number
  • codec: String|null The codec used to encode the file which can take values as specified by RFC 4281: http://tools.ietf.org/html/rfc4281
  • id: String|null
  • fileSize: Number|null
  • mediaType: String|null Type of media file (3D / 360 / etc). Optional. Default value = 2D
  • fileURL: String|null

InteractiveCreativeFile

  • type: String|null MIME type for the file provided
  • apiFramework: String|null Identifies the API needed to execute the resource file, if applicable
  • variableDuration: Boolean|null Identifies whether the ad always drops when the duration is reached, or if it can potentially extend the duration by pausing the underlying video or delaying the adStopped call after adVideoComplete
  • fileURL: String|null

ClosedCaptionFile

  • type: String|null MIME type for the file provided
  • language: String|null Language of the Closed Caption File using ISO 631-1 codes
  • fileURL: String|null

NonLinearAd

  • id: String|null
  • width: Number
  • height: Number
  • expandedWidth: Number
  • expandedHeight: Number
  • scalable: Boolean
  • maintainAspectRatio: Boolean
  • minSuggestedDuration: Number
  • apiFramework: String
  • type: String|null
  • staticResource: String|null
  • htmlResource: String|null
  • iframeResource: String|null
  • nonlinearClickThroughURLTemplate: String|null
  • nonlinearClickTrackingURLTemplates: Array<Object>
  • adParameters: Object|null go to object

CompanionAd

  • id: String|null
  • width: Number
  • height: Number
  • assetWidth: Number|null
  • assetHeight: Number|null
  • expandedWidth: Number|null
  • expandedHeight: Number|null
  • apiFramework: String|null
  • adSlotId: String|null
  • pxratio: String|'1' The pixel ratio for which the companion creative is intended. Default value = 1
  • renderingMode: String|'default' Used to indicate when and where to use this companion ad. Default value = default
  • staticResources: Array<{ url: String, creativeType: String|null }>
  • htmlResources: Array<String>
  • iframeResources: Array<String>
  • altText: String|null
  • companionClickThroughURLTemplate: String|null
  • companionClickTrackingURLTemplates: Array<Object>
  • trackingEvents: Object
  • adParameters: Object|null go to object

Icon

  • program: String|null
  • height: Number
  • width: Number
  • xPosition: Number
  • yPosition: Number
  • apiFramework: String|null
  • offset: String|null
  • duration: Number
  • type: String|null
  • pxratio: String|'1' The pixel ratio for which the icon creative is intended. Default value = 1
  • staticResource: String|null
  • htmlResource: String|null
  • iframeResource: String|null
  • iconClickThroughURLTemplate: String|null
  • iconClickTrackingURLTemplates: Array<Object>
  • iconViewTrackingURLTemplate: String|null
  • iconClickFallbackImages: Array<object> go to object
  • altText: String|null
  • hoverText: String|null

Extension

  • name: String|null
  • value: any
  • attributes: Object
  • children: Array<Extension>

UniversalAdId

  • idRegistry: String|'unknown' A string used to identify the URL for the registry website where the unique creative ID is cataloged. Default value is “unknown”.
  • value: any

AdVerification

  • apiFramework: String|null The name of the API framework used to execute the AdVerification code
  • browserOptional: Boolean If true, this resource is optimized and able to execute in an environment without DOM and other browser built-ins (e.g. iOS' JavaScriptCore).
  • resource: String|null URI to the JavaScript file used to collect verification data
  • vendor: String|null An identifier for the verification vendor
  • type: String|null The type of executable resource provided
  • parameters: String|null String intended for bootstrapping the verification code and providing metadata about the current impression
  • trackingEvents: Object

Category

  • authority: String A URL for the organizational authority that produced the list being used to identify ad content category
  • value: String A category code or label that identifies the ad content category

ViewableImpression

  • id: String|null
  • viewable: Array<String>
  • notViewable: Array<String>
  • viewUndetermined: Array<String>

BlockedAdCategories

  • authority: String
  • value: String

AdParameters

  • value: String
  • xmlEncoded: String|null

Survey

  • value: String
  • type: String|null

IconClickFallbackImage

  • url: String|null,
  • width: String|null,
  • height: String|null