adjust-icon

SDK v5移行ガイド

事前準備

SDK v5にアップデートする前に、以下を行ってください。

  1. SDK v5はSDKシグネチャーの検証をネイティブにサポートします。現在SDKシグネチャーライブラリを使用している場合は、まずこれをアンインストールしてください。
  2. アプリがバージョン21以前のAPIバージョンを対象にしている場合、SDK v5を使用する前にアプリをアップデートする必要があります。

SDKをインストールする

SDK v5の使用を開始するには、プロジェクトにdependencyとしてSDK v5を追加する必要があります。これを行うには、以下の手順に従ってください。

  1. 現在build.gradleファイルにある古いバージョンの SDK を全て削除します。

  2. build.gradleファイルに以下のdependencyを追加します:

    build.gradle
    dependencies {
    implementation 'com.adjust.sdk:adjust-android:5.0.0'
    implementation 'com.android.installreferrer:installreferrer:2.2'
    // Add the following if you are using the Adjust SDK inside web views on your app
    implementation 'com.adjust.sdk:adjust-android-webbridge:5.0.0'
    }

初期化メソッドを更新

v5で変更

SDK v4では、初期化メソッドはAdjust.onCreate(AdjustConfig)です。SDK v5ではAdjust.initSdk(AdjustConfig)に変更されています。

SDKシグネチャーライブラリを設定

SDK v5には、 SDKシグネチャーライブラリが含まれています。これは、シグネチャーライブラリ連携ガイドのテスト手順に従ってテストすることができます。

シグネチャーの保護機能は、デフォルトで非アクティブになっています。これを有効化するには、以下の手順に従ってください

  1. シグネチャーの検証を有効化します
  2. テスト前にアプリのSHA-1フィンガープリントを提供してください

v5 SDKをインストールしたら、新しいAPIを使用するために既存のAdjustコードを更新する必要があります。

新規API

v5に追加

SDK v5では、以下のプラグインが追加されました。

インストールリファラーゲッター

SDK v5には、インストールリファラー情報を取得するための新しいゲッターメソッドが含まれています。

変更されたAPI

v5で変更

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

SDKを無効化および有効化する

SDK v4では、boolean値でAdjust.setEnabled()を呼び出すことで、SDKを有効化・無効化することができます。

  • SDKを無効化するには、Adjust.setEnabled(false)を呼び出します。
  • SDKを有効化するには、Adjust.setEnabled(true)を呼び出します。

より明確にするため、SDK v5では、この機能は別々のコマンドに分割されています。

  • SDKを無効化するには、Adjust.disable()を呼び出します。
  • SDKを有効化するには、Adjust.enable()を呼び出します。

オフラインモード

SDK v4では、boolean値でAdjust.setOfflineMode()を呼び出すことで、SDKでオフラインモードを有効化・無効化することができます。

より明確にするため、SDK v5では、この機能は別々のコマンドに分割されています。

  • SDKをオフラインモードに設定するには、Adjust.switchToOfflineMode()を呼び出します。
  • SDKをオンラインモードに戻すには、Adjust.switchBackToOnlineMode()を呼び出します。

プリインストール記録

SDK v4では、ブーリアン引数でAdjustConfigインスタンスのsetPreinstallTrackingEnabledメソッドを呼び出すことで、SDKがユーザーのデバイスにプリインストールされているアプリのアクティビティを記録するように設定できます。

SDK v5では、このメソッドはenablePreinstallTrackingに改名されています。このメソッドは引数を取りません。

セッション情報を送信する

SDK v4では、ActivityLifecycleCallbacksを実装し、アクティビティ再開時と一時停止時にそれぞれAdjust.onResume()Adjust.onPause()を呼び出すことで、アクティビティライフサイクルのコールバックを登録する必要があります。

SDK v5では、ActivityLifecycleCallbacks機能はSDKによって処理されます。コードから全てのカスタム アクティビティ ライフサイクル コールバックを削除してください。

