設定

Adjust.initSdkメソッドにプロパティを割り当てることで、Adjust SDKの動作を設定することができます。

必要な設定

function initSdk({ logLevel, logOutput, ...options }: InitOptions): void;

Adjust SDKを設定するには、次の引数を使用してAdjust.initSdkメソッドを呼び出す必要があります。

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

1
Adjust.initSdk({
2
   appToken: "YOUR_APP_TOKEN",
3
   environment: "sandbox",
4
});

ログのオプション

export type LogOptionsT = $ReadOnly<
   $Shape<{|
      logLevel: "none" | "error" | "warning" | "info" | "verbose",
      logOutput: string,
   |}>
>;

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

値	説明
`verbose`	ログをフルで有効化する
`info`	情報、警告、エラーログを返す
`warning`	警告とエラーログを返す
`error`	エラーログのみを返す
`none`	全てのログを無効化する

ログレベルを設定するには、initSdkメソッドにlogLevel引数を指定します。値をパスしない場合、SDKのデフォルトはerrorとなります。

1
Adjust.initSdk({
2
   appToken: "YOUR_APP_TOKEN",
3
   environment: "sandbox",
4
   logLevel: "verbose",
5
});

ログアウトプットを設定する

Webアプリでログの出力先を他に設定することで、ログを画面に直接表示することができます。これを設定するには、initSdkメソッドのlogOutput引数にHTMLセレクターを指定します。SDKのログはこのコンテナに出力されます。

1
Adjust.initSdk({
2
   appToken: "YOUR_APP_TOKEN",
3
   environment: "sandbox",
4
   logOutput: "#logDiv",
5
});

初期化オプション

export type InitOptionsT = $ReadOnly<
   $Shape<{|
      appToken: $PropertyType<BaseParamsT, "appToken">,
      environment: $PropertyType<BaseParamsT, "environment">,
      defaultTracker: $PropertyType<BaseParamsT, "defaultTracker">,
      externalDeviceId: $PropertyType<BaseParamsT, "externalDeviceId">,
      customUrl: $PropertyType<CustomConfigT, "customUrl">,
      dataResidency: $PropertyType<CustomConfigT, "dataResidency">,
      urlStrategy: $PropertyType<CustomConfigT, "urlStrategy">,
      eventDeduplicationListLimit: $PropertyType<
         CustomConfigT,
         "eventDeduplicationListLimit"
      >,
      namespace: $PropertyType<CustomConfigT, "namespace">,
      attributionCallback: (string, Object) => mixed,
   |}>
>;

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

externalDeviceId: string;

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

外部デバイスIDをデバイスのカスタム識別子として使用できます。これは、他のシステム上で継続性を保ちたい場合に役立ちます。Adjust.initSdkを呼び出すとき、外部デバイスIDをexternalDeviceId引数としてパスします。

1
Adjust.initSdk({
2
   appToken: "YOUR_APP_TOKEN",
3
   environment: "sandbox",
4
   externalDeviceId: "YOUR_EXTERNAL_DEVICE_ID",
5
});

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

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

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

defaultTracker: string;

アプリがデバイスにプリインストールされている場合、デフォルトのリンクトークンを設定できます。ユーザーがプリインストールされたアプリを初めて起動すると、インストールはデフォルトのリンクトークンにアトリビュートされます。Adjust.initSdkを呼び出すとき、defaultTracker引数でトークンをパスします。

1
Adjust.initSdk({
2
   appToken: "YOUR_APP_TOKEN",
3
   environment: "sandbox",
4
   defaultTracker: "YOUR_LINK_TOKEN",
5
});

ストレージの名前空間を設定する

namespace: string;

Adjust SDKは、デフォルトでデータを保存するストレージの名前空間を作成します。データの宛先を制御する場合は、これをオーバーライドしてカスタム名前空間を指定することができます。

SDKがデフォルトの名前空間に保存していたデータは、カスタム名前空間が設定されるとその名前空間に移動します。

initSdkメソッドでnamespaceプロパティを指定することで、カスタム名前空間を設定することができます。

1
Adjust.initSdk({
2
   appToken: "YOUR_APP_TOKEN",
3
   environment: "sandbox",
4
   namespace: "myCustomNamespace",
5
});

動的設定

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

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

function switchToOfflineMode(): void;

Adjust SDKは、イベントとセッションのデータをAdjustのサーバーにリアルタイムで送信します。SDKをオフラインモードにすると、情報の送信を一時停止することができます。オフラインモードでは、SDKは全てのデータをブラウザのIndexedDBに保存するか、または、IndexedDBがサポートされていない場合は、localStorage に保存します。

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

1
Adjust.switchToOfflineMode();

イベントバッファリング

function switchBackToOnlineMode(): void;

オフラインモードを無効にすると、SDKは保存されている全ての情報をAdjustのサーバーに送信します。これを行うには、switchBackToOnlineModeメソッドを呼び出します。

1
Adjust.switchBackToOnlineMode();

SDKを無効化する

1
function stop(): void;

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

stopメソッドを呼び出すことで、Adjust SDKをいつでも無効化できます。

1
Adjust.stop();

SDKを再有効化する

1
function restart(): void;

restartメソッドを呼び出すことで、Adjust SDKをいつでも再起動できます。

1
Adjust.restart();