設定

Adjust SDKの動作を設定するには、このドキュメントに記載されたメソッドを使用してください。

Configオブジェクトをインスタンス化する

constructor(appToken: string, environment: Environment)

Adjust SDKを設定するには、AdjustConfigオブジェクトをインスタンス化する必要があります。このオブジェクトには、Adjust SDKにパスする必要のある 読み取り専用 の設定オプションが含まれています。

Configオブジェクトをインスタンス化するには、新しいAdjustConfigインスタンスを作成して以下のパラメーターをパスしてください：

appToken （string）：お客様のAdjustアプリトークン。
environment （Environment）：SDKを実行したい環境。テスト用のサンドボックスモードでSDKを実行するにはAdjustConfig.EnvironmentSandboxをパスします。リリース用の本番モードでSDKを実行するにはAdjustConfig.EnvironmentProductionをパスします。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
//...
6
Adjust.create(adjustConfig);

読み取り専用の設定

読み取り専用 の設定オプションは、SDKの初期化前に AdjustConfigインスタンスで設定されます。これらのオプションは、SDKの実行中は変更できません。Adjust.start()を実行する前に、使用したいオプションを設定する必要があります。

ログレベルを設定する

public setLogLevel(level: LogLevel): void

Adjust SDKは、さまざまな量の情報を返すために、設定可能なログレベルを提供しています。以下のログレベルが利用可能です。

logLevel	説明
`AdjustConfig.LogLevelVerbose`	ログを全て有効化する
`AdjustConfig.LogLevelDebug`	デバッグのログを有効化する
`AdjustConfig.LogLevelInfo`	情報レベルのログのみを表示する（デフォルトオプション）
`AdjustConfig.LogLevelWarn`	情報ログを無効化する
`AdjustConfig.LogLevelError`	警告レベル以下のログを無効化する
`AdjustConfig.LogLevelAssert`	エラーレベル以下のログを無効化する
`AdjustConfig.LogLevelSuppress`	ログを全て無効化する

AdjustConfigインスタンスのsetLogLevelメソッドを以下のパラメーターで呼び出すことで、ログレベルを設定できます：

logLevel （LogLevel）：使用したいログレベル

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
//...
6
adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7
//...
8
Adjust.create(adjustConfig);

外部デバイスIDを設定する

public setExternalDeviceId(externalDeviceId: string): void

外部デバイスIDは、デバイスまたはユーザーに割り当てることができるカスタム値です。セッションやプラットフォームを横断してユーザーを認識することができます。また、ユーザーが新規インストールとして2度カウントされないように、ユーザーごとにインストールの重複を排除することも可能です。外部デバイスIDの使用を開始する際は、Adjustの担当者にお問い合わせください。

外部デバイスIDをデバイスのカスタム識別子として使用できます。これは、他のシステム上で継続性を保ちたい場合に役立ちます。以下のパラメーターを使用して、setExternalDeviceIdメソッドを呼び出すプロパティを設定できます：

externalDeviceId （string）：外部デバイスID。この値は 大文字と小文字を区別します 。外部デバイスIDをインポートしている場合は、パス値がインポートした値と一致することを確認してください。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
//...
6
adjustConfig.setExternalDeviceId("{Your-External-Device-Id}");
7
//...
8
Adjust.create(adjustConfig);

外部デバイスIDをビジネスアナリティクスに使用する場合は、IDをセッションコールバックパラメーターとしてパスすることができます。

既存の外部デバイスIDをAdjustにインポートすることが可能です。これにより、Adjustサーバーが今後のデータを既存のデバイス記録と一致させることができます。この設定をご希望の場合は、Adjustの担当者にお問い合わせください。

デフォルトのリンクトークンを設定する

public setDefaultTracker(defaultTracker: string): void

アプリがデバイスにプリインストールされている場合、デフォルトのリンクトークンを設定できます。ユーザーがプリインストールされたアプリを初めて起動すると、インストールはデフォルトのリンクトークンにアトリビュートされます。デフォルトのリンクトークンを設定するには、次の引数を使用してsetDefaultTrackerメソッドを呼び出します：

defaultTracker （string）：プリインストールを記録したいAdjustリンクトークン。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
//...
6
adjustConfig.setDefaultTracker("{TrackerToken}");
7
//...
8
Adjust.create(adjustConfig);

コストデータの送信を有効化する

public setNeedsCost(needsCost: boolean): void

デフォルトでは、Adjust SDKはユーザーのアトリビューションの一環としてコストデータを送信しません。コストデータの送信を有効化することで、このデータを送信するようにSDKを設定できます。コストデータの送信を有効化するには、次のパラメーターを使用して、configインスタンスでsetNeedsCostメソッドを呼び出します：

needsCost （boolean）：コストデータの送信を有効化するにはtrue、無効化するにはfalseに設定します。

コストデータには、ユーザーのアトリビューション情報でアクセスできます。

