アプリ内イベント

概要

開発者向けのアプリ内イベントについての概要については、アプリ内イベントをご覧ください。

始める前に

SDKを実装する必要があります。

Integrate In-App Events with our SDK wizard

アプリ内イベントの記録

SDKでは、アプリで発生したユーザーアクションを記録できます。これは、一般的にアプリ内イベントと呼ばれます。

The `logEvent` method

The logEvent method lets you log in-app events and send them to AppsFlyer for processing.

To access the logEvent method, import AppsFlyerLib:

import com.appsflyer.AppsFlyerLib;

import com.appsflyer.AppsFlyerLib

To access predefined event constants, import AFInAppEventType and AFInAppEventParameterName:

import com.appsflyer.AFInAppEventType; // Predefined event names
import com.appsflyer.AFInAppEventParameterName; // Predefined parameter names

import com.appsflyer.AFInAppEventType // Predefined event names
import com.appsflyer.AFInAppEventParameterName // Predefined parameter names

logEvent は4つの引数を取ります。

void logEvent(Context context,
              java.lang.String eventName,
              java.util.Map<java.lang.String,java.lang.Object> eventValues,
              AppsFlyerRequestListener listener)

The first argument (context) is the Application/Activity Context
The second argument (eventName) is the In-app event name
The third argument (eventValues) is the event parameters Map
The fourth argument (listener) is an optional AppsFlyerRequestListener (useful for Handling event submission success/failure)

Example: Send "add to wishlist" event

例えば、ユーザーが商品をウィッシュリストに追加したことを記録する方法は次のとおりです：

Map<String, Object> eventValues = new HashMap<String, Object>();
eventValues.put(AFInAppEventParameterName.PRICE, 1234.56);
eventValues.put(AFInAppEventParameterName.CONTENT_ID,"1234567");

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    AFInAppEventType.ADD_TO_WISHLIST , eventValues);

val eventValues = HashMap<String, Any>() 
eventValues.put(AFInAppEventParameterName.PRICE, 1234.56)
eventValues.put(AFInAppEventParameterName.CONTENT_ID,"1234567")

AppsFlyerLib.getInstance().logEvent(getApplicationContext() ,
                                    AFInAppEventType.ADD_TO_WISHLIST , eventValues)

In the above logEvent invocation:

イベント名は、 AFInAppEventType.ADD_TO_WISHLIST
The event value is a Map containing these event parameters:
- AFInAppEventParameterName.PRICE：イベントに紐づく価格
- AFInAppEventParameterName.CONTENT_ID：追加された商品の識別子

Implementing event structure definitions

イベント構成の定義にて提供されている定義の例に基づいて、イベントは次のように実装する必要があります。

Map<String, Object> eventValues = new HashMap<String, Object>();
eventValues.put(AFInAppEventParameterName.PRICE, <ITEM_PRICE>);
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, <ITEM_TYPE>);
eventValues.put(AFInAppEventParameterName.CONTENT_ID, <ITEM_SKU>);

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    AFInAppEventType.CONTENT_VIEW, eventValues);

val eventValues = HashMap<String, Any>() 
eventValues.put(AFInAppEventParameterName.PRICE, <ITEM_PRICE>)
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, <ITEM_TYPE>)
eventValues.put(AFInAppEventParameterName.CONTENT_ID, <ITEM_SKU>)

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    AFInAppEventType.CONTENT_VIEW, eventValues)

Handling event submission success and failure

You can provide logEvent with a AppsFlyerRequestListener object when recording in-app events. The handler allows you to define logic for two scenarios:

アプリ内イベントが正常に記録された
アプリ内イベントの記録中にエラーが発生しました

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    AFInAppEventType.PURCHASE,
                                    eventValues,
                                    new AppsFlyerRequestListener() {
                    @Override
                    public void onSuccess() {
                        Log.d(LOG_TAG, "Event sent successfully");
                    }
                    @Override
                    public void onError(int i, @NonNull String s) {
                        Log.d(LOG_TAG, "Event failed to be sent:\n" +
                                "Error code: " + i + "\n"
                                + "Error description: " + s);
                    }
                });

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    AFInAppEventType.PURCHASE,
                                    eventValues,
                                    object : AppsFlyerRequestListener {
            override fun onSuccess() {
                Log.d(LOG_TAG, "Event sent successfully")
            }
            override fun onError(errorCode: Int, errorDesc: String) {
                Log.d(LOG_TAG, "Event failed to be sent:\n" +
                        "Error code: " + errorCode + "\n"
                        + "Error description: " + errorDesc)
            }
        })

アプリ内イベントの記録時にエラーが発生した場合には、次の表のようにエラーコードと文字列での説明が提供されます。

