PartialCustomAudience

Kotlin |Java

class PartialCustomAudience : Parcelable

kotlin.Any
↳	android.adservices.customaudience.PartialCustomAudience

Represents a partial custom audience that is passed along to the buyer ad tech, when scheduling a delayed update for Custom Audience. Any field set by the caller cannot be overridden by the custom audience fetched from the updateUri

Given multiple Custom Audiences could be returned by the buyer, we will match the override restriction based on the name of Custom Audience. Thus name would be a required field.

Other nullable fields will not be overridden if left null

For more information about each field refer to CustomAudience.

Summary

Nested classes
	`Builder` Builder for `PartialCustomAudience` objects.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
Instant?	`getActivationTime()` Reference `CustomAudience.getActivationTime()` for details.
Instant?	`getExpirationTime()` Reference `CustomAudience.getExpirationTime()` for details.
String	`getName()` Reference `CustomAudience.getName()` for details.
AdSelectionSignals?	`getUserBiddingSignals()` Reference `CustomAudience.getUserBiddingSignals()` for details.
Int	`hashCode()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PartialCustomAudience!>	`CREATOR`

Public methods

describeContents

fun describeContents(): Int

equals

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` only if two `PartialCustomAudience` objects contain the same information.

getActivationTime

Added in Ad Services Extensions 14

fun getActivationTime(): Instant?

Reference CustomAudience.getActivationTime() for details. Will not be overridden if left null.

Return
`Instant?`	the `Instant` by which joining the custom audience will be delayed.

getExpirationTime

Added in Ad Services Extensions 14

fun getExpirationTime(): Instant?

Reference CustomAudience.getExpirationTime() for details. Will not be overridden if left null.

Return
`Instant?`	the `Instant` by when the membership to the custom audience will expire.

getName

Added in Ad Services Extensions 14

fun getName(): String

Reference CustomAudience.getName() for details.

Return
`String`	the `String` name of the custom audience to join. This value cannot be `null`.

getUserBiddingSignals

Added in Ad Services Extensions 14

fun getUserBiddingSignals(): AdSelectionSignals?

Reference CustomAudience.getUserBiddingSignals() for details. Will not be overridden if left null.

Return
`AdSelectionSignals?`	the buyer signals to be consumed by the buyer-provided JavaScript when the custom audience participates in an ad selection.

hashCode

fun hashCode(): Int

Return
`Int`	the hash of the `PartialCustomAudience` object's data.

toString

fun toString(): String

Return
`String`	a human-readable representation of `PartialCustomAudience`.

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in Ad Services Extensions 14

static val CREATOR: Parcelable.Creator<PartialCustomAudience!>