1
const adjustConfig = new AdjustConfig(
2
   "{Your App Token}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
6
adjustConfig.setNeedsCost(true);

バックグランドでの計測機能を有効化する

public setSendInBackground(sendInBackground: boolean): void

デフォルトでは、アプリがバックグラウンドで動作している間、Adjust SDKはリクエストの送信を一時停止します。バックグランドでの計測機能を有効化することで、SDKがバックグランドでリクエストを送信するよう設定することが可能です。バックグランドでの計測機能を有効化するには、次のパラメーターを使用して、configインスタンスでsetSendInBackgroundメソッドを呼び出します：

sendInBackground （boolean）：バックグランドでの送信を有効化するにはtrue、無効化するにはfalseに設定します。

1
const adjustConfig = new AdjustConfig(appToken, environment);
2
//...
3
adjustConfig.setSendInBackground(true);
4
//...
5
Adjust.create(adjustConfig);

イベントのバッファリングを有効化する

public setEventBufferingEnabled(eventBufferingEnabled: boolean): void

Adjust SDKは、ユーザーがアプリ内でイベントをトリガーすると、すぐにイベント情報を送信します。イベントバッファリングを有効にすることで、イベント情報をスケジュールに沿って送信することができます。イベントバッファリングは、デバイス上のローカルバッファにイベントを保存し、1分間に1回、全てのリクエストを送信します。

ConfigオブジェクトにはブーリアンeventBufferingEnabledプロパティが含まれており、それが動作を制御します。このプロパティを設定するには、次のパラメーターを使用して、configオブジェクトのsetEventBufferingEnabledメソッドを呼び出します：

eventBufferingEnabled （boolean）：イベントのバッファリングを有効化するにはtrue、無効化するにはfalseに設定します。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
//...
6
adjustConfig.setEventBufferingEnabled(true);
7
//...
8
Adjust.create(adjustConfig);

SDKの起動を遅らせる

public setDelayStart(delayStart: number): void

デフォルトでは、Adjust SDKはアプリの起動直後に動作を開始します。起動時に取得できないデータをセッションパラメーターで送信したい場合は、SDKの動作開始を遅らせることができます。これは、ユニークな識別子などの情報を送信する場合に便利です。

動作開始の遅延を設定するには、次の引数を使用してsetDelayStartメソッドを呼び出します。

delayStart （number）：SDKの動作開始を遅らせる時間（秒）。SDKの動作開始を遅らせることができるのは最長 10秒間 です。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
//...
6
adjustConfig.setDelayStart(5.5);
7
//...
8
Adjust.create(adjustConfig);

動的設定

動的設定オプションは、SDKのライフサイクル中に、ユーザーによるイベントやアクションに応じて変更されることがあります。

オフラインモードに切り替える

setOfflineMode: (enabled: boolean) => void

Adjust SDKは、イベントとセッションのデータをAdjustのサーバーにリアルタイムで送信します。SDKをオフラインモードにすると、情報の送信を一時停止することができます。オフラインモードでは、SDKは全てのデータをデバイスのローカルファイルに保存します。オフラインモードを無効にすると、SDKはこの情報をAdjustのサーバーに送信します。

以下の引数を使用してsetOfflineModeメソッドを呼び出すことで、いつでもオフランモードに切り替えられます：

enabled （boolean）：オフラインモードを有効化するにはtrueに、オフラインモードを無効化するにはfalseに設定します。

1
Adjust.setOfflineMode(true);

Pushトークンを設定する

setPushToken: (token: string) => void

Pushトークンは、Audiences機能やクライアントコールバックに使用されます。また、アンインストール・再インストール計測にも必要です。

Configオブジェクトは、pushTokenを保管できる文字列pushTokenを含みます。このプロパティは、setPushTokenメソッドと以下の引数を呼び出すことで、いつでも更新することが可能です：

token （string）：Push トークン

1
Adjust.setPushToken("YourPushNotificationToken");

SDKを無効化または有効化する

setEnabled: (enabled: boolean) => void

Adjust SDKは、デフォルトでアプリが開いている時に実行されます。Adjust SDKを無効化または再有効化することで、計測を一時停止したり再起動したりすることができます。Adjust SDKを無効にすると、Adjustサーバーにデータが送信されなくなります。

以下の引数を使用してsetEnabledメソッドを呼び出すことで、SDKをいつでも有効化または無効化できます：

enabled （boolean）：SDKを有効化するにはtrueに、SDKを無効化するにはfalseに設定します。

1
Adjust.setEnabled(false);

有効化ステータスを確認する

isEnabled: (callback: (enabled: boolean) => void) => void

Adjust SDKが有効であるかどうかを確認するには、isEnabledメソッドを呼び出します。このメソッドは、SDKが有効（true）か無効（false）かを示すboolean値を返します。

1
Adjust.isEnabled();