AdIdManager


open class AdIdManager
kotlin.Any
   ↳ 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
open static AdIdManager
get(context: Context)

Factory method for creating an instance of AdIdManager.

open Unit

Return the AdId.

open Unit
getAdId(executor: Executor, callback: OutcomeReceiver<AdId!, Exception!>)

Return the AdId.

Public methods

get

open static fun get(context: Context): AdIdManager

Factory method for creating an instance of AdIdManager.

Parameters
context Context: The Context to use This value cannot be null.
Return
AdIdManager A AdIdManager instance This value cannot be null.

getAdId

open fun getAdId(
    executor: Executor,
    callback: AdServicesOutcomeReceiver<AdId!, Exception!>
): Unit

Return the AdId. For use on Android R or lower.
Requires android.adservices.common.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<AdId!, Exception!>: The callback that's called after adid are available or an error occurs. This value cannot be null.
Return
Unit This value cannot be null.

getAdId

open fun getAdId(
    executor: Executor,
    callback: OutcomeReceiver<AdId!, Exception!>
): Unit

Return the AdId.
Requires android.adservices.common.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<AdId!, Exception!>: The callback that's called after adid are available or an error occurs. This value cannot be null.
Return
Unit This value cannot be null.