ads-sdk/com.dolby.optiview.ads.sdk/AdBeginEvent

AdBeginEvent

data class AdBeginEvent(val break_: Break, val assetId: String, val adIndex: Int, val totalAds: Int, val timestamp: Long, val format: BreakFormat? = null, val asset: Asset? = null, val adId: String? = null, val creativeId: String? = null, val podPosition: Int? = null) : OptiViewAdsEvent

An individual ad starts playing. A GAM pod reports one adbegin per ad it was filled with.

Constructors

AdBeginEvent

constructor(break_: Break, assetId: String, adIndex: Int, totalAds: Int, timestamp: Long, format: BreakFormat? = null, asset: Asset? = null, adId: String? = null, creativeId: String? = null, podPosition: Int? = null)

Properties

adId

val adId: String?

IMA ad id for an ad of a GAM pod (PLAYG-362); null otherwise.

adIndex

val adIndex: Int

0-based index of the ad within the break.

asset

val asset: Asset?

The resolved asset, mirroring the web events' asset field.

assetId

val assetId: String

Id of the asset that starts; for an ad of a GAM pod, <podAssetId>-ad-<n>.

break_

val break_: Break

The break the ad belongs to.

creativeId

val creativeId: String?

IMA creative id for an ad of a GAM pod (PLAYG-362); null otherwise.

format

val format: BreakFormat?

Declared format of the break's selected variant (PLAYG-182).

podPosition

val podPosition: Int?

1-based position of the ad within its pod, as the ad system reports it at runtime (IMA adPodInfo.adPosition / VAST sequence). Null when the ad system reports none — static assets never have one.

timestamp

open override val timestamp: Long

When the event was emitted, in milliseconds since the Unix epoch.

totalAds

val totalAds: Int

Total number of ads in the break.

type

open override val type: OptiViewAdsEventType

Which event this is.