AdIdManager

public class AdIdManager
extends Object

java.lang.Object
   ↳ android.adservices.adid.AdIdManager


AdId Manager provides APIs for app and ad-SDKs to access advertising ID. The advertising ID is a unique, per-device, user-resettable ID for advertising. It gives users better controls and provides developers with a simple, standard system to continue to monetize their apps via personalized ads (formerly known as interest-based ads).

Summary

Public methods

static AdIdManager get(Context context)

Factory method for creating an instance of AdIdManager.

void getAdId(Executor executor, AdServicesOutcomeReceiver<AdIdException> callback)

Return the AdId.

void getAdId(Executor executor, OutcomeReceiver<AdIdException> callback)

Return the AdId.

Inherited methods

Public methods

get

public static AdIdManager get (Context context)

Factory method for creating an instance of AdIdManager.

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

Returns
AdIdManager A AdIdManager instance This value cannot be null.

getAdId

public void getAdId (Executor executor, 
                AdServicesOutcomeReceiver<AdIdException> callback)

Return the AdId. For use on Android R or lower.
Requires AdServicesPermissions.ACCESS_ADSERVICES_AD_ID

Parameters
executor Executor: The executor to run callback. 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.

callback AdServicesOutcomeReceiver: The callback that's called after adid are available or an error occurs. This value cannot be null.

Returns
void This value cannot be null.

getAdId

public void getAdId (Executor executor, 
                OutcomeReceiver<AdIdException> callback)

Return the AdId.
Requires AdServicesPermissions.ACCESS_ADSERVICES_AD_ID

Parameters
executor Executor: The executor to run callback. 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.

callback OutcomeReceiver: The callback that's called after adid are available or an error occurs. This value cannot be null.

Returns
void This value cannot be null.