PartialCustomAudience

class PartialCustomAudience : Parcelable
kotlin.Any
   ↳ android.adservices.customaudience.PartialCustomAudience

Represents a partial custom audience that is passed along to DSP, 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 DSP 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 for PartialCustomAudience objects.
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)
Instant?

Reference CustomAudience#getActivationTime() for details.
Instant?

Reference CustomAudience#getExpirationTime() for details.
String

Reference CustomAudience#getName() for details.
AdSelectionSignals?

Reference CustomAudience#getUserBiddingSignals() for details.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<PartialCustomAudience!>

Public methods

describeContents

Added in API level VanillaIceCream
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level VanillaIceCream
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 API level VanillaIceCream
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 API level VanillaIceCream
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 API level VanillaIceCream
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 API level VanillaIceCream
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

Added in API level VanillaIceCream
fun hashCode(): Int
Return
Int the hash of the PartialCustomAudience object's data.

toString

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

writeToParcel

Added in API level VanillaIceCream
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 API level VanillaIceCream
static val CREATOR: Parcelable.Creator<PartialCustomAudience!>