com.bitmovin.player.api.advertising.vast
VastAdData
interface VastAdData : AdData
Holds various additional ad data that's available in the VAST response.
Inheritors
Properties
| Name | Summary |
|---|---|
| adDescription | abstract val adDescription: String? A longer description of the ad. Specified in InLine.Description in the VAST response. |
| adSystem | abstract val adSystem: AdSystem? The AdSystem that returned the ad. Specified in InLine.AdSystem in the VAST response. |
| adTitle | abstract val adTitle: String? A common name for the ad. Specified in InLine.AdTitle in the VAST response. |
| advertiser | abstract val advertiser: Advertiser? The Advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response. |
| apiFramework | abstract val 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. |
| codec | abstract val 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. |
| creative | abstract val creative: Creative? Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response. |
| delivery | abstract val delivery: MediaFileDeliveryType? Either 'progressive' for progressive download protocols or 'streaming' for streaming protocols. Specified in MediaFile.delivery in the VAST response. |
| mediaFileId | abstract val mediaFileId: String? The media file ID. Specified in MediaFile.id in the VAST response. |
| minSuggestedDuration | abstract val minSuggestedDuration: Double? The minimum suggested duration that the creative should be displayed. Specified in NonLinear.minSuggestedDuration in the VAST response. |
| pricing | abstract val pricing: AdPricing? 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. |
| survey | abstract val survey: AdSurvey? URI to any resource relating to an integrated AdSurvey. Specified in InLine.Survey in the VAST response. |
| wrapperAdIds | abstract val wrapperAdIds: Array<String> The IDs of the Wrapper ads, starting at the innermost wrapper ad and ending at the outermost Wrapper ad. If a Wrapper ad does not specify an id, the corresponding entry is an empty string. Contains an empty list if there are no Wrapper ads. |
| wrapperAdSystems | abstract val wrapperAdSystems: List<AdSystem> The AdSystems of the Wrapper ads, starting at the innermost wrapper ad and ending at the outermost Wrapper ad. Contains an empty list if there are no Wrapper ads. |
| wrapperCreativeIds | abstract val wrapperCreativeIds: List<String> The IDs of the Wrapper ads Creative elements, starting at the innermost wrapper ad and ending at the outermost Wrapper ad. If a wrapper Creative element does not specify an id, the corresponding entry is an empty string. Contains an empty list if there are no Wrapper ads. |