sdk_core/com.adition.sdk_core.api.entities.request/AdRequest

AdRequest

Describes a request to load an advertisement.

Used as a parameter of the AdService.makeAdvertisement method. You can pass all configurable request data through the constructor.

Constructors

AdRequest

constructor(contentUnit: String, profiles: HashMap<String, String> = hashMapOf(), keywords: List<String> = listOf(), window: UInt? = null, timeoutAfterSeconds: UInt? = null, gdprPd: Boolean? = null, campaignId: String? = null, bannerId: String? = null, isSHBEnabled: Boolean? = null, dsa: AdRequestGlobalParameters.DSA? = null)

Creates a request with passed content unit and request data.

constructor(learningTag: Map<String, String>, profiles: HashMap<String, String> = hashMapOf(), keywords: List<String> = listOf(), window: UInt? = null, timeoutAfterSeconds: UInt? = null, gdprPd: Boolean? = null, campaignId: String? = null, bannerId: String? = null, isSHBEnabled: Boolean? = null, dsa: AdRequestGlobalParameters.DSA? = null)

Creates a request with passed learning tag and request data.

Properties

bannerId

val bannerId: String?

The SDK provides functionality to request a specific banner from the backend. This could be helpful for debugging and testing purposes.

campaignId

val campaignId: String?

The SDK provides functionality to request a specific campaign from the backend. This could be helpful for debugging and testing purposes.

contentUnit

val contentUnit: String?

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

dsa

val dsa: AdRequestGlobalParameters.DSA?

Digital Service Act (“DSA”) is a EU regulation which aims among other things to increase transparency on online platforms for users in relation to recommended content – including advertising.

gdprPd

val gdprPd: Boolean?

If your app passes personal information as part of the user profiles, you can set an gdprPd parameter when creating an Advertisement.

isSHBEnabled

val isSHBEnabled: Boolean?

Defines, if the request should also consider the server side header bidding.

keywords

val keywords: List<String>

The keyword targeting is a simple comma separated list of keywords that can be used to make partial or complete keyword list targeting.

learningTag

val learningTag: Map<String, String>?

Key-value pairs that are attached to content units.

profiles

val profiles: HashMap<String, String>

When requesting an advertisement it is possible to send application targeting profiles which can be used to select the correct banner that should be delivered.

timeoutAfterSeconds

val timeoutAfterSeconds: UInt?

Timeout for specific ad request.

window

val window: UInt?

The SDK provides functionality to organize window ids so that inclusion and exclusion filters can be evaluated.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)