Device Identifier Plugin #

📖 中文文档请点这里 (README_zh.md)

A comprehensive Flutter plugin for obtaining various device identifiers, supporting both Android and iOS platforms.

Features #

Android Supported Identifiers #

• Android ID: Unique device identifier (recommended)
• Advertising ID: Google Advertising Identifier (GAID)
• Install UUID: Unique ID generated on app installation
• Device Fingerprint: Identifier generated based on hardware info
• Build Serial: Device serial number (requires permission)
• File-based ID: Persistent ID stored in external storage
• Combined ID: Hash of multiple identifiers

iOS Supported Identifiers #

• iOS Device ID: Concept similar to Android ID (recommended)
• IDFV: Identifier for Vendor, shared among the same developer's apps
• IDFA: Advertising Identifier (requires user authorization)
• Keychain UUID: Stable identifier stored in the keychain
• Device Fingerprint: Identifier generated based on hardware info
• Launch UUID: Temporary ID generated on each app launch
• Combined ID: Hash of multiple identifiers

Installation #

Add to your pubspec.yaml:

dependencies:
  device_identifier_plugin: ^0.0.6

Then run:

flutter pub get

Platform Setup #

Android #

Configure AndroidManifest.xml

Add the following permissions to your android/app/src/main/AndroidManifest.xml as needed:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">
     <!-- Note, don't forget the line xmlns:tools='xxxxx' above -->
      <!-- Basic permissions -->
      <uses-permission android:name="android.permission.INTERNET" />
      <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

      <!-- For serial number (optional) -->
      <uses-permission android:name="android.permission.READ_PHONE_STATE" />

      <!-- If you need to obtain a Google Advertising ID (optional) -->
      <uses-permission android:name="com.google.android.gms.permission.AD_ID" />

      <!-- For file-based ID (optional) -->
      <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
      <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

      <!-- Android 11+ File access, if file storage device identifier is required (optional) -->
      <uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE"
              tools:ignore="ScopedStorage" />


      <application>
        ...
      </application>

</manifest>

Configure app/build.gradle, minimum supported SDK 23

 android {                                                                                     
   defaultConfig {                                                                             
     minSdkVersion 23                                                                          
   }                                                                                           
 } 

Tip: If you need to obtain GAID, your device must support Google services

iOS #

Add the following to your ios/Runner/Info.plist for advertising tracking:

Privacy - Tracking Usage Description

<key>NSUserTrackingUsageDescription</key>
<string>This app would like to access IDFA for analytics and personalized ads.</string>

Please check whether there is an AppTrackingTransparency.framework in this path: Xcode - Build Phases - Link Binary With Libraries add AppTrackingTransparency.framework

The minimum supported version for iOS is 14. Please modify it in Podfile

platform :ios, '14.0'

Usage #

Import the package:

import 'package:device_identifier_plugin/device_identifier_plugin.dart';

Singleton Access #

final deviceIdentifier = DeviceIdentifierPlugin.instance;

Get the Best Device Identifier #

String bestId = await deviceIdentifier.getBestDeviceIdentifier();
print('Best Device ID: $bestId');

Check if Device is an Emulator #

bool isEmu = await deviceIdentifier.isEmulator();
print('Is Emulator: $isEmu');

Get Device Info #

Map<String, String?> info = await deviceIdentifier.getDeviceInfo();
print('Device Info: $info');

Get Supported Identifiers #

Map<String, dynamic> ids = await deviceIdentifier.getSupportedIdentifiers();
print('Supported Identifiers: $ids');

Android-specific: File-based Device Identifier #

// Request storage permission first
await deviceIdentifier.requestExternalStoragePermission();

bool hasPermission = await deviceIdentifier.hasExternalStoragePermission();
if (hasPermission) {
  String? fileId = await deviceIdentifier.getFileDeviceIdentifier();
  print('File Device ID: $fileId');
}

iOS-specific: Advertising ID and Tracking Authorization #

if (Platform.isIOS) {
  // Request tracking authorization (iOS 14.5+)
  String? status = await deviceIdentifier.requestTrackingAuthorization();
  print('Tracking Authorization Status: $status');

  // Get IDFA (after authorization)
  String? idfa = await deviceIdentifier.getAdvertisingIdForiOS();
  print('IDFA: $idfa');
}

iOS-specific: Keychain UUID #

if (Platform.isIOS) {
  bool exists = await deviceIdentifier.hasKeychainUUID();
  String? uuid = await deviceIdentifier.getKeychainUUID();
  if (!exists) {
    uuid = await deviceIdentifier.generateKeychainUUID();
  }
  print('Keychain UUID: $uuid');
}

API Reference #

Privacy & Compliance #

• iOS: Fully supports App Tracking Transparency (ATT) and requires user authorization for IDFA.
• Android: Handles runtime permissions for storage and complies with Google Play policies for advertising ID.
• General: Only collect device identifiers when necessary and inform users about the purpose.

License #

MIT License. See LICENSE for details.

Changelog #

See CHANGELOG.md for version history.

Contribution #

Contributions are welcome! Please submit issues or pull requests via GitHub.