Added in API level 35
Also in Ad Services Extensions 10

Summary: Nested Classes | Methods | Inherited Methods

FetchAndJoinCustomAudienceRequest

---

Kotlin |Java

public final class FetchAndJoinCustomAudienceRequest
extends Object

java.lang.Object
↳	android.adservices.customaudience.FetchAndJoinCustomAudienceRequest

---

The request object wrapping the required and optional parameters needed to fetch a CustomAudience.

fetchUri is the only required parameter. It represents the URI to fetch a custom audience from. name, activationTime, expirationTime and userBiddingSignals are optional parameters. They represent a partial custom audience which can be used by the caller to inform the choice of the custom audience the user should be added to. Any field set by the caller cannot be overridden by the custom audience fetched from the fetchUri. For more information about each field refer to CustomAudience.

Summary

Nested classes
class	FetchAndJoinCustomAudienceRequest.Builder Builder for FetchAndJoinCustomAudienceRequest objects.

Public methods
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
Instant	getActivationTime() Reference CustomAudience.getActivationTime() for details.
Instant	getExpirationTime() Reference CustomAudience.getExpirationTime() for details.
Uri	getFetchUri()
String	getName() Reference CustomAudience.getName() for details.
AdSelectionSignals	getUserBiddingSignals() Reference CustomAudience.getUserBiddingSignals() for details.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.

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.

Public methods

equals

Added in API level 35

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

Returns
boolean	true only if two FetchAndJoinCustomAudienceRequest objects contain the same information.

getActivationTime

Added in API level 35
Also in Ad Services Extensions 10

public Instant getActivationTime ()

Reference CustomAudience.getActivationTime() for details.

Returns
Instant	the Instant by which joining the custom audience will be delayed. This value may be null.

getExpirationTime

Added in API level 35
Also in Ad Services Extensions 10

public Instant getExpirationTime ()

Reference CustomAudience.getExpirationTime() for details.

Returns
Instant	the Instant by when the membership to the custom audience will expire. This value may be null.

getFetchUri

Added in API level 35
Also in Ad Services Extensions 10

public Uri getFetchUri ()

Returns
Uri	the Uri from which the custom audience is to be fetched. This value cannot be null.

getName

Added in API level 35
Also in Ad Services Extensions 10

public String getName ()

Reference CustomAudience.getName() for details.

Returns
String	the String name of the custom audience to join. This value may be null.

getUserBiddingSignals

Added in API level 35
Also in Ad Services Extensions 10

public AdSelectionSignals getUserBiddingSignals ()

Reference CustomAudience.getUserBiddingSignals() for details.

Returns
AdSelectionSignals	the buyer signals to be consumed by the buyer-provided JavaScript when the custom audience participates in an ad selection. This value may be null.

hashCode

Added in API level 35

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

Returns
int	the hash of the FetchAndJoinCustomAudienceRequest object's data.

toString

Added in API level 35

public String toString ()

Returns a string representation of the object.

Returns
String	a human-readable representation of FetchAndJoinCustomAudienceRequest.