Uplynk Connector/com.theoplayer.android.connector.uplynk.network/UplynkAd

UplynkAd

@Serializable
data class UplynkAd(val apiFramework: String?, val companions: List<UplynkAd>, val mimeType: String, val creative: String, val events: Map<String, List<String>>? = null, val width: Float, val height: Float, val duration: Duration, val extensions: JsonElement? = null, val fwParameters: Map<String, String>? = null)

Represents details about an ad, including its API framework, companion ads, creative details, and other properties.

Constructors

Link copied to clipboard
constructor(apiFramework: String?, companions: List<UplynkAd>, mimeType: String, creative: String, events: Map<String, List<String>>? = null, width: Float, height: Float, duration: Duration, extensions: JsonElement? = null, fwParameters: Map<String, String>? = null)

Properties

Link copied to clipboard
val apiFramework: String?

Indicates the API Framework for the ad (e.g., VPAID). A null value is returned for ads that do not have an API Framework.

Link copied to clipboard
val companions: List<UplynkAd>

List of companion ads that go with the ad. Companion ads are also ad objects.

Link copied to clipboard
val creative: String

If applicable, indicates the creative to display. Video Ad (CMS): Indicates the asset ID for the video ad pushed from the CMS. Video Ad (VPAID): Indicates the URL to the VPAID JS or SWF.

Link copied to clipboard
@Serializable(with = DurationToSecDeserializer::class)
val duration: Duration

Indicates the duration, in seconds, of an ad's encoded video. VPAID: For VPAID ads, this parameter reports the duration returned from the ad server.

Link copied to clipboard
val events: Map<String, List<String>>? = null

Object containing all of the events for this ad. Each event type contains an array of URLs.

Link copied to clipboard
val extensions: JsonElement? = null

Contains the custom set of VAST extensions returned by the ad server. Each custom extension is reported as an object.

Link copied to clipboard
val fwParameters: Map<String, String>? = null

FreeWheel only: If the ad response provided by FreeWheel contains creative parameters, they are reported as name-value pairs within this object.

Link copied to clipboard
val height: Float

If applicable, indicates the height of the creative.

Link copied to clipboard
val mimeType: String

Indicates the ad's Internet media type (aka mime-type).

Link copied to clipboard
val width: Float

If applicable, indicates the width of the creative. This parameter reports "0" for the width/height of video ads.