Adjust SDKはADJEvent
オブジェクトを提供しており、アプリのイベント情報を構造化してAdjustのサーバーに送信することができます。
ADJEventオブジェクトをインスタンス化する
- (nullable id)initWithEventToken:(nonnull NSString *)eventToken;
Adjust SDKでイベント情報を送信するには、ADJEvent
オブジェクトをインスタンス化する必要があります。このオブジェクトには、アプリでイベントが発生した時にAdjustに送信される変数が含まれます。
イベントオブジェクトをインスタンス化するには、新しいADJEvent
インスタンスを作成して以下のパラメーターをパスしてください:
eventToken
(NSString
):お客様のAdjustイベントトークン。
イベントを送信する
+ (void)trackEvent:(nullable ADJEvent *)event;
Adjustイベントトークンを関連付けることで、アプリ内のユーザー行動を記録できます。イベントを記録する方法:
- Adjustイベントのインスタンスを新規作成し、イベントトークンを文字列引数としてパスします。
- イベントのインスタンスを引数として
trackEvent
メソッドを呼び出します。
例
この例では、ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する方法を示します。
Path: /eventClientSdk: ios5.1.0Parameters: app_token 2fm9gkqubvpc app_version 1.035 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: /eventClientSdk: ios5.1.0Parameters: environment sandbox event_count 3 event_token abc123 currency EUR revenue 0.25
収益イベントの重複排除
- (void)setDeduplicationId:(nonnull NSString *)deduplicationId;
識別子を設定するには、イベントインスタンスのsetDeduplicationId
プロパティにトランザクションIDを割り当てます。
重複排除IDの制限を設定
重複したイベントを識別するために、リストに追加できるdeduplicationId
の数をカスタム制限することができます。デフォルトでは、制限は 10 に設定されています。
例
この例では、ユーザーがボタンを操作する度にg3mfiw
のトークンでイベントを計測する例を示します。この関数はsetTransactionId
メソッドを使用して、uniqueId
を5e85484b-1ebc-4141-aab7-25b869e54c49
に設定します。
Path: /eventClientSdk: ios5.1.0Parameters: environment sandbox event_count 3 event_token abc123 deduplication_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
が登録されている場合、コールバックは以下のようになります:
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
Path: /eventClientSdk: ios5.1.0Parameters: 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: /eventClientSdk: ios5.1.0Parameters: 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: /eventClientSdk: ios5.1.0Parameters: callback_id f2e728d8-271b-49ab-80ea-27830a215147 environment sandbox event_count 1 event_token g3mfiw