AdData

interface AdData

AdData exposes the ad data attributes of the VAST protocol.

Properties

Link copied to clipboard
abstract val adDescription: String?

The ad description field from VAST response. return null if missing

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 val adTitle: String

The ad title field from VAST response. return empty string if missing

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. The Advertiser.id is an (optional) identifier for the advertiser, provided by the ad server. Can be used for internal analytics. This is only available in newer VAST versions such as 4.1, 4.2, etc. The Advertiser.value is a string that provides the name of the advertiser as defined by the ad serving party. Recommend using the domain of the advertiser.

Link copied to clipboard

Creative extensions from the VAST response

Link copied to clipboard
abstract val duration: Duration?

The duration of the ad taken from the VAST response

Link copied to clipboard

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

Unique id of the ad instance. While two request on the same zone id can return the same ad with the same id, the instanceId will be different.

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

The companion selected by the SDK to be displayed based on AdCompanionOptions settings

Link copied to clipboard
abstract val skipOffset: Duration?

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

The list of all companions from the VAST response