Added in API level 34
Also in Ad Services Extensions 4

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

AdSelectionConfig

public final class AdSelectionConfig
extends Object implements Parcelable

java.lang.Object
↳	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 AdSelectionManager.selectAds(AdSelectionConfig, Executor, OutcomeReceiver) and AdSelectionManager#reportImpression methods in AdSelectionManager.

Summary

Nested classes
`class`	`AdSelectionConfig.Builder` Builder for `AdSelectionConfig` object.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<AdSelectionConfig>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`AdSelectionSignals`	`getAdSelectionSignals()`
`List<AdTechIdentifier>`	`getCustomAudienceBuyers()`
`Uri`	`getDecisionLogicUri()`
`Map<AdTechIdentifier, AdSelectionSignals>`	`getPerBuyerSignals()`
`AdTechIdentifier`	`getSeller()`
`AdSelectionSignals`	`getSellerSignals()`
`Uri`	`getTrustedScoringSignalsUri()`
`int`	`hashCode()` Returns a hash code value for the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34
Also in Ad Services Extensions 4

public static final Creator<AdSelectionConfig> CREATOR

Public methods

describeContents

Added in API level 34

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 34

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getAdSelectionSignals

Added in API level 34
Also in Ad Services Extensions 4

public AdSelectionSignals getAdSelectionSignals ()

Returns
`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`.

getCustomAudienceBuyers

Added in API level 34
Also in Ad Services Extensions 4

public List<AdTechIdentifier> getCustomAudienceBuyers ()

Returns
`List<AdTechIdentifier>`	a list of custom audience buyers allowed by the SSP to participate in the ad selection process This value cannot be `null`.

getDecisionLogicUri

Added in API level 34
Also in Ad Services Extensions 4

public Uri getDecisionLogicUri ()

Returns
`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

Added in API level 34
Also in Ad Services Extensions 4

public Map<AdTechIdentifier, AdSelectionSignals> getPerBuyerSignals ()

Returns
`Map<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

Added in API level 34
Also in Ad Services Extensions 4

public AdTechIdentifier getSeller ()

Returns
`AdTechIdentifier`	a AdTechIdentifier of the seller, for example "www.example-ssp.com" This value cannot be `null`.

getSellerSignals

Added in API level 34
Also in Ad Services Extensions 4

public AdSelectionSignals getSellerSignals ()

Returns
`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

Added in API level 34
Also in Ad Services Extensions 4

public Uri getTrustedScoringSignalsUri ()

Returns
`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

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Returns
`int`	a hash code value for this object.

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

AdSelectionConfig

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

equals

getAdSelectionSignals

getCustomAudienceBuyers

getDecisionLogicUri

getPerBuyerSignals

getSeller

getSellerSignals

getTrustedScoringSignalsUri

hashCode

writeToParcel