ScheduleCustomAudienceUpdateRequest

class ScheduleCustomAudienceUpdateRequest
kotlin.Any
   ↳ 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

Builder for ScheduleCustomAudienceUpdateRequest objects.
Public methods
Boolean
equals(other: Any?)
Duration

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

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

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

Returns the hash of ScheduleCustomAudienceUpdateRequest object's data.
Boolean

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

Public methods

equals

Added in API level 36
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true only if two ScheduleCustomAudienceUpdateRequest objects contain the same information.

getMinDelay

Added in API level 36
Also in Ad Services Extensions 14
fun getMinDelay(): Duration

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

Return
Duration This value cannot be null.

getPartialCustomAudienceList

Added in API level 36
Also in Ad Services Extensions 14
fun getPartialCustomAudienceList(): MutableList<PartialCustomAudience!>

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.

Return
MutableList<PartialCustomAudience!> This value cannot be null.

getUpdateUri

Added in API level 36
Also in Ad Services Extensions 14
fun getUpdateUri(): Uri

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.

Return
Uri This value cannot be null.

hashCode

Added in API level 36
fun hashCode(): Int

Returns the hash of ScheduleCustomAudienceUpdateRequest object's data.

Return
Int a hash code value for this object.

shouldReplacePendingUpdates

Added in API level 36
Also in Ad Services Extensions 14
fun shouldReplacePendingUpdates(): Boolean

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 android.adservices.customaudience.CustomAudienceManager#scheduleCustomAudienceUpdate(android.adservices.customaudience.ScheduleCustomAudienceUpdateRequest,java.util.concurrent.Executor,android.adservices.common.AdServicesOutcomeReceiver) with this ScheduleCustomAudienceUpdateRequest will fail.

toString

Added in API level 36
fun toString(): String
Return
String a human-readable representation of ScheduleCustomAudienceUpdateRequest.