Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

PartialCustomAudience

Kotlin |Java

public final class PartialCustomAudience
extends Object implements Parcelable

java.lang.Object
↳	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
`class`	`PartialCustomAudience.Builder` Builder for `PartialCustomAudience` objects.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<PartialCustomAudience>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`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()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in Ad Services Extensions 14

public static final Creator<PartialCustomAudience> CREATOR

Public methods

describeContents

public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`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

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` only if two `PartialCustomAudience` objects contain the same information.

getActivationTime

Added in Ad Services Extensions 14

public Instant getActivationTime ()

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

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

getExpirationTime

Added in Ad Services Extensions 14

public Instant getExpirationTime ()

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

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

getName

Added in Ad Services Extensions 14

public String getName ()

Reference CustomAudience.getName() for details.

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

getUserBiddingSignals

Added in Ad Services Extensions 14

public AdSelectionSignals getUserBiddingSignals ()

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

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

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	the hash of the `PartialCustomAudience` object's data.

toString

public String toString ()

Returns a string representation of the object.

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

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

PartialCustomAudience

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

equals

getActivationTime

getExpirationTime

getName

getUserBiddingSignals

hashCode

toString

writeToParcel