FetchAndJoinCustomAudienceRequest
classFetchAndJoinCustomAudienceRequest
| 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 |
|
| Public methods | |
|---|---|
| Boolean | |
| Instant? |
Reference |
| Instant? |
Reference |
| Uri | |
| String? |
getName()Reference |
| AdSelectionSignals? |
Reference |
| Int |
hashCode() |
| String |
toString() |
Public methods
equals
funequals(other: Any?): Boolean
Deprecated: Deprecated in Java.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true only if two FetchAndJoinCustomAudienceRequest objects contain the same information. |
getActivationTime
fungetActivationTime(): Instant?
Deprecated: Deprecated in Java.
Reference CustomAudience.getActivationTime() for details.
| Return | |
|---|---|
Instant? |
the Instant by which joining the custom audience will be delayed. This value may be null. |
getExpirationTime
fungetExpirationTime(): Instant?
Deprecated: Deprecated in Java.
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
fungetFetchUri(): Uri
Deprecated: Deprecated in Java.
| Return | |
|---|---|
Uri |
the Uri from which the custom audience is to be fetched. This value cannot be null. |
getName
fungetName(): String?
Deprecated: Deprecated in Java.
Reference CustomAudience.getName() for details.
| Return | |
|---|---|
String? |
the String name of the custom audience to join. This value may be null. |
getUserBiddingSignals
fungetUserBiddingSignals(): AdSelectionSignals?
Deprecated: Deprecated in Java.
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
funhashCode(): Int
Deprecated: Deprecated in Java.
| Return | |
|---|---|
Int |
the hash of the FetchAndJoinCustomAudienceRequest object's data. |
toString
funtoString(): String
Deprecated: Deprecated in Java.
| Return | |
|---|---|
String |
a human-readable representation of FetchAndJoinCustomAudienceRequest. |