Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
137 lines (109 sloc) 3.53 KB

Class reference

VASTResponse

This class represents a parsed VAST response.

  • ads: Array<Ad> go to class
  • errorURLTemplates: Array<String>
  • version: String

Ad

This class represents a single parsed Ad

  • id: String|null
  • sequence: Number|null
  • system: String|null
  • title: String|null
  • description: String|null
  • advertiser: String|null
  • pricing: String|null
  • survey: String|null
  • errorURLTemplates: Array<String>
  • impressionURLTemplates: Array<String>
  • creatives: Array<Creative> go to class
  • extensions: Array<AdExtension> go to class

Creative

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

  • id: String|null
  • adId: String|null
  • sequence: Number|null
  • apiFramework: String|null
  • trackingEvents: Object

CreativeLinear extends Creative

  • type: String
  • duration: Number
  • skipDelay: Number|null
  • mediaFiles: Array<MediaFile> go to class
  • videoClickThroughURLTemplate: String|null
  • videoClickTrackingURLTemplates: Array<String>
  • videoCustomClickURLTemplates: Array<String>
  • adParameters: String|null
  • icons: Array<Icon> go to class

CreativeNonLinear extends Creative

  • type: String
  • variations: Array<NonLinearAd> go to class

CreativeCompanion extends Creative

  • type: String
  • variations: Array<CompanionAd> go to class

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
  • apiFramework: String|null
  • scalable: Boolean|null
  • maintainAspectRatio: Boolean|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<String>
  • adParameters: String|null

CompanionAd

  • id: String|null
  • width: Number
  • height: Number
  • type: String|null
  • staticResource: String|null
  • htmlResource: String|null
  • iframeResource: String|null
  • altText: String|null
  • nonlinearClickThroughURLTemplate: String|null
  • nonlinearClickTrackingURLTemplates: Array<String>
  • trackingEvents: Object

Icon

  • program: String|null
  • height: Number
  • width: Number
  • xPosition: Number
  • yPosition: Number
  • apiFramework: String|null
  • offset: String|null
  • duration: Number
  • type: String|null
  • staticResource: String|null
  • htmlResource: String|null
  • iframeResource: String|null
  • iconClickThroughURLTemplate: String|null
  • iconClickTrackingURLTemplates: Array<String>
  • iconViewTrackingURLTemplate: String|null

AdExtension

  • attributes: Object
  • children: Array<AdExtensionChild> go to class

AdExtensionChild

  • name: String|null
  • value: any
  • attributes: Object
You can’t perform that action at this time.