TestCustomAudienceManager

Kotlin |Java

public class TestCustomAudienceManager
extends Object

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

TestCustomAudienceManager provides APIs for app and ad-SDKs to test custom audiences.

Summary

Public methods
`void`	`overrideCustomAudienceRemoteInfo(AddCustomAudienceOverrideRequest request, Executor executor, OutcomeReceiver<Object, Exception> receiver)` Overrides the Custom Audience API to avoid fetching data from remote servers and use the data provided in `AddCustomAudienceOverrideRequest` instead.
`void`	`removeCustomAudienceRemoteInfoOverride(RemoveCustomAudienceOverrideRequest request, Executor executor, OutcomeReceiver<Object, Exception> receiver)` Removes an override in th Custom Audience API with associated the data in `RemoveCustomAudienceOverrideRequest`.
`void`	`resetAllCustomAudienceOverrides(Executor executor, OutcomeReceiver<Object, Exception> receiver)` Removes all override data in the Custom Audience API.

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

overrideCustomAudienceRemoteInfo

Added in API level 34
Also in Ad Services Extensions 4

public void overrideCustomAudienceRemoteInfo (AddCustomAudienceOverrideRequest request, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

Overrides the Custom Audience API to avoid fetching data from remote servers and use the data provided in AddCustomAudienceOverrideRequest instead. The AddCustomAudienceOverrideRequest is provided by the Ads SDK.

This method is intended to be used for end-to-end testing. This API is enabled only for apps in debug mode with developer options enabled.

This call will fail silently if the owner in the request is not the calling app's package name.
Requires AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parameters
`request`	`AddCustomAudienceOverrideRequest`: 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`.

Throws
`IllegalStateException`	if this API is not enabled for the caller The receiver either returns a `void` for a successful run, or an `Exception` indicates the error.

removeCustomAudienceRemoteInfoOverride

Added in API level 34
Also in Ad Services Extensions 4

public void removeCustomAudienceRemoteInfoOverride (RemoveCustomAudienceOverrideRequest request, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

Removes an override in th Custom Audience API with associated the data in RemoveCustomAudienceOverrideRequest.

This method is intended to be used for end-to-end testing. This API is enabled only for apps in debug mode with developer options enabled.
Requires AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

Parameters
`request`	`RemoveCustomAudienceOverrideRequest`: 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`.

Throws
`IllegalStateException`	if this API is not enabled for the caller The `RemoveCustomAudienceOverrideRequest` is provided by the Ads SDK. The receiver either returns a `void` for a successful run, or an `Exception` indicates the error.

resetAllCustomAudienceOverrides

Added in API level 34
Also in Ad Services Extensions 4

public void resetAllCustomAudienceOverrides (Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

Removes all override data in the Custom Audience API.

Parameters
`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`.

Throws
`IllegalStateException`	if this API is not enabled for the caller The receiver either returns a `void` for a successful run, or an `Exception` indicates the error.