adjust-icon

イベント情報の送信

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

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

メソッドシグネチャー
AdjustEvent(string eventToken)

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

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

AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
Adjust.trackEvent(myAdjustEvent);

イベントを送信する

メソッドシグネチャー
static void trackEvent(AdjustEvent event)

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

  • Adjustイベントのインスタンスを新規作成し、イベントトークンを文字列引数としてパスします。
  • イベントのインスタンスを引数としてtrackEventメソッドを呼び出します。
AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
Adjust.trackEvent(myAdjustEvent);

例

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

util.dart
import 'package:adjust_sdk/adjust_event.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';


class Util {
   static const String EVENT_TOKEN_SIMPLE = 'g3mfiw';


   static Widget buildCupertinoButton(String text, Function action) {
      return new CupertinoButton(
         child: Text(text),
         color: CupertinoColors.activeBlue,
         padding: const EdgeInsets.symmetric(vertical: 12.0, horizontal: 30.0),
         onPressed: action as void Function()?,
      );
   }


   static AdjustEvent myAdjustEvent() {
      return new AdjustEvent(EVENT_TOKEN_SIMPLE);
   }
}


// main.dart
import 'util.dart';


Util.buildCupertinoButton('Track Simple Event',
   () => Adjust.trackEvent(Util.myAdjustEvent())),
const Padding(padding: const EdgeInsets.all(7.0))
イベントログ
Path:      /event
ClientSdk: flutter4.38.1
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

イベント収益の記録

メソッドシグネチャー
void setRevenue(Num revenue, String currency)

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

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

  • revenue （num）：イベントによって発生した収益額
  • currency （String）：イベント通貨のISO 4217コード
AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
adjustEvent.setRevenue(0.01, 'EUR');
//...
Adjust.trackEvent(myAdjustEvent);

例

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

util.dart
import 'package:adjust_sdk/adjust_event.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';


class Util {
   static const String EVENT_TOKEN_REVENUE = 'g3mfiw';


   static Widget buildCupertinoButton(String text, Function action) {
      return new CupertinoButton(
         child: Text(text),
         color: CupertinoColors.activeBlue,
         padding: const EdgeInsets.symmetric(vertical: 12.0, horizontal: 30.0),
         onPressed: action as void Function()?,
      );
   }


   static AdjustEvent myAdjustEvent() {
      AdjustEvent event = new AdjustEvent(EVENT_TOKEN_REVENUE);
      event.setRevenue(0.25, 'EUR');
      return event;
   }


}


// main.dart
import 'util.dart';


// Send revenue event button.
Util.buildCupertinoButton('Send Revenue Event',
   () => Adjust.trackEvent(Util.myAdjustEvent())),
const Padding(padding: const EdgeInsets.all(7.0))
イベントログ
Path:      /event
ClientSdk: flutter4.38.1
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  revenue          0.25
  currency         EUR

収益イベントの重複排除

プロパティ宣言
String? transactionId;

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

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

AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
myAdjustEvent.transactionId = '{TransactionId}';
//...
Adjust.trackEvent(myAdjustEvent);

例

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

util.dart
import 'package:adjust_sdk/adjust_event.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';


class Util {
   static const String EVENT_TOKEN_REVENUE = 'g3mfiw';
   static const String UNIQUE_ID = '5e85484b-1ebc-4141-aab7-25b869e54c49';


   static Widget buildCupertinoButton(String text, Function action) {
      return new CupertinoButton(
         child: Text(text),
         color: CupertinoColors.activeBlue,
         padding: const EdgeInsets.symmetric(vertical: 12.0, horizontal: 30.0),
         onPressed: action as void Function()?,
      );
   }


   static AdjustEvent myAdjustEvent() {
      AdjustEvent event = new AdjustEvent(EVENT_TOKEN_REVENUE);
      event.transactionId = UNIQUE_ID;
      return event;
   }


}


// main.dart
import 'util.dart';


// Send revenue event button.
Util.buildCupertinoButton('Send Revenue Event',
   () => Adjust.trackEvent(Util.myAdjustEvent())),
const Padding(padding: const EdgeInsets.all(7.0))
イベントログ
Path:      /event
ClientSdk: flutter4.38.1
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  transaction_id   5e85484b-1ebc-4141-aab7-25b869e54c49

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

メソッドシグネチャー
void addCallbackParameter(String key, String value)

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

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

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

AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
adjustEvent.addCallbackParameter('key', 'value');
//...
Adjust.trackEvent(myAdjustEvent);

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
util.dart
import 'package:adjust_sdk/adjust_event.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';


class Util {
   static const String EVENT_TOKEN_CALLBACK = 'g3mfiw';


   static Widget buildCupertinoButton(String text, Function action) {
      return new CupertinoButton(
         child: Text(text),
         color: CupertinoColors.activeBlue,
         padding: const EdgeInsets.symmetric(vertical: 12.0, horizontal: 30.0),
         onPressed: action as void Function()?,
      );
   }


   static AdjustEvent buildCallbackEvent() {
      AdjustEvent event = new AdjustEvent(EVENT_TOKEN_CALLBACK);
         event.addCallbackParameter('event_token', EVENT_TOKEN_CALLBACK);
         event.addCallbackParameter('revenue_amount', '0.05');
   return event;
   }


}


// main.dart
import 'util.dart';


// Send callback event button.
Util.buildCupertinoButton('Send Callback Event',
   () => Adjust.trackEvent(Util.buildCallbackEvent())),
const Padding(padding: const EdgeInsets.all(7.0))
イベントログ
Path:      /event
ClientSdk: flutter4.38.1
Parameters:
  callback_params  {"event_token":"g3mfiw","revenue_amount":"0.05"}
  environment      sandbox
  event_count      1
  event_token      g3mfiw

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

メソッドシグネチャー
void addPartnerParameter(String key, String value)

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

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

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

AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
adjustEvent.addPartnerParameter('key', 'value');
//...
Adjust.trackEvent(myAdjustEvent);

例

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

  • 関連する製品のproduct_id
  • イベントをトリガーしたユーザーのuser_id
util.dart
import 'package:adjust_sdk/adjust_event.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';


class Util {
   static const String EVENT_TOKEN_PARTNER = 'g3mfiw';


   static Widget buildCupertinoButton(String text, Function action) {
      return new CupertinoButton(
         child: Text(text),
         color: CupertinoColors.activeBlue,
         padding: const EdgeInsets.symmetric(vertical: 12.0, horizontal: 30.0),
         onPressed: action as void Function()?,
      );
   }


   static AdjustEvent buildPartnerEvent() {
      AdjustEvent event = new AdjustEvent(EVENT_TOKEN_PARTNER);
      event.addPartnerParameter('product_id', '29');
      event.addPartnerParameter('user_id', '835');
      return event;
   }


}


// main.dart
import 'util.dart';


// Send partner event button.
Util.buildCupertinoButton('Send Partner Event',
   () => Adjust.trackEvent(Util.buildPartnerEvent())),
const Padding(padding: const EdgeInsets.all(7.0))
イベントログ
Path:      /event
ClientSdk: flutter4.38.1
Parameters:
  partner_params  {"product_id":"29","user_id":"835"}
  environment      sandbox
  event_count      1
  event_token      g3mfiw

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

プロパティ宣言
String? callbackId;

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

イベントインスタンスのcallbackIdプロパティにIDを割り当てることで、この識別子を設定します。

AdjustEvent myAdjustEvent = new AdjustEvent('abc123');
//...
myAdjustEvent.callbackId = '{your_callback_id}';
//...
Adjust.trackEvent(myAdjustEvent);

例

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

util.dart
import 'package:adjust_sdk/adjust_event.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';


class Util {
   static const String EVENT_TOKEN_SIMPLE = 'g3mfiw';
   static const String CALLBACK_ID = "f2e728d8-271b-49ab-80ea-27830a215147"


   static Widget buildCupertinoButton(String text, Function action) {
      return new CupertinoButton(
         child: Text(text),
         color: CupertinoColors.activeBlue,
         padding: const EdgeInsets.symmetric(vertical: 12.0, horizontal: 30.0),
         onPressed: action as void Function()?,
      );
   }


   static AdjustEvent myAdjustEvent() {
      AdjustEvent event = new AdjustEvent(EVENT_TOKEN_SIMPLE);
      event.callbackId = CALLBACK_ID;
      return event;
}


// main.dart
import 'util.dart';


Util.buildCupertinoButton('Send Callback Event',
   () => Adjust.trackEvent(Util.myAdjustEvent())),
const Padding(padding: const EdgeInsets.all(7.0))
イベントログ
Path:      /event
ClientSdk: flutter4.38.1
Parameters:
  environment      sandbox
  event_count      3
  event_token      g3mfiw
  callback_id      f2e728d8-271b-49ab-80ea-27830a215147