Adjust SDKはAdjustEvent
オブジェクトを提供しており、アプリのイベント情報を構造化してAdjustのサーバーに送信することができます。
AdjustEventオブジェクトをインスタンス化する
public AdjustEvent(String eventToken)
Adjust SDKでイベント情報を送信するには、AdjustEvent
オブジェクトをインスタンス化する必要があります。このオブジェクトには、アプリでイベントが発生した時にAdjustに送信される変数が含まれます。
イベントオブジェクトをインスタンス化するには、新しいAdjustEvent
インスタンスを作成して以下のパラメーターをパスしてください:
eventToken
(String
):お客様のAdjustイベントトークン。
イベントを送信する
public static void trackEvent(AdjustEvent event)
Adjustイベントトークンを関連付けることで、アプリ内のユーザー行動を記録できます。イベントを記録する方法:
- Adjustイベントのインスタンスを新規作成し、イベントトークンを
String
引数としてパスします。 - イベントのインスタンスを引数として
trackEvent
メソッドを呼び出します。
例
この例では、ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する方法を示します。
fun onTrackSimpleEventClick(v: View) { val event = AdjustEvent("g3mfiw") Adjust.trackEvent(event)}
Path: /eventClientSdk: android4.38.5Parameters: android_uuid 781f17d5-5048-4fae-a4e5-77b58bab62b9 api_level 3441 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コード
val adjustEvent = AdjustEvent("abc123")adjustEvent.setRevenue(0.01, "EUR")Adjust.trackEvent(adjustEvent)
例
この例では、ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する方法を示します。この関数はこのイベントのrevenue
プロパティを 0.25
、currency
プロパティを EUR
に設定します。
fun onTrackRevenueEventClick(v: View) { val event = AdjustEvent("g3mfiw") event.setRevenue(0.25, "EUR") Adjust.trackEvent(event)}
Path: /eventClientSdk: android4.38.5Parameters: environment sandbox event_count 3 event_token abc123 revenue 0.25 currency EUR
収益イベントの重複排除
public void setDeduplicationId(String deduplicationId)
AdjustEvent.setDeduplicationId
メソッドを呼び出すと、イベント重複排除のためのオプション識別子をパスすることができます。AdjustはSDKから重複したイベントを受信すると、それらを排除します。
重複排除IDの制限を設定
public void setEventDeduplicationIdsMaxSize(Integer eventDeduplicationIdsMaxSize)
デフォルトでは、Adjust SDKは最大 10 のユニークIDをサポートしています。AdjustConfig.setEventDeduplicationIdsMaxSize
メソッドを呼び出すことで、この設定を構成できます。
例
この例では、ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する例を示します。この関数はsetDeduplicationId
メソッドを使用して、orderId
を5e85484b-1ebc-4141-aab7-25b869e54c49
に設定します。
fun onTrackUniqueEventClick(v: View) { val event = AdjustEvent("g3mfiw") event.setDeduplicationId("5e85484b-1ebc-4141-aab7-25b869e54c49") Adjust.trackEvent(event)}
Path: /eventClientSdk: android5.0.0Parameters: environment sandbox event_count 3 event_token abc123 deduplication_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
メソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。
val adjustEvent = AdjustEvent("abc123")adjustEvent.addCallbackParameter("key", "value")adjustEvent.addCallbackParameter("foo", "bar")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
fun onTrackUniqueEventClick(v: View) { val event = AdjustEvent("g3mfiw") event.addCallbackParameter("event_token", "g3mfiw") event.addCallbackParameter("revenue_amount", "0.05") Adjust.trackEvent(event)}
パラメーターがAdjustに送信されたかどうかは、ログにcallback_params
があるかどうかで確認できます。
Path: /eventClientSdk: android4.38.5Parameters: 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
メソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。
val adjustEvent = AdjustEvent("abc123")adjustEvent.addPartnerParameter("key", "value")adjustEvent.addPartnerParameter("foo", "bar")Adjust.trackEvent(adjustEvent)
例
この例では、ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する方法を示します。次のパートナーパラメーターが追加されました:
- 関連する製品の
product_id
- イベントをトリガーしたユーザーの
user_id
fun onTrackUniqueEventClick(v: View) { val event = AdjustEvent("g3mfiw") event.addPartnerParameter("product_id", "29") event.addPartnerParameter("user_id", "835") Adjust.trackEvent(event)}
パラメーターがAdjustに送信されたかどうかは、ログにpartner_params
があるかどうかで確認できます。
Path: /eventClientSdk: android4.38.5Parameters: 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
メソッドを呼び出してください。
val adjustEvent = AdjustEvent("abc123")adjustEvent.setCallbackId("{Your-Custom-Id}")Adjust.trackEvent(adjustEvent)
例
ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する例を示します。この例では、callbackId
がf2e728d8-271b-49ab-80ea-27830a215147
に設定されています。
fun onTrackUniqueEventClick(v: View) { val event = AdjustEvent("g3mfiw") event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147") Adjust.trackEvent(event)}
Path: /eventClientSdk: android4.38.5Parameters: environment sandbox event_count 3 event_token g3mfiw callback_id f2e728d8-271b-49ab-80ea-27830a215147