Package-level declarations

Contains all public entities related to requests to the ad server that you will encounter when working with the AdSDK.

Types

Link copied to clipboard

Enum class describing the expected type of placement for the Advertisement.

Link copied to clipboard
data class AdRequest : Parcelable

Describes a request to load an advertisement.

Link copied to clipboard

An object for storing global parameters that will be applied when creating an AdRequest.

Link copied to clipboard

Base class for storing global parameters that will be applied when creating an TagRequest, TrackingRequest and AdRequest.

Link copied to clipboard

Independent of pubrender, the publisher may need the transparency data for audit purposes.

Link copied to clipboard

Signals if the publisher is able to and intends to render an icon or other appropriate user-facing symbol and display the DSA transparency info to the end user.

Link copied to clipboard

Indicates if DSA information should be made available.

Link copied to clipboard
class ExternalUID(val uid: String, val isStable: Boolean? = null)

If your app has means to identify a user, for example through association with an user account or an advertising ID, you can share this with the ad server.

Link copied to clipboard
data class GDPR(val consent: String, val isRulesEnabled: Boolean? = null)

An app can ask users about their consent for sharing information with third parties.

Link copied to clipboard
data class TagRequest(val tags: List<TagRequest.Tag>)

Describes a request to "tag" a user.

Link copied to clipboard

An object for storing global parameters that will be applied when creating an TagRequest and TrackingRequest.

Link copied to clipboard
data class TrackingRequest(val landingPageId: Int, val trackingSpotId: Int, val orderId: String? = null, val itemNumber: String? = null, val description: String? = null, val quantity: Int? = null, val price: Float? = null, val total: Float? = null)

Trigger a request for conversion tracking.

Link copied to clipboard
sealed class UserIdType

This sealed class is a list of the user ID types that the SDK supports.