@capacitor-community/advertising-id
v7.0.0
Published
Allows access to the IDFA (iOS) and GAID (Android)
Downloads
19,292
Maintainers
Readme
@capacitor-community/advertising-id
Allows access to the IDFA (iOS) and GAID (Android)
Install
npm install @capacitor-community/advertising-id
npx cap sync
iOS
iOS requires the following usage description be added and filled out for your app in Info.plist
to use the requestTracking()
method:
NSUserTrackingUsageDescription
(Privacy - Tracking Usage Description
)
Android
Variables
This plugin will use the following project variables (defined in your app's variables.gradle
file):
playServicesAdsId
version ofcom.google.android.gms:play-services-ads-identifier
(default:18.2.0
)
API
requestTracking()
requestTracking() => Promise<{ value: AdvertisingStatus; }>
Returns: Promise<{ value: AdvertisingStatus; }>
getAdvertisingId()
getAdvertisingId() => Promise<{ id: string; status: AdvertisingStatus; }>
Returns: Promise<{ id: string; status: AdvertisingStatus; }>
getAdvertisingStatus()
getAdvertisingStatus() => Promise<{ status: AdvertisingStatus; }>
Returns: Promise<{ status: AdvertisingStatus; }>
Type Aliases
AdvertisingStatus
'Authorized' | 'Denied' | 'Not Determined' | 'Restricted'