安卓 SDK 集成指南

通过 Adjust安卓SDK，您可以在安卓应用中记录归因、事件及更多数据。请按照本指南中说明的步骤操作，在应用内设置 Adjust SDK。

1. 设置环境

要开始使用 Adjust SDK，您首先要将其作为依赖添加至项目中。Adjust SDK 可在Maven上使用。

要将 Adjust SDK 添加至您的项目：

1. 将 Adjust SDK和安卓 Install Referrer 实现添加至您的 build.gradle 文件。如果您在应用中使用网页视图，则可以选择添加 Adjust web view bridge。

   1
   dependencies {
   2
      implementation 'com.adjust.sdk:adjust-android:5.0.1'
   3
      implementation 'com.android.installreferrer:installreferrer:2.2'
   4
      // Add the following if you are using the Adjust SDK inside web views on your app
   5
      implementation 'com.adjust.sdk:adjust-android-webbridge:5.0.1'
   6
   }

2. 添加 Google Play 服务

定向到 Google Play 商店的应用必须使用gps_adid(Google 广告 ID) 来识别设备。要访问 gps_adid，请向项目中添加 play-services-ads-identifier AAR。

如果您使用的是 Maven，请将以下行添加至您的 build.gradle 文件：

1
dependencies {
2
   implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
3
}

3. 添加权限

要授予 Adjust SDK 读取设备信息的权限，您需要声明应用所需的权限。为此，请在 AndroidManifest.xml 文件中添加权限。

请添加下列权限，以访问在线功能：

1
<uses-permission android:name="android.permission.INTERNET"/>
2
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

如果您的应用并不面向 Google Play 商店，那么请添加下列权限，以读取设备的互联网连接状态：

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

Adjust SDK 默认包含 com.google.android.gms.AD_ID 权限。如果您要让应用符合 COPPA (儿童在线隐私保护法) 规定，或者应用并不面向 Google Play 商店，请务必使用 remove 命令移除权限。

1
<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove"/>

4. 设置 Proguard

如果您使用 Proguard 优化应用，那么请务必添加规则，避免Proguard 移除类：

1
-keep class com.adjust.sdk.** { *; }
2
-keep class com.google.android.gms.common.ConnectionResult {
3
   int SUCCESS;
4
}
5
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
6
   com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
7
}
8
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
9
   java.lang.String getId();
10
   boolean isLimitAdTrackingEnabled();
11
}
12
-keep public class com.android.installreferrer.** { *; }

应用不在 Google Play 商店发布，请添加下列规则：

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

5. 设置 Install Referrer

Install Referrer 是一种唯一标识符，可用来将安装归因至来源。Adjust SDK 需要该信息进行归因。您可以使用下列方法之一调取 install referrer 信息：

Google Play Referrer API

面向 Google Play 商店的应用可以使用 Google Play Referrer API。

要支持 Google Play Referrer API，请将下列行添加进您的 build.gradle 文件：

1
dependencies {
2
   implementation 'com.android.installreferrer:installreferrer:2.2'
3
}

如果您使用的是 Proguard，请务必添加规则，避免依赖被移除。

1
-keep public class com.android.installreferrer.** { *; }

华为 Referrer API

面向华为设备的应用可以使用华为 Referrer API。Adjust SDK 可以使用 Adjust Huawei Referrer 插件记录华为设备上的安装。

要安装插件，请将下列依赖添加至您的build.gradle文件：

1
dependencies {
2
   implementation: "com.adjust.sdk:adjust-android-huawei-referrer:5.0.0"
3
}

小米 referrer 插件

借助小米 referrer 插件，您可以记录面向小米设备应用的 Install Referrer 值。请查看插件相关文档，了解安装信息。

Samsung referrer 插件

借助 Samsung referrer 插件，您可以记录面向 Samsung Galaxy Store 的应用的 Install Referrer 值。请查看插件相关文档，了解安装信息。

Meta referrer 集成

通过 Adjust Meta Install Referrer 插件，Adjust SDK 可以支持 Meta Install Referrer。请参阅文档了解集成详情。

6. 设置 SDK 签名

如果您想使用 SDK 签名库来保护 Adjust SDK 与 Adjust 服务器之间的通信，请按照Adjust 帮助中心 SDK 签名指南中的说明进行操作。

7. 集成 Adjust SDK

初始化 Adjust SDK 必需信息如下：

• appToken: 您的 Adjust 应用识别码。
• environment: 应用运行的环境。要在本地测试应用，请设置为AdjustConfig.ENVIRONMENT_SANDBOX。

我们建议您在全局安卓Application 类中初始化 Adjust SDK。如果您还没有为自己的应用完成该设置，请按照下列步骤进行设置：

1. 创建一个扩展 Application的类。

2. 打开 AndroidManifest.xml 文件，找到 <application> 元素。

3. 添加 android:name 属性至 <application> 元素，并将其设置为 Application 类的名称。例如，如果您的 Application 类名称为 GlobalApplication，那么您可以进行如下设置：

   1
   <application android:name=".GlobalApplication">
   2
      <!-- ... -->
   3
   </application>

4. 在 Application 类中找到 initSdk 方法；如果方法不存在，请进行添加。传送下列参数，以初始化 Adjust SDK：

   • 您的 appToken
   • 应用运行预期 environment
   • 要记录的 LogLevel

1
import com.adjust.sdk.Adjust;
2
import com.adjust.sdk.AdjustConfig;
3