セッションコールバックパラメーター

SDK v5では、セッション コールバック パラメーターはグローバル コールバック パラメーターに名称変更されました。

セッションパートナーパラメーター

SDK v5では、セッション パートナー パラメーターはグローバル パートナー パラメーターに名称変更されました。

イベントの重複排除

SDK v4では、イベント重複排除はイベントorder IDと組み合わされ、最大10個のユニークIDに制限されています。

SDK v5では、この機能はorder IDから切り離され、イベント重複排除のためにdeduplicationIdという新しいIDフィールドが追加されました。ユーザーは、重複イベントを識別するためにリストに追加可能なdeduplicationIdの数にカスタム制限を設定できます。デフォルトでは、制限は 10 に設定されています。

AdjustAttributionクラス

SDK v4では、AdjustAttributionコールはadidというプロパティを持ちます。SDK v5 では、AdjustAttribution クラスからadidプロパティが削除されました。デバイスのADIDを取得するには、getAdid()ゲッターメソッドを使用してください。

Adjust SDKにディープリンクデータをパスするためのメソッドの名前が変更されました。

  • v4:Adjust.appWillOpenUrl()
  • v5:Adjust.processDeeplink()

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

SDK v4では、setOnDeeplinkResponseListenerメソッドを呼び出してディファード ディープリンク コールバックを処理できます。

より明確にするため、SDK v5では、このメソッドはsetOnDeferredDeeplinkResponseListenerに改名されています。全ての引数は同じです。

児童オンラインプライバシー保護法(COPPA)コンプライアンス

SDK v4では、ブーリアン値でAdjustConfigインスタンスのsetCoppaCompliantEnabledメソッドを呼び出すことで、アプリをCOPPAに準拠していることをマークできます。

SDK v5では、このメソッドはenableCoppaComplianceに改名されています。このメソッドは引数を取りません。

Playストアの子供向けアプリ

SDK v4では、ブーリアン引数でAdjustConfigインスタンスのsetPlayStoreKidsAppEnabledメソッドを呼び出すことで、アプリをPlayストアの子供向けアプリとしてマークできます。

SDK v5では、このメソッドはenablePlayStoreKidsComplianceに改名されています。このメソッドは引数を取りません。

特定のソースの広告収益を送信する

SDK v4では、広告収益ソースはAdjustConfigクラスの定数として定義されています。SDK v5では、広告収益ソースは文字列としてパスされる必要があります。

v4v5
AdjustConfig.AD_REVENUE_APPLOVIN_MAX"applovin_max_sdk"
AdjustConfig.AD_REVENUE_ADMOB"admob_sdk"
AdjustConfig.AD_REVENUE_IRONSOURCE"ironsource_sdk"
AdjustConfig.AD_REVENUE_ADMOST"admost_sdk"
AdjustConfig.AD_REVENUE_UNITY"unity_sdk"
AdjustConfig.AD_REVENUE_HELIUM_CHARTBOOST"helium_chartboost_sdk"
AdjustConfig.AD_REVENUE_ADX"adx_sdk"
AdjustConfig.AD_REVENUE_SOURCE_PUBLISHER"publisher_sdk"
AdjustConfig.AD_REVENUE_TRADPLUS"tradplus_sdk"
AdjustConfig.AD_REVENUE_TOPON"topon_sdk"
AdjustConfig.AD_REVENUE_MOPUB"mopub"

データレジデンシーとURL戦略を設定する

SDK v4では、URL戦略とデータレジデンシーのドメインはAdjustConfigクラスの定数として定義されています。

SDK v5では、選択したドメインを配列としてパスする必要があります。また、以下を設定することも可能です:

  • useSubdomainsboolean):ソースにサブドメインのプレフィックスを付けるかどうか。
  • isDataResidencyboolean):ドメインをデータレジデンシーに使用するかどうか。

SDK v5でURL戦略を設定する方法については、以下の表をご確認ください。

