Package selection guidance compiled from public package information, community data, and project usage.
The app_tracking_transparency package is a Flutter plugin that enables iOS apps to request user permission for tracking via Apple's App Tracking Transparency framework. It provides a simple interface to display the system-level authorization dialog, allowing developers to comply with Apple's privacy requirements. The plugin integrates seamlessly with iOS and ensures proper handling of user consent status. It is essential for apps that collect data for advertising or analytics purposes on iOS devices.
Use cases
Requesting user consent for tracking on iOS
Complying with Apple's privacy regulations
Integrating with ad networks that require tracking permissions
Monitoring user consent status in real time
Enabling privacy-compliant analytics
Key features
Displays native iOS tracking authorization dialog
Supports iOS platform only
Provides callback for tracking authorization status
Developers needing compliance with Apple's privacy policies
Apps integrating with third-party analytics or ad SDKs
Projects requiring user consent management for tracking
Considerations
Only available on iOS platforms
Requires proper handling of user response in app logic
Does not work on Android devices
Must be used in conjunction with Apple's AppTrackingTransparency framework
User consent must be respected for all tracking activities
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
app_tracking_transparency
This Flutter plugin allows you to display ios 14+ tracking authorization dialog and request permission to collect data. Collected data is crucial for ad networks (ie admob) to work efficiently on ios 14+ devices.
Introduction
Starting in iOS 14.0 App Tracking Transparency framework is available so we can present the app-tracking authorization request to the end user.
Starting in iOS 14.5, IDFA will be unavailable until an app calls the App Tracking Transparency framework to present the app-tracking authorization request to the end user. If an app does not present this request, the IDFA will automatically be zeroed out which may lead to a significant loss in ad revenue.
On iOS >=14.0 <14.5, tracking authorization request dialog isn't required in order to get IDFA. Keep in mind that, in those iOS versions, if you ask for it and the user rejects it you will lose access to IDFA (see tests).
This plugin lets you display App Tracking Transparency authorization request and ask for permission.
Usage
Step 1:
Make sure you update Info.plist file located in ios/Runner directory and add the NSUserTrackingUsageDescription key with a custom message describing your usage.
<key>NSUserTrackingUsageDescription</key><string>This identifier will be used to deliver personalized ads to you.</string>
Step 2:
Google recommends that you should be using Google Mobile Ads SDK 7.64.0 or higher. The Google Mobile Ads SDK supports conversion tracking using Apple's SKAdNetwork, which means Google is able to attribute an app install even when IDFA is unavailable. This is a crucial step if you want to maximize your ad revenue when IDFA is not available. To enable this functionality, you will need to update the SKAdNetworkItems key with an additional dictionary in your Info.plist, check them here.
Example
In this example, the tracking authorization dialog is requested from the Home widget of the application. You can initiate this request from any StatefulWidget in your app.
// Import packageimport'package:app_tracking_transparency/app_tracking_transparency.dart';
voidmain() {
runApp(MyApp());
}
classMyAppextendsStatefulWidget{
@override_MyAppStatecreateState() => _MyAppState();
}
class_MyAppStateextendsState<MyApp> {
@overridevoidinitState() {
super.initState();
// Show tracking authorization dialog and ask for permissionWidgetsFlutterBinding.ensureInitialized().addPostFrameCallback((_) async {
final status = awaitAppTrackingTransparency.requestTrackingAuthorization();
});
}
@overrideWidgetbuild(BuildContext context) {
...
}
}
Google (admob) recommends implementing an explainer message that appears to users immediately before the consent dialogue. For additional info on this topic please refer to this article: https://support.google.com/admob/answer/9997589?hl=en
// If the system can show an authorization request dialogif (awaitAppTrackingTransparency.trackingAuthorizationStatus ==
TrackingStatus.notDetermined) {
// Show a custom explainer dialog before the system dialogawaitshowCustomTrackingDialog(context);
// Wait for dialog popping animationawaitFuture.delayed(constDuration(milliseconds: 200));
// Request system's tracking authorization dialogawaitAppTrackingTransparency.requestTrackingAuthorization();
}
The explainer dialog must not contain a "Decide later" button. It should contain only a "Continue" button and the system dialog must be shown after the explainer dialog. See this issue for details.
You can also get advertising identifier after authorization. Until a user grants authorization, the UUID returned will be all zeros: 00000000-0000-0000-0000-000000000000. Also note, the advertisingIdentifier will be all zeros in the Simulator, regardless of the tracking authorization status.
final uuid = awaitAppTrackingTransparency.getAdvertisingIdentifier();
Notes
To use this plugin you should compile your project using XCode 12+ and run your app on an ios 14 + device.
Important Notice
IOS does not allow to display multiple native dialogs. If you try to open a native dialog when there is already a dialog on screen, previous dialog will be forcefully closed by the system. It's very common to show notification permission dialog on the first run of an ios application. If you both try to show a notification permission dialog and app tracking request dialog, one of the each will be cancelled. One way to handle this is using an explainer dialog before requesting tracking authorization. Please check the sample project for more on this. I highly recommend this approach.
Another way to get over this problem is postponing permission request until 2nd, or Nth run of the application. If you choose this way, please make sure that you inform app store reviewer that you postponed tracking request, or your submission may be rejected.
And finally; Always test on a real device with a fresh installed application.