Added in API level 36
Also in Ad Services Extensions 14
Deprecated in API level 37

PartialCustomAudience

---

Kotlin |Java

class PartialCustomAudience : Parcelable

kotlin.Any
↳	android.adservices.customaudience.PartialCustomAudience

---

This class was deprecated in API level 37.

The Rubidium (Rb) Relevance APIs, including those in android.adservices.customaudience, are being deprecated. Relevance APIs have no direct replacement. Developers should stop using them, as calls will be rejected in future Android releases. Please refer to official Privacy Sandbox documentation for deprecation and roadmap details: https://privacysandbox.com/news/update-on-plans-for-privacy-sandbox-technologies/

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() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
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

Added in API level 36
Deprecated in API level 37

fun describeContents(): Int

Deprecated: Deprecated in Java.

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 36
Deprecated in API level 37

fun equals(other: Any?): Boolean

Deprecated: Deprecated in Java.

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 36
Also in Ad Services Extensions 14
Deprecated in API level 37

fun getActivationTime(): Instant?

Deprecated: Deprecated in Java.

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 36
Also in Ad Services Extensions 14
Deprecated in API level 37

fun getExpirationTime(): Instant?

Deprecated: Deprecated in Java.

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 36
Also in Ad Services Extensions 14
Deprecated in API level 37

fun getName(): String

Deprecated: Deprecated in Java.

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 36
Also in Ad Services Extensions 14
Deprecated in API level 37

fun getUserBiddingSignals(): AdSelectionSignals?

Deprecated: Deprecated in Java.

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 36
Deprecated in API level 37

fun hashCode(): Int

Deprecated: Deprecated in Java.

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

toString

Added in API level 36
Deprecated in API level 37

fun toString(): String

Deprecated: Deprecated in Java.

Return
String	a human-readable representation of PartialCustomAudience.

writeToParcel

Added in API level 36
Deprecated in API level 37

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

Deprecated: Deprecated in Java.

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 the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 36
Also in Ad Services Extensions 14
Deprecated in API level 37

static val CREATOR: Parcelable.Creator<PartialCustomAudience!>

Deprecated: Deprecated in Java.