Adjust SDKの動作を設定するには、このドキュメントに記載されたメソッドを使用してください。
Configオブジェクトをインスタンス化する
public AdjustConfig(Context context, String appToken, String environment, boolean allowSuppressLogLevel) { init(context, appToken, environment, allowSuppressLogLevel);}
Adjust SDKを設定するには、AdjustConfig
オブジェクトをインスタンス化する必要があります。このオブジェクトには、Adjust SDKにパスする必要のある 読み取り専用 の設定オプションが含まれています。
Configオブジェクトをインスタンス化するには、新しいAdjustConfig
インスタンスを作成して以下のパラメーターをパスしてください:
context
(Context
):アプリが実行されているAndroidコンテキスト。現在のアプリのコンテキストを取得するにはthis
をパスします。appToken
(String
):お客様のAdjustアプリトークン。environment
(String
):SDKを実行したい環境。テスト用のサンドボックスモードでSDKを実行するにはAdjustConfig.ENVIRONMENT_SANDBOX
をパスします。リリース用の本番モードでSDKを実行するにはAdjustConfig.ENVIRONMENT_PRODUCTION
をパスします。allowSuppressLogLevel
(Boolean
):全てのログを無効化するかどうか。ログを無効化するにはtrue
に、ログを有効化するにはfalse
に設定します。
読み取り専用の設定
読み取り専用 の設定オプションは、SDKの初期化 前に AdjustConfig
インスタンスで設定されます。これらのオプションは、SDKの実行中は変更できません。Adjust.initSdk()
を実行する前に、使用したいオプションを設定する必要があります。
ログレベルを設定する
public void setLogLevel(LogLevel logLevel)
Adjust SDKは、さまざまな量の情報を返すために、設定可能なログレベルを提供しています。以下のログレベルが利用可能です。
logLevel | 説明 |
---|---|
LogLevel.VERBOSE | ログを全て有効化する |
LogLevel.DEBUG | デバッグのログを有効化する |
LogLevel.INFO | 情報レベルのログのみを表示する(デフォルトオプション) |
LogLevel.WARN | 情報警告を無効化する |
LogLevel.ERROR | 警告レベル以下のログを無効化する |
LogLevel.ASSERT | エラーレベル以下のログを無効化する |
LogLevel.SUPPRESS | 全てのログを無効化する |
AdjustConfig
インスタンスのsetLogLevel
メソッドを以下のパラメーターで呼び出すことで、ログレベルを設定できます:
logLevel
(LogLevel
):使用したいログレベル
外部デバイスIDを設定する
public void setExternalDeviceId(String externalDeviceId)
外部デバイスIDは、デバイスまたはユーザーに割り当てることができるカスタム値です。セッションやプラットフォームを横断してユーザーを認識することができます。また、ユーザーが新規インストールとして2度カウントされないように、ユーザーごとにインストールの重複を排除することも可能です。外部デバイスIDの使用を開始する際は、Adjustの担当者にお問い合わせください。
外部デバイスIDをデバイスのカスタム識別子として使用できます。これは、他のシステム上で継続性を保ちたい場合に役立ちます。以下のパラメーターを使用して、setExternalDeviceId
メソッドを呼び出すプロパティを設定できます:
externalDeviceId
(String
):外部デバイスID。この値は 大文字と小文字を区別します 。外部デバイスIDをインポートしている場合は、パス値がインポートした値と一致することを確認してください。
外部デバイスIDをビジネスアナリティクスに使用する場合は、IDをセッションコールバックパラメーターとしてパスすることができます。
既存の外部デバイスIDをAdjustにインポートすることが可能です。これにより、Adjustサーバーが今後のデータを既存のデバイス記録と一致させることができます。この設定をご希望の場合は、Adjustの担当者にお問い合わせください。
デフォルトのリンクトークンを設定する
public void setDefaultTracker(String defaultTracker)
アプリがデバイスにプリインストールされている場合、デフォルトのリンクトークンを設定できます。ユーザーがプリインストールされたアプリを初めて起動すると、インストールはデフォルトのリンクトークンにアトリビュートされます。デフォルトのリンクトークンを設定するには、次の引数を使用してsetDefaultTracker
メソッドを呼び出します:
defaultTracker
(String
):プリインストールを記録したいAdjustリンクトークン。
コストデータの送信を有効化する
public void enableCostDataInAttribution()
デフォルトでは、Adjust SDKはユーザーのアトリビューションの一環としてコストデータを送信しません。コストデータの送信を有効化することで、このデータを送信するようにSDKを設定できます。コストデータ送信を有効化するには、enableCostDataInAttribution
メソッドを呼び出します。
コストデータには、ユーザーのアトリビューション情報でアクセスできます。
バックグランドでの計測機能を有効化する
public void enableSendingInBackground()
デフォルトでは、アプリがバックグラウンドで動作している間、Adjust SDKはリクエストの送信を一時停止します。バックグランドでの計測機能を有効化することで、SDKがバックグランドでリクエストを送信するよう設定することが可能です。バックグラウンドでの計測機能を有効化するには、AdjustConfig.enableSendingInBackground
メソッドを呼び出します。
ダイナミックな設定
ダイナミック な設定オプションは、SDKのライフサイクル中に、ユーザーによるイベントやアクションに応じて変更されることがあります。
オフラインモードを有効化する
public static void switchToOfflineMode()
Adjust SDKは、イベントとセッションのデータをAdjustのサーバーにリアルタイムで送信します。SDKをオフラインモードにすると、情報の送信を一時停止することができます。オフラインモードでは、SDKは全てのデータをデバイスのローカルファイルに保存します。オフラインモードを無効にすると、SDKはこの情報をAdjustのサーバーに送信します。
Adjust.switchToOfflineMode
メソッドを呼び出すことで、いつでもオフランモードに切り替えられます:
オフラインモードを無効化する
public static void switchBackToOnlineMode()
Adjust.switchBackToOnlineMode
メソッドを呼び出して、SDKを再度有効化することができます。これにより、SDKは情報の送信を再開します。
Pushトークンを設定する
public static void setPushToken(final String token, final Context context)
Pushトークンは、Audiences機能やクライアントコールバックに使用されます。また、アンインストール・再インストール計測にも必要です。
Configオブジェクトは、pushToken
を保管できる文字列pushTokenを含みます。このプロパティは、setPushToken
メソッドと以下の引数を呼び出すことで、いつでも更新することが可能です:
token
(String
):Push トークンcontext
(Context
):アプリが実行されているAndroidコンテキスト。現在のアプリのコンテキストを取得するにはgetApplicationContext()
をパスします。
Adjust SDKを無効化する
public static void disable()
Adjust SDKは、デフォルトでアプリが開いている時に実行されます。Adjust.disable
メソッドを呼び出すことで、Adjust SDKを無効にしてAdjustへの情報の送信を一時停止することができます。Adjust SDKを無効にすると、Adjustのサーバーにデータが送信されなくなります。
SDKを有効化する
public static void enable()
SDKを無効にして再度有効にしたい場合は、Adjust.enable
メソッドを呼び出してください。SDKが有効になると、Adjustのサーバーに情報が送信されます。
SDK有効化ステータスを確認する
public static void isEnabled(final Context context, final OnIsEnabledListener isEnabledListener)
Adjust SDKが現在有効化されているかどうかを確認したい場合は、Adjust.isEnabled
メソッドにコールバック関数をパスすることで、この情報を非同期的に返すことができます。