FetchAndJoinCustomAudienceRequest

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

Builder for FetchAndJoinCustomAudienceRequest objects.
Public methods
Boolean
equals(other: Any?)
Instant?

Reference CustomAudience.getActivationTime() for details.
Instant?

Reference CustomAudience.getExpirationTime() for details.
Uri

String?

Reference CustomAudience.getName() for details.
AdSelectionSignals?

Reference CustomAudience.getUserBiddingSignals() for details.
Int

String

Public methods

equals

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

getActivationTime

Added in API level 35
Also in Ad Services Extensions 10
fun getActivationTime(): Instant?

Reference CustomAudience.getActivationTime() for details.

Return
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
fun getExpirationTime(): Instant?

Reference CustomAudience.getExpirationTime() for details.

Return
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
fun getFetchUri(): Uri
Return
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
fun getName(): String?

Reference CustomAudience.getName() for details.

Return
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
fun getUserBiddingSignals(): AdSelectionSignals?

Reference CustomAudience.getUserBiddingSignals() for details.

Return
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
fun hashCode(): Int
Return
Int the hash of the FetchAndJoinCustomAudienceRequest object's data.

toString

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