Capacitor plugin to request user authorization to access app-related data for tracking the user or the device. iOS only.
Read more about Apple's App Tracking Transparency framework here. Also this might be a good read.
iOS only but with web fallback for development purposes.
| Capacitor version | Plugin version |
|---|---|
| 6.x | >= 2.0.2 |
| 5.x | >= 2.0.2 |
| 4.x | >= 2.0.2 |
| 3.x | >= 2.0.0 |
| < 3.0.0 | 1.x.x |
For plugin version 1.x.x docs please refer to branch v1.
| Maintainer | GitHub | Social |
|---|---|---|
| Manuel Heidrich | mahnuh | @mahnuh |
npm install capacitor-plugin-app-tracking-transparency
npx cap syncAdd this to your app's Info.plist and update the message according to your needs:
<key>NSUserTrackingUsageDescription</key>
<string>Your data will be used to deliver personalized ads to you.</string>This message can be provided in multiple languages by using a InfoPlist.strings file. See the Apple docs or this stack overflow answer for help.
There is a small demo app available to showcase this plugin and its usage: capacitor-plugin-app-tracking-transparency-demo-app
import {
AppTrackingTransparency,
AppTrackingStatusResponse,
} from 'capacitor-plugin-app-tracking-transparency';
...
public async getStatus(): Promise<AppTrackingStatusResponse> {
const response = await AppTrackingTransparency.getStatus();
console.log(response);
// { status: 'authorized' } for example
return response;
}
public async requestPermission(): Promise<AppTrackingStatusResponse> {
const response = await AppTrackingTransparency.requestPermission();
console.log(response);
// { status: 'authorized' } for example
return response;
}Both available methods return AppTrackingStatusResponse with status: AppTrackingStatus, which will be one of the following: authorized, denied, notDetermined or restricted. See Apple's docs for reference.
getStatus() => Promise<AppTrackingStatusResponse>Returns: Promise<AppTrackingStatusResponse>
requestPermission() => Promise<AppTrackingStatusResponse>Returns: Promise<AppTrackingStatusResponse>
{ status: AppTrackingStatus }
'authorized' | 'denied' | 'notDetermined' | 'restricted'
- Extend API docs