Android SDK連携ガイド

Adjust Android SDKを実装することで、アトリビューション、イベント、さらにその他のさまざまなデータをAndroidアプリで記録できます。Adjust SDKをアプリに実装するには、以下の手順に従ってください。

1. 環境を設定する

Adjust SDKを使い始めるには、SDKをdependencyとしてプロジェクトに追加してください。Adjust SDKはMavenで利用可能です。

プロジェクトにAdjust SDKを追加する方法：

1. Adjust SDKとAndroidリファラーの実装をbuild.gradleファイルに追加します。アプリでWeb viewを使用する場合、オプションでAdjust Web viewブリッジを追加します。

   1
   dependencies {
   2
      implementation 'com.adjust.sdk:adjust-android:5.1.0'
   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.1.0'
   6
   }

2. Google Play 開発者サービスを追加する

Google Playストアを対象とするアプリは、gps_adid（Google広告ID）を使用してデバイスを識別する必要があります。gps_adidにアクセスするには、play-services-ads-identifierAARをプロジェクトに追加する必要があります。

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. インストールリファラーを設定する

インストールリファラーは、インストールをソースにアトリビュートするために使用される一意の識別子です。Adjust SDKは、アトリビューションを実行するためにこの情報を必要とします。インストールのリファラー情報を取得するには、以下のいずれかの方法を使用します：

Google Play Referrer API

Google Play Referrer APIは、Google Play ストアを対象とするアプリで使用できます。

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

Huawei Referrer API

Huawei Referrer APIは、Huaweiデバイスを対象とするアプリで使用できます。Adjust SDKは、Adjust Huawei Referrerプラグインを使用して、Huaweiデバイスでのインストールを記録します。

このプラグインをインストールするには、build.gradleファイルに以下のdependencyを追加します：

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

Xiaomiリファラープラグイン

Xiaomiリファラープラグインを使用すると、Xiaomiデバイスを対象とするアプリのインストールリファラー値を記録できます。インストール情報については、プラグインに関するドキュメントを参照してください。

Samsungリファラープラグイン

Samsungリファラープラグインを使用すると、Samsung Galaxyストアを対象とするアプリのインストールリファラー値を記録できます。インストール情報については、プラグインに関するドキュメントを参照してください。

Metaとのリファラー連携

AdjustSDKはAdjustのMetaインストールリファラーを使用してMetaインストールリファラーをサポートしています。連携の詳細については、ドキュメントをご覧ください。

6. SDKシグネチャーを設定する

Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、AdjustヘルプセンターのSDKシグネチャーガイドの手順に従ってください。

7. Adjust SDKを実装する

Adjust SDKを初期化するには以下の情報が必要です：

• appToken: お客様のAdjustアプリトークン。
• environment: アプリの実行環境。アプリをローカルでテストするには、これをAdjustConfig.ENVIRONMENT_SANDBOXに設定します。

Adjust SDKを初期化する推奨の方法は、グローバルAndroidアプリケーションクラス内です。まだこれをアプリに設定していない場合は、以下の手順に従ってください：

1. Applicationを継承したクラスを作成します。

2. AndroidManifest.xml ファイルを開き、 <application>エレメントを確認します。

3. android:nameアトリビュートを<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 viewを使用している場合、Adjust Web View SDKを使って情報を記録する必要があります。WebViewオブジェクトへのリファレンスを取得する必要があります。これが完了したら、以下の手順に従ってください：

1. webView.getSettings().setJavaScriptEnabled(true)を呼び出して、WebビューでJavascriptを有効にします。

2. AdjustBridge.registerAndGetInstance(getApplication(), webview)を呼び出して、デフォルトのAdjustBridgeInstanceを起動します。これにより、AdjustブリッジがJavascriptインターフェイスとしてWeb viewに登録されます。

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 viewで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);