エラーコード	説明 (NSError)
`10`	"Event timeout. Check 'minTimeBetweenSessions' param"
`11`	"Skipping event because 'isStopTracking' enabled"
`40`	ネットワークエラー：Android経由のエラーの説明
`41`	"No dev key"
`50`	"Status code failure" + サーバーからの実際のエラーコード

Recording offline events

SDKはインターネットに接続されていないときに発生するイベントを記録することができます。詳細はオフライン時のアプリ内イベントを参照してください。

Logging events before calling `start`

If you initialized the SDK but didn't call start, the SDK will cache in-app events until start is invoked.

キャッシュに複数のイベントがある場合は、それらは次々とサーバーに送信されます（非バッチ、イベント毎に1つのネットワークリエスト）。

収益の記録

📘
注意
For events with revenue, including in-app purchases, subscriptions, and ad revenue events, AppsFlyer customers with an ROI360 subscription should avoid using the AFInAppEventParameterName.REVENUE(af_revenue) parameter in their in-app events. Doing so can result in duplicate revenue being reported. Instead, they should utilize the purchase connector and the ad revenue SDK API.

You can send revenue with any in-app event. Use the AFInAppEventParameterName.REVENUE event parameter to include revenue in the in-app event. You can populate it with any numeric value, positive or negative.

コンマの値区切り、通貨記号、テキストなどは収益の値に含めないでください。たとえば、収益の値は「1234.56」のように設定してください。

Example: Purchase event with revenue

Map<String, Object> eventValues = new HashMap<String, Object>();
eventValues.put(AFInAppEventParameterName.CONTENT_ID, <ITEM_SKU>);
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, <ITEM_TYPE>);
eventValues.put(AFInAppEventParameterName.REVENUE, 200);

AppsFlyerLib.getInstance().logEvent(getApplicationContext(), 
                                    AFInAppEventType.PURCHASE, eventValues);

val eventValues = HashMap<String, Any>() 
eventValues.put(AFInAppEventParameterName.CONTENT_ID, <ITEM_SKU>)
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, <ITEM_TYPE>)
eventValues.put(AFInAppEventParameterName.REVENUE, 200)

AppsFlyerLib.getInstance().logEvent(getApplicationContext(), 
                                    AFInAppEventType.PURCHASE, eventValues)

上記の購入イベントの収益は200ドルで、管理画面にも収益として表示されます。

📘
注意
収益値 (REVENUE) に通貨記号を含めないでください。数値のみを挿入してください。

Configuring revenue currency

You can set the currency code for an event's revenue by using the af_currency predefined event parameter:

Map<String, Object> eventValues = new HashMap<String, Object>();
eventValues.put(AFInAppEventParameterName.CURRENCY, "USD");
eventValues.put(AFInAppEventParameterName.REVENUE, <TRANSACTION_REVENUE>);
AppsFlyerLib.getInstance().logEvent(getApplicationContext(), 
                                    AFInAppEventType.PURCHASE, eventValues);

val eventValues = HashMap<String, Any>() 
eventValues.put(AFInAppEventParameterName.REVENUE, <TRANSACTION_REVENUE>)
eventValues.put(AFInAppEventParameterName.CURRENCY,"USD")
AppsFlyerLib.getInstance().logEvent(getApplicationContext() , AFInAppEventType.PURCHASE , eventValues)

通貨コードは3桁のISO 4217コードを使用してください。
デフォルトの通貨はUSDです

通貨単位の設定、管理画面上での表示、通貨換算については、収益通貨に関するガイドをご覧ください。

Logging negative revenue

稀に、マイナスの収益を計測したいケースがあるかと思います。たとえば、ユーザーは払い戻しを受け取ったり、サブスクリプションをキャンセルしたときです。

マイナスの収益を記録する方法：

Map<String, Object> eventValues = new HashMap<String, Object>();
eventValues.put(AFInAppEventParameterName.REVENUE, -1234.56);
eventValues.put(AFInAppEventParameterName.CONTENT_ID,"1234567");
AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    "cancel_purchase",
                                    eventValues);

val eventValues = HashMap<String, Any>() 
eventValues.put(AFInAppEventParameterName.REVENUE, -1234.56)
eventValues.put(AFInAppEventParameterName.CONTENT_ID,"1234567")
AppsFlyerLib.getInstance().logEvent(getApplicationContext(),
                                    "cancel_purchase",
                                    eventValues)

📘
注意
上記のコードについて次のことに注意してください。

収益値の前にはマイナス記号が追加されています

イベント名は、"cancel_purchase" というカスタムイベント名です。管理画面やローデータレポートで、収益がマイナスのイベントを簡単に特定するのに役立ちます。

購入の検証

AppsFlyer provides server verification for in-app purchases. For more information see Validate and log purchase

イベント定数

Predefined event names

