Cordova plugin for getting Advertising ID (IDFA or AAID)
npm install cordova-plugin-idfa[![NPM version][npm-version]][npm-url] [![NPM downloads][npm-downloads]][npm-url] [![NPM total downloads][npm-total-downloads]][npm-url] ![PayPal donate][donate-url] [![Twitter][twitter-follow]][twitter-url]
- Supported Platforms
- Installation
- API
- Example
- iOS
- Android
$ cordova plugin add cordova-plugin-idfa
Use variable ANDROID_PLAY_ADID_VERSION to override dependency version on Android:
$ cordova plugin add cordova-plugin-idfa --variable ANDROID_PLAY_ADID_VERSION='16.+'
The API is available on the cordova.plugins.idfa global object.
Returns a Promise with the following fields:
- trackingLimited: boolean - Whether usage of advertising id is allowed by user.
- idfa: string (_iOS only_) - Identifier for advertisers.
- trackingPermission (_iOS 14+ only_): number
Tracking permission status, available on iOS 14+ devices.
- aaid: string (_Android only_) - Android advertising ID.
_(iOS only)_ A one-time request to authorize or deny access to app-related data that can be used for
tracking the user or the device. See Apple's API docs
for more info on the dialog presented to the user. Available only for iOS 14+ devices.
Returns a Promise<number>. On devices
with iOS < 14 the method will return a rejected promise.
Note: You should make sure to set theNSUserTrackingUsageDescription key in your app's
Information Property List file, otherwise your app will crash when you use this API.
You can do it with the following code in your Cordova project's config.xml:
``xml`
The tracking permission values are numbers returned by getInfo()
and . The possible values are stored in constants on the
plugin object. See the example on how to use them.
For the meaning of the values see the tracking transparency API docs:
| Constant | Value | Description |
| :--------------------------------- | :---- | :-------------------------------------------------------------------------------------------------------- |
| TRACKING_PERMISSION_NOT_DETERMINED | 0 | User has not yet received an authorization request to authorize access to IDFA |
| TRACKING_PERMISSION_RESTRICTED | 1 | User restricted the value returned if authorization to access IDFA |
| TRACKING_PERMISSION_DENIED | 2 | The value returned if the user denies authorization to access IDFA |
| TRACKING_PERMISSION_AUTHORIZED | 3 | The value returned if the user authorizes access to IDFA |
`js
const idfaPlugin = cordova.plugins.idfa;
idfaPlugin.getInfo()
.then(info => {
if (!info.trackingLimited) {
return info.idfa || info.aaid;
} else if (info.trackingPermission === idfaPlugin.TRACKING_PERMISSION_NOT_DETERMINED) {
return idfaPlugin.requestPermission().then(result => {
if (result === idfaPlugin.TRACKING_PERMISSION_AUTHORIZED) {
return idfaPlugin.getInfo().then(info => {
return info.idfa || info.aaid;
});
}
});
}
})
.then(idfaOrAaid => {
if (idfaOrAaid) {
console.log(idfaOrAaid);
}
});
``
[npm-url]: https://www.npmjs.com/package/cordova-plugin-idfa
[npm-version]: https://img.shields.io/npm/v/cordova-plugin-idfa.svg
[npm-downloads]: https://img.shields.io/npm/dm/cordova-plugin-idfa.svg
[npm-total-downloads]: https://img.shields.io/npm/dt/cordova-plugin-idfa.svg?label=total+downloads
[twitter-url]: https://twitter.com/chemerisuk
[twitter-follow]: https://img.shields.io/twitter/follow/chemerisuk.svg?style=social&label=Follow%20me
[donate-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=E62XVSR3XUGDE&source=url