Added in API level 34
Also in Ad Services Extensions 4

Summary: Methods | Inherited Methods

CustomAudienceManager

Kotlin |Java

public class CustomAudienceManager
extends Object

java.lang.Object
↳	android.adservices.customaudience.CustomAudienceManager

CustomAudienceManager provides APIs for app and ad-SDKs to join / leave custom audiences.

Summary

Public methods
`void`	`fetchAndJoinCustomAudience(FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)` Adds the user to the `CustomAudience` fetched from a `fetchUri`.
`static CustomAudienceManager`	`get(Context context)` Factory method for creating an instance of CustomAudienceManager.
`TestCustomAudienceManager`	`getTestCustomAudienceManager()` Create a service with test-enabling APIs
`void`	`joinCustomAudience(JoinCustomAudienceRequest joinCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)` Adds the user to the given `CustomAudience`.
`void`	`leaveCustomAudience(LeaveCustomAudienceRequest leaveCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)` Attempts to remove a user from a custom audience by deleting any existing `CustomAudience` data, identified by `ownerPackageName`, `buyer`, and `name`.

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.

Public methods

fetchAndJoinCustomAudience

Added in API level 35
Also in Ad Services Extensions 10

public void fetchAndJoinCustomAudience (FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

Adds the user to the CustomAudience fetched from a fetchUri.

An attempt to register the user for a custom audience with the same combination of ownerPackageName, buyer, and name will cause the existing custom audience's information to be overwritten, including the list of ads data.

Note that the ads list can be completely overwritten by the daily background fetch job.

This call fails with an SecurityException if

the ownerPackageName is not calling app's package name and/or
the buyer is not authorized to use the API.

This call fails with an IllegalArgumentException if

the storage limit has been exceeded by the calling application and/or
any URI parameters in the CustomAudience given are not authenticated with the CustomAudience buyer.

This call fails with LimitExceededException if the calling package exceeds the allowed rate limits and is throttled.

This call fails with an IllegalStateException if an internal service error is encountered.
Requires AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parameters
`fetchAndJoinCustomAudienceRequest`	`FetchAndJoinCustomAudienceRequest`: This value cannot be `null`.
`executor`	`Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`receiver`	`OutcomeReceiver`: This value cannot be `null`.

get

Added in API level 34
Also in Ad Services Extensions 6

public static CustomAudienceManager get (Context context)

Factory method for creating an instance of CustomAudienceManager.

Parameters
`context`	`Context`: The `Context` to use This value cannot be `null`.

Returns
`CustomAudienceManager`	A `CustomAudienceManager` instance This value cannot be `null`.

getTestCustomAudienceManager

Added in API level 34
Also in Ad Services Extensions 4

public TestCustomAudienceManager getTestCustomAudienceManager ()

Create a service with test-enabling APIs

Returns
`TestCustomAudienceManager`	This value cannot be `null`.

joinCustomAudience

Added in API level 34
Also in Ad Services Extensions 4

public void joinCustomAudience (JoinCustomAudienceRequest joinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

Adds the user to the given CustomAudience.

Note that the ads list can be completely overwritten by the daily background fetch job.

This call fails with an SecurityException if

the ownerPackageName is not calling app's package name and/or
the buyer is not authorized to use the API.

This call fails with an IllegalArgumentException if

the storage limit has been exceeded by the calling application and/or
any URI parameters in the CustomAudience given are not authenticated with the CustomAudience buyer.

This call fails with LimitExceededException if the calling package exceeds the allowed rate limits and is throttled.

This call fails with an IllegalStateException if an internal service error is encountered.
Requires AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parameters
`joinCustomAudienceRequest`	`JoinCustomAudienceRequest`: This value cannot be `null`.
`executor`	`Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`receiver`	`OutcomeReceiver`: This value cannot be `null`.

leaveCustomAudience

Added in API level 34
Also in Ad Services Extensions 4

public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

Attempts to remove a user from a custom audience by deleting any existing CustomAudience data, identified by ownerPackageName, buyer, and name.

This call fails with an SecurityException if

the ownerPackageName is not calling app's package name; and/or
the buyer is not authorized to use the API.

This call fails with LimitExceededException if the calling package exceeds the allowed rate limits and is throttled.

This call does not inform the caller whether the custom audience specified existed in on-device storage. In other words, it will fail silently when a buyer attempts to leave a custom audience that was not joined.
Requires AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parameters
`leaveCustomAudienceRequest`	`LeaveCustomAudienceRequest`: This value cannot be `null`.
`executor`	`Executor`: This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`receiver`	`OutcomeReceiver`: This value cannot be `null`.