次のコンスタントを使用するには、com.appsflyer.AFInAppEventType をインポートしてください。

import com.appsflyer.AFInAppEventType;

import com.appsflyer.AFInAppEventType

Predefined event name constants follow a AFInAppEventType.EVENT_NAME naming convention. For example, AFInAppEventType.ADD_TO_CART

イベント名	Android 定数名
`"af_level_achieved"`	`AFInAppEventType.LEVEL_ACHIEVED`
`"af_add_payment_info"`	`AFInAppEventType.ADD_PAYMENT_INFO`
`"af_add_to_cart"`	`AFInAppEventType.ADD_TO_CART`
`"af_add_to_wishlist"`	`AFInAppEventType.ADD_TO_WISHLIST`
`"af_complete_registration"`	`AFInAppEventType.COMPLETE_REGISTRATION`
`"af_tutorial_completion"`	`AFInAppEventType.TUTORIAL_COMPLETION`
`"af_initiated_checkout"`	`AFInAppEventType.INITIATED_CHECKOUT`
`"af_purchase"`	`AFInAppEventType.PURCHASE`
`"af_rate"`	`AFInAppEventType.RATE`
`"af_search"`	`AFInAppEventType.SEARCH`
`"af_spent_credits"`	`AFInAppEventType.SPENT_CREDITS`
`"af_achievement_unlocked"`	`AFInAppEventType.ACHIEVEMENT_UNLOCKED`
`"af_content_view"`	`AFInAppEventType.CONTENT_VIEW`
`"af_list_view"`	`AFInAppEventType.LIST_VIEW`
`"af_travel_booking"`	`AFInAppEventType.TRAVEL_BOOKING`
`"af_share"`	`AFInAppEventType.SHARE`
`"af_invite"`	`AFInAppEventType.INVITE`
`"af_login"`	`AFInAppEventType.LOGIN`
`"af_re_engage"`	`AFInAppEventType.RE_ENGAGE`
`"af_update"`	`AFInAppEventType.UPDATE`
`"af_location_coordinates"`	`AFInAppEventType.LOCATION_COORDINATES`
`"af_customer_segment"`	`AFInAppEventType.CUSTOMER_SEGMENT`
`"af_subscribe"`	`AFInAppEventType.SUBSCRIBE`
`"af_start_trial"`	`AFInAppEventType.START_TRIAL`
`"af_ad_click"`	`AFInAppEventType.AD_CLICK`
`"af_ad_view"`	`AFInAppEventType.AD_VIEW`
`"af_opened_from_push_notification"`	`AFInAppEventType.OPENED_FROM_PUSH_NOTIFICATION`

Predefined event parameters

To use the following constants, import AFInAppEventParameterName:

import com.appsflyer.AFInAppEventParameterName;

import com.appsflyer.AFInAppEventParameterName

Predefined event parameter constants follow a AFInAppEventParameterName.PARAMETER_NAME naming convention. For example, AFInAppEventParameterName.CURRENCY

