AdSelectionConfig

class AdSelectionConfig : Parcelable
kotlin.Any
   ↳ android.adservices.adselection.AdSelectionConfig

Contains the configuration of the ad selection process.

Instances of this class are created by SDKs to be provided as arguments to the android.adservices.adselection.AdSelectionManager#selectAds and AdSelectionManager#reportImpression methods in AdSelectionManager.

Summary

Nested classes

Builder for AdSelectionConfig object.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

AdSelectionSignals

MutableMap<AdTechIdentifier!, SignedContextualAds!>

MutableList<AdTechIdentifier!>

Uri

MutableMap<AdTechIdentifier!, AdSelectionSignals!>

AdTechIdentifier

AdSelectionSignals

Uri

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AdSelectionConfig!>

Public methods

describeContents

Added in API level 34
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAdSelectionSignals

fun getAdSelectionSignals(): AdSelectionSignals
Return
AdSelectionSignals JSON in an AdSelectionSignals object, fetched from the AdSelectionConfig and consumed by the JS logic fetched from the DSP, represents signals given to the participating buyers in the ad selection and reporting processes. This value cannot be null.

getBuyerSignedContextualAds

fun getBuyerSignedContextualAds(): MutableMap<AdTechIdentifier!, SignedContextualAds!>
Return
MutableMap<AdTechIdentifier!, SignedContextualAds!> a Map of buyers and corresponding Contextual Ads, these ads are expected to be pre-downloaded from the contextual path and injected into Ad Selection. This value cannot be null.

getCustomAudienceBuyers

fun getCustomAudienceBuyers(): MutableList<AdTechIdentifier!>
Return
MutableList<AdTechIdentifier!> a list of custom audience buyers allowed by the SSP to participate in the ad selection process This value cannot be null.

getDecisionLogicUri

fun getDecisionLogicUri(): Uri
Return
Uri the URI used to retrieve the JS code containing the seller/SSP scoreAd function used during the ad selection and reporting processes This value cannot be null.

getPerBuyerSignals

fun getPerBuyerSignals(): MutableMap<AdTechIdentifier!, AdSelectionSignals!>
Return
MutableMap<AdTechIdentifier!, AdSelectionSignals!> a Map of buyers and AdSelectionSignals, fetched from the AdSelectionConfig and consumed by the JS logic fetched from the DSP, representing any information that each buyer would provide during ad selection to participants (such as bid floor, ad selection type, etc.) This value cannot be null.

getSeller

fun getSeller(): AdTechIdentifier
Return
AdTechIdentifier a AdTechIdentifier of the seller, for example "www.example-ssp.com" This value cannot be null.

getSellerSignals

fun getSellerSignals(): AdSelectionSignals
Return
AdSelectionSignals JSON in an AdSelectionSignals object, provided by the SSP and consumed by the JS logic fetched from the SSP, represents any information that the SSP used in the ad scoring process to tweak the results of the ad selection process (e.g. brand safety checks, excluded contextual ads). This value cannot be null.

getTrustedScoringSignalsUri

fun getTrustedScoringSignalsUri(): Uri
Return
Uri URI endpoint of sell-side trusted signal from which creative specific realtime information can be fetched from. This value cannot be null.

hashCode

Added in API level 34
fun hashCode(): Int
Return
Int a hash code value for this object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

static val CREATOR: Parcelable.Creator<AdSelectionConfig!>