事前準備
SDK v5にアップデートする前に、以下を行ってください。
- SDK v5はSDKシグネチャーの検証をネイティブにサポートします。現在SDKシグネチャーライブラリを使用している場合は、まずこれをアンインストールしてください。
- アプリがバージョン21以前のAPIバージョンを対象にしている場合、SDK v5を使用する前にアプリをアップデートする必要があります。
SDKをインストールする
SDK v5の使用を開始するには、プロジェクトにdependencyとしてSDK v5を追加する必要があります。これを行うには、以下の手順に従ってください。
-
現在build.gradle
ファイルにある古いバージョンの SDK を全て削除します。
-
build.gradle
ファイルに以下のdependencyを追加します:
初期化メソッドを更新
SDK v4では、初期化メソッドはAdjust.onCreate(AdjustConfig)
です。SDK v5ではAdjust.initSdk(AdjustConfig)
に変更されています。
変更されたAPI
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
メソッドをブール引数で呼び出すことで、Adjust SDKがインストールデータをAdjustに送信できるように設定できます。
SDK v5では、このメソッドはenabledPreinstallTracking
に改名されています。この新しいメソッドは引数を取りません。
アトリビューションにコストデータを有効化する
SDK v4では、AdjustConfig
インスタンスのsetNeedsCost
メソッドをブール引数で呼び出すことで、SDKがユーザーのアトリビューションの一部としてコストデータを送信できるように設定できます。
SDK v5では、このメソッドはenableCostDataInAttribution
に改名されています。この新しいメソッドは引数を取りません。
SDK v4では、AdjustConfig
インスタンスのsetSendInBackground
メソッドをブール引数で呼び出すことで、アプリがバックグラウンドで実行されている時に、SDKがAdjustに情報を送信できるように設定できます。
SDK v5では、このメソッドの名前はenableSendingInBackground
に変更されました。この新しいメソッドは引数を取りません。
デバイスIDを1回だけ読み取る
SDK v4では、ブーリアン値でsAdjustConfig
インスタンスのsetReadDeviceInfoOnceEnabled
メソッドを呼び出すことで、初期化時にデバイスIDを1度だけ読み取るようにSDKを設定することができます。
SDK v5では、このメソッドはenableDeviceIdsReadingOnce
に改名されています。この新しいメソッドは引数を取りません。
セッションコールバックパラメーター
SDK v5では、セッション コールバック パラメーターはグローバル コールバック パラメーターに名称変更されました。
セッションパートナーパラメーター
SDK v5では、セッション パートナー パラメーターはグローバル パートナー パラメーターに名称変更されました。
イベントの重複排除
SDK v4では、イベント重複排除はイベントorder ID
と組み合わされ、最大10個のユニークIDに制限されています。
SDK v5では、この機能はorder ID
から切り離され、イベント重複排除のためにdeduplicationId
という新しいIDフィールドが追加されました。ユーザーは、重複イベントを識別するためにリストに追加可能なdeduplicationId
の数にカスタム制限を設定できます。デフォルトでは、制限は 10 に設定されています。
児童オンラインプライバシー保護法(COPPA)コンプライアンス
SDK v4では、 COPPAコンプライアンスは、ブーリアン引数でconfigオブジェクトのsetCoppaCompliantEnabled
メソッドを呼び出すことで設定されます。
SDK v5では、このメソッドはenableCoppaCompliance
に改名されています。この新しいメソッドは引数を受け取りません。
Playストアの子供向けアプリ
SDK v4では、ブーリアン引数でconfigオブジェクトのsetPlayStoreKidsAppEnabled
メソッドを呼び出すことで、アプリをPlayストアの子供向けアプリとしてマークできます。
SDK v5では、このメソッドはenablePlayStoreKidsCompliance
に改名されています。この新しいメソッドは引数を受け取りません。
データレジデンシーとURL戦略を設定する
SDK v4では、URL戦略とデータレジデンシーのドメインはAdjustConfig
クラスの定数として定義されています。
SDK v5では、選択したドメインを配列としてパスする必要があります。また、以下を設定することも可能です:
useSubdomains
(boolean
):ソースにサブドメインのプレフィックスを付けるかどうか。
isDataResidency
(boolean
):ドメインをデータレジデンシーに使用するかどうか。
SDK v5でURL戦略を設定する方法については、以下の表をご確認ください。
v4 | v5 - メインおよびフォールバックドメイン | v5 - サブドメインの使用 | v5 - データレジデンシー |
---|
AdjustConfig.DataResidencyEU | "eu.adjust.com" | true | true |
AdjustConfig.DataResidencyTR | "tr.adjust.com" | true | true |
AdjustConfig.DataResidencyUS | "us.adjust.com" | true | true |
AdjustConfig.UrlStrategyChina | "adjust.world" 。 "adjust.com" | true | false |
AdjustConfig.UrlStrategyCn | "adjust.cn" 。 "adjust.com" | true | false |
AdjustConfig.UrlStrategyCnOnly | "adjust.cn" | true | false |
AdjustConfig.UrlStrategyIndia | "adjust.net.in" 。 "adjust.com" | true | false |
例
サードパーティとの共有をグローバルに無効化する
SDK v4では、Adjust.disableThirdPartySharing()
メソッドを呼び出すことで、サードパーティとの情報共有をグローバルに無効化することができます。
この機能はSDK v5では削除されました。SDK v5では、Adjust.trackThirdPartySharing()
メソッドを使用してサードパーティとのデータ共有を有効化または無効化できます。
デバイスIDゲッター
SDK v4では、全てのデバイスIDのゲッターメソッドは同期的に実行されます。SDK v5では、これらのメソッドは非同期に実行されるように変更されています。
削除されたAPI
SDK v5では、以下のAPIが削除されました。
イベントバッファリング
SDK v4はイベントのバッファリングをサポートしています。この機能は、リクエストイベント、広告収益、Pushトークン、その他の情報をローカルバッファに保存し、後日送信します。
SDK v5では、この設定はご利用いただけません。
カスタムユーザーエージェント文字列
SDK v4は、ユーザーエージェント文字列でAdjustConfig
インスタンスのsetUserAgent
メソッドを呼び出すことで、カスタムユーザーエージェントの設定をサポートしています。
SDK v5では、この設定はご利用いただけません。
既知のデバイスかどうかを設定する
SDK v4では、AdjustConfig
インスタンスのsetDeviceKnown
メソッドを呼び出して、既知のデバイスかどうかをSDKに手動で通知することができます。
SDK v5では、この設定はご利用いただけません。
SDKの起動開始を遅延させる
SDK v4では、最大 120秒 の遅延でAdjustConfig
インスタンスのsetDelayStart
メソッドを呼び出すことで、SDKの起動を遅らせることができます。遅延が終了する前にアプリの準備ができている場合、 Adjust.sendFirstPackages
を呼び出すことで情報がすぐに送信されます。
SDK v5では、これら両方のメソッドが削除されました。
ディープリンクを使用したリアトリビューション
SDK v4では、 Adjust.appWillOpenUrl()
メソッドを呼び出すことで、Web BridgeでディープリンクURLをAdjustにパスすることができます。
このメソッドはSDK v5では廃止されています。
特定のソースの広告収益を送信する
SDK v4では、 Adjust.trackAdRevenue()
メソッドにソースとペイロードをパスすることで、特定のソースから広告収益を送信することができます。
このメソッドはSDK v5では廃止されています。
アプリシークレットを設定
SDK v4では、AdjustConfig
インスタンスのsetAppSecret
メソッドを呼び出して、SDKトラフィックの署名に使用するアプリシークレットを設定することができます。
SDK v5では、この設定はご利用いただけません。