Interface VastAdData

Holds various additional ad data. Refer to ImaAdData or BitmovinAdData for more information on what additional data is available when using our Google IMA SDK implementation or our native VAST implementation.

interface VastAdData {
    adDescription?: string;
    adSystem?: AdSystem;
    adTitle?: string;
    advertiser?: Advertiser;
    apiFramework?: string;
    bitrate?: number;
    codec?: string;
    creative?: Creative;
    delivery?: string;
    maxBitrate?: number;
    mediaFileId?: string;
    mimeType?: string;
    minBitrate?: number;
    minSuggestedDuration?: number;
    pricing?: AdPricing;
    survey?: AdSurvey;
    wrapperAdIds?: string[];
}

Hierarchy (view full)

Properties

adDescription? adSystem? adTitle? advertiser? apiFramework? bitrate? codec? creative? delivery? maxBitrate? mediaFileId? mimeType? minBitrate? minSuggestedDuration? pricing? survey? wrapperAdIds?

Properties

Optional adDescription

adDescription?: string

A longer description of the ad. Specified in InLine.Description in the VAST response.

Optional adSystem

adSystem?: AdSystem

The ad system that returned the ad. Specified in InLine.AdSystem in the VAST response.

Optional adTitle

adTitle?: string

A common name for the ad. Specified in InLine.AdTitle in the VAST response.

Optional advertiser

advertiser?: Advertiser

The advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.

Optional apiFramework

apiFramework?: string

Identifies the API needed to execute an interactive media file or communicate with the creative. Specified in MediaFile.apiFramework for linear ads or NonLinear.apiFramework for non-linear ads in the VAST response.

Optional bitrate

bitrate?: number

The average bitrate of the progressive media file as defined in the VAST response.

Optional codec

codec?: string

The codec used to encode the file which can take values as specified by https://tools.ietf.org/html/rfc4281. Specified in MediaFile.codec in the VAST response.

Optional creative

creative?: Creative

Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response.

Optional delivery

delivery?: string

Either 'progressive' for progressive download protocols or 'streaming' for streaming protocols. Specified in MediaFile.delivery in the VAST response.

Optional maxBitrate

maxBitrate?: number

The maximum bitrate of the streaming media file as defined in the VAST response.

Optional mediaFileId

mediaFileId?: string

The media file ID. Specified in MediaFile.id in the VAST response.

Optional mimeType

mimeType?: string

The MIME type of the media file or creative as defined in the VAST response.

Optional minBitrate

minBitrate?: number

The minimum bitrate of the streaming media file as defined in the VAST response.

Optional minSuggestedDuration

minSuggestedDuration?: number

The minimum suggested duration that the creative should be displayed. Specified in NonLinear.minSuggestedDuration in the VAST response.

Optional pricing

pricing?: AdPricing

Used to provide a value that represents a price that can be used by real-time bidding (RTB) systems. Specified in Inline.Pricing in the VAST response.

Optional survey

survey?: AdSurvey

URI to any resource relating to an integrated survey. Specified in InLine.Survey in the VAST response.

Optional wrapperAdIds

wrapperAdIds?: string[]

The IDs of the Wrapper ads, starting at the InLine ad and ending at the outermost Wrapper ad. Contains an empty array if there are no Wrapper ads.

Settings

Member Visibility

Theme

On This Page

adDescriptionadSystemadTitleadvertiserapiFrameworkbitratecodeccreativedeliverymaxBitratemediaFileIdmimeTypeminBitrateminSuggestedDurationpricingsurveywrapperAdIds