Stay organized with collections Save and categorize content based on your preferences.

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

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<AdTechIdentifierAdSelectionSignals> 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

Fields

Public methods

describeContents

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

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

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

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

public Uri getDecisionLogicUri ()

Returns
Uri the URL 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

public Map<AdTechIdentifierAdSelectionSignals> getPerBuyerSignals ()

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

public AdTechIdentifier getSeller ()

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

getSellerSignals

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

public Uri getTrustedScoringSignalsUri ()

Returns
Uri URL endpoint of sell-side trusted signal from which creative specific realtime information can be fetched from. This value cannot be null.

hashCode

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. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

writeToParcel

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