イベント情報の送信

Adjust SDKはAdjustEventオブジェクトを提供しており、アプリのイベント情報を構造化してAdjustのサーバーに送信することができます。

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

constructor(eventToken: string)

Adjust SDKでイベント情報を送信するには、AdjustEventオブジェクトをインスタンス化する必要があります。このオブジェクトには、アプリでイベントが発生した時にAdjustに送信される変数が含まれます。

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

eventToken （string）：お客様のAdjustイベントトークン。

1
var adjustEvent = new AdjustEvent("abc123");
2
Adjust.trackEvent(adjustEvent);

イベントを送信する

trackEvent(event: AdjustEvent): void

Adjustイベントトークンを関連付けることで、アプリ内のユーザー行動を記録できます。イベントを記録する方法：

Adjustイベントのインスタンスを新規作成し、イベントトークンを文字列引数としてパスします。
イベントのインスタンスを引数としてtrackEventメソッドを呼び出します。

1
var adjustEvent = new AdjustEvent("abc123");
2
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度に g3mfiw のトークンでイベントを計測する方法を示します。

JS
HTML

var app = {
   // Application Constructor
   initialize: function () {
      this.bindEvents();
   },

   // Bind Event Listeners
   bindEvents: function () {
      document.addEventListener("deviceready", this.onDeviceReady, false);
   },
   onDeviceReady: function () {
      app.receivedEvent("deviceready");

      var adjustConfig = new AdjustConfig(
         { APP_ID },
         AdjustConfig.EnvironmentSandbox,
      );
      Adjust.create(adjustConfig);
   },
   receivedEvent: function (id) {
      console.log("[AdjustExample]: Received Event: " + id);

      var btnRecordSimpleEvent = document.getElementById(
         "btnRecordSimpleEvent",
      );

      btnRecordSimpleEvent.addEventListener(
         "click",
         function () {
            var adjustEvent = new AdjustEvent("g3mfiw");
            Adjust.trackEvent(adjustEvent);
         },
         false,
      );
   },
};
app.initialize();

1
<!doctype >
2
<html>
3
   <head>
4
      <!---->
5
   </head>
6
   <body>
7
      <div class="app">
8
         <button
9
            id="sl-btnRecordSimpleEvent"
10
            style="color: black; height: 30px; margin: 5px"
11
         >
12
            Record simple event
13
         </button>
14
      </div>
15
      <script src="cordova.js"></script>
16
      <script src="js/index.js"></script>
17
   </body>
18
</html>

	
		OSZAR »

Path:      /event
ClientSdk: cordova4.38.1
Parameters:
  android_uuid     781f17d5-5048-4fae-a4e5-77b58bab62b9
  api_level        34
  app_token        2fm9gkqubvpc
15 collapsed lines
  app_version      1.0
  attribution_deeplink 1
  callback_params  {"key":"value","foo":"bar"}
  connectivity_type 1
  country          US
  cpu_type         arm64-v8a
  created_at       2024-01-25T14:13:16.151Z+0100
  currency         EUR
  device_manufacturer Google
  device_name      sdk_gphone64_arm64
  device_type      phone
  display_height   2205
  display_width    1080
  environment      sandbox
  event_buffering_enabled 0
  event_count      3
  event_token      g3mfiw
23 collapsed lines
  gps_adid         5962dfc1-3a53-4692-850b-22c4bf4311a5
  gps_adid_attempt 2
  gps_adid_src     service
  hardware_name    UE1A.230829.036
  language         en
  mcc              310
  mnc              260
  needs_response_details 1
  os_build         UE1A.230829.036
  os_name          android
  os_version       14
  package_name     com.adjust.examples
  partner_params   {"key":"value","foo":"bar"}
  revenue          0.25
  screen_density   high
  screen_format    long
  screen_size      normal
  session_count    2
  session_length   23
  subsession_count 1
  time_spent       23
  tracking_enabled 1
  ui_mode          1

イベント収益を記録する

setRevenue(revenue: number, currency: string): void

イベントインスタンスにrevenueとcurrencyプロパティを設定することで、イベントに関連する収益を記録できます。この機能を使用して、アプリ内で収益が生成されるアクションを記録しましょう。

これらのプロパティを設定するには、setRevenueメソッドを呼び出し、以下の引数をパスします。

