-
public class AppEventsConstants
Predefined event and parameter names for logging events common to many apps. Logging occurs through the AppEventsLogger.logEvent family of methods.
-
-
Field Summary
-
Method Summary
Modifier and Type Method Description final String
getEVENT_NAME_ACTIVATED_APP()
Log this event when an app is being activated. final String
getEVENT_NAME_DEACTIVATED_APP()
final String
getEVENT_NAME_SESSION_INTERRUPTIONS()
final String
getEVENT_NAME_TIME_BETWEEN_SESSIONS()
final String
getEVENT_NAME_COMPLETED_REGISTRATION()
Log this event when the user has completed registration with the app. final String
getEVENT_NAME_VIEWED_CONTENT()
Log this event when the user has viewed a form of content in the app. final String
getEVENT_NAME_SEARCHED()
Log this event when the user has performed a search within the app. final String
getEVENT_NAME_RATED()
Log this event when the user has rated an item in the app. final String
getEVENT_NAME_COMPLETED_TUTORIAL()
Log this event when the user has completed a tutorial in the app. final String
getEVENT_NAME_PUSH_TOKEN_OBTAINED()
Log this event when the app obtained a push registration token from FCM. final String
getEVENT_NAME_ADDED_TO_CART()
Log this event when the user has added an item to their cart. final String
getEVENT_NAME_ADDED_TO_WISHLIST()
Log this event when the user has added an item to their wishlist. final String
getEVENT_NAME_INITIATED_CHECKOUT()
Log this event when the user has entered the checkout process. final String
getEVENT_NAME_ADDED_PAYMENT_INFO()
Log this event when the user has entered their payment info. final String
getEVENT_NAME_PURCHASED()
final String
getEVENT_NAME_ACHIEVED_LEVEL()
Log this event when the user has achieved a level in the app. final String
getEVENT_NAME_UNLOCKED_ACHIEVEMENT()
Log this event when the user has unlocked an achievement in the app. final String
getEVENT_NAME_SPENT_CREDITS()
Log this event when the user has spent app credits. final String
getEVENT_NAME_CONTACT()
A telephone/SMS, email, chat or other type of contact between a customer and your business. final String
getEVENT_NAME_CUSTOMIZE_PRODUCT()
The customization of products through a configuration tool or other application your business owns. final String
getEVENT_NAME_DONATE()
The donation of funds to your organization or cause. final String
getEVENT_NAME_FIND_LOCATION()
When a person finds one of your locations via web or application, with an intention to visit (example: find product at a local store). final String
getEVENT_NAME_SCHEDULE()
The booking of an appointment to visit one of your locations. final String
getEVENT_NAME_START_TRIAL()
The start of a free trial of a product or service you offer (example: trial subscription). final String
getEVENT_NAME_SUBMIT_APPLICATION()
The submission of an application for a product, service or program you offer (example: credit card, educational program or job). final String
getEVENT_NAME_SUBSCRIBE()
The start of a paid subscription for a product or service you offer. final String
getEVENT_NAME_AD_IMPRESSION()
Log this event when the user views an ad. final String
getEVENT_NAME_AD_CLICK()
Log this event when the user clicks an ad. final String
getEVENT_NAME_LIVE_STREAMING_START()
Log the live streaming events from sdk final String
getEVENT_NAME_LIVE_STREAMING_STOP()
final String
getEVENT_NAME_LIVE_STREAMING_PAUSE()
final String
getEVENT_NAME_LIVE_STREAMING_RESUME()
final String
getEVENT_NAME_LIVE_STREAMING_ERROR()
final String
getEVENT_NAME_LIVE_STREAMING_UPDATE_STATUS()
final String
getEVENT_NAME_PRODUCT_CATALOG_UPDATE()
Product Catalog related events final String
getEVENT_PARAM_LIVE_STREAMING_PREV_STATUS()
Paramete keys for live streaming events final String
getEVENT_PARAM_LIVE_STREAMING_STATUS()
final String
getEVENT_PARAM_LIVE_STREAMING_ERROR()
final String
getEVENT_PARAM_CURRENCY()
Parameter key used to specify currency used with logged event. final String
getEVENT_PARAM_REGISTRATION_METHOD()
Parameter key used to specify the method the user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc. final String
getEVENT_PARAM_CONTENT_TYPE()
Parameter key used to specify a generic content type/family for the logged event, e.g. final String
getEVENT_PARAM_CONTENT()
Parameter key used to specify data for the one or more pieces of content being logged about. final String
getEVENT_PARAM_CONTENT_ID()
Parameter key used to specify an ID for the specific piece of content being logged about. final String
getEVENT_PARAM_SEARCH_STRING()
Parameter key used to specify the string provided by the user for a search operation. final String
getEVENT_PARAM_SUCCESS()
Parameter key used to specify whether the activity being logged about was successful or not. final String
getEVENT_PARAM_MAX_RATING_VALUE()
Parameter key used to specify the maximum rating available for the EVENT_NAME_RATE event. final String
getEVENT_PARAM_PAYMENT_INFO_AVAILABLE()
Parameter key used to specify whether payment info is available for the EVENT_NAME_INITIATED_CHECKOUT event. final String
getEVENT_PARAM_NUM_ITEMS()
Parameter key used to specify how many items are being processed for an EVENT_NAME_INITIATED_CHECKOUT or EVENT_NAME_PURCHASE event. final String
getEVENT_PARAM_LEVEL()
Parameter key used to specify the level achieved in an EVENT_NAME_LEVEL_ACHIEVED event. final String
getEVENT_PARAM_DESCRIPTION()
Parameter key used to specify a description appropriate to the event being logged. final String
getEVENT_PARAM_SOURCE_APPLICATION()
Parameter key used to specify source application package. final String
getEVENT_PARAM_PACKAGE_FP()
Parameter key used to specify package fingerprint. final String
getEVENT_PARAM_APP_CERT_HASH()
Parameter key used to specify hashed cert for signing the apk. final String
getEVENT_PARAM_VALUE_YES()
Yes-valued parameter value to be used with parameter keys that need a Yes/No value final String
getEVENT_PARAM_VALUE_NO()
No-valued parameter value to be used with parameter keys that need a Yes/No value final String
getEVENT_PARAM_AD_TYPE()
Parameter key used to specify the type of ad in an EVENT_NAME_AD_IMPRESSION or EVENT_NAME_AD_CLICK event. final String
getEVENT_PARAM_ORDER_ID()
Parameter key used to specify the unique ID for all events within a subscription in an EVENT_NAME_SUBSCRIBE or EVENT_NAME_START_TRIAL event. final String
getEVENT_PARAM_VALUE_TO_SUM()
final String
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_0()
Parameter keys used to specify additional information about item for EVENT_NAME_PRODUCT_CATALOG_UPDATE event. final String
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_1()
final String
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_2()
final String
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_3()
final String
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_4()
final String
getEVENT_PARAM_PRODUCT_CATEGORY()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IOS_URL()
Parameter keys used to specify the product deep links for EVENT_NAME_PRODUCT_CATALOG_UPDATE event. final String
getEVENT_PARAM_PRODUCT_APPLINK_IOS_APP_STORE_ID()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IOS_APP_NAME()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_URL()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_STORE_ID()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_NAME()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IPAD_URL()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_STORE_ID()
final String
getEVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_NAME()
final String
getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_URL()
final String
getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_PACKAGE()
final String
getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_APP_NAME()
final String
getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_URL()
final String
getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_ID()
final String
getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_NAME()
-
-
Method Detail
-
getEVENT_NAME_ACTIVATED_APP
final String getEVENT_NAME_ACTIVATED_APP()
Log this event when an app is being activated.
-
getEVENT_NAME_DEACTIVATED_APP
final String getEVENT_NAME_DEACTIVATED_APP()
-
getEVENT_NAME_SESSION_INTERRUPTIONS
final String getEVENT_NAME_SESSION_INTERRUPTIONS()
-
getEVENT_NAME_TIME_BETWEEN_SESSIONS
final String getEVENT_NAME_TIME_BETWEEN_SESSIONS()
-
getEVENT_NAME_COMPLETED_REGISTRATION
final String getEVENT_NAME_COMPLETED_REGISTRATION()
Log this event when the user has completed registration with the app.
-
getEVENT_NAME_VIEWED_CONTENT
final String getEVENT_NAME_VIEWED_CONTENT()
Log this event when the user has viewed a form of content in the app.
-
getEVENT_NAME_SEARCHED
final String getEVENT_NAME_SEARCHED()
Log this event when the user has performed a search within the app.
-
getEVENT_NAME_RATED
final String getEVENT_NAME_RATED()
Log this event when the user has rated an item in the app. The valueToSum passed to logEvent should be the numeric rating.
-
getEVENT_NAME_COMPLETED_TUTORIAL
final String getEVENT_NAME_COMPLETED_TUTORIAL()
Log this event when the user has completed a tutorial in the app.
-
getEVENT_NAME_PUSH_TOKEN_OBTAINED
final String getEVENT_NAME_PUSH_TOKEN_OBTAINED()
Log this event when the app obtained a push registration token from FCM.
-
getEVENT_NAME_ADDED_TO_CART
final String getEVENT_NAME_ADDED_TO_CART()
Log this event when the user has added an item to their cart. The valueToSum passed to logEvent should be the item's price.
-
getEVENT_NAME_ADDED_TO_WISHLIST
final String getEVENT_NAME_ADDED_TO_WISHLIST()
Log this event when the user has added an item to their wishlist. The valueToSum passed to logEvent should be the item's price.
-
getEVENT_NAME_INITIATED_CHECKOUT
final String getEVENT_NAME_INITIATED_CHECKOUT()
Log this event when the user has entered the checkout process. The valueToSum passed to logEvent should be the total price in the cart.
-
getEVENT_NAME_ADDED_PAYMENT_INFO
final String getEVENT_NAME_ADDED_PAYMENT_INFO()
Log this event when the user has entered their payment info.
-
getEVENT_NAME_PURCHASED
final String getEVENT_NAME_PURCHASED()
-
getEVENT_NAME_ACHIEVED_LEVEL
final String getEVENT_NAME_ACHIEVED_LEVEL()
Log this event when the user has achieved a level in the app.
-
getEVENT_NAME_UNLOCKED_ACHIEVEMENT
final String getEVENT_NAME_UNLOCKED_ACHIEVEMENT()
Log this event when the user has unlocked an achievement in the app.
-
getEVENT_NAME_SPENT_CREDITS
final String getEVENT_NAME_SPENT_CREDITS()
Log this event when the user has spent app credits. The valueToSum passed to logEvent should be the number of credits spent.
-
getEVENT_NAME_CONTACT
final String getEVENT_NAME_CONTACT()
A telephone/SMS, email, chat or other type of contact between a customer and your business.
-
getEVENT_NAME_CUSTOMIZE_PRODUCT
final String getEVENT_NAME_CUSTOMIZE_PRODUCT()
The customization of products through a configuration tool or other application your business owns.
-
getEVENT_NAME_DONATE
final String getEVENT_NAME_DONATE()
The donation of funds to your organization or cause.
-
getEVENT_NAME_FIND_LOCATION
final String getEVENT_NAME_FIND_LOCATION()
When a person finds one of your locations via web or application, with an intention to visit (example: find product at a local store).
-
getEVENT_NAME_SCHEDULE
final String getEVENT_NAME_SCHEDULE()
The booking of an appointment to visit one of your locations.
-
getEVENT_NAME_START_TRIAL
final String getEVENT_NAME_START_TRIAL()
The start of a free trial of a product or service you offer (example: trial subscription).
-
getEVENT_NAME_SUBMIT_APPLICATION
final String getEVENT_NAME_SUBMIT_APPLICATION()
The submission of an application for a product, service or program you offer (example: credit card, educational program or job).
-
getEVENT_NAME_SUBSCRIBE
final String getEVENT_NAME_SUBSCRIBE()
The start of a paid subscription for a product or service you offer.
-
getEVENT_NAME_AD_IMPRESSION
final String getEVENT_NAME_AD_IMPRESSION()
Log this event when the user views an ad.
-
getEVENT_NAME_AD_CLICK
final String getEVENT_NAME_AD_CLICK()
Log this event when the user clicks an ad.
-
getEVENT_NAME_LIVE_STREAMING_START
final String getEVENT_NAME_LIVE_STREAMING_START()
Log the live streaming events from sdk
-
getEVENT_NAME_LIVE_STREAMING_STOP
final String getEVENT_NAME_LIVE_STREAMING_STOP()
-
getEVENT_NAME_LIVE_STREAMING_PAUSE
final String getEVENT_NAME_LIVE_STREAMING_PAUSE()
-
getEVENT_NAME_LIVE_STREAMING_RESUME
final String getEVENT_NAME_LIVE_STREAMING_RESUME()
-
getEVENT_NAME_LIVE_STREAMING_ERROR
final String getEVENT_NAME_LIVE_STREAMING_ERROR()
-
getEVENT_NAME_LIVE_STREAMING_UPDATE_STATUS
final String getEVENT_NAME_LIVE_STREAMING_UPDATE_STATUS()
-
getEVENT_NAME_PRODUCT_CATALOG_UPDATE
final String getEVENT_NAME_PRODUCT_CATALOG_UPDATE()
Product Catalog related events
-
getEVENT_PARAM_LIVE_STREAMING_PREV_STATUS
final String getEVENT_PARAM_LIVE_STREAMING_PREV_STATUS()
Paramete keys for live streaming events
-
getEVENT_PARAM_LIVE_STREAMING_STATUS
final String getEVENT_PARAM_LIVE_STREAMING_STATUS()
-
getEVENT_PARAM_LIVE_STREAMING_ERROR
final String getEVENT_PARAM_LIVE_STREAMING_ERROR()
-
getEVENT_PARAM_CURRENCY
final String getEVENT_PARAM_CURRENCY()
Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See ISO-4217 for specific values.
-
getEVENT_PARAM_REGISTRATION_METHOD
final String getEVENT_PARAM_REGISTRATION_METHOD()
Parameter key used to specify the method the user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc.
-
getEVENT_PARAM_CONTENT_TYPE
final String getEVENT_PARAM_CONTENT_TYPE()
Parameter key used to specify a generic content type/family for the logged event, e.g. "music", "photo", "video". Options to use will vary depending on the nature of the app.
-
getEVENT_PARAM_CONTENT
final String getEVENT_PARAM_CONTENT()
Parameter key used to specify data for the one or more pieces of content being logged about. Data should be a JSON encoded string. Example: "{\"id\": \"1234\", \"quantity\": 2, \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}"
-
getEVENT_PARAM_CONTENT_ID
final String getEVENT_PARAM_CONTENT_ID()
Parameter key used to specify an ID for the specific piece of content being logged about. This could be an EAN, article identifier, etc., depending on the nature of the app.
-
getEVENT_PARAM_SEARCH_STRING
final String getEVENT_PARAM_SEARCH_STRING()
Parameter key used to specify the string provided by the user for a search operation.
-
getEVENT_PARAM_SUCCESS
final String getEVENT_PARAM_SUCCESS()
Parameter key used to specify whether the activity being logged about was successful or not. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this parameter.
-
getEVENT_PARAM_MAX_RATING_VALUE
final String getEVENT_PARAM_MAX_RATING_VALUE()
Parameter key used to specify the maximum rating available for the EVENT_NAME_RATE event. E.g., "5" or "10".
-
getEVENT_PARAM_PAYMENT_INFO_AVAILABLE
final String getEVENT_PARAM_PAYMENT_INFO_AVAILABLE()
Parameter key used to specify whether payment info is available for the EVENT_NAME_INITIATED_CHECKOUT event. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this parameter.
-
getEVENT_PARAM_NUM_ITEMS
final String getEVENT_PARAM_NUM_ITEMS()
Parameter key used to specify how many items are being processed for an EVENT_NAME_INITIATED_CHECKOUT or EVENT_NAME_PURCHASE event.
-
getEVENT_PARAM_LEVEL
final String getEVENT_PARAM_LEVEL()
Parameter key used to specify the level achieved in an EVENT_NAME_LEVEL_ACHIEVED event.
-
getEVENT_PARAM_DESCRIPTION
final String getEVENT_PARAM_DESCRIPTION()
Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the EVENT_NAME_ACHIEVEMENT_UNLOCKED event.
-
getEVENT_PARAM_SOURCE_APPLICATION
final String getEVENT_PARAM_SOURCE_APPLICATION()
Parameter key used to specify source application package.
-
getEVENT_PARAM_PACKAGE_FP
final String getEVENT_PARAM_PACKAGE_FP()
Parameter key used to specify package fingerprint.
-
getEVENT_PARAM_APP_CERT_HASH
final String getEVENT_PARAM_APP_CERT_HASH()
Parameter key used to specify hashed cert for signing the apk.
-
getEVENT_PARAM_VALUE_YES
final String getEVENT_PARAM_VALUE_YES()
Yes-valued parameter value to be used with parameter keys that need a Yes/No value
-
getEVENT_PARAM_VALUE_NO
final String getEVENT_PARAM_VALUE_NO()
No-valued parameter value to be used with parameter keys that need a Yes/No value
-
getEVENT_PARAM_AD_TYPE
final String getEVENT_PARAM_AD_TYPE()
Parameter key used to specify the type of ad in an EVENT_NAME_AD_IMPRESSION or EVENT_NAME_AD_CLICK event. E.g. "banner", "interstitial", "rewarded_video", "native"
-
getEVENT_PARAM_ORDER_ID
final String getEVENT_PARAM_ORDER_ID()
Parameter key used to specify the unique ID for all events within a subscription in an EVENT_NAME_SUBSCRIBE or EVENT_NAME_START_TRIAL event.
-
getEVENT_PARAM_VALUE_TO_SUM
final String getEVENT_PARAM_VALUE_TO_SUM()
-
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_0
final String getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_0()
Parameter keys used to specify additional information about item for EVENT_NAME_PRODUCT_CATALOG_UPDATE event.
-
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_1
final String getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_1()
-
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_2
final String getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_2()
-
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_3
final String getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_3()
-
getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_4
final String getEVENT_PARAM_PRODUCT_CUSTOM_LABEL_4()
-
getEVENT_PARAM_PRODUCT_CATEGORY
final String getEVENT_PARAM_PRODUCT_CATEGORY()
-
getEVENT_PARAM_PRODUCT_APPLINK_IOS_URL
final String getEVENT_PARAM_PRODUCT_APPLINK_IOS_URL()
Parameter keys used to specify the product deep links for EVENT_NAME_PRODUCT_CATALOG_UPDATE event.
-
getEVENT_PARAM_PRODUCT_APPLINK_IOS_APP_STORE_ID
final String getEVENT_PARAM_PRODUCT_APPLINK_IOS_APP_STORE_ID()
-
getEVENT_PARAM_PRODUCT_APPLINK_IOS_APP_NAME
final String getEVENT_PARAM_PRODUCT_APPLINK_IOS_APP_NAME()
-
getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_URL
final String getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_URL()
-
getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_STORE_ID
final String getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_STORE_ID()
-
getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_NAME
final String getEVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_NAME()
-
getEVENT_PARAM_PRODUCT_APPLINK_IPAD_URL
final String getEVENT_PARAM_PRODUCT_APPLINK_IPAD_URL()
-
getEVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_STORE_ID
final String getEVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_STORE_ID()
-
getEVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_NAME
final String getEVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_NAME()
-
getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_URL
final String getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_URL()
-
getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_PACKAGE
final String getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_PACKAGE()
-
getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_APP_NAME
final String getEVENT_PARAM_PRODUCT_APPLINK_ANDROID_APP_NAME()
-
getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_URL
final String getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_URL()
-
getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_ID
final String getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_ID()
-
getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_NAME
final String getEVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_NAME()
-
-
-
-