Skip to content

Latest commit

 

History

History
107 lines (69 loc) · 3.05 KB

imei-plugin.mdx

File metadata and controls

107 lines (69 loc) · 3.05 KB
Raw
title description slug versions redirects
IMEI
Use the IMEI plugin to pass IMEI information to Adjust.
en/sdk/android/v4/plugins/imei-plugin
label value default
v5
v5
true
label value
v4
v4
v5
/en/sdk/android/plugins/imei-plugin

This plugin is only meant for apps that aren't targeting the Google Play Store.

Mobile devices come with an International Mobile Equipment Identity (IMEI) and a Mobile Equipment Identifier (MEID). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin.

The IMEI plugin provides the IMEI and MEID values of a device. The SDK will continue to use other identifiers as well as the IMEI and MEID.

Before you use this plugin, make sure to follow the get started guide and integrate the Adjust SDK into your app.

Add IMEI plugin to your app {#add-imei-plugin-to-your-app}

Maven {#maven}

If you are using Maven, add the following dependency to your build.gradle file:

dependencies {
   implementation 'com.adjust.sdk:adjust-android:$ANDROID_V4_VERSION'
   implementation 'com.adjust.sdk:adjust-android-imei:$ANDROID_V4_VERSION'
}

Add as JAR {#add-as-jar}

You can also add the plugin as a JAR file from the releases page.

Add permission {#add-permission}

Ensure the following permission is present in your AndroidManifest.xml file. If it isn't, add it.

<uses-permission android:name="android.permission.READ_PHONE_STATE" />

As of Android 6.0 you may need to request app permission. This isn't necessary if the OS has been set up to not require app permissions.

Proguard settings {#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 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.** { *; }

Use the plugin {#use-the-plugin}

The IMEI and MEID are persistent identifiers. You are responsible for ensuring that your collection and processing of this data is lawful.

Once you have set up the plugin, you can gather the device's IMEI and MEID. To do this, call the AdjustImei.readImeie method before starting the Adjust SDK.

AdjustImei.readImei();
// ...
Adjust.onCreate(config);

If you want to prevent the SDK from reading the IMEI and MEID, call the AdjustImei.doNotReadImei method.

AdjustImei.doNotReadImei();