Adjust SDKの動作を設定するには、このドキュメントに記載されたメソッドを使用してください。
Configオブジェクトをインスタンス化する
public AdjustConfig(string appToken, string environment, Action<string> logDelegate = null, LogLevel? logLevel = null)
Adjust SDKを設定するには、AdjustConfig
オブジェクトをインスタンス化する必要があります。このオブジェクトには、Adjust SDKにパスする必要のある 読み取り専用 の設定オプションが含まれています。
Configオブジェクトをインスタンス化するには、新しいAdjustConfig
インスタンスを作成して以下のパラメーターをパスしてください:
appToken
(string
):お客様のAdjustアプリトークン。environment
(string
):SDKを実行したい環境。テスト用のサンドボックスモードでSDKを実行するにはAdjustConfig.EnvironmentSandbox
をパスします。リリース用の本番モードでSDKを実行するにはAdjustConfig.EnvironmentProduction
をパスします。logDelegate
(Action<string>
):ログが委譲される関数。setLogDelegate
メソッドを使用しても設定できます。logLevel
(LogLevel
):記録したいログのレベル。以下のログレベルがサポートされています。
logLevel | 説明 |
---|---|
LogLevel.Verbose | ログを全て有効化する |
LogLevel.Debug | デバッグのログを有効化する |
LogLevel.Info | 情報レベルのログのみを表示する(デフォルトオプション) |
LogLevel.Warn | 情報警告を無効化する |
LogLevel.Error | 警告レベル以下のログを無効化する |
LogLevel.Assert | エラーレベル以下のログを無効化する |
LogLevel.Suppress | ログを全て無効化する |
string appToken = "hmqwpvspxnuo";string environment = AdjustConfig.EnvironmentSandbox;var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);Adjust.ApplicationLaunching(adjustConfig);
読み取り専用の設定
読み取り専用 の設定オプションは、SDKの初期化 前に AdjustConfig
インスタンスで設定されます。これらのオプションは、SDKの実行中は変更できません。Adjust.ApplicationLaunching()
を実行する前に、使用したいオプションを設定する必要があります。
ログデリゲートを設定する
public void setLogDelegate(Action<string> logDelegate);
ログデリゲートは、Adjust SDKがログを記録するために呼び出す関数です。ログデリゲートを設定するには、ログ関数をsetLogDelegate
にパスします。Adjust SDKはログメッセージを出力するたびにこの関数を呼び出します。
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);//...adjustConfig.setLogDelegate(msg => Debug.Log(msg));//...Adjust.ApplicationLaunching(config);
外部デバイスIDを設定する
public void setExternalDeviceId(string externalDeviceId);
外部デバイスIDは、デバイスまたはユーザーに割り当てることができるカスタム値です。セッションやプラットフォームを横断してユーザーを認識することができます。また、ユーザーが新規インストールとして2度カウントされないように、ユーザーごとにインストールの重複を排除することも可能です。外部デバイスIDの使用を開始する際は、Adjustの担当者にお問い合わせください。
外部デバイスIDをデバイスのカスタム識別子として使用できます。これは、他のシステム上で継続性を保ちたい場合に役立ちます。以下のパラメーターを使用して、setExternalDeviceId
メソッドを呼び出すプロパティを設定できます:
externalDeviceId
(string
):外部デバイスID。この値は 大文字と小文字を区別します 。外部デバイスIDをインポートしている場合は、パス値がインポートした値と一致することを確認してください。
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);//...adjustConfig.setExternalDeviceId("{Your-External-Device-Id}");//...Adjust.ApplicationLaunching(adjustConfig);
外部デバイスIDをビジネスアナリティクスに使用する場合は、IDをセッションコールバックパラメーターとしてパスすることができます。
既存の外部デバイスIDをAdjustにインポートすることが可能です。これにより、Adjustサーバーが今後のデータを既存のデバイス記録と一致させることができます。この設定をご希望の場合は、Adjustの担当者にお問い合わせください。
デフォルトのリンクトークンを設定する
public string DefaultTracker { get; set; }
アプリがデバイスにプリインストールされている場合、デフォルトのリンクトークンを設定できます。ユーザーがプリインストールされたアプリを初めて起動すると、インストールはデフォルトのリンクトークンにアトリビュートされます。デフォルトのリンクトークンを設定するには、AdjustリンクトークンをconfigインスタンスのDefaultTracker
プロパティに割り当てます。
var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);adjustConfig.DefaultTracker = "{TrackerToken}";Adjust.ApplicationLaunching(adjustConfig);
バックグランドでの計測機能を有効化する
public bool SendInBackground { get; set; }
デフォルトでは、アプリがバックグラウンドで動作している間、Adjust SDKはリクエストの送信を一時停止します。バックグランドでの計測機能を有効化することで、SDKがバックグランドでリクエストを送信するよう設定することが可能です。バックグラウンドでの計測機能を有効化するには、configインスタンスのSendInBackground
プロパティにbool
値を割り当てます。
var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);//...adjustConfig.SendInBackground = true;//...Adjust.ApplicationLaunching(adjustConfig);
イベントのバッファリングを有効化する
public bool EventBufferingEnabled { get; set; }
Adjust SDKは、ユーザーがアプリ内でイベントをトリガーすると、すぐにイベント情報を送信します。イベントバッファリングを有効にすることで、イベント情報をスケジュールに沿って送信することができます。イベントバッファリングは、デバイス上のローカルバッファにイベントを保存し、1分間に1回、全てのリクエストを送信します。
Configオブジェクトにはbool
EventBufferingEnabled
プロパティが含まれており、それが動作を制御します。イベントのバッファリングを有効化するには、configインスタンスのEventBufferingEnabled
プロパティにbool
値を割り当てます。
EventBufferingEnabled
(bool
):イベントのバッファリングを有効化するにはtrue
、無効化するにはfalse
に設定します。
var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);//...adjustConfig.EventBufferingEnabled = true;//...Adjust.ApplicationLaunching(adjustConfig);
SDKの起動開始を遅延させる
public TimeSpan? DelayStart { get; set; }
デフォルトでは、Adjust SDKはアプリの起動直後に動作を開始します。起動時に取得できないデータをセッションパラメーターで送信したい場合は、SDKの動作開始を遅らせることができます。これは、ユニークな識別子などの情報を送信する場合に便利です。
動作開始の遅延を設定するには、configインスタンスのDelayStart
プロパティにTimeSpan
値を割り当てます。
delayStart
(TimeSpan
):SDKの動作開始を遅らせる時間(秒)。SDKの動作開始を遅らせることができるのは最長 10秒間 です。
adjustConfig.DelayStart = TimeSpan.FromSeconds(5.5);
動的設定
動的 設定オプションは、SDKのライフサイクル中に、ユーザーによるイベントやアクションに応じて変更されることがあります。
オフラインモードに切り替える
public void SetOfflineMode(bool offline);
Adjust SDKは、イベントとセッションのデータをAdjustのサーバーにリアルタイムで送信します。SDKをオフラインモードにすると、情報の送信を一時停止することができます。オフラインモードでは、SDKは全てのデータをデバイスのローカルファイルに保存します。オフラインモードを無効にすると、SDKはこの情報をAdjustのサーバーに送信します。
以下の引数を使用してSetOfflineMode
メソッドを呼び出すことで、いつでもオフランモードに切り替えられます:
offline
(bool
):オフラインモードを有効化するにはtrue
に、オフラインモードを無効化するにはfalse
に設定します。
Adjust.SetOfflineMode(true);
Pushトークンを設定する
public static void SetPushToken(string pushToken);
Pushトークンは、Audiences機能やクライアントコールバックに使用されます。また、アンインストール・再インストール計測にも必要です。
Configオブジェクトは、Push トークンを保管できるstring
pushToken
プロパティを含みます。このプロパティは、setPushToken
メソッドと以下の引数を呼び出すことで、いつでも更新することが可能です:
pushToken
(string
):Push トークン
Adjust.SetPushToken("{YourDeviceToken}");
SDKを無効化または有効化する
public static void SetEnabled(bool enabled);
Adjust SDKは、デフォルトでアプリが開いている時に実行されます。Adjust SDKを無効化または再有効化することで、計測を一時停止したり再起動したりすることができます。Adjust SDKを無効にすると、Adjustサーバーにデータが送信されなくなります。
以下の引数を使用してSetEnabled
メソッドを呼び出すことで、SDKをいつでも有効化または無効化できます:
enabled
(bool
):SDKを有効化するにはtrue
に、SDKを無効化するにはfalse
に設定します。
Adjust.SetEnabled(false);
有効化ステータスを確認する
public static bool IsEnabled();
Adjust SDKが有効であるかどうかを確認するには、isEnabled
メソッドを呼び出します。このメソッドは、SDKが 有効 (true
)か 無効 (false
)かを示すbool
値を返します。
Adjust.IsEnabled();