Added in Ad Services Extensions 14

Summary: Nested Classes | Methods | Inherited Methods

ScheduleCustomAudienceUpdateRequest

---

Kotlin |Java

public final class ScheduleCustomAudienceUpdateRequest
extends Object

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

---

The request object wrapping the required and optional parameters to schedule a deferred update for a buyer ad tech's custom audiences.

The on-device caller can specify information in a series of PartialCustomAudience objects that will be sent to the buyer ad tech's server after a designated minimum delay.

Summary

Nested classes
class	ScheduleCustomAudienceUpdateRequest.Builder Builder for ScheduleCustomAudienceUpdateRequest objects.

Public methods
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
Duration	getMinDelay() Returns the minimum Duration that the update will be deferred before the service fetches updates for the buyer ad tech's custom audiences.
List<PartialCustomAudience>	getPartialCustomAudienceList() Returns the list of PartialCustomAudience objects which are sent along with the request to download the updates for the buyer ad tech's custom audiences.
Uri	getUpdateUri() Returns the Uri from which the update for the buyer's custom audiences will be fetched.
int	hashCode() Returns the hash of ScheduleCustomAudienceUpdateRequest object's data.
boolean	shouldReplacePendingUpdates() Returns true if any pending scheduled updates should be canceled and replaced with the update detailed in the current ScheduleCustomAudienceUpdateRequest.
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

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 ScheduleCustomAudienceUpdateRequest objects contain the same information.

getMinDelay

Added in Ad Services Extensions 14

public Duration getMinDelay ()

Returns the minimum Duration that the update will be deferred before the service fetches updates for the buyer ad tech's custom audiences.

Returns
Duration	This value cannot be null.

getPartialCustomAudienceList

Added in Ad Services Extensions 14

public List<PartialCustomAudience> getPartialCustomAudienceList ()

Returns the list of PartialCustomAudience objects which are sent along with the request to download the updates for the buyer ad tech's custom audiences.

Returns
List<PartialCustomAudience>	This value cannot be null.

getUpdateUri

Added in Ad Services Extensions 14

public Uri getUpdateUri ()

Returns the Uri from which the update for the buyer's custom audiences will be fetched.

The Uri must use the same HTTPS site as the buyer ad tech's enrolled server.

Returns
Uri	This value cannot be null.

hashCode

public int hashCode ()

Returns the hash of ScheduleCustomAudienceUpdateRequest object's data.

Returns
int	a hash code value for this object.

shouldReplacePendingUpdates

Added in Ad Services Extensions 14

public boolean shouldReplacePendingUpdates ()

Returns true if any pending scheduled updates should be canceled and replaced with the update detailed in the current ScheduleCustomAudienceUpdateRequest.

If this method returns false and there are previously requested updates still pending for the same buyer in the same app, a call to CustomAudienceManager.scheduleCustomAudienceUpdate(android.adservices.customaudience.ScheduleCustomAudienceUpdateRequest, java.util.concurrent.Executor, android.adservices.common.AdServicesOutcomeReceiver) with this ScheduleCustomAudienceUpdateRequest will fail.

Returns
boolean

toString

public String toString ()

Returns a string representation of the object.

Returns
String	a human-readable representation of ScheduleCustomAudienceUpdateRequest.