イベント情報の送信

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

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

public AdjustEvent(String eventToken)

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

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

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

1
val adjustEvent = AdjustEvent("abc123")
2
Adjust.trackEvent(adjustEvent)

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

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

イベントを送信する

public static void trackEvent(AdjustEvent event)

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

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

1
val adjustEvent = AdjustEvent("abc123")
2
Adjust.trackEvent(adjustEvent)

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

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

例

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

1
fun onTrackSimpleEventClick(v: View) {
2
   val event = AdjustEvent("g3mfiw")
3
   Adjust.trackEvent(event)
4
}

1
public void onTrackSimpleEventClick(View v) {
2
   AdjustEvent event = new AdjustEvent("g3mfiw");
3
   Adjust.trackEvent(event);
4
}

1
window.onload = function () {
2
   var btnTrackSimpleEvent = document.getElementById("btnTrackSimpleEvent");
3
   btnTrackSimpleEvent.onclick = function (e) {
4
      e.preventDefault();
5
      var adjustEvent = new AdjustEvent("g3mfiw");
6
      Adjust.trackEvent(adjustEvent);
7
   };
8
};

Path:      /event
ClientSdk: android4.38.5
Parameters:
  android_uuid     781f17d5-5048-4fae-a4e5-77b58bab62b9
  api_level        34
41 collapsed lines
  app_token        2fm9gkqubvpc
  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
  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

イベント収益の記録

public void setRevenue(double revenue, String currency)

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

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

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

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

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

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

例

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

1
fun onTrackRevenueEventClick(v: View) {
2
   val event = AdjustEvent("g3mfiw")
3
   event.setRevenue(0.25, "EUR")
4
   Adjust.trackEvent(event)
5
}

1
public void onTrackRevenueEventClick(View v) {
2
   AdjustEvent event = new AdjustEvent("g3mfiw");
3
   event.setRevenue(0.25, "EUR")
4
   Adjust.trackEvent(event);
5
}

1
window.onload = function () {
2
   var btnTrackRevenueEvent = document.getElementById("btnTrackRevenueEvent");
3
   btnTrackRevenueEvent.onclick = function (e) {
4
      e.preventDefault();
5
      var adjustEvent = new AdjustEvent("g3mfiw");
6
      adjustEvent.setRevenue(0.25, "EUR");
7
      Adjust.trackEvent(adjustEvent);
8
   };
9
};

Path:      /event
ClientSdk: android4.38.5
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  revenue          0.25
  currency         EUR

収益イベントの重複排除

public void setOrderId(String orderId)

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

識別子を設定するには、setOrderIdメソッドを呼び出し、String引数としてトランザクションIDをパスしてください。

1
val adjustEvent = AdjustEvent("abc123")
2
adjustEvent.setRevenue(0.01, "EUR")
3
adjustEvent.setOrderId("{OrderId}")
4
Adjust.trackEvent(adjustEvent)

1
AdjustEvent adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.setRevenue(0.01, "EUR");
3
adjustEvent.setOrderId("{OrderId}");
4
Adjust.trackEvent(adjustEvent);

1
let adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.setRevenue(0.01, "EUR");
3
adjustEvent.setOrderId("{OrderId}");
4
Adjust.trackEvent(event);

例

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

1
fun onTrackUniqueEventClick(v: View) {
2
   val event = AdjustEvent("g3mfiw")
3
   event.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49")
4
   Adjust.trackEvent(event)
5
}

1
public void onTrackUniqueEventClick(View v) {
2
   AdjustEvent event = new AdjustEvent("g3mfiw");
3
   event.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49")
4
   Adjust.trackEvent(event);
5
}

1
window.onload = function () {
2
   var btnTrackUniqueEvent = document.getElementById("btnTrackUniqueEvent");
3
   btnTrackUniqueEvent.onclick = function (e) {
4
      e.preventDefault();
5
      var adjustEvent = new AdjustEvent("g3mfiw");
6
      adjustEvent.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49");
7
      Adjust.trackEvent(adjustEvent);
8
   };
9
};