revenue （number）：イベントによって発生した収益額
currency （string）：イベント通貨のISO 4217コード

1
var adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.setRevenue(0.01, "EUR");
3
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度に g3mfiw のトークンでイベントを計測する方法を示します。この関数は、このイベントのrevenueプロパティを 0.25 に、currencyプロパティを EUR に設定します。

JS
HTML

var app = {
   // Application Constructor
   initialize: function () {
      this.bindEvents();
   },

   // Bind Event Listeners
   bindEvents: function () {
      document.addEventListener("deviceready", this.onDeviceReady, false);
   },
   onDeviceReady: function () {
      app.receivedEvent("deviceready");

      var adjustConfig = new AdjustConfig(
         { APP_ID },
         AdjustConfig.EnvironmentSandbox,
      );
      Adjust.create(adjustConfig);
   },
   receivedEvent: function (id) {
      console.log("[AdjustExample]: Received Event: " + id);

      var btnRecordRevenueEvent = document.getElementById(
         "btnRecordRevenueEvent",
      );

      btnRecordRevenueEvent.addEventListener(
         "click",
         function () {
            var adjustEvent = new AdjustEvent("g3mfiw");
            adjustEvent.setRevenue(0.25, "EUR");
            Adjust.trackEvent(adjustEvent);
         },
         false,
      );
   },
};
app.initialize();

1
<!doctype >
2
<html>
3
   <head>
4
      <!---->
5
   </head>
6
   <body>
7
      <div class="app">
8
         <button
9
            id="sl-btnRecordRevenueEvent"
10
            style="color: black; height: 30px; margin: 5px"
11
         >
12
            Record revenue event
13
         </button>
14
      </div>
15
      <script src="cordova.js"></script>
16
      <script src="js/index.js"></script>
17
   </body>
18
</html>

	
		OSZAR »

Path:      /event
ClientSdk: cordova4.38.1
Parameters:
  environment      sandbox
  event_count      3
  event_token      g3mfiw
  revenue          0.25
  currency         EUR

一意のトランザクションIDを設定する

setTransactionId(transactionId: string)

イベントを重複して計測するのを防ぐため、オプションとして任意のIDをパスすることもできます。SDKが最新10件のIDを保存し、トランザクションIDが重複した収益イベントを排除します。

識別子を設定するには、イベントインスタンスのsetTransactionIdプロパティにトランザクションIDを割り当てます。

1
var adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.setTransactionId("{YourTransactionId}");
3
Adjust.trackEvent(adjustEvent);

例

この例は、ユーザーがボタンを操作する度に g3mfiw のトークンでイベントを計測する方法です。この関数はsetTransactionIdメソッドを使用して、transactionIdを 5e85484b-1ebc-4141-aab7-25b869e54c49 に設定します。

JS
HTML

var app = {
   // Application Constructor
   initialize: function () {
      this.bindEvents();
   },

   // Bind Event Listeners
   bindEvents: function () {
      document.addEventListener("deviceready", this.onDeviceReady, false);
   },
   onDeviceReady: function () {
      app.receivedEvent("deviceready");

      var adjustConfig = new AdjustConfig(
         { APP_ID },
         AdjustConfig.EnvironmentSandbox,
      );
      Adjust.create(adjustConfig);
   },
   receivedEvent: function (id) {
      console.log("[AdjustExample]: Received Event: " + id);

      var btnRecordUniqueEvent = document.getElementById(
         "btnRecordUniqueEvent",
      );

      btnRecordUniqueEvent.addEventListener(
         "click",
         function () {
            var adjustEvent = new AdjustEvent("g3mfiw");
            adjustEvent.setTransactionId(
               "5e85484b-1ebc-4141-aab7-25b869e54c49",
            );
            Adjust.trackEvent(adjustEvent);
         },
         false,
      );
   },
};
app.initialize();

1
<!doctype >
2
<html>
3
   <head>
4
      <!---->
5
   </head>
6
   <body>
7
      <div class="app">
8
         <button
9
            id="sl-btnRecordUniqueEvent"
10
            style="color: black; height: 30px; margin: 5px"
11
         >
12
            Record unique event
13
         </button>
14
      </div>
15
      <script src="cordova.js"></script>
