AdSelectionConfig

public final 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(
    @NonNull AdTechIdentifier seller,
    @NonNull Uri decisionLogicUri,
    @NonNull List<@NonNull AdTechIdentifier> customAudienceBuyers,
    @NonNull AdSelectionSignals adSelectionSignals,
    @NonNull AdSelectionSignals sellerSignals,
    @NonNull Map<@NonNull AdTechIdentifier, @NonNull AdSelectionSignals> perBuyerSignals,
    @NonNull Uri trustedScoringSignalsUri
)

Public methods
boolean
equals(Object other)

Checks whether two AdSelectionConfig objects contain the same information.
final @NonNull AdSelectionSignals

signals given to the participating buyers in the ad selection and reporting processes.
final @NonNull List<@NonNull AdTechIdentifier>

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

the URI used to retrieve the JS code containing the seller/SSP scoreAd function used during the ad selection and reporting processes.
final @NonNull Map<@NonNull AdTechIdentifier, @NonNull AdSelectionSignals>

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

AdTechIdentifier of the seller, for example "www.example-ssp.com".
final @NonNull 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).
final @NonNull Uri

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

Returns the hash of the AdSelectionConfig object's data.
@NonNull String

Overrides the toString method.

Public constructors

AdSelectionConfig

Added in 1.0.0
public AdSelectionConfig(
    @NonNull AdTechIdentifier seller,
    @NonNull Uri decisionLogicUri,
    @NonNull List<@NonNull AdTechIdentifier> customAudienceBuyers,
    @NonNull AdSelectionSignals adSelectionSignals,
    @NonNull AdSelectionSignals sellerSignals,
    @NonNull Map<@NonNull AdTechIdentifier, @NonNull AdSelectionSignals> perBuyerSignals,
    @NonNull Uri trustedScoringSignalsUri
)
Parameters
@NonNull AdTechIdentifier seller

AdTechIdentifier of the seller, for example "www.example-ssp.com".
@NonNull Uri decisionLogicUri

the URI used to retrieve the JS code containing the seller/SSP scoreAd function used during the ad selection and reporting processes.
@NonNull List<@NonNull AdTechIdentifier> customAudienceBuyers

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

signals given to the participating buyers in the ad selection and reporting processes.
@NonNull 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).
@NonNull Map<@NonNull AdTechIdentifier, @NonNull AdSelectionSignals> perBuyerSignals

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

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

Public methods

equals

public boolean equals(Object other)

Checks whether two AdSelectionConfig objects contain the same information.

getAdSelectionSignals

Added in 1.0.0
public final @NonNull AdSelectionSignals getAdSelectionSignals()

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

getCustomAudienceBuyers

Added in 1.0.0
public final @NonNull List<@NonNull AdTechIdentifier> getCustomAudienceBuyers()

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

getDecisionLogicUri

Added in 1.0.0
public final @NonNull Uri getDecisionLogicUri()

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

getPerBuyerSignals

Added in 1.0.0
public final @NonNull Map<@NonNull AdTechIdentifier, @NonNull AdSelectionSignals> getPerBuyerSignals()

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

getSeller

Added in 1.0.0
public final @NonNull AdTechIdentifier getSeller()

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

getSellerSignals

Added in 1.0.0
public final @NonNull AdSelectionSignals getSellerSignals()

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

getTrustedScoringSignalsUri

Added in 1.0.0
public final @NonNull Uri getTrustedScoringSignalsUri()

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

hashCode

public int hashCode()

Returns the hash of the AdSelectionConfig object's data.

toString

public @NonNull String toString()

Overrides the toString method.