アンインストールと再インストールの計測

Adjust Android SDKを使用して、アンインストールと再インストールを計測します。AdjustはPushトークンを使用することでユーザーのデバイスにサイレントPush通知を送信し、アプリが現在インストールされているかどうかを確認します。

この機能をアプリに追加するには、以下の手順に従ってください。

事前準備

はじめに、以下の設定手順をご覧ください。

要件

• Android SDK v4.12.0以降
• AndroidプロジェクトにFirebaseを追加すること
• 管理者、編集者およびカスタム編集者のユーザー権限

Google FCMをAdjustに連携する

GoogleのFirebase Cloud Messaging（FCM）APIを使用してサイレントPush通知を設定することで、アンインストールと再インストールを計測できます。 AdjustがGoogle FCMに接続するには、FCM HTTP v1 APIプライベートキーが必要です。

Google Cloudコンソール

1.Adjustのアンインストール・再インストール計測のカスタムアクセス権限を作成する

1. Google Cloud Consoleにアクセスします。

2. Firebaseプロジェクトに関連付けられているGoogle Cloudプロジェクトを選択します。

3. IAM & Admin を検索します。

4. サイドメニューで、 ロール（Role） を選択します。

5. + 権限を作成 (Create Role) を選択します。

6. 以下の詳細を入力します：

   1. Title : Adjust Uninstall
   2. ID : adjust_uninstall
   3. Role launch stage : General Availability

7. + Add Permissions を選択します。

8. Enter property name or value フィールドにcloudmessaging.messages.createと入力し、検索結果から選択します。

9. cloudmessaging.messages.create オプションにチェックを入れ、 Add を選択します。

10. Create を選択します。

2.サービスアカウントを作成する

1. サイドメニューから Service Accounts を選択します。
2. + Create Service Account を選択します。
3. Service account name フィールドに、 Adjust Uninstall Service Accountと入力します。
4. Create and Continue を選択します。
5. Select a role ドロップダウンを選択します。 Adjust Uninstallを入力し、検索結果から選択します。
6. 続ける（Continue） を選択します。
7. Done を選択します。

3.プライベートキーを生成してダウンロードする

1. 新しく作成したサービスアカウントを選択します。書式は以下のようになります：adjust-uninstall-service-account@test3-55065.iam.gserviceaccount.com。
2. Keys タブを選択します。
3. Add Key > Create new key を選択します。
4. JSON > 作成 (Create) を選択します。 プライベートキーは、JSONファイルとしてコンピューターにダウンロードされます。

Adjustダッシュボードにて

AdjustとGoogle FCMを連携するために必要なプライベートキーの詳細を取得したら、AppViewのアプリ設定でアンインストール・再インストール計測を有効にする必要があります。

1. プラットフォーム (Platforms) を選択します。
2. 編集（EDIT） を選択します。
3. 「詳細設定（Advanced settings）」 で、 「アンインストールと再インストールデータを記録（Record uninstall and reinstall data）」 を見つけます。
4. 接続先を追加（Add Connection） を選択します。モーダルが開き、AdjustとGoogle FCMの間に新しいパートナー接続を追加するよう求められます。
5. 最近生成したFCMプライベートキーなどの必要な情報を入力します。 パートナー と サービス のフィールドは自動的に入力されます。
6. 接続（Connect） を選択します。
7. アプリの設定を確認し、 保存（Save） を選択します。

Adjust SDKを実装する

FCMをAdjust SDKに連携するには、以下の手順に従ってください。

1. build.gradleファイルに、 Firebase Messaging に必要なdependencyがあることを確認してください。

   1
   dependencies {
   2
      // ...
   3
      implementation 'com.google.firebase:firebase-messaging:23.4.0'
   4
      // ...
   5
   }

2. まだ未設定の場合は、Googleのドキュメントに従ってFirebase Cloud Messagingクライアントアプリを設定してください。

3. デバイスのプッシュトークンをAdjust SDKにパスします。

   • アプリに独自のPush通知を送信する場合は、全てのタイプのPush通知を処理するロジックを使ってFirebaseMessagingServiceクラスのonMessageReceivedメソッドをオーバーライドするようにしてください。それにはアンインストールおよび再インストール計測のためのAdjustのサイレントPush通知も含まれます。

例