16
      <script src="js/index.js"></script>
17
   </body>
18
</html>

	
		OSZAR »

Path:      /event
ClientSdk: cordova4.38.1
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  transaction_id   5e85484b-1ebc-4141-aab7-25b869e54c49

コールバックパラメーターを追加する

addCallbackParameter(key: string, value: string): void

AdjustダッシュボードでコールバックURLを登録した場合、SDKがイベントを記録する際にコールバックURLにGETリクエストを送信します。

サーバーに送信するコールバックパラメーターを設定できます。イベントにパラメーターを設定すると、SDKはそれらをコールバックURLに追加します。この情報を使用して、自社のBIシステムでユーザーのアプリ内行動を分析することが可能です。

イベントにコールバックパラメーターを追加するには、 string key-value引数を指定してaddCallbackParameterメソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。

1
var adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.addCallbackParameter("key", "value");
3
adjustEvent.addCallbackParameter("foo", "bar");
4
Adjust.trackEvent(adjustEvent);

Adjust SDKはイベントを計測し、コールバックパラメーターが追加されたURLにリクエストを送信します。例えば、URL https://www.mydomain.com/callbackが登録されている場合、コールバックは以下のようになります：

https://www.mydomain.com/callback?key=value&foo=bar

CSVレポートを使用している場合、CSVの定義欄にパラメーターを追加するようにしてください。

Adjustでは、SDKからURLに情報をパスするための様々なプレースホルダーをサポートしています。例えば、iOSの{idfa}プレースホルダーやAndroidの{gps_adid}プレースホルダーなどです。{publisher_parameter}プレースホルダーは、単一の文字列での全てのコールバックパラメーターを表示します。

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。次のコールバックパラメーターが追加されました。

- event_token
イベントごとに生成されるrevenue_amount

コールバックURLの結果は以下のようになります：

http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05

JS
HTML

var app = {
   // Application Constructor
   initialize: function () {
      this.bindEvents();
   },

   // Bind Event Listeners
   bindEvents: function () {
      document.addEventListener("deviceready", this.onDeviceReady, false);
   },
   onDeviceReady: function () {
      app.receivedEvent("deviceready");

      var adjustConfig = new AdjustConfig(
         { APP_ID },
         AdjustConfig.EnvironmentSandbox,
      );
      Adjust.create(adjustConfig);
   },
   receivedEvent: function (id) {
      console.log("[AdjustExample]: Received Event: " + id);

      var btnRecordCallbackEvent = document.getElementById(
         "btnRecordCallbackEvent",
      );

      btnRecordCallbackEvent.addEventListener(
         "click",
         function () {
            var adjustEvent = new AdjustEvent("g3mfiw");
            adjustEvent.addCallbackParameter("event_token", "g3mfiw");
            adjustEvent.addCallbackParameter("revenue_amount", "0.05");
            Adjust.trackEvent(adjustEvent);
         },
         false,
      );
   },
};
app.initialize();

1
<!doctype >
2
<html>
3
   <head>
4
      <!---->
5
   </head>
6
   <body>
7
      <div class="app">
8
         <button
9
            id="sl-btnRecordCallbackEvent"
10
            style="color: black; height: 30px; margin: 5px"
11
         >
12
            Record callback event
13
         </button>
14
      </div>
15
      <script src="cordova.js"></script>
16
      <script src="js/index.js"></script>
17
   </body>
18
</html>

	
		OSZAR »

Path:      /event
ClientSdk: cordova4.38.1
Parameters:
  callback_params  {"event_token":"g3mfiw","revenue_amount":"0.05"}
  environment      sandbox
  event_count      1
  event_token      g3mfiw

パートナーパラメーターを追加する

addPartnerParameter(key: string, value: string): void

パートナーパラメーターを追加することで、ネットワークパートナーに追加情報を送信することができます。

Adjustは、設定した外部パートナーにパートナーパラメーターを送信します。この情報は、より詳細な分析やリターゲティング施策にご利用いただけます。パートナー用にパラメーターの設定が完了し、機能が有効化されると、Adjustのサーバーはデータ転送を開始します。

イベントにパートナーパラメーターを追加するには、 string key-value引数を指定してaddPartnerParameterメソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。

