AdData

interface AdData

AdData exposes the ad data attributes of the VAST protocol.

Properties

Link copied to clipboard
abstract val adFormat: AdFormat

The ad format: normal, extension or silence extension

Link copied to clipboard
abstract val adParameters: AdParameters?

Ad parameters from the VAST response

Link copied to clipboard
abstract var adType: Ad.AdType

Expose ad type information

Link copied to clipboard
abstract val advertiser: Advertiser?

The advertiser field from VAST response

Link copied to clipboard
abstract val creativeExtensions: List<CreativeExtension>

Creative extensions from the VAST response

Link copied to clipboard
abstract val duration: Double?

The duration of the ad taken from the VAST response

Link copied to clipboard
abstract val extensions: List<VastExtension>

Ad extensions from VAST response

Link copied to clipboard
abstract val hasCompanion: Boolean

Exposes whether the ad has a companion banner information or not.

Link copied to clipboard
abstract val height: Int?

The media file height field value from the VAST response

Link copied to clipboard
abstract val id: String?

The ad ID from the VAST response

Link copied to clipboard
abstract val instanceId: String
Link copied to clipboard
abstract val mediaUrlString: String?

The media file that was chosen be used for the ad

Link copied to clipboard
abstract val pricing: Pricing?

The pricing field from VAST response

Link copied to clipboard
abstract val skipOffset: Double?

The minimum time that has to pass until an ad can be skipped. If null, the ad can be skipped immediately.

Link copied to clipboard
abstract val width: Int?

The media file width field value from the VAST response

Functions

Link copied to clipboard
abstract fun getAllCompanions(): List<CompanionVast>

The list of all companions from the VAST response