事前準備
SDK v5にアップデートする前に、以下を行ってください。
- SDK v5はSDKシグネチャーの検証をネイティブにサポートします。現在SDKシグネチャーライブラリを使用している場合は、まずこれをアンインストールしてください。
- アプリが以下のバージョン以前のAPIバージョンを対象にしている場合、SDK v5を使用する前にアプリをアップデートする必要があります:
- iOS: 12.0
- tvOS: 12.0
SDKのインストール
SDK v5の使用を開始するには、XCodeプロジェクトにdependencyとしてSDK v5を追加する必要があります。これを行うには、以下の手順に従ってください。
-
現在
Podfile
にある古いバージョンの SDK を全て削除します。 -
以下を
Podfile
ファイルに追加します: -
pod install
を実行してdependencyをインストールします。
変更内容
SDK v5はメジャーバージョンアップです。つまり、コードを更新しなければならないような大きな変更があるということです。
v5 SDKをインストールしたら、新しいAPIを使用するために既存のAdjustコードを更新する必要があります。
初期化メソッド
SDK v4では、初期化メソッドはAdjust.onCreate(AdjustConfig)
です。SDK v5ではAdjust.initSdk(AdjustConfig)
に変更されています。
設定
このセクションでは、SDK設定の変更について説明します。
IDFAの読み取りを無効化する
SDK v5では、 AdjustConfig
インスタンスの disableIdfaReading
メソッドを呼び出すことで、 Adjust SDKが広告主のデバイスID IDFAを読み取らないようにすることができます。
AdServices情報の読み取りを無効化する
SDK v4では、AdjustConfig
インスタンスのsetAllowAdServicesInfoReading
メソッドをfalse
引数をつけて呼び出すことで、Adjust SDKがAdServices情報を読み取らないようにすることができます。
SDK v5では、Adjust SDKがAdServices情報を読み取らないようにするには、引数なしでdisableAdServices
メソッドを呼び出す必要があります。
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
インスタンスのsetNeedsCost
メソッドを呼び出すことで、SDKがユーザーのアトリビューションの一部としてコストデータを送信できるようにすることができます。
SDK v5では、このメソッドはenableCostDataInAttribution
に改名されています。この新しいメソッドは引数を取りません。
イベントバッファリング
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では、これら両方のメソッドが削除されました。
setPushToken
SDK v4は、プッシュトークンでAdjust.setDeviceToken
を呼び出すことによる、デバイスプッシュトークンの設定をサポートしています。
この機能はSDK v5では削除されました。
記録機能
このセクションでは、Adjustに情報を送信する機能の変更点について説明します。
セッションコールバックパラメーター
SDK v5では、セッション コールバック パラメーターはグローバル コールバック パラメーターに名称変更されました。
セッションパートナーパラメーター
SDK v5では、セッション パートナー パラメーターはグローバル パートナー パラメーターに名称変更されました。
イベントの重複排除
SDK v4では、イベント重複排除はイベントorder ID
と組み合わされ、最大10個のユニークIDに制限されています。
SDK v5では、この機能はorder ID
から切り離され、イベント重複排除のためにdeduplicationId
という新しいIDフィールドが追加されました。ユーザーは、重複イベントを識別するためにリストに追加可能なdeduplicationId
の数にカスタム制限を設定できます。デフォルトでは、制限は 10 に設定されています。
ディープリンク
このセクションでは、SDK v5でのディープリンクに関する変更点を説明します。
ディファードディープリンクを無効にする
SDK v5では、 AdjustConfig
インスタンスのdisableDeferredDeeplinkOpening
メソッドを呼び出すことで、SDKがディファードディープリンクを開かないようにすることができます。
ディープリンクを使用したリアトリビューション
SDK v4では、 Adjust.appWillOpenUrl()
メソッドを呼び出すことで、Web BridgeでディープリンクURLをAdjustにパスすることができます。
このメソッドはSDK v5では廃止されています。
Adjust LinkMe
SDK v4では、ブーリアン引数でAdjustConfig
インスタンスのsetLinkMeEnabled
メソッドを呼び出すことで、Adjust Web bridgeを使用してAdjust LinkMeを有効にできます。
このメソッドはSDK v5では廃止されています。
プライバシー機能
このセクションでは、Adjust SDKのプライバシー機能の変更点について説明します。
児童オンラインプライバシー保護法(COPPA)コンプライアンス
SDK v4では、 COPPAへの準拠は、ブーリアン引数でAdjustConfig
インスタンスのsetCoppaCompliantEnabled
メソッドを呼び出すことで設定されます。
SDK v5では、このメソッドはenableCoppaCompliance
に改名されています。この新しいメソッドは引数を受け取りません。
特定のソースの広告収益を送信する
SDK v4では、 Adjust.trackAdRevenue()
メソッドにソースとペイロードをパスすることで、特定のソースから広告収益を送信することができます。
このメソッドはSDK v5では廃止されています。
データレジデンシーと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()
メソッドを使用してサードパーティとのデータ共有を有効化または無効化できます。
SKAdNetworkとATT
このセクションでは、SDK v5におけるSKAdNetworkとApp Tracking Transparency(ATT)機能の変更点について説明します。
SKAdNetworkアトリビューションを無効化
SDK v5では、 AdjustConfig
インスタンスのdisableSkanAttributionHandling
メソッドを呼び出すことで、Adjust SDKがAppleのSKAdNetworkにアトリビューション情報を送信するのを防ぐことができます。
SKAdNetworkアップデートコールバック
SDK v5では、コールバック関数でAdjustConfig
インスタンスのsetSkanUpdatedCallback
メソッドを呼び出すことで、ユーザーのSKAdNetworkのconversion valueが変更された時にコールバック関数を実行するようにAdjust SDKを設定することができます。
ATTの承認ステータスをリクエスト
SDK v4では、Adjust.requestTrackingAuthorizationWithCompletionHandler
メソッドを使用してユーザーのATT認証ステータスの変更を処理できます。
より明確にするため、SDK v5ではrequestAppTrackingAuthorizationWithCompletionHandler
に改名されました。
ATTステータスを確認
SDK v4では、 Adjust.checkForNewAttStatus
メソッドを呼び出すことで、ユーザーのATTステータスの変更を確認できます。
このメソッドはSDK v5では廃止されています。
デバイス情報を取得
このセクションでは、SDK v5におけるデバイス情報ゲッターの変更点について説明します。
デバイスIDゲッター
SDK v4では、全てのデバイスIDのゲッターメソッドは同期的に実行されます。SDK v5では、これらのメソッドは非同期に実行されるように変更されています。