sdk_core/com.adition.sdk_core.api.entities.response/AdResponse

AdResponse

data class AdResponse(val adType: String, val bannerId: String, val adName: String = "", val body: AdResponse.Body? = null, val campaignId: String, val clickUrl: String, val contentUnitId: String, val files: List<AdResponse.FileItem>, val height: Int, val logId: String, val networkId: Int, val options: AdResponse.Options, val placementType: String, val width: Int) : Parcelable

The data received from the ad server and decoded by the SDK.

The successful result of executing an AdRequest is the receipt and decoding of an AdResponse. This class contains basic information about the ad received from the ad server and decoded by the SDK.

Constructors

AdResponse

constructor(adType: String, bannerId: String, adName: String = "", body: AdResponse.Body? = null, campaignId: String, clickUrl: String, contentUnitId: String, files: List<AdResponse.FileItem>, height: Int, logId: String, networkId: Int, options: AdResponse.Options, placementType: String, width: Int)

Creates an AdResponse instance. You can use this constructor for testing. Normally you do not need to use it.

Types

Body

data class Body(val assets: List<AdResponse.Body.Asset>, val eventTrackers: List<AdResponse.Body.EventTracker>, val ext: AdResponse.Body.Ext? = null) : Parcelable

A portion of the data received from the ad server and decoded by the SDK that is associated with advertising content and tracking events.

FileItem

data class FileItem(val url: String, val name: String, val options: AdResponse.FileItem.FileOptions? = null) : Parcelable

A portion of the data received from the ad server and decoded by the SDK that is associated with additional advertising content.

Options

data class Options(val body: String? = null, val closeAfter: UInt? = null, val closeButtonAfter: UInt? = null, val countdownColor: String? = null) : Parcelable

A portion of the data received from the ad server and decoded by the SDK that is associated with additional options related to the advertisement.

Properties

adName

val adName: String

The name of the advertisement.

adType

val adType: String

The type of advertisement.

bannerId

val bannerId: String

The banner identifier the advertisement has been served for.

body

val body: AdResponse.Body? = null

Body instance, that contain advertisement content information.

campaignId

val campaignId: String

The campaign identifier the advertisement has been served for.

clickUrl

val clickUrl: String

The URL is associated with clicking on an ad. If the Advertisement.performTapEvent method called without the url parameter, this URL will be processed.

contentUnitId

val contentUnitId: String

Unique identifier of a content space in the ADITION ad-serving platform.

files

val files: List<AdResponse.FileItem>

Additional FileItems related to the advertisement.

height

val height: Int

Height of the advertisement.

logId

val logId: String

The log identifier of the advertisement.