AdvertisingIdClient
open class AdvertisingIdClient
kotlin.Any | |
↳ | androidx.ads.identifier.AdvertisingIdClient |
Client for retrieving Advertising ID related info from an AndroidX ID Provider installed on the device.
Typical usage would be:
- Call
isAdvertisingIdProviderAvailable
to make sure there is an Advertising ID Provider available. - Call
getAdvertisingIdInfo
to get Advertising ID info (the Advertising ID and LAT setting).
Summary
Public methods | |
---|---|
open static ListenableFuture<AdvertisingIdInfo!> |
getAdvertisingIdInfo(@NonNull context: Context) Retrieves the user's Advertising ID info. |
open static Boolean |
isAdvertisingIdProviderAvailable(@NonNull context: Context) Checks whether there is any Advertising ID Provider installed on the device. |
Public methods
getAdvertisingIdInfo
@NonNull open static fun getAdvertisingIdInfo(@NonNull context: Context): ListenableFuture<AdvertisingIdInfo!>
Retrieves the user's Advertising ID info.
When multiple Advertising ID Providers are installed on the device, this method will always return the Advertising ID information from same Advertising ID Provider for all apps which use this library, using following priority:
- System-level providers with "androidx.ads.identifier.provider.HIGH_PRIORITY" permission
- Other system-level providers
If there are ties in any of the above categories, it will use this priority:
- First app by earliest install time (
android.content.pm.PackageInfo#firstInstallTime
) - First app by package name alphabetically sorted
Parameters | |
---|---|
context |
Context: Current Context (such as the current android.app.Activity ). |
Return | |
---|---|
ListenableFuture<AdvertisingIdInfo!> |
A ListenableFuture that will be fulfilled with a AdvertisingIdInfo which contains the user's Advertising ID info, or rejected with the following exceptions,
|
isAdvertisingIdProviderAvailable
open static fun isAdvertisingIdProviderAvailable(@NonNull context: Context): Boolean
Checks whether there is any Advertising ID Provider installed on the device.
This method does a quick check for the Advertising ID providers.
Note: Even if this method returns true, there is still a possibility that the getAdvertisingIdInfo(Context)
method throws an exception for some reason.
Parameters | |
---|---|
context |
Context: Current Context (such as the current android.app.Activity ). |
Return | |
---|---|
Boolean |
whether there is an Advertising ID Provider available on the device. |