Path:      /event
ClientSdk: android4.38.5
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  order_id         5e85484b-1ebc-4141-aab7-25b869e54c49

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

public void addCallbackParameter(String key, String value)

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

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

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

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

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

1
let 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

1
fun onTrackUniqueEventClick(v: View) {
2
   val event = AdjustEvent("g3mfiw")
3
   event.addCallbackParameter("event_token", "g3mfiw")
4
   event.addCallbackParameter("revenue_amount", "0.05")
5
   Adjust.trackEvent(event)
6
}

1
public void onTrackUniqueEventClick(View v) {
2
   AdjustEvent event = new AdjustEvent("g3mfiw");
3
   event.addCallbackParameter("event_token", "g3mfiw");
4
   event.addCallbackParameter("revenue_amount", "0.05");
5
   Adjust.trackEvent(event);
6
}

1
window.onload = function () {
2
   var btnTrackUniqueEvent = document.getElementById("btnTrackUniqueEvent");
3
   btnTrackUniqueEvent.onclick = function (e) {
4
      e.preventDefault();
5
      var adjustEvent = new AdjustEvent("g3mfiw");
6
      adjustEvent.addCallbackParameter("event_token", "g3mfiw");
7
      adjustEvent.addCallbackParameter("revenue_amount", "0.05");
8
      Adjust.trackEvent(adjustEvent);
9
   };
10
};

パラメーターがAdjustに送信されたかどうかは、ログにcallback_paramsがあるかどうかで確認できます。

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

パートナーパラメーターの追加

public void addPartnerParameter(String key, String value)

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

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

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

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

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

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

例

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

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

1
fun onTrackUniqueEventClick(v: View) {
2
   val event = AdjustEvent("g3mfiw")
3
   event.addPartnerParameter("product_id", "29")
4
   event.addPartnerParameter("user_id", "835")
5
   Adjust.trackEvent(event)
6
}

1
public void onTrackUniqueEventClick(View v) {
2
   AdjustEvent event = new AdjustEvent("g3mfiw");
3
   event.addPartnerParameter("product_id", "29");
4
   event.addPartnerParameter("user_id", "835");
5
   Adjust.trackEvent(event);
6
}

1
window.onload = function () {
2
   var btnTrackUniqueEvent = document.getElementById("btnTrackUniqueEvent");
3
   btnTrackUniqueEvent.onclick = function (e) {
4
      e.preventDefault();
5
      var adjustEvent = new AdjustEvent("g3mfiw");
6
      adjustEvent.addPartnerParameter("product_id", "29");
7
      adjustEvent.addPartnerParameter("user_id", "835");
8
      Adjust.trackEvent(adjustEvent);
9
   };
10
};

パラメーターがAdjustに送信されたかどうかは、ログにpartner_paramsがあるかどうかで確認できます。

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

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

public void setCallbackId(String callbackId)

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

この識別子を設定するには、IDをString引数としsetCallbackIdメソッドを呼び出してください。

1
val adjustEvent = AdjustEvent("abc123")
2
adjustEvent.setCallbackId("{Your-Custom-Id}")
3
Adjust.trackEvent(adjustEvent)

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

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

例

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

1
fun onTrackUniqueEventClick(v: View) {
2
   val event = AdjustEvent("g3mfiw")
3
   event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147")
4
   Adjust.trackEvent(event)
5
}

1
public void onTrackUniqueEventClick(View v) {
2
   AdjustEvent event = new AdjustEvent("g3mfiw");
3
   event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147")
4
   Adjust.trackEvent(event);
5
}

1
window.onload = function () {
2
   var btnTrackUniqueEvent = document.getElementById("btnTrackUniqueEvent");
3
   btnTrackUniqueEvent.onclick = function (e) {
4
      e.preventDefault();
5
      var adjustEvent = new AdjustEvent("g3mfiw");
6
      adjustEvent.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147");
7
      Adjust.trackEvent(adjustEvent);
8
   };
9
};

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