次のコードスニペットは、 FirebaseMessagingServiceクラスを拡張してAdjust SDKにプッシュトークンをパスし、Push通知の処理ロジックを更新する方法を示しています。独自のPush通知を送信しない場合は、 onMessageReceivedメソッドのオーバーライドをスキップできます。

1
import com.adjust.sdk.Adjust
2
import com.adjust.sdk.Util
3
import com.google.firebase.messaging.FirebaseMessaging
4
import com.google.firebase.messaging.FirebaseMessagingService
5
import com.google.firebase.messaging.RemoteMessage
6

7
class MyFirebaseMessagingService : FirebaseMessagingService() {
8

9
  override fun onCreate() {
10
    super.onCreate()
11
    // Fetch FCM token and set in Adjust SDK
12
    FirebaseMessaging.getInstance().token
13
      .addOnCompleteListener { task ->
14
        if (task.isSuccessful && task.result != null) {
15
          Adjust.setPushToken(task.result, applicationContext)
16
        }
17
      }
18
  }
19

20
  override fun onNewToken(token: String) {
21
    super.onNewToken(token)
22

23
    // Receive new FCM token and set in Adjust SDK
24
    Adjust.setPushToken(token, applicationContext)
25
  }
26

27
  override fun onMessageReceived(remoteMessage: RemoteMessage) {
28
    super.onMessageReceived(remoteMessage)
29

30
    // Check if message has data payload
31
    if (remoteMessage.data.isNotEmpty()) {
32
      val payload: Map<String, String> = remoteMessage.data
33

34
      // Check for Adjust uninstall detection data message
35
      if (Util.isAdjustUninstallDetectionPayload(payload)) {
36
        // No handling required for Adjust data payload
37
      } else {
38
        // Handle other data payloads here
39
      }
40
    }
41

42
    // Check if message has notification payload
43
    remoteMessage.notification?.let {
44
      // Handle notification payload here
45
    }
46
  }
47
}

1
import com.adjust.sdk.Adjust;
2
import com.adjust.sdk.Util;
3
import com.google.firebase.messaging.FirebaseMessagingService;
4
import com.google.firebase.messaging.RemoteMessage;
5
import java.util.Map;
6

7
public class MyFirebaseMessagingService extends FirebaseMessagingService {
8

9
  @Override
10
  public void onCreate() {
11
    super.onCreate();
12
    // Fetch FCM token and set in Adjust SDK
13
    FirebaseMessaging.getInstance().getToken()
14
      .addOnCompleteListener(task -> {
15
        if (task.isSuccessful() && task.getResult() != null) {
16
          Adjust.setPushToken(task.getResult(),getApplicationContext());
17
        }
18
      });
19
  }
20

21
  @Override
22
  public void onNewToken(String token) {
23
    super.onNewToken(token);
24

25
    // Receive new FCM token and set in Adjust SDK
26
    Adjust.setPushToken(token, getApplicationContext());
27
  }
28

29
  @Override
30
  public void onMessageReceived(RemoteMessage remoteMessage) {
31
    super.onMessageReceived(remoteMessage);
32

33
    // Check if message has data payload
34
    if (!remoteMessage.getData().isEmpty()) {
35
      Map<String, String> payload = remoteMessage.getData();
36

37
      // Check for Adjust uninstall detection data message
38
      if (Util.isAdjustUninstallDetectionPayload(payload)) {
39
        // No handling required for Adjust data payload
40
      } else {
41
        // Handle other data payloads here
42
      }
43
    }
44

45
    // Check if message has notification payload
46
    if (remoteMessage.getNotification() != null) {
47
      // Handle notification payload here
48
    }
49
  }
50
}

4. Adjust SDKを初期化する前に、アプリのFirebaseインスタンスを初期化します。

例

Androidプロジェクトのアプリケーションクラスの例を次に示します。アプリを起動すると同時に、Firebaseインスタンスが初期化されていることが確認できます。

1
import android.app.Application
2
import com.adjust.sdk.Adjust
3
import com.adjust.sdk.AdjustConfig
4
import com.google.firebase.FirebaseApp
5

6
class MyApp : Application() {
7

8
  override fun onCreate() {
9
    super.onCreate()
10

11
    // Initialize Firebase App
12
    FirebaseApp.initializeApp(this)
13

14
    // Configure Adjust SDK
15
    // Replace {YourAppToken} with your Adjust app token
16
    val appToken = "{YourAppToken}"
17
    val environment = AdjustConfig.ENVIRONMENT_PRODUCTION
18
    val config = AdjustConfig(this, appToken, environment)
19

20
    // Initialize Adjust SDK
21
    Adjust.onCreate(config)
22
  }
23
}

