ScheduleCustomAudienceUpdateRequest

Artifact: androidx.privacysandbox.ads:ads-adservices

Kotlin |Java

@ExperimentalFeatures.Ext14OptIn
class ScheduleCustomAudienceUpdateRequest

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

Summary

Public constructors
`ScheduleCustomAudienceUpdateRequest( updateUri: Uri, minDelay: Duration, partialCustomAudienceList: List<PartialCustomAudience>, shouldReplacePendingUpdates: Boolean )`

Public functions
`open operator Boolean`	`equals(other: Any?)` Checks whether two ScheduleCustomAudienceUpdateRequest objects contain the same information.
`open Int`	`hashCode()` Returns the hash of the ScheduleCustomAudienceUpdateRequest object's data.
`open String`	`toString()`

Public properties
`Duration`	`minDelay` The `Duration` representing the minimum of the delay before the service fetches updates for the buyer ad tech's custom audiences.
`List<PartialCustomAudience>`	`partialCustomAudienceList` The list of `PartialCustomAudience` objects which are sent along with the request to download the updates for the buyer ad tech's custom audiences.
`Boolean`	`shouldReplacePendingUpdates` If any pending scheduled updates should be canceled and replaced with the update detailed in the current `ScheduleCustomAudienceUpdateRequest`.
`Uri`	`updateUri` The `Uri` from which the update for the buyer's custom audiences will be fetched.

Public constructors

ScheduleCustomAudienceUpdateRequest

Added in 1.1.0-beta12

ScheduleCustomAudienceUpdateRequest(
    updateUri: Uri,
    minDelay: Duration,
    partialCustomAudienceList: List<PartialCustomAudience>,
    shouldReplacePendingUpdates: Boolean = false
)

Parameters
`updateUri: Uri`	The `Uri` from which the update for the buyer's custom audiences will be fetched.
`minDelay: Duration`	The `Duration` representing the minimum of the delay before the service fetches updates for the buyer ad tech's custom audiences.
`partialCustomAudienceList: List<PartialCustomAudience>`	The list of `PartialCustomAudience` objects which are sent along with the request to download the updates for the buyer ad tech's custom audiences.
`shouldReplacePendingUpdates: Boolean = false`	If any pending scheduled updates should be canceled and replaced with the update detailed in the current `ScheduleCustomAudienceUpdateRequest`. If it is false and there are previously requested updates still pending for the same buyer in the same app, a call to `CustomAudienceManager.scheduleCustomAudienceUpdate` with this `ScheduleCustomAudienceUpdateRequest` will fail.

Public functions

equals

open operator fun equals(other: Any?): Boolean

Checks whether two ScheduleCustomAudienceUpdateRequest objects contain the same information.

hashCode

open fun hashCode(): Int

Returns the hash of the ScheduleCustomAudienceUpdateRequest object's data.

toString

open fun toString(): String

Public properties

minDelay

Added in 1.1.0-beta12

val minDelay: Duration

The Duration representing the minimum of the delay before the service fetches updates for the buyer ad tech's custom audiences.

partialCustomAudienceList

Added in 1.1.0-beta12

val partialCustomAudienceList: List<PartialCustomAudience>

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

shouldReplacePendingUpdates

Added in 1.1.0-beta12

val shouldReplacePendingUpdates: Boolean

If any pending scheduled updates should be canceled and replaced with the update detailed in the current ScheduleCustomAudienceUpdateRequest. If it is false and there are previously requested updates still pending for the same buyer in the same app, a call to CustomAudienceManager.scheduleCustomAudienceUpdate with this ScheduleCustomAudienceUpdateRequest will fail.

updateUri

Added in 1.1.0-beta12

val updateUri: Uri

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