adjust-icon

コールバックの設定

SDKがAdjustに情報を送信する時に関数をトリガーするコールバックを設定します。コールバックは セッション と イベント に対して設定できます。

セッションコールバック

SDKがセッション情報を送信した時に関数をトリガーする、セッションコールバックを設定します。 Success コールバックと failure コールバックが作成できます。 Success コールバックは、SDKが情報をAdjustのサーバーに送信する時にトリガーします。 Failure コールバックは、SDKが情報を送信している間に問題が発生した際にトリガーします。

セッションコールバックは、レスポンス データ オブジェクトにアクセスできます。そのプロパティをコールバック関数内で使用することが可能です。

プロパティデータタイプ説明
MessagestringサーバーからのメッセージまたはSDKのエラーログ
TimestampstringAdjustのサーバーからのタイムスタンプ
AdidstringAdjustから提供されるユニークデバイスID
JsonResponseobject<string, object>サーバーからのレスポンスを含むJSONオブジェクト
WillRetryboolean失敗したパッケージの再送を試みるかどうかを示します。

Successコールバック

メソッドシグネチャー
public setSessionTrackingSucceededCallbackListener(
   callback: (sessionSuccess: AdjustSessionTrackingSuccess) => void
): void

SDKがセッションを記録した時に関数をトリガーする、successコールバックを設定します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setSessionTrackingSucceededCallbackListener(
   function (sessionSuccess) {
      // Printing all session success properties.
      console.log("Session recording succeeded!");
      console.log(sessionSuccess.message);
      console.log(sessionSuccess.timestamp);
      console.log(sessionSuccess.adid);
      console.log(sessionSuccess.jsonResponse);
   },
);
//...
Adjust.create(adjustConfig);

例

この例では、コールバック関数sessionSuccessを作成し、 success コールバックとして登録する方法を示しています。その関数は、SDKがセッションを記録した際にタイムスタンプをログに記録します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setSessionTrackingSucceededCallbackListener(
   function (sessionSuccess) {
      console.log(sessionSuccess.timestamp);
   },
);
//...
Adjust.create(adjustConfig);

Failureコールバック

メソッドシグネチャー
public setSessionTrackingFailedCallbackListener(
   callback: (sessionFailed: AdjustSessionTrackingFailure) => void
): void

SDKがセッションの記録に失敗した時に関数をトリガーする、failureコールバックを設定します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setSessionTrackingFailedCallbackListener(
   function (sessionFailure) {
      // Printing all session failure properties.
      console.log("Session recording failed!");
      console.log(sessionFailure.message);
      console.log(sessionFailure.timestamp);
      console.log(sessionFailure.adid);
      console.log(sessionFailure.willRetry);
      console.log(sessionFailure.jsonResponse);
   },
);
//...
Adjust.create(adjustConfig);

例

この例では、コールバック関数sessionFailureを作成し、 failure コールバックとして登録する方法を示します。その関数は、セッションの失敗メッセージをログに記録します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setSessionTrackingFailedCallbackListener(
   function (sessionFailure) {
      console.log(sessionFailure.message);
   },
);
//...
Adjust.create(adjustConfig);

イベントコールバック

SDKがイベント情報を送信した時に関数をトリガーする、イベントコールバックを設定します。 Success コールバックと failure コールバックが作成できます。 Success コールバックは、SDKが情報をAdjustのサーバーに送信する時にトリガーします。 Failure コールバックは、SDKが情報を送信している間に問題が発生した際にトリガーします。

イベントコールバックは、レスポンス データ オブジェクトにアクセスできます。そのプロパティをコールバック関数内で使用することが可能です。

プロパティデータタイプ説明
MessagestringサーバーからのメッセージまたはSDKのエラーログ
TimestampstringAdjustのサーバーからのタイムスタンプ
AdidstringAdjustから提供されるユニークデバイスID
EventTokenstringイベントトークン
CallbackIdstringイベントオブジェクトに設定されたカスタムコールバックID
JsonResponseobject<string, object>サーバーからのレスポンスを含むJSONオブジェクト
WillRetryboolean失敗したパッケージの再送を試みるかどうかを示します。

Successコールバック

メソッドシグネチャー
public setEventTrackingSucceededCallbackListener(
   callback: (eventSuccess: AdjustEventTrackingSuccess) => void
): void

SDKがイベントを記録した時に関数をトリガーする、successコールバックを設定します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
   // Printing all event success properties.
   console.log("Event recording succeeded!");
   console.log(eventSuccess.message);
   console.log(eventSuccess.timestamp);
   console.log(eventSuccess.eventToken);
   console.log(eventSuccess.callbackId);
   console.log(eventSuccess.adid);
   console.log(eventSuccess.jsonResponse);
});
//...
Adjust.create(adjustConfig);

例

この例では、コールバック関数eventSuccessを作成し、 success コールバックとして登録する方法を示しています。その関数は、SDKがイベントを記録した際にタイムスタンプをログに記録します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
   console.log(eventSuccess.timestamp);
});
//...
Adjust.create(adjustConfig);

Failureコールバック

メソッドシグネチャー
public setEventTrackingFailedCallbackListener(
   callback: (eventFailed: AdjustEventTrackingFailure) => void
): void

SDKがセッションの記録に失敗した時に関数をトリガーする、failureコールバックを設定します。

const adjustConfig = new AdjustConfig(
   "{Your App Token}",
   AdjustConfig.EnvironmentSandbox,
);
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
   // Printing all event failure properties.
   console.log("Event recording failed!");
   console.log(eventFailure.message);
   console.log(eventFailure.timestamp);
   console.log(eventFailure.eventToken);
   console.log(eventFailure.callbackId);
   console.log(eventFailure.adid);
   console.log(eventFailure.willRetry);
   console.log(eventFailure.jsonResponse);
});
//...
Adjust.create(adjustConfig);

例

この例では、コールバック関数eventFailureを作成し、 failure コールバックとして登録する方法を示します。その関数は、イベントの失敗メッセージをログに記録します。

const adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
//...
adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
   console.log(eventFailure.message);
});
//...
Adjust.create(adjustConfig);