AdSelectionConfig

Artifact: androidx.privacysandbox.ads:ads-adservices

View Source

Added in 1.0.0

---

Kotlin |Java

class AdSelectionConfig

---

Contains the configuration of the ad selection process.

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

Summary

Public constructors
AdSelectionConfig(     seller: AdTechIdentifier,     decisionLogicUri: Uri,     customAudienceBuyers: List<AdTechIdentifier>,     adSelectionSignals: AdSelectionSignals,     sellerSignals: AdSelectionSignals,     perBuyerSignals: Map<AdTechIdentifier, AdSelectionSignals>,     trustedScoringSignalsUri: Uri )

Public functions
open operator Boolean	equals(other: Any?) Checks whether two AdSelectionConfig objects contain the same information.
open Int	hashCode() Returns the hash of the AdSelectionConfig object's data.
open String	toString() Overrides the toString method.

Public properties
AdSelectionSignals	adSelectionSignals signals given to the participating buyers in the ad selection and reporting processes.
List<AdTechIdentifier>	customAudienceBuyers a list of custom audience buyers allowed by the SSP to participate in the ad selection process.
Uri	decisionLogicUri the URI used to retrieve the JS code containing the seller/SSP scoreAd function used during the ad selection and reporting processes.
Map<AdTechIdentifier, AdSelectionSignals>	perBuyerSignals any information that each buyer would provide during ad selection to participants (such as bid floor, ad selection type, etc.)
AdTechIdentifier	seller AdTechIdentifier of the seller, for example "www.example-ssp.com".
AdSelectionSignals	sellerSignals 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).
Uri	trustedScoringSignalsUri URI endpoint of sell-side trusted signal from which creative specific realtime information can be fetched from.

Public constructors

AdSelectionConfig

Added in 1.0.0

AdSelectionConfig(
    seller: AdTechIdentifier,
    decisionLogicUri: Uri,
    customAudienceBuyers: List<AdTechIdentifier>,
    adSelectionSignals: AdSelectionSignals,
    sellerSignals: AdSelectionSignals,
    perBuyerSignals: Map<AdTechIdentifier, AdSelectionSignals>,
    trustedScoringSignalsUri: Uri
)

Parameters
seller: AdTechIdentifier	AdTechIdentifier of the seller, for example "www.example-ssp.com".
decisionLogicUri: Uri	the URI used to retrieve the JS code containing the seller/SSP scoreAd function used during the ad selection and reporting processes.
customAudienceBuyers: List<AdTechIdentifier>	a list of custom audience buyers allowed by the SSP to participate in the ad selection process.
adSelectionSignals: AdSelectionSignals	signals given to the participating buyers in the ad selection and reporting processes.
sellerSignals: AdSelectionSignals	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).
perBuyerSignals: Map<AdTechIdentifier, AdSelectionSignals>	any information that each buyer would provide during ad selection to participants (such as bid floor, ad selection type, etc.)
trustedScoringSignalsUri: Uri	URI endpoint of sell-side trusted signal from which creative specific realtime information can be fetched from.

Public functions

equals

open operator fun equals(other: Any?): Boolean

Checks whether two AdSelectionConfig objects contain the same information.

hashCode

open fun hashCode(): Int

Returns the hash of the AdSelectionConfig object's data.

toString

open fun toString(): String

Overrides the toString method.

Public properties

adSelectionSignals

Added in 1.0.0

val adSelectionSignals: AdSelectionSignals

signals given to the participating buyers in the ad selection and reporting processes.

customAudienceBuyers

Added in 1.0.0

val customAudienceBuyers: List<AdTechIdentifier>

a list of custom audience buyers allowed by the SSP to participate in the ad selection process.

decisionLogicUri

Added in 1.0.0

val decisionLogicUri: Uri

the URI used to retrieve the JS code containing the seller/SSP scoreAd function used during the ad selection and reporting processes.

perBuyerSignals

Added in 1.0.0

val perBuyerSignals: Map<AdTechIdentifier, AdSelectionSignals>

any information that each buyer would provide during ad selection to participants (such as bid floor, ad selection type, etc.)

seller

Added in 1.0.0

val seller: AdTechIdentifier

AdTechIdentifier of the seller, for example "www.example-ssp.com".

sellerSignals

Added in 1.0.0

val sellerSignals: AdSelectionSignals

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).

trustedScoringSignalsUri

Added in 1.0.0

val trustedScoringSignalsUri: Uri

URI endpoint of sell-side trusted signal from which creative specific realtime information can be fetched from.