v4v5 - メインおよびフォールバックドメインv5 - サブドメインの使用v5 - データレジデンシー
AdjustConfig.DATA_RESIDENCY_EU"eu.adjust.com"truetrue
AdjustConfig.DATA_RESIDENCY_TR"tr.adjust.com"truetrue
AdjustConfig.DATA_RESIDENCY_US"us.adjust.com"truetrue
AdjustConfig.URL_STRATEGY_CHINA"adjust.world""adjust.com"truefalse
AdjustConfig.URL_STRATEGY_CN"adjust.cn""adjust.com"truefalse
AdjustConfig.URL_STRATEGY_CN_ONLY"adjust.cn"truefalse
AdjustConfig.URL_STRATEGY_INDIA"adjust.net.in""adjust.com"truefalse

デバイスIDゲッター

SDK v4では、全てのデバイスIDのゲッターメソッドは同期的に実行されます。SDK v5では、これらのメソッドは非同期に実行されるように変更されています。

削除されたAPI

v5で削除

SDK v5では、以下のAPIが削除されました。

イベントバッファリング

SDK v4はイベントのバッファリングをサポートしています。この機能は、リクエストイベント、広告収益、Pushトークン、その他の情報をローカルバッファに保存し、後日送信します。

SDK v5では、この設定はご利用いただけません。

カスタムユーザーエージェント文字列

SDK v4では、ユーザーエージェント文字列でAdjustConfig.setUserAgent()を呼び出すことによるカスタムユーザーエージェントの設定をサポートしています。

SDK v5では、この設定はご利用いただけません。

既知のデバイスかどうかを設定する

SDK v4では、AdjustConfig.setDeviceKnown()メソッドを呼び出して、既知のデバイスかどうかをSDKに手動で通知することができます。

SDK v5では、この設定はご利用いただけません。

SDKの起動開始を遅延させる

SDK v4では、AdjustConfig.setDelayStart()を最大 120秒 遅延させて呼び出すことで、SDKの開始を遅延させることができます。

SDK v5では、この設定はご利用いただけません。

サードパーティとの共有をグローバルに無効化する

SDK v4では、Adjust.disableThirdPartySharing()メソッドを呼び出すことで、サードパーティとの情報共有をグローバルに無効化することができます。

この機能はSDK v5では削除されました。SDK v5では、Adjust.trackThirdPartySharing()メソッドを使用してサードパーティとのデータ共有を有効化または無効化できます。

アプリシークレットを設定

SDK v4では、AdjustConfigインスタンスのsetAppSecretメソッドを呼び出して、SDKトラフィックの署名に使用するアプリシークレットを設定することができます。

SDK v5では、この設定はご利用いただけません。

新規プラグイン

v5に追加

SDK v5では、以下のプラグインが削除されました。

Huawei インストールリファラープラグイン

SDK v5は、デバイスのインストールリファラープラグイン情報を記録するHuawei インストールリファラープラグインをサポートしています。プラグインを追加するには、build.gradleファイルに以下のdependencyを追加します:

build.gradle
dependencies {
implementation 'com.adjust.sdk:adjust-android-huawei-referrer:5.0.0'
}

Meta インストールリファラープラグイン

SDK v5は、Metaのインストールリファラー情報を記録するMeta インストールリファラープラグインをサポートしています。この情報を読み取る方法は以下の通りです:

  1. build.gradleファイルに以下のdependencyを追加します:

    build.gradle
    dependencies {
    implementation 'com.adjust.sdk:adjust-android-meta-referrer:5.0.0'
    }
  2. App DashboardでMetaアプリIDを検索します。詳しくはMetaのアプリダッシュボードのドキュメントをご覧ください。

  3. AdjustConfig.setFbAppIdメソッドにString引数としてアプリIDをパスします。

削除されたプラグイン

v5で削除

SDK v5では以下のプラグインが削除されました:

  • Criteo
  • Trademob
  • Sociomantic