1
import android.app.Application;
2
import com.adjust.sdk.Adjust;
3
import com.adjust.sdk.AdjustConfig;
4
import com.google.firebase.FirebaseApp;
5

6
public class MyApp extends Application {
7

8
  @Override
9
  public void onCreate() {
10
    super.onCreate();
11

12
    // Initialize Firebase App
13
    FirebaseApp.initializeApp(this);
14

15
    // Configure Adjust SDK
16
    // Replace {YourAppToken} with your Adjust app token
17
    String appToken = "{YourAppToken}";
18
    String environment = AdjustConfig.ENVIRONMENT_PRODUCTION;
19
    AdjustConfig config = new AdjustConfig(this, appToken, environment);
20

21
    // Initialize Adjust SDK
22
    Adjust.onCreate(config);
23
  }
24
}

実装テスト

Adjustは、Adjustの本番環境で最後のアクティビティがあったデバイスからのAndroidアプリのアンインストールを確認します。

アンインストールと再インストールの計測をテストするには、デバッグビルドまたはリリースビルドのいずれかを使用してください。主な要件として、テストインストールを実行する際は、Adjust SDK環境を 本番用 に設定する必要があります。

アンインストール計測をテストする方法：

1. Adjust SDKで、Adjust SDKを初期化する前に環境をAdjustConfig.ENVIRONMENT_PRODUCTIONに設定します。

2. 実機テスト用のデバイスまたはエミュレーターにアプリをインストールします。

3. アプリを開きます。

4. Adjustのテストコンソール（Testing Console）を開きます。

5. デバイスID を入力し、 デバイスデータを表示（View device data） を選択します。

6. アプリ情報（App information） セクションで以下を実行します。

   • インストールの状態（Install state） が インストール済み（Installed） と表示されていることを確認します。
   • Pushトークン の値が確認できます。

7. アプリをアンインストールします。

8. Adjustは1日1回アンインストールを確認するため、24時間後に再度テストコンソールを確認してください。 アプリ情報 (App information) セクションの インストールの状態（Install state） に アンインストール済み（Uninstalled） と表示されます。

状態が インストール済み (Installed） から アンインストール済み（Uninstalled） に変更されることで、アンインストールと再インストール計測機能が正しく機能するようになります。 再インストール計測もテストする場合は、次の手順に従ってください。

1. 実際のテストデバイスまたはエミュレーターにデバッグビルドまたはリリースビルドを再インストールします。
2. アプリを開きます。
3. Adjustは1日に1回再インストールを確認するため、24時間後に再度テストコンソールを確認してください。 アプリ情報 (App information) セクションの インストールの状態（Install state） に 再インストール済み（Reinstalled） と表示されます。

トラブルシューティング

アンインストール・再インストール計測をテストする際によくある問題は、以下のとおりです。

• テストインストールが行われると、Adjust SDK環境はAdjustConfig.ENVIRONMENT_SANDBOXに設定されます。アンインストール・再インストール計測はこの設定では機能しません。Adjust SDKでの設定は、必ずAdjustConfig.ENVIRONMENT_PRODUCTIONに変更してください。
• Pushトークンがありません。Pushトークンがテストコンソールに表示されない場合、Firebaseの実装またはFirebase SDKとAdjust SDKを連携するコードに問題がある可能性があります。実装に関するこれらの要素を確認してください。
• FCM HTTP v1 APIプライベートキーに問題があります。例えば、生成したプライベートキーが誤ったプロジェクトに属しているか、 Adjust suiteに詳細が誤って入力された可能性があります。担当のテクニカルアカウントマネージャーまたはsupport@adjust.comにご連絡いただき、デバイスのPushトークンをお知らせください。担当者がログを取得して、AppleのAPIからのレスポンスを確認します。

問題が解決したら、次の手順に従って実装を再度テストしてください。

1. アプリをアンインストールします。
2. テストコンソールで デバイスID を入力し、 デバイスデータの表示（View device data） > デバイス削除（Forget Device） を選択します。
3. 連携をテストするのセクションの手順を繰り返します。