設定

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をパスします。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
Adjust.initSdk(adjustConfig);

読み取り専用の設定

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

ログレベルを設定する

public setLogLevel(level: LogLevel): void

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

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

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

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);

adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);

Adjust.initSdk(adjustConfig);

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

public setExternalDeviceId(externalDeviceId: string): void

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

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

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

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);

adjustConfig.setExternalDeviceId("{Your-External-Device-Id}");

Adjust.initSdk(adjustConfig);

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

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

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

public setDefaultTracker(defaultTracker: string): void

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

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

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);

adjustConfig.setDefaultTracker("{TrackerToken}");

Adjust.initSdk(adjustConfig);

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

public enableCostDataInAttribution(): void

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

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

const adjustConfig = new AdjustConfig(
   "{Your App Token}",
   AdjustConfig.EnvironmentSandbox,
);
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
adjustConfig.enableCostDataInAttribution();

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

public enableSendingInBackground(): void

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

const adjustConfig = new AdjustConfig(
   "{Your App Token}",
   AdjustConfig.EnvironmentSandbox,
);
adjustConfig.enableSendingInBackground();
Adjust.initSdk(adjustConfig);

動的設定

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

オフラインモードを有効化する

switchToOfflineMode: () => void

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

オフラインモードを有効化するには、 Adjust.switchToOfflineModeメソッドを呼び出します。

Adjust.switchToOfflineMode();

オフラインモードを無効化する

switchBackToOnlineMode: () => void

Adjust.switchBackToOnlineModeメソッドを呼び出して、SDKを再度有効化することができます。これにより、SDKは情報の送信を再開します。

Adjust.switchBackToOnlineMode();

Pushトークンを設定する

setPushToken: (token: string) => void

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

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

• token （string）：Push トークン

Adjust.setPushToken("YourPushNotificationToken");

SDKを無効化する

disable: () => void

Adjust SDKは、デフォルトでアプリが開いている時に実行されます。Adjust.disableメソッドを呼び出すと、Adjust SDKを無効にしてAdjustへの情報送信を停止できます。Adjust SDKを無効にするとデータはAdjustに送信されず、SDKは情報を記録しません。これは、SDKが無効化されているときに呼び出されたAdjustメソッドは何も記録しないことを意味します。

Adjust.disable();

SDKを有効化する

enable: () => void

無効にしたSDKを再度有効にしたい場合は、Adjust.enableメソッドを呼び出してください。SDKが有効になると、Adjustのサーバーに情報が送信されます。

Adjust.enable();

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

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

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

Adjust.isEnabled((isEnabled) => {
   if (isEnabled) {
      console.log("SDK is enabled");
   } else {
      console.log("SDK is disabled");
   }
});