Package | com.myflashlab.air.extensions.firebase.analytics |
Class | public class AnalyticsEvent |
Inheritance | AnalyticsEvent Object |
An Event is an important occurrence in your app that you want to measure. You can report up to 500 different types of Events per app and you can associate up to 25 unique parameters with each Event type. Some common events are suggested below, but you may also choose to specify custom Event types that are associated with your specific app. Each event type is identified by a unique name. Event names can be up to 32 characters long, may only contain alphanumeric characters and underscores ("_"), and must start with an alphabetic character. The "firebase_" prefix is reserved and should not be used.
The following event names are reserved and cannot be used:
Constant | Defined By | ||
---|---|---|---|
ADD_PAYMENT_INFO : String = add_payment_info [static]
Add Payment Info event. | AnalyticsEvent | ||
ADD_TO_CART : String = add_to_cart [static]
E-Commerce Add To Cart event. | AnalyticsEvent | ||
ADD_TO_WISHLIST : String = add_to_wishlist [static]
E-Commerce Add To Wishlist event. | AnalyticsEvent | ||
APP_OPEN : String = app_open [static]
App Open event. | AnalyticsEvent | ||
BEGIN_CHECKOUT : String = begin_checkout [static]
E-Commerce Begin Checkout event. | AnalyticsEvent | ||
CAMPAIGN_DETAILS : String = campaign_details [static]
Log this event to supply the referral details of a re-engagement campaign. | AnalyticsEvent | ||
CHECKOUT_PROGRESS : String = checkout_progress [static]
Checkout progress. | AnalyticsEvent | ||
EARN_VIRTUAL_CURRENCY : String = earn_virtual_currency [static]
Earn Virtual Currency event. | AnalyticsEvent | ||
ECOMMERCE_PURCHASE : String = ecommerce_purchase [static]
E-Commerce Purchase event. | AnalyticsEvent | ||
GENERATE_LEAD : String = generate_lead [static]
Generate Lead event. | AnalyticsEvent | ||
JOIN_GROUP : String = join_group [static]
Join Group event. | AnalyticsEvent | ||
LEVEL_END : String = level_end [static]
Level End event. | AnalyticsEvent | ||
LEVEL_START : String = level_start [static]
Level Start event. | AnalyticsEvent | ||
LEVEL_UP : String = level_up [static]
Level Up event. | AnalyticsEvent | ||
LOGIN : String = login [static] Login event. | AnalyticsEvent | ||
POST_SCORE : String = post_score [static]
Post Score event. | AnalyticsEvent | ||
PRESENT_OFFER : String = present_offer [static]
Present Offer event. | AnalyticsEvent | ||
PURCHASE_REFUND : String = purchase_refund [static]
E-Commerce Purchase Refund event. | AnalyticsEvent | ||
REMOVE_FROM_CART : String = remove_from_cart [static]
Remove from cart event. | AnalyticsEvent | ||
SEARCH : String = search [static]
Search event. | AnalyticsEvent | ||
SELECT_CONTENT : String = select_content [static]
Select Content event. | AnalyticsEvent | ||
SET_CHECKOUT_OPTION : String = set_checkout_option [static]
Set checkout option. | AnalyticsEvent | ||
SHARE : String = share [static]
Share event. | AnalyticsEvent | ||
SIGN_UP : String = sign_up [static]
Sign Up event. | AnalyticsEvent | ||
SPEND_VIRTUAL_CURRENCY : String = spend_virtual_currency [static]
Spend Virtual Currency event. | AnalyticsEvent | ||
TUTORIAL_BEGIN : String = tutorial_begin [static] Tutorial Begin event. | AnalyticsEvent | ||
TUTORIAL_COMPLETE : String = tutorial_complete [static] Tutorial End event. | AnalyticsEvent | ||
UNLOCK_ACHIEVEMENT : String = unlock_achievement [static]
Unlock Achievement event. | AnalyticsEvent | ||
VIEW_ITEM : String = view_item [static]
View Item event. | AnalyticsEvent | ||
VIEW_ITEM_LIST : String = view_item_list [static]
View Item List event. | AnalyticsEvent | ||
VIEW_SEARCH_RESULTS : String = view_search_results [static]
View Search Results event. | AnalyticsEvent |
ADD_PAYMENT_INFO | Constant |
public static const ADD_PAYMENT_INFO:String = add_payment_info
Add Payment Info event. This event signifies that a user has submitted their payment information to your app.
ADD_TO_CART | Constant |
public static const ADD_TO_CART:String = add_to_cart
E-Commerce Add To Cart event. This event signifies that an item was added to a cart for purchase. Add this
event to a funnel with ECOMMERCE_PURCHASE
to gauge the effectiveness of your checkout
process. Note: If you supply the VALUE parameter, you must also supply the CURRENCY
parameter
so that revenue metrics can be computed accurately. Params:
ADD_TO_WISHLIST | Constant |
public static const ADD_TO_WISHLIST:String = add_to_wishlist
E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist. Use this event
to identify popular gift items in your app. Note: If you supply the VALUE parameter, you must also supply
the CURRENCY
parameter so that revenue metrics can be computed accurately. Params:
APP_OPEN | Constant |
public static const APP_OPEN:String = app_open
App Open event. By logging this event when an App is moved to the foreground, developers can understand how often users leave and return during the course of a Session. Although Sessions are automatically reported, this event can provide further clarification around the continuous engagement of app-users.
BEGIN_CHECKOUT | Constant |
public static const BEGIN_CHECKOUT:String = begin_checkout
E-Commerce Begin Checkout event. This event signifies that a user has begun the process of checking out.
Add this event to a funnel with your ECOMMERCE_PURCHASE
event to gauge the effectiveness of
your checkout process. Note: If you supply the VALUE parameter, you must also supply the
CURRENCY
parameter so that revenue metrics can be computed accurately. Params:
CAMPAIGN_DETAILS | Constant |
public static const CAMPAIGN_DETAILS:String = campaign_details
Log this event to supply the referral details of a re-engagement campaign. Params:
CHECKOUT_PROGRESS | Constant |
public static const CHECKOUT_PROGRESS:String = checkout_progress
Checkout progress.
EARN_VIRTUAL_CURRENCY | Constant |
public static const EARN_VIRTUAL_CURRENCY:String = earn_virtual_currency
Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log this along with SPEND_VIRTUAL_CURRENCY to better understand your virtual economy. Params:
ECOMMERCE_PURCHASE | Constant |
public static const ECOMMERCE_PURCHASE:String = ecommerce_purchase
E-Commerce Purchase event. This event signifies that an item was purchased by a user. Note: This is different from the in-app purchase
event, which is reported automatically for Google Play-based apps. Note: If you supply the VALUE parameter, you must also supply the
CURRENCY
parameter so that revenue metrics can be computed accurately. Params:
GENERATE_LEAD | Constant |
public static const GENERATE_LEAD:String = generate_lead
Generate Lead event. Log this event when a lead has been generated in the app to understand the efficacy of your install and
re-engagement campaigns. Note: If you supply the VALUE parameter, you must also supply the CURRENCY
parameter so
that revenue metrics can be computed accurately. Params:
JOIN_GROUP | Constant |
public static const JOIN_GROUP:String = join_group
Join Group event. Log this event when a user joins a group such as a guild, team or family. Use this event to analyze how popular certain groups or social features are in your app. Params:
LEVEL_END | Constant |
public static const LEVEL_END:String = level_end
Level End event. Params:
LEVEL_START | Constant |
public static const LEVEL_START:String = level_start
Level Start event. Params:
LEVEL_UP | Constant |
public static const LEVEL_UP:String = level_up
Level Up event. This event signifies that a player has leveled up in your gaming app. It can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass. Params:
LOGIN | Constant |
public static const LOGIN:String = login
Login event. Apps with a login feature can report this event to signify that a user has logged in.
POST_SCORE | Constant |
public static const POST_SCORE:String = post_score
Post Score event. Log this event when the user posts a score in your gaming app. This event can help you understand how users are actually performing in your game and it can help you correlate high scores with certain audiences or behaviors. Params:
PRESENT_OFFER | Constant |
public static const PRESENT_OFFER:String = present_offer
Present Offer event. This event signifies that the app has presented a purchase offer to a user. Add this event to a funnel with
the ADD_TO_CART and ECOMMERCE_PURCHASE
to gauge your conversion process. Note: If you supply the VALUE parameter,
you must also supply the CURRENCY
parameter so that revenue metrics can be computed accurately. Params:
PURCHASE_REFUND | Constant |
public static const PURCHASE_REFUND:String = purchase_refund
E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded. Note: If you supply the VALUE parameter,
you must also supply the CURRENCY
parameter so that revenue metrics can be computed accurately. Params:
REMOVE_FROM_CART | Constant |
public static const REMOVE_FROM_CART:String = remove_from_cart
Remove from cart event.
SEARCH | Constant |
public static const SEARCH:String = search
Search event. Apps that support search features can use this event to contextualize search operations by supplying the appropriate, corresponding parameters. This event can help you identify the most popular content in your app. Params:
SELECT_CONTENT | Constant |
public static const SELECT_CONTENT:String = select_content
Select Content event. This general purpose event signifies that a user has selected some content of a certain type in an app. The content can be any object in your app. This event can help you identify popular content and categories of content in your app. Params:
SET_CHECKOUT_OPTION | Constant |
public static const SET_CHECKOUT_OPTION:String = set_checkout_option
Set checkout option.
SHARE | Constant |
public static const SHARE:String = share
Share event. Apps with social features can log the Share event to identify the most viral content. Params:
SIGN_UP | Constant |
public static const SIGN_UP:String = sign_up
Sign Up event. This event indicates that a user has signed up for an account in your app. The parameter signifies the method by which the user signed up. Use this event to understand the different behaviors between logged in and logged out users. Params:
SPEND_VIRTUAL_CURRENCY | Constant |
public static const SPEND_VIRTUAL_CURRENCY:String = spend_virtual_currency
Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can help you identify which virtual goods are the most popular objects of purchase. Params:
TUTORIAL_BEGIN | Constant |
public static const TUTORIAL_BEGIN:String = tutorial_begin
Tutorial Begin event. This event signifies the start of the on-boarding process in your app. Use this in a funnel with TUTORIAL_COMPLETE
to understand how many users complete this process and move on to the full app experience.
TUTORIAL_COMPLETE | Constant |
public static const TUTORIAL_COMPLETE:String = tutorial_complete
Tutorial End event. Use this event to signify the user’s completion of your app’s on-boarding process. Add this to a funnel with TUTORIAL_BEGIN
to gauge the completion rate of your on-boarding process.
UNLOCK_ACHIEVEMENT | Constant |
public static const UNLOCK_ACHIEVEMENT:String = unlock_achievement
Unlock Achievement event. Log this event when the user has unlocked an achievement in your game. Since achievements generally represent the breadth of a gaming experience, this event can help you understand how many users are experiencing all that your game has to offer. Params:
VIEW_ITEM | Constant |
public static const VIEW_ITEM:String = view_item
View Item event. This event signifies that some content was shown to the user. This content may be a product, a webpage or just
a simple image or text. Use the appropriate parameters to contextualize the event. Use this event to discover the most popular
items viewed in your app. Note: If you supply the VALUE parameter, you must also supply the CURRENCY
parameter so that revenue
metrics can be computed accurately. Params:
VIEW_ITEM_LIST | Constant |
public static const VIEW_ITEM_LIST:String = view_item_list
View Item List event. Log this event when the user has been presented with a list of items of a certain category. Params:
VIEW_SEARCH_RESULTS | Constant |
public static const VIEW_SEARCH_RESULTS:String = view_search_results
View Search Results event. Log this event when the user has been presented with the results of a search. Params: