設定

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

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

constructor(appToken: string, environment: AdjustEnvironment)

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

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

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

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
Adjust.initSdk(adjustConfig);

読み取り専用の設定

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

ログレベルを設定する

setLogLevel(logLevel: AdjustLogLevel): void

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

Log level	説明
`AdjustLogLevel.Verbose`	ログを全て有効化する
`AdjustLogLevel.Debug`	デバッグのログを有効化する
`AdjustLogLevel.Info`	情報レベルのログのみを表示する（デフォルトオプション）
`AdjustLogLevel.Warn`	情報ログを無効化する
`AdjustLogLevel.Error`	警告レベル以下のログを無効化する
`AdjustLogLevel.Assert`	エラーレベル以下のログを無効化する
`AdjustLogLevel.Suppress`	ログを全て無効化する

setLogLevelメソッドを以下の引数で呼び出すことで、ログレベルを設定できます。

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

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
6
Adjust.initSdk(adjustConfig);

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

setExternalDeviceId(externalDeviceId: string): void

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

外部デバイスIDをデバイスのカスタム識別子として使用できます。これは、他のシステム上で継続性を保ちたい場合に役立ちます。次の引数でsetExternalDeviceIdメソッドを呼び出し、外部デバイスIDを割り当てます。

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

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setExternalDeviceId("{Your-External-Device-Id}");
6
Adjust.initSdk(adjustConfig);

外部デバイスIDをビジネスアナリティクスに使用する場合は、そのIDをグローバルコールバックパラメーターとして指定できます。

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

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

setDefaultTracker(defaultTracker: string): void

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

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

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setDefaultTracker("{LinkToken}");
6
Adjust.initSdk(adjustConfig);

アトリビューションで広告費用データを受信する

enableCostDataInAttribution(): void

デフォルトでは、Adjust SDKはユーザーのアトリビューションの一部として広告費用データを受信しません。AdjustConfigインスタンスのenableCostDataInAttributionメソッドを呼び出すことで、この情報をリクエストするようにSDKを設定できます。

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

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.enableCostDataInAttribution();
6
Adjust.initSdk(adjustConfig);

バックグラウンドでの送信を有効にする

enableSendingInBackground(): void

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

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.enableSendingInBackground();
6
Adjust.initSdk(adjustConfig);

動的設定

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

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

switchToOfflineMode(): void

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

Adjust.switchToOfflineModeメソッドを呼び出すことで、いつでもオフランモードに切り替えられます：

1
Adjust.switchToOfflineMode();

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

switchBackToOnlineMode(): void

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

1
Adjust.switchBackToOnlineMode();

Pushトークンを設定する

setPushToken(pushToken: string): void

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

Configオブジェクトには、Pudhトークンを格納するための文字列pushTokenプロパティが含まれています。このプロパティは、Adjust.setPushTokenメソッドと以下の引数を呼び出すことで、いつでも更新することが可能です：

token （string）：Push トークン

1
Adjust.setPushToken("{PushNotificationsToken}");

SDKを無効化する

disable(): void

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

1
Adjust.disable();

SDKを有効化する

enable(): void

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

1
Adjust.enable();

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

isEnabled(): Promise<boolean>

Adjust SDKが有効であることを確認するには、コールバック関数を含むAdjust.isEnabledメソッドを呼び出します。ステータスがboolean値としてコールバック関数に返され、 SDKが有効（true）か無効（false）かが示されます。

1
Adjust.isEnabled(function (isEnabled) {
2
   if (isEnabled) {
3
      console.log("SDK is enabled");
4
   } else {
5
      console.log("SDK is disabled");
6
   }
7
});