事前準備
SDK v5にアップデートする前に、以下を行ってください。
-
Adjust SDK v5は、 SDKシグネチャーの検証をネイティブでサポートしています。現在、SDKシグネチャーライブラリを使用している場合は、まずシグネチャーライブラリをアプリから削除する必要があります。
-
SDK v5の最小サポート対象APIバージョンが更新されました。以前のバージョンをターゲットにしている場合は、まずアプリをアップデートする必要があります。
- iOS: 12.0
- Android: 21
SDKをインストールする
SDK v5の使用を開始するには、プロジェクトにdependencyとしてSDK v5を追加する必要があります。これを行うには、以下の手順に従ってください。
- 次のオプションのいずれか1つを使用して、React Nativeライブラリをダウンロードします。
ターミナルで以下のコマンドを実行します:
- ターミナルで以下のコマンドを実行し、iOSアプリのCocoaPodsのdependencyをインストールします:
初期化メソッドを更新
SDK v4では、初期化メソッドはAdjust.create
です。SDK v5ではAdjust.initSdk
に変更されています。
変更されたAPI
SDK v5では、以下のAPIが変更されました。
SDKを無効化および有効化する
SDK v4では、bool
値でAdjust.setEnabled
を呼び出すことで、SDKを有効化・無効化することができます。
より明確にするため、SDK v5では、この機能は別々のコマンドに分割されています。
- SDKを無効化するには、
Adjust.disable
を呼び出します。 - SDKを有効化するには、
Adjust.enable
を呼び出します。
バックグラウンドで情報を送信する
SDK v4では、adjustConfig
インスタンスのsetSendInBackground
メソッドをbool
値で呼び出し、アプリがバックグラウンドで動作している間にSDKがAdjustに情報を送信できるようにする必要があります。
SDK v5では、adjustConfig
インスタンスのenableSendingInBackground
メソッドを呼び出し、アプリがバックグラウンドで動作している間にSDKがAdjustに情報を送信できるようにする必要があります。デフォルトの状態はfalse
です。
プリインストールアプリ計測
SDK v4では、 adjustConfig
インスタンスのsetPreinstallTrackingEnabled
メソッドをtrue
値で呼び出し、プリインストールアプリの計測を有効化することができます。
SDK v5でプリインストールアプリの計測を有効化するには、 adjustConfig
インスタンスのenablePreinstallTracking
メソッドを呼び出す必要があります。デフォルトの状態はfalse
です。
AdServices情報の読み取りを無効化する
SDK v4では、adjustConfig
のsetAllowAdServicesInfoReading
メソッドをfalse
で呼び出すことで、Adjust SDKがAdServices情報を読み取らないようにすることができます。
SDK v5でAdjust SDKがAdServices情報を読み取らないようにするには、 adjustConfig
インスタンスのdisableAdServices
メソッドを呼び出す必要があります。デフォルトの状態はtrue
です。
IDFAの読み取りを無効化する
SDK v4では、adjustConfig
のsetAllowIdfaReading
メソッドをfalse
値で呼び出すことで、Adjust SDKがデバイスのIDFAを読み取らないようにすることができます。
SDK v5でAdjust SDKがデバイスのIDFAを読み取らないようにするには、 adjustConfig
インスタンスのdisableIdfaReading
メソッドを呼び出す必要があります。デフォルトの状態はtrue
です。
アトリビューションにコストデータを有効化する
SDK v4でデバイスのアトリビューション情報のコストデータを有効化するには、 adjustConfig
インスタンスのsetNeedsCost
メソッドをtrue
値で呼び出す必要があります。
SDK v5でデバイスのアトリビューション情報のコストデータを有効化するには、adjustConfig
インスタンスのenableCostDataInAttribution
メソッドを呼び出す必要があります。デフォルトの状態はfalse
です。
アトリビューションコールバックを設定する
SDK v4では、AdjustConfig
インスタンスのsetAttributionCallbackListener
メソッドを呼び出すことで、ユーザーのアトリビューションデータが変更されたときにトリガーするデリゲートコールバック関数を設定できます。
SDK v5では、このメソッドの名前はsetAttributionCallback
に変更されました。全ての引数は同じままです。
LinkMeを有効化する
SDK v4では、 adjustConfig
インスタンスのsetLinkMeEnabled
メソッドをtrue
値で呼び出し、Adjust LinkMeを有効化することができます。
SDK v5でAdjust LinkMeを有効化するには、 adjustConfig
インスタンスのenableLinkMe
メソッドを呼び出す必要があります。デフォルトの状態はfalse
です。
デバイスIDを1回だけ読み取る
SDK v4では、adjustConfig
のsetReadDeviceInfoOnceEnabled
メソッドをtrue
値で呼び出し、SDKがデバイスIDを1回だけ読み取るように指示することができます。
SDK v5では、adjustConfig
のenableDeviceIdsReadingOnce
メソッドを呼び出し、SDKがデバイスIDを1回だけ読み取るように指示することができます。デフォルトの状態はfalse
です。
オフラインモード
SDK v4では、bool
引数でAdjust.setOfflineMode
を呼び出すことで、SDKでオフラインモードを有効化・無効化することができます。
より明確にするため、SDK v5では、この機能は別々のコマンドに分割されています。
- SDKをオフラインモードに設定するには、
Adjust.switchToOfflineMode
を呼び出します。 - SDKをオンラインモードに戻すには、
Adjust.switchBackToOnlineMode
を呼び出します。
セッションコールバックパラメーター
SDK v4では、Adjust.addSessionCallbackParameter
メソッドにキーと値のペアをパスすることでセッションパラメーターを追加し、Adjust.removeSessionCallbackParameter
メソッドを使用して個々のパラメーターを削除することができます。
SDK v5では、セッションパラメーターはグローバルパラメーターに改名されています。
セッションパートナーパラメーター
SDK v4では、Adjust.addSessionPartnerParameter
メソッドにキーと値のペアをパスすることでセッション パートナー パラメーターを追加し、Adjust.removeSessionPartnerParameter
メソッドを使用して個々のパラメーターを削除することができます。
SDK v5では、セッション パートナー パラメーターはグローバル パートナー パラメーターに改名されました。
重複排除
SDK v4では、イベント重複排除はイベントtransaction ID
と組み合わされ、最大10個のユニークIDに制限されています。
SDK v5では、この機能はtransaction ID
から分離されています。イベント重複排除のため、 deduplicationId
と呼ばれる新しいIDフィールドが追加されました。
重複したイベントを識別するために、ユーザーはリストに追加できる重複IDの数をカスタム制限することができます。デフォルトでは、制限は10に設定されています。
セッションのsuccessコールバック
SDK v4では、setSessionTrackingSucceededCallbackListener
を呼び出すことで、SDKにより正常に記録されたセッションを登録することができます。
SDK v5では、この名前はsetSessionTrackingSucceededCallback
に変更されました。
セッションのfailureコールバック
SDK v4では、setSessionTrackingFailedCallbackListener
を呼び出すことで、SDKが記録に失敗したセッションを登録することができます。
SDK v5では、この名前はsetSessionTrackingFailedCallback
に変更されました。
イベントのsuccessコールバック
SDK v4では、setEventTrackingSucceededCallbackListener
を呼び出すことで、SDKにより正常に記録されたイベントを登録することができます。
SDK v5では、この名前はsetEventTrackingSucceededCallback
に変更されました。
イベントのfailureコールバック
SDK v4では、setEventTrackingFailedCallbackListener
を呼び出すことで、SDKにより正常に記録されたイベントを登録することができます。
SDK v5では、この名前はsetEventTrackingFailedCallback
に変更されました。
App Storeのサブスクリプション
SDK v4では、 AdjustAppStoreSubscription
オブジェクトを設定することで新しいサブスクリプションを設定できます。このオブジェクトは、 price
、 currency
、 transactionId
、 receipt
の4つの引数で初期化されます。
SDK v5では、購入認証に receipt
引数が不要になったため、引数をパスする必要はありません。
ディープリンクを使用したリアトリビューション
SDK v4では、Adjust.appWillOpenUrl
メソッドにディープリンク情報をパスすることができます。
SDK v5では、Adjust.processDeeplink
に改名されています。ディープリンクを作成するための新しいAdjustDeeplink
クラスが追加されました。ディープリンクを処理するには、ディープリンクURLでAdjustDeeplink
オブジェクトをインスタンス化し、 Adjust.processDeeplink
メソッドにパスしてください。
ディファードディープリンクをローンチする
SDK v4では、adjustConfig
インスタンスのsetShouldlaunchDeeplink
メソッドをtrue
値で呼び出すことで、SDKがディープリンクを開けるようにできます。また、false
値で呼び出すことで、ディープリンクを開かないようにすることができます。
SDK v5では、ディープリンクはデフォルトで開かれます。SDKがディープリンクを開けるようにするには、adjustConfig
インスタンスでisDeferredDeeplinkOpeningEnabled
メソッドを呼び出す必要があります。
ディープリンクの解決
SDK v4では、 url
をprocessDeeplink
メソッドにパスすることで、短縮されたディープリンクを解決できます。
SDK v5では、ディープリンクurl
で初期化されたAdjustDeeplink
オブジェクトを送信する必要があります。これが、短縮されていない元のディープリンクを返します。
ディープリンクコールバックリスナー
SDK v4では、AdjustConfig
インスタンスでsetDeferredDeeplinkCallbackListener
メソッドを呼び出すことで、ディープリンクを受信したときに発動するリスナー関数を設定できます。
SDK v5では、このメソッドの名前はsetDeferredDeeplinkCallback
に変更されました。全ての引数は同じままです。
児童オンラインプライバシー保護法(COPPA)コンプライアンス
SDK v4では、 true
値でadjustConfig
インスタンスのcoppaCompliantEnabled
メソッドをコールして、COPPAへの準拠を有効化できます。
SDK v5でCOPPAコンプライアンスを有効化するには、 adjustConfig
インスタンスのisCoppaComplianceEnabled
メソッドを呼び出す必要があります。デフォルトの状態はfalse
です。
Playストアの子供向けアプリ
SDK v4では、true
値でadjustConfig
インスタンスのsetPlayStoreKidsAppEnabled
メソッドを呼び出すことで、アプリをPlayストアの子供向けアプリとしてマークできます。これはSDKの初期化中に読み込まれるため、SDKを初期化したら値を更新することはできません。
SDK v5でコンプライアンスを有効化するには、 adjustConfig
インスタンスのenablePlayStoreKidsCompliance
メソッドを呼び出す必要があります。デフォルトの状態はfalse
です。
データレジデンシーとURL戦略を設定する
SDK v4では、URL戦略とデータレジデンシーのドメインはadjustConfig
クラスの定数として定義されています。
SDK v5では、選択したドメインまたはドメインを配列としてパスする必要があります。以下も設定してください。
useSubdomains
(bool
):ドメインをAdjustドメインとして扱うかどうか。true
の場合、SDKはAdjust固有のサブドメインをドメインにプレフィックスとします。false
の場合、SDKはプレフィックスを追加せずに、指定されたドメインをそのまま使用します。isDataResidency
(bool
):ドメインをデータレジデンシーに使用するかどうか。
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では、 source
とpayload
を引数としてパスし、 trackAdRevenue
メソッドを呼び出すことで広告収益を記録できます。
SDK v4の更新されたメソッドを使用すると、 source
で新しいAdjustAdRevenue
オブジェクトを作成し、このオブジェクトをtrackAdRevenueNew
メソッドにパスすることで広告収益を記録できます。
SDK v5では、 source
で新しいAdjustAdRevenue
オブジェクトを作成し、このオブジェクトをtrackAdRevenue
メソッドにパスすることで広告収益を記録する必要があります。
特定のソースの広告収益を送信する
SDK v4では、広告収益ソースはadjustConfig
クラスの定数として定義されています。SDK v5では、広告収益ソースは文字列としてパスされる必要があります。
v4 | v5 |
---|---|
adjustConfig.AdRevenueAppLovinMAX | "applovin_max_sdk" |
adjustConfig.AdRevenueSourceAdMob | "admob_sdk" |
adjustConfig.AdRevenueSourceIronSource | "ironsource_sdk" |
adjustConfig.AdRevenueSourceAdMost | "admost_sdk" |
adjustConfig.AdRevenueSourceUnity | "unity_sdk" |
adjustConfig.AdRevenueSourceHeliumChartboost | "helium_chartboost_sdk" |
adjustConfig.AdRevenueSourceADX | "adx_sdk" |
adjustConfig.AdRevenueSourcePublisher | "publisher_sdk" |
adjustConfig.AdRevenueSourceTradplus | "tradplus_sdk" |
adjustConfig.AdRevenueSourceTopOn | "topon_sdk" |
adjustConfig.AdRevenueSourceMopub | サポート終了 |
SKAdNetworkの通信を無効化する
SDK v4では、adjustConfig.deactivateSKAdNetworkHandling
メソッドを呼び出すことで、SDKがSKAdNetworkと通信しないようにすることができます。
SDK v5では、SKAdNetworkとの通信を無効にするには、adjustConfig
インスタンスのdisableSkanAttribution
メソッドを呼び出す必要があります。デフォルトの状態はtrue
です。
Conversion valueのアップデートを受信する
SDK v4では、 adjustConfig
でsetSkad4ConversionValueUpdatedCallbackListener
メソッドを呼び出してconversion valueの更新を受信できます。SKAN4より前は、 setConversionValueUpdatedCallbackListener
メソッドを使用できました。
SDK v5では、 adjustConfig
オブジェクトのsetSkanUpdatedCallback
メソッドにコールバック関数を割り当てる必要があります。
Conversion valueを更新する
SDK v4では、以下のいずれかのメソッドを使用して、更新されたconversion valueをAdjustに送信できます:
SDK v5でconversion valueを更新するには、以下の引数でupdateSkanConversionValue
メソッドを使用します:
conversionValue
(int
):更新されたconversion valuecoarseValue
(string
):更新された粗いconversion valuelockWindow
(bool
):コンバージョン期間が終了する前にポストバックを送信するかどうか
App Tracking Transparency認証ラッパー
SDK v4では、Adjust.requestTrackingAuthorizationWithCompletionHandler
メソッドを使用して、ユーザーのATT認証ステータスの変更を処理することができます。
より明確にするため、SDK v5ではAdjust.requestAppTrackingAuthorization
に改名されました。
削除された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では、 adjustConfig
インスタンスのsetDelayStart
メソッドを遅延するように呼び出すことで、SDKの起動を遅らせることができます。最大 10秒 の遅延を設定できます。
このメソッドはSDK v5では廃止されています。この遅延を中断させるAdjust.sendFirstPackages
メソッドも削除されました。
新しいATTステータスを確認する
SDK v4はAdjust.checkForNewAttStatus
メソッドをサポートしています。このメソッドを呼び出すと、SDKは遅延を解除し、機能を継続します。
このメソッドはSDK v5では廃止されています。
Android最終アトリビューション
SDK v4では、adjustConfig
インスタンスのsetFinalAndroidAttributionEnabled
メソッドをtrue
値で呼び出し、最終的なAndroidでのアトリビューションを送信することができます。
この設定はSDK v5では削除されました。現在では、Androidプラットフォームでは最終的なアトリビューションのみがアトリビューションコールバックを通じて提供されるようになっています。
リファラーを設定する
SDK v4では、SDKの開始時にカスタムクリックIDでSDKクリックのトリガーとなるsetReferrer
メソッドを呼び出すことができます。
このメソッドはSDK v5では廃止されています。Googleは、Google Play 開発者サービスのリファラー情報を提供する INSTALL_REFERRER
インテントメソッドを廃止しました。現在このメソッドを使用している場合は、Google Play Referrer APIに移行してください。
ユニバーサルリンクをコンバートする
SDK v4では、convertUniversalLink
メソッドを呼び出すことができます。
このメソッドはSDK v5では廃止されています。
AdjustEventの変更
SDK v4では、サブスクリプションと購入のためにreceipt
をadjustEvent
のadjustEvent.setReceipt
メソッドに送信できます。
購入認証に必要がなくなったため、このパラメーターはSDK v5で削除されました。
購入認証
SDK v4では、receipt
プロパティを持つAdjustAppStorePurchase
オブジェクトをインスタンス化する必要があります。このプロパティは購入認証に使用されます。
このプロパティはSDK v5では廃止されています。購入認証にAdjustAppStorePurchase
クラスを使用する場合は、この引数をコンストラクションコールから削除する必要があります。
サードパーティとの共有をグローバルに無効化する
SDK v4では、Adjust.disableThirdPartySharing
メソッドを呼び出すことで、サードパーティとの情報共有をグローバルに無効化することができます。
この機能はSDK v5では削除されました。SDK v5では、Adjust.trackThirdPartySharing
メソッドを使用してサードパーティとのデータ共有を有効化または無効化できます。