4
class GlobalApplication : Application () {
5
   override fun onCreate() {
6
      super.onCreate()
7

8
      val appToken = "{YourAppToken}"
9
      val environment = AdjustConfig.ENVIRONMENT_SANDBOX;
10
      val config = AdjustConfig(this, appToken, environment)
11
      config.setLogLevel(LogLevel.VERBOSE)
12
      Adjust.initSdk(config)
13
   }
14
}

1
import com.adjust.sdk.Adjust;
2
import com.adjust.sdk.AdjustConfig;
3

4
public class GlobalApplication extends Application {
5
   @Override
6
   public void onCreate() {
7
      super.onCreate();
8

9
      String appToken = "{YourAppToken}";
10
      String environment = AdjustConfig.ENVIRONMENT_SANDBOX;
11
      AdjustConfig config = new AdjustConfig(this, appToken, environment);
12
      config.setLogLevel(LogLevel.VERBOSE)
13
      Adjust.initSdk(config);
14
   }
15
}

集成 Adjust Web View SDK

如果您的应用使用的是 web 视图，请通过 Adjust Web View SDK 记录信息。您需要获得对 WebView 对象的引用。完成后，请按照下列步骤操作：

1. 调用 webView.getSettings().setJavaScriptEnabled(true) 在 web view 中启用 Javascript。

2. 调用 AdjustBridge.registerAndGetInstance(getApplication(), webview)，启动默认 AdjustBridgeInstance。这会将 Adjust bridge 注册为 web view 的 Javascript 接口。

3. 调用 AdjustBridge.setWebView()，已设置新的 WebView。

4. 调用 AdjustBridge.unregister() 来注销 AdjustBridgeInstance 和 WebView 。

5. 完整设置示例如下：

   • Kotlin
   • Java

   1
   class MainActivity : Activity() {
   2
      override fun onCreate(savedInstanceState: Bundle?) {
   3
            super.onCreate(savedInstanceState)
   4
            setContentView(R.layout.activity_main)
   5
   
   6
            val webView = findViewById<webview>(R.id.webView)
   7
            webView.settings.javaScriptEnabled = true
   8
            webView.webChromeClient = WebChromeClient()
   9
            webView.webViewClient = WebViewClient()
   10
   
   11
            AdjustBridge.registerAndGetInstance(application, webView)
   12
            try {
   13
               webView.loadUrl("file:///android_asset/AdjustExample-WebView.html")
   14
            } catch (e: Exception) {
   15
               e.printStackTrace()
   16
            }
   17
      }
   18
   
   19
      override fun onDestroy() {
   20
         AdjustBridge.unregister()
   21
   
   22
         super.onDestroy()
   23
      }
   24
   }

   1
   public class MainActivity extends Activity {
   2
      @Override
   3
      protected void onCreate(Bundle savedInstanceState) {
   4
         super.onCreate(savedInstanceState);
   5
         setContentView(R.layout.activity_main);
   6
   
   7
         WebView webView = (WebView) findViewById(R.id.webView);
   8
         webView.getSettings().setJavaScriptEnabled(true);
   9
         webView.setWebChromeClient(new WebChromeClient());
   10
         webView.setWebViewClient(new WebViewClient());
   11
   
   12
         AdjustBridge.registerAndGetInstance(getApplication(), webview);
   13
         try {
   14
               webView.loadUrl("file:///android_asset/AdjustExample-WebView.html");
   15
         } catch (Exception e) {
   16
               e.printStackTrace();
   17
         }
   18
      }
   19
   
   20
      @Override
   21
      protected void onDestroy() {
   22
         AdjustBridge.unregister();
   23
   
   24
         super.onDestroy();
   25
      }
   26
   }

6. 在 HTML 中导入 Adjust Javascript 文件：

   1
   <script type="text/javascript" src="adjust.js"></script>
   2
   <script type="text/javascript" src="adjust_event.js"></script>
   3
   <script type="text/javascript" src="adjust_third_party_sharing.js"></script>
   4
   <script type="text/javascript" src="adjust_config.js"></script>

7. 现在，您可以将 appToken 和 environment 传送至 AdjustConfig 类，以在 web 视图中初始化 Adjust SDK：

   1
   let yourAppToken = "{YourAppToken}";
   2
   let environment = AdjustConfig.EnvironmentSandbox;
   3
   let adjustConfig = new AdjustConfig(yourAppToken, environment);
   4
   adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
   5
   Adjust.initSdk(adjustConfig);

8. 针对生产环境构建应用

完成测试后，您就可以针对生产环境构建应用了。为此，请更新您的 config 对象。

1. 调整日志等级，仅返回您需要的信息。

2. 将您的 environment 设为 AdjustConfig.ENVIRONMENT_PRODUCTION。

   • Kotlin
   • Java

   1
   val appToken = "{YourAppToken}"
   2
   val environment = AdjustConfig.ENVIRONMENT_PRODUCTION;
   3
   val config = AdjustConfig(this, appToken, environment)
   4
   config.setLogLevel(LogLevel.WARN)
   5
   Adjust.initSdk(config)

   1
   String appToken = "{YourAppToken}";
   2
   String environment = AdjustConfig.ENVIRONMENT_PRODUCTION;
   3
   AdjustConfig config = new AdjustConfig(this, appToken, environment);
   4
   config.setLogLevel(LogLevel.WARN)
   5
   Adjust.initSdk(config);