@dailymotion/vast-client

# Object reference ## VASTResponse This object represents a parsed VAST response. - `ads: Array<Object>` [go to object](#ad) - `errorURLTemplates: Array<String>` - `version: String` ## Ad<a name="ad"></a> 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](#category) - `expires: Number|null` - `viewableImpression: Array<Object>` [go to object](#viewable-impression) - `system: String|null` - `title: String|null` - `description: String|null` - `advertiser: Object|null` - `pricing: String|null` - `survey: Object|null` [go to object](#survey) - `errorURLTemplates: Array<String>` - `impressionURLTemplates: Array<Object>` - `creatives: Array<Object>` [go to object](#creative) - `extensions: Array<Object>` [go to object](#extension) - `adVerifications: Array<Object>` [go to object](#ad-verification) - `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<a name="creative"></a> 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](#universaladid) - `creativeExtensions: Array<Object>` [go to object](#extension) ## CreativeLinear *extends* Creative<a name="creative-linear"></a> - `type: String` - `duration: Number` - `skipDelay: Number|null` - `mediaFiles: Array<Object>` [go to object](#mediafile) - `mezzanine: Object<Object>` [go to object](#mezzanine) - `interactiveCreativeFile: Object` [go to object](#interactivecreativefile) - `closedCaptionFiles: Array<Object>` [go to object](#closedcaptionfile) - `videoClickThroughURLTemplate: String|null` - `videoClickTrackingURLTemplates: Array<String>` - `videoCustomClickURLTemplates: Array<String>` - `adParameters: Object|null` [go to object](#adparameters) - `icons: Array<Object>` [go to object](#icon) - `trackingEvents: Object` ## CreativeNonLinear *extends* Creative<a name="creative-non-linear"></a> - `type: String` - `variations: Array<Object>` [go to object](#non-linear-ad) - `trackingEvents: Object` ## CreativeCompanion *extends* Creative<a name="creative-companion"></a> - `type: String` - `required: String|null` - `variations: Array<Object>` [go to object](#companion-ad) ## MediaFile<a name="mediafile"></a> - `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<a name="mezzanine"></a> - `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<a name="interactivecreativefile"></a> - `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<a name="closedcaptionfile"></a> - `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<a name="non-linear-ad"></a> - `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](#adparameters) ## CompanionAd<a name="companion-ad"></a> - `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](#adparameters) ## Icon<a name="icon"></a> - `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](#iconclickfallbackimage) - `altText: String|null` - `hoverText: String|null` ## Extension<a name="extension"></a> - `name: String|null` - `value: any` - `attributes: Object` - `children: Array<Extension>` ## UniversalAdId<a name="universaladid"></a> - `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<a name="ad-verification"></a> - `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<a name="category"></a> - `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<a name="viewable-impression"></a> - `id: String|null` - `viewable: Array<String>` - `notViewable: Array<String>` - `viewUndetermined: Array<String>` ## BlockedAdCategories<a name="blocked-ad-categories"></a> - `authority: String` - `value: String` ## AdParameters<a name="adparameters"></a> - `value: String` - `xmlEncoded: String|null` ## Survey<a name="survey"></a> - `value: String` - `type: String|null` ## IconClickFallbackImage <a name="iconclickfallbackimage"></a> - `url: String|null`, - `width: String|null`, - `height: String|null`