Implementing OAID in the Android SDK

At a glance: Collecting the OAID device identifier in the AppsFlyer SDK

Collecting OAIDs

The AppsFlyer SDK supports OAID collection using several methods. The method depends on two factors: the model and OS of the mobile device and the AppsFlyer SDK version.

The methods include setCollectOaid and setOaidData.

Supported devices

Supported devices

Use AppsFLyer SKD V5.1.0 and later with the AppsFlyer OAID module

Supported manufacturer versions
Huawei
  • EMUI: V9.0 and later
  • HMS: V2.62 and later
Xiaomi MIUI 10.2
Vivo FuntouchOS 9
OPPO Color OS 7.0
Lenovo ZUI 11.4
Samsung, Meizu, Nubia, ZTE, ASUS, OnePlus, Freeme OS, Ssui OS Android 10

Collection methods

The methods include setCollectOaid and setOaidData. 

  • setCollectOaid: For supported devices, the AppsFlyer SDK collects the OAID directly from the device OS.
  • setOaidData: The developer uses AIDL to collect the OAID, then passes the OAID to the AppsFlyer SDK.

setCollectOaid(): Collect the OAID from the device OS

Select a collection method based on the SDK version. The developer must add the manufacturer's standalone JAR file to the app or add it to the AppsFlyer OAID SDK. 

To collect the OAID in AppsFlyer SDK version V5.1.0 and later:

  1. Add OAID dependencies; they must support the manufacturer's standalone JAR file in the app-level build.gradle file:
    • implementation 'com.appsflyer:af-android-sdk:5.1.0@aar'
    • implementation 'com.appsflyer:oaid:5.1.0@aar'
  2. Call setCollectOaid() before calling startTracking(). In the code call, AppsFlyerLib.getInstance().setCollectOaid(true); 

setOaidData() (AIDL): Developer passes the OAID

To collect the OAID in AppsFlyer SDK version V4.10.3 and later: 

  1. Follow Huawei instructions source 1 or source 2 to collect OAID via AIDL.
  2. Pass the OAID collected by Huawei to the AppsFlyer SDK.
  3. Call setOaidData() before calling setartTracking(). In the code call, 
    AppsFlyerLib.getInstance().setOaidData(###OAID_HERE###);

Example:

  1. Create a folder, aidl.
  2. In the aidl folder, create a package with this exact name, com.uodis.opendevice.aidl.
  3. Create an .aidl file, OpenDeviceIdentifierServiced.

    image.png
  4. Check that file OpenDeviceIdentifierServiced includes this code:

    package com.uodis.opendevice.aidl;
    
    /*
    * Important: Do not modify the method sequence of the AIDL file.!!!
    */
    interface OpenDeviceIdentifierService {
    String getOaid();
    boolean isOaidTrackLimited();
    }
  5. Create a class that fetches the OAID and passes it to the AppsFlyer SDK. 
    In this example, the class is OaidFetcher.

    public class OaidFetcher {
    public static void connect(Context context) {
    ServiceConnection connection = new ServiceConnection() {
    @Override
    public void onServiceConnected(ComponentName name, IBinder service) {
    OpenDeviceIdentifierService oaidService = OpenDeviceIdentifierService.Stub.asInterface(service);
    try {
    String oaid = oaidService.getOaid();
    AppsFlyerLib.getInstance().setOaidData(oaid);
    } catch (RemoteException e) {
    }
    }
    @Override
    public void onServiceDisconnected(ComponentName name) {
    }
    };
    Intent bindIntent = new Intent("com.uodis.opendevice.OPENIDS_SERVICE");
    bindIntent.setPackage("com.huawei.hwid");
    context.bindService(bindIntent, connection, context.BIND_AUTO_CREATE);
    }
    } 

 

Was this article helpful?