OAID plugin

The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and measure devices where Google Play Services isn’t available.

The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or HMS (Huawei Mobile Service) Core SDK on Huawei devices.

Add the plugin to your app

Install standalone binary

You can also add the plugin as a standalone binary from the releases page.

Use the plugin as a Prefab

You can load the OAID plugin as a Prefab on Unity apps. The standalone binary includes a Prefab folder containing this information.

To load the OAID plugin as a Prefab:

1. Locate the Prefab in the AdjustOaid/Prefab folder.
2. Untick the Start Manually option.
3. Tick the Read Oaid option.

Add the MSA SDK to your app

Requirements

To enable the OAID plugin to read OAID values from the MSA SDK, you need to add it to your project. To do this:

1. Copy the MSA SDK (AAR file) to the libs directory of your project and set the dependency.
2. Copy the supplierconfig.json file to the assets directory of your project.
3. You can find the MSA SDK and detailed instructions at the MSA website.

Add the HMS Core SDK to your app

You can use the HMS Core SDK to access the OAID of Huawei devices. To enable the Adjust OAID plugin to read values from the HMS Core SDK, update your build.gradle as follows:

1. Add the Huawei maven repository.

repositories {
  maven {
      url "https://developer.huawei.com/repo/"
  }
}

2. Add the HMS Core SDK.

dependencies {
   implementation 'com.huawei.hms:ads-identifier:3.4.62.300'
}

Proguard settings

If your app isn’t targeting the Google Play Store, you don’t need to add all the rules set out in the Android get started guide. You can remove rules related to Google Play Services and install referrer libraries. You only need to keep the rules that apply to the Adjust SDK.

-keep public class com.adjust.sdk.** { *; }

If you are adding the MSA SDK AAR as a dependency, add the following rules:

-keep class com.bun.miitmdid.core.** { *; }

Use the plugin

Once you have set up the plugin, you can gather the device’s OAID. To do this, call the AdjustOaid.readOaid(applicationContext) method before starting the Adjust SDK.

AdjustOaid.ReadOaid();
// ...
Adjust.start(config);

If you want to prevent the SDK from reading the OAID, call the AdjustOaid.doNotReadOaid() method.

AdjustOaid.DoNotReadOaid();