イベント情報の送信

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

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

+ (nullable ADJEvent *)eventWithEventToken:(nonnull NSString *)eventToken;

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

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

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

イベントを送信する

+ (void)trackEvent:(nullable ADJEvent *)event;

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

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

例

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

Path:      /event
ClientSdk: ios4.38.4
Parameters:
  app_token        2fm9gkqubvpc
  app_version      1.0
35 collapsed lines
  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 Apple
  device_type      phone
  display_height   2205
  display_width    1080
  environment      sandbox
  event_buffering_enabled 0
  event_count      3
  event_token      g3mfiw
  hardware_name    UE1A.230829.036
  language         en
  mcc              310
  mnc              260
  needs_response_details 1
  os_build         UE1A.230829.036
  os_name          ios
  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:(double)amount currency:(nonnull NSString *)currency;

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

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

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

例

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

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

収益イベントの重複排除

- (void)setTransactionId:(nonnull NSString *)transactionId;

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

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

例

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

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

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

- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

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

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

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

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

1
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の結果は以下のようになります：

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

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

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

- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

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

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

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

例

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

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

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

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

- (void)setCallbackId:(nonnull NSString *)callbackId;

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

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

例

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

Path:      /event
ClientSdk: ios4.38.4
Parameters:
  callback_id      f2e728d8-271b-49ab-80ea-27830a215147
  environment      sandbox
  event_count      1
  event_token      g3mfiw