1
var adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.addPartnerParameter("key", "value");
3
adjustEvent.addPartnerParameter("foo", "bar");
4
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。次のパートナーパラメーターが追加されました。

関連する製品のproduct_id
イベントをトリガーしたユーザーのuser_id

JS
HTML

var app = {
   // Application Constructor
   initialize: function () {
      this.bindEvents();
   },

   // Bind Event Listeners
   bindEvents: function () {
      document.addEventListener("deviceready", this.onDeviceReady, false);
   },
   onDeviceReady: function () {
      app.receivedEvent("deviceready");

      var adjustConfig = new AdjustConfig(
         { APP_ID },
         AdjustConfig.EnvironmentSandbox,
      );
      Adjust.create(adjustConfig);
   },
   receivedEvent: function (id) {
      console.log("[AdjustExample]: Received Event: " + id);

      var btnRecordPartnerParamEvent = document.getElementById(
         "btnRecordPartnerParamEvent",
      );

      btnRecordPartnerParamEvent.addEventListener(
         "click",
         function () {
            var adjustEvent = new AdjustEvent("g3mfiw");
            adjustEvent.addPartnerParameter("product_id", "29");
            adjustEvent.addPartnerParameter("user_id", "835");
            Adjust.trackEvent(adjustEvent);
         },
         false,
      );
   },
};
app.initialize();

1
<!doctype >
2
<html>
3
   <head>
4
      <!---->
5
   </head>
6
   <body>
7
      <div class="app">
8
         <button
9
            id="sl-btnRecordPartnerParamEvent"
10
            style="color: black; height: 30px; margin: 5px"
11
         >
12
            Record partner param event
13
         </button>
14
      </div>
15
      <script src="cordova.js"></script>
16
      <script src="js/index.js"></script>
17
   </body>
18
</html>

	
		OSZAR »

Path:      /event
ClientSdk: cordova4.38.1
Parameters:
  partner_params  {"product_id":"29","user_id":"835"}
  environment      sandbox
  event_count      1
  event_token      g3mfiw

コールバック識別子を追加する

setCallbackId(callbackId: string)

計測したいイベントにカスタムの文字列識別子を追加できます。Adjustのサーバーが、この識別子をイベントコールバックでレポートします。これにより、どのイベントが正確に計測されたかを確認することが可能です。

この識別子を設定するには、以下の引数を指定してsetCallbackIdメソッドを呼び出します：

callbackId （string）：固有のコールバックID。

1
var adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.setCallbackId("Your-Custom-Id");
3
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。この例では、 callbackIdはf2e728d8-271b-49ab-80ea-27830a215147に設定されています。

JS
HTML

var app = {
   // Application Constructor
   initialize: function () {
      this.bindEvents();
   },

   // Bind Event Listeners
   bindEvents: function () {
      document.addEventListener("deviceready", this.onDeviceReady, false);
   },
   onDeviceReady: function () {
      app.receivedEvent("deviceready");

      var adjustConfig = new AdjustConfig(
         { APP_ID },
         AdjustConfig.EnvironmentSandbox,
      );
      Adjust.create(adjustConfig);
   },
   receivedEvent: function (id) {
      console.log("[AdjustExample]: Received Event: " + id);

      var btnRecordCallbackIdEvent = document.getElementById(
         "btnRecordCallbackIdEvent",
      );

      btnRecordCallbackIdEvent.addEventListener(
         "click",
         function () {
            var adjustEvent = new AdjustEvent("g3mfiw");
            adjustEvent.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147");
            Adjust.trackEvent(adjustEvent);
         },
         false,
      );
   },
};
app.initialize();

1
<!doctype >
2
<html>
3
   <head>
4
      <!---->
5
   </head>
6
   <body>
7
      <div class="app">
8
         <button
9
            id="sl-btnRecordCallbackIdEvent"
10
            style="color: black; height: 30px; margin: 5px"
11
         >
12
            Record callback ID event
13
         </button>
14
      </div>
15
      <script src="cordova.js"></script>
16
      <script src="js/index.js"></script>
17
   </body>
18
</html>

	
		OSZAR »

Path:      /event
ClientSdk: cordova4.38.1
Parameters:
  environment      sandbox
  event_count      3
  event_token      g3mfiw
  callback_id      f2e728d8-271b-49ab-80ea-27830a215147