Player Module/com.bitmovin.player.api.advertising.vast/VastAdData

VastAdData

interface VastAdData : AdData
Content copied to clipboard

Holds various additional ad data that's available in the VAST response.

Properties

Link copied to clipboard
abstract val adDescription: String?
Content copied to clipboard

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

Link copied to clipboard
abstract val adSystem: AdSystem?
Content copied to clipboard

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

Link copied to clipboard
abstract val adTitle: String?
Content copied to clipboard

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

Link copied to clipboard
abstract val advertiser: Advertiser?
Content copied to clipboard

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

Link copied to clipboard
abstract val apiFramework: String?
Content copied to clipboard

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.

Link copied to clipboard
abstract val codec: String?
Content copied to clipboard

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.

Link copied to clipboard
abstract val creative: Creative?
Content copied to clipboard

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

Link copied to clipboard
abstract val delivery: MediaFileDeliveryType?
Content copied to clipboard

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

Link copied to clipboard
abstract val mediaFileId: String?
Content copied to clipboard

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

Link copied to clipboard
abstract val minSuggestedDuration: Double?
Content copied to clipboard

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

Link copied to clipboard
abstract val pricing: AdPricing?
Content copied to clipboard

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

Link copied to clipboard
abstract val survey: AdSurvey?
Content copied to clipboard

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

Link copied to clipboard
abstract val wrapperAdIds: Array<String>
Content copied to clipboard

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.

Inheritors

Link copied to clipboard