Android Adobe Extension v3移行ガイド

Adobe Experience SDKのAdjust Extensionがv3にアップデートされ、Adjust Android SDK v5のサポートが追加されました。Extensionをv2からv3に移行するには、このガイドの手順に従ってください。

Adobe ExperienceのAdjust Android Extension v3をインストールするには、build.gradleのdependency宣言を以下の通り更新してください。

com.adjust.adobeextension:adobeextension を3.0.0以降に更新する必要があります。
com.adjust.sdk:adjust-android を5.0.0以降に更新する必要があります。

1
dependencies {
2
   implementation 'com.adjust.adobeextension:adobeextension:3.0.0'
3
   implementation 'com.adjust.sdk:adjust-android:5.3.0'
4
   implementation 'com.adobe.marketing.mobile:core:3.2.0'
5
   implementation 'com.android.installreferrer:installreferrer:2.2'
6
}

Adobe ExperienceのAdjust Android Extensionを設定する方法については、連携ガイドを参照してください。

新規API

v3に追加

Extension v3では、以下のAPIが追加されました。

ショートブランドリンクの解析

Adobe Experience SDKのAdjust Extension v3では、ショートブランドリンクの解析に対するサポートが追加されます。短縮リンクを解析するには、以下の引数を使用して Adjust.processAndResolveDeeplink メソッドを呼び出します。

adjustDeeplink: AdjustDeeplink: アプリを起動するディープリンク。
context: Context: アプリのコンテキスト。getApplicationContext() を呼び出して、この値を入力します。
callback: OnDeeplinkResolvedListener: 解析されたショートリンクを引数として受け取るコールバック関数。

1
Intent intent = getIntent();
2
Uri data = intent.getData();
3
AdjustDeeplink adjustDeeplink = new AdjustDeeplink(data);
4
Adjust.processAndResolveDeeplink(adjustDeeplink, getApplicationContext(), new OnDeeplinkResolvedListener() {
5
   @Override
6
   public void onDeeplinkResolved(String s) {
7

8
   }
9
});

グローバルコールバックパラメーター

Adobe Experience SDKのAdjust Extension v3では、Android SDK v5によるグローバルコールバックパラメーターAPIのサポートが追加されます。セッションにグローバルコールバックを追加するには、次の引数を指定して Adjust.addGlobalCallbackParameter メソッドを呼び出します。

key: String: パラメーターのキー。
value: String: パラメーターの値。

1
Adjust.addGlobalCallbackParameter("key", "value");
2
Adjust.addGlobalCallbackParameter("user_id", "855");

グローバルコールバックの設定方法をご確認ください。

グローバルパートナーパラメーター

Adobe Experience SDKのAdjust Extension v3では、Android SDK v5によるグローバルパートナーパラメーターAPIのサポートが追加されます。グローバルパートナーパラメーターを追加するには、以下の引数を使用してAdjust.addGlobalPartnerParameterメソッドを呼び出します。

key: String: パラメーターのキー。
value: String: パラメーターの値。

1
Adjust.addGlobalPartnerParameter("key", "value");
2
Adjust.addGlobalPartnerParameter("user_id", "855");

グローバルパートナーパラメーターの設定方法をご確認ください。

外部デバイスIDを設定する

Adobe Experience SDKのAdjust Extension v3では、外部デバイスID設定のサポートが追加されます。外部デバイスIDを設定するには、以下の引数で AdjustAdobeExtensionConfig の setExternalDeviceId メソッドを呼び出します。

externalDeviceId: String: 外部デバイスID。

1
String environment = AdjustAdobeExtensionConfig.ENVIRONMENT_SANDBOX;
2
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
3
config.setExternalDeviceId("{YourExternalDeviceId}");
4
AdjustAdobeExtension.setConfiguration(config);

外部デバイスIDの設定方法をご確認ください。

プリインストールアプリのデフォルトリンクトークンの設定

Adobe Experience SDKのAdjust Extension v3では、プレインストールされたアプリインストールをデフォルトキャンペーンに記録するため、デフォルトのリンクトークンを設定することができます。デフォルトのリンクトークンを設定するには、以下の引数を使用して AdjustAdobeExtensionConfig インスタンスの setDefaultTracker メソッドを呼び出します。

defaultTracker: String: プリインストールキャンペーン用の英数字のリンクトークン。

1
String environment = AdjustAdobeExtensionConfig.ENVIRONMENT_SANDBOX;
2
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
3
config.setDefaultTracker("{Token}");
4
AdjustAdobeExtension.setConfiguration(config);

プリインストールアプリのアクティビティを送信する方法をご確認ください。

変更されたAPI

v3で変更

Extension v3では、以下のAPIが変更されました。

デバイスADIDの取得

SDK v2では、AdjustAttributionクラスはadidというプロパティを持ちます。このプロパティは削除されました。デバイスのADIDを非同期的に取得するには、Adjust.getAdidを呼び出します。

1
Adjust.getAdid(new OnAdidReadListener() {
2
    @Override
3
    public void onAdidRead(String adid) {
4
      // Your callback function
5
    }
6
});

ダイレクトディープリンク

SDK v2では、ディープリンクデータを引数としてAdjustAdobeExtension.openUrlメソッドを呼び出すことで、アトリビューションのディープリンクを開くことができます。

1
Intent intent = getIntent();
2
Uri data = intent.getData();
3
AdjustAdobeExtension.openUrl(data, getApplicationContext());

SDK v3では、Adjust Android SDKのprocessDeeplinkメソッドを使用するように更新されました。ダイレクトディープリンクを開くには、以下の手順に従ってください。

ディープリンクURLを使用して新しいAdjustDeeplinkインスタンスを作成します。
Adjust.processDeeplink メソッドにAdjustDeeplinkインスタンスを渡します。

1
Intent intent = getIntent();
2
Uri data = intent.getData();
3
AdjustDeeplink adjustDeeplink = new AdjustDeeplink(data);
4
Adjust.processDeeplink(adjustDeeplink, getApplicationContext());

ダイレクトディープリンクでユーザーをリアトリビュートする方法をご確認ください。

ディファードディープリンクのコールバック

SDK v2では、AdjustAdobeExtensionConfigインスタンスのsetOnDeeplinkResponseListenerメソッドに関数を渡すように設定することで、ディファードディープリンクが開いた時にコールバック関数を起動させることができます。

1
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
2

3
config.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() {
4
    @Override
5
    public boolean launchReceivedDeeplink(Uri deeplink) {
6
        if (shouldAdjustSdkLaunchTheDeeplink(deeplink)) {
7
            return true;
8
        } else {
9
            return false;
10
        }
11
    }
12
});
13

14
AdjustAdobeExtension.setConfiguration(config);

SDK v3では、このメソッドの名前がsetOnDeeplinkResponseListenerからsetOnDeferredDeeplinkResponseListenerに変更されました。

1
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
2

3
config.setOnDeferredDeeplinkResponseListener(new OnDeferredDeeplinkResponseListener() {
4
    @Override
5
    public boolean launchReceivedDeeplink(Uri deeplink) {
6
        if (shouldAdjustSdkLaunchTheDeeplink(deeplink)) {
7
            return true;
8
        } else {
9
            return false;
10
        }
11
    }
12
});
13

14
AdjustAdobeExtension.setConfiguration(config);

ディファードディープリンクコールバックとの利用方法をご確認ください。