イベントパラメーター名	Android 定数名	タイプ
`"af_content"`	`CONTENT`	`String[]`
`"af_achievement_id"`	`ACHIEVEMENT_ID`	`String`
`"af_level"`	`LEVEL`	`String`
`"af_score"`	`SCORE`	`String`
`"af_success"`	`SUCCESS`	`String`
`"af_price"`	`PRICE`	`float`
`"af_content_type"`	`CONTENT_TYPE`	`String`
`"af_content_id"`	`CONTENT_ID`	`String`
`"af_content_list"`	`CONTENT_LIST`	`String[]`
`"af_currency"`	`CURRENCY`	`String`
`"af_quantity"`	`QUANTITY`	`int`
`"af_registration_method"`	`REGISTRATION_METHOD`	`String`
`"af_payment_info_available"`	`PAYMENT_INFO_AVAILABLE`	`String`
`"af_max_rating_value"`	`MAX_RATING_VALUE`	`String`
`"af_rating_value"`	`RATING_VALUE`	`String`
`"af_search_string"`	`SEARCH_STRING`	`String`
`"af_date_a"`	`DATE_A`	`String`
`"af_date_b"`	`DATE_B`	`String`
`"af_destination_a"`	`DESTINATION_A`	`String`
`"af_destination_b"`	`DESTINATION_B`	`String`
`"af_description"`	`DESCRIPTION`	`String`
`"af_class"`	`CLASS`	`String`
`"af_event_start"`	`EVENT_START`	`String`
`"af_event_end"`	`EVENT_END`	`String`
`"af_lat"`	`LAT`	`String`
`"af_long"`	`LONG`	`String`
`"af_customer_user_id"`	`CUSTOMER_USER_ID`	`String`
`"af_validated"`	`VALIDATED`	`boolean`
`"af_revenue"`	`REVENUE`	`float`
`"af_projected_revenue"`	`PROJECTED_REVENUE`	`float`
`"af_receipt_id"`	`RECEIPT_ID`	`String`
`"af_tutorial_id"`	`TUTORIAL_ID`	`String`
`"af_virtual_currency_name"`	`VIRTUAL_CURRENCY_NAME`	`String`
`"af_deep_link"`	`DEEP_LINK`	`String`
`"af_old_version"`	`OLD_VERSION`	`String`
`"af_new_version"`	`NEW_VERSION`	`String`
`"af_review_text"`	`REVIEW_TEXT`	`String`
`"af_coupon_code"`	`COUPON_CODE`	`String`
`"af_order_id"`	`ORDER_ID`	`String`
`"af_param_1"`	`PARAM_1`	`String`
`"af_param_2"`	`PARAM_2`	`String`
`"af_param_3"`	`PARAM_3`	`String`
`"af_param_4"`	`PARAM_4`	`String`
`"af_param_5"`	`PARAM_5`	`String`
`"af_param_6"`	`PARAM_6`	`String`
`"af_param_7"`	`PARAM_7`	`String`
`"af_param_8"`	`PARAM_8`	`String`
`"af_param_9"`	`PARAM_9`	`String`
`"af_param_10"`	`PARAM_10`	`String`
`"af_departing_departure_date"`	`DEPARTING_DEPARTURE_DATE`	`String`
`"af_returning_departure_date"`	`RETURNING_DEPARTURE_DATE`	`String`
`"af_destination_list"`	`DESTINATION_LIST`	`String[]`
`"af_city"`	`CITY`	`String`
`"af_region"`	`REGION`	`String`
`"af_country"`	`COUNTRY`	`String`
`"af_departing_arrival_date"`	`DEPARTING_ARRIVAL_DATE`	`String`
`"af_returning_arrival_date"`	`RETURNING_ARRIVAL_DATE`	`String`
`"af_suggested_destinations"`	`SUGGESTED_DESTINATIONS`	`String[]`
`"af_travel_start"`	`TRAVEL_START`	`String`
`"af_travel_end"`	`TRAVEL_END`	`String`
`"af_num_adults"`	`NUM_ADULTS`	`String`
`"af_num_children"`	`NUM_CHILDREN`	`String`
`"af_num_infants"`	`NUM_INFANTS`	`String`
`"af_suggested_hotels"`	`SUGGESTED_HOTELS`	`String[]`
`"af_user_score"`	`USER_SCORE`	`String`
`"af_hotel_score"`	`HOTEL_SCORE`	`String`
`"af_purchase_currency"`	`PURCHASE_CURRENCY`	`String`
`"af_preferred_neighborhoods"`	`PREFERRED_NEIGHBORHOODS`	`String[]`
`"af_preferred_num_stops"`	`PREFERRED_NUM_STOPS`	`String`
`"af_adrev_ad_type"`	`AD_REVENUE_AD_TYPE`	`String`
`"af_adrev_network_name"`	`AD_REVENUE_NETWORK_NAME`	`String`
`"af_adrev_placement_id"`	`AD_REVENUE_PLACEMENT_ID`	`String`
`"af_adrev_ad_size"`	`AD_REVENUE_AD_SIZE`	`String`
`"af_adrev_mediated_network_name"`	`AD_REVENUE_MEDIATED_NETWORK_NAME`	`String`
`"af_preferred_price_range"`	`PREFERRED_PRICE_RANGE`	`String`、次のようにフォーマットされたint tuple: `(min,max)`
`"af_preferred_star_ratings"`	`PREFERRED_STAR_RATINGS`	`String`、次のようにフォーマットされたint tuple: `(min,max)`

アプリ内イベント

概要

始める前に

Integrate In-App Events with our SDK wizard

アプリ内イベントの記録

The `logEvent` method

Example: Send "add to wishlist" event

Implementing event structure definitions

Handling event submission success and failure

Recording offline events

Logging events before calling `start`

収益の記録

📘
注意

Example: Purchase event with revenue

📘
注意

Configuring revenue currency

Logging negative revenue

📘
注意

購入の検証

イベント定数

Predefined event names

Predefined event parameters

概要

始める前に

Integrate In-App Events with our SDK wizard

アプリ内イベントの記録

The logEvent method

Example: Send "add to wishlist" event

Implementing event structure definitions

Handling event submission success and failure

Recording offline events

Logging events before calling start

収益の記録

📘注意

Example: Purchase event with revenue

📘注意

Configuring revenue currency

Logging negative revenue

📘注意

購入の検証

イベント定数

Predefined event names

Predefined event parameters

The `logEvent` method

Logging events before calling `start`

📘
注意

📘
注意

📘
注意