adjust-icon

コールバックの設定

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

セッションコールバック

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

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

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

Successコールバック

メソッドシグネチャー
setSessionTrackingSucceededCallbackListener(
   sessionTrackingSucceededCallback: (session: AdjustSessionSuccess) => void
)

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

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setSessionTrackingSucceededCallbackListener(
   function (sessionSuccess) {
      // Printing all session success properties.
      console.log("Session tracking succeeded!");
      console.log(sessionSuccess.message);
      console.log(sessionSuccess.timestamp);
      console.log(sessionSuccess.adid);
      console.log(sessionSuccess.jsonResponse);
   },
);


Adjust.create(adjustConfig);

例

この例では、SDKがAdjustにセッションデータを送信した時刻のタイムスタンプを表示するsessionTrackingSucceededCallbackを登録する方法を示しています。

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setSessionTrackingSucceededCallbackListener(
   function (sessionSuccess) {
      console.log(`Session recorded at ${sessionSuccess.timestamp}`);
   },
);


Adjust.create(adjustConfig);

Failureコールバック

メソッドシグネチャー
setSessionTrackingFailedCallbackListener(sessionTrackingFailedCallback: (session: AdjustSessionFailure) => void)

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

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setSessionTrackingFailedCallbackListener(
   function (sessionFailure) {
      // Printing all session failure properties.
      console.log("Session tracking failed!");
      console.log(sessionFailure.message);
      console.log(sessionFailure.timestamp);
      console.log(sessionFailure.adid);
      console.log(sessionFailure.willRetry);
      console.log(sessionFailure.jsonResponse);
   },
);


Adjust.create(adjustConfig);

例

この例では、SDKがセッションデータの送信に失敗した理由を表示するsessionTrackingFailedCallbackを登録する方法を示しています。

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setSessionTrackingFailedCallbackListener(
   function (sessionFailure) {
      console.log(
         `SDK failed to record session due to ${sessionFailure.message}`,
      );
   },
);


Adjust.create(adjustConfig);

イベントコールバック

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

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

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

Successコールバック

メソッドシグネチャー
setEventTrackingSucceededCallbackListener(eventTrackingSucceededCallback: (event: AdjustEventSuccess) => void)

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

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
   // Printing all event success properties.
   console.log("Event tracking 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);

例

この例では、SDKがAdjustにセッションデータを送信した時刻のタイムスタンプを表示するeventTrackingSucceededCallbackを登録する方法を示しています。

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
   console.log(`Event recorded at ${eventSuccess.timestamp}`);
});


Adjust.create(adjustConfig);

Failureコールバック

メソッドシグネチャー
setEventTrackingFailedCallbackListener(eventTrackingFailedCallback: (event: AdjustEventFailure) => void)

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

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
   // Printing all event failure properties.
   console.log("Event tracking 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);

例

この例では、SDKがセッションデータの送信に失敗した理由を表示するeventFailureCallbackを登録する方法を示しています。

var adjustConfig = new AdjustConfig(appToken, environment);


adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
   console.log(`SDK failed to record event due to ${eventFailure.message}`);
});


Adjust.create(adjustConfig);