Analytics Events

Predefined event names.

Summary

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 40 characters long, may only contain alphanumeric characters and underscores ("_"), and must start with an alphabetic character. The "firebase_", "google_", and "ga_" prefixes are reserved and should not be used.

Variables
`EventAdImpression = "ad_impression"`	`string` Ad Impression event.
`EventAddPaymentInfo = "add_payment_info"`	`string` Add Payment Info event.
`EventAddShippingInfo = "add_shipping_info"`	`string` Add Shipping Info event.
`EventAddToCart = "add_to_cart"`	`string` E-Commerce Add To Cart event.
`EventAddToWishlist = "add_to_wishlist"`	`string` E-Commerce Add To Wishlist event.
`EventAppOpen = "app_open"`	`string` App Open event.
`EventBeginCheckout = "begin_checkout"`	`string` E-Commerce Begin Checkout event.
`EventCampaignDetails = "campaign_details"`	`string` Campaign Detail event.
`EventEarnVirtualCurrency = "earn_virtual_currency"`	`string` Earn Virtual Currency event.
`EventGenerateLead = "generate_lead"`	`string` Generate Lead event.
`EventJoinGroup = "join_group"`	`string` Join Group event.
`EventLevelEnd = "level_end"`	`string` Level End event.
`EventLevelStart = "level_start"`	`string` Level Start event.
`EventLevelUp = "level_up"`	`string` Level Up event.
`EventLogin = "login"`	`string` Login event.
`EventPostScore = "post_score"`	`string` Post Score event.
`EventPurchase = "purchase"`	`string` E-Commerce Purchase event.
`EventRefund = "refund"`	`string` E-Commerce Refund event.
`EventRemoveFromCart = "remove_from_cart"`	`string` E-Commerce Remove from Cart event.
`EventScreenView = "screen_view"`	`string` Screen View event.
`EventSearch = "search"`	`string` Search event.
`EventSelectContent = "select_content"`	`string` Select Content event.
`EventSelectItem = "select_item"`	`string` Select Item event.
`EventSelectPromotion = "select_promotion"`	`string` Select promotion event.
`EventShare = "share"`	`string` Share event.
`EventSignUp = "sign_up"`	`string` Sign Up event.
`EventSpendVirtualCurrency = "spend_virtual_currency"`	`string` Spend Virtual Currency event.
`EventTutorialBegin = "tutorial_begin"`	`string` Tutorial Begin event.
`EventTutorialComplete = "tutorial_complete"`	`string` Tutorial End event.
`EventUnlockAchievement = "unlock_achievement"`	`string` Unlock Achievement event.
`EventViewCart = "view_cart"`	`string` E-commerce View Cart event.
`EventViewItem = "view_item"`	`string` View Item event.
`EventViewItemList = "view_item_list"`	`string` View Item List event.
`EventViewPromotion = "view_promotion"`	`string` View Promotion event.
`EventViewSearchResults = "view_search_results"`	`string` View Search Results event.

Variables

EventAdImpression

string EventAdImpression =
    "ad_impression"

Ad Impression event.

This event signifies when a user sees an ad impression. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterAdPlatform (String) (optional)
AnalyticsParameterAdFormat (String) (optional)
AnalyticsParameterAdSource (String) (optional)
AnalyticsParameterAdUnitName (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterValue (Double) (optional)

EventAddPaymentInfo

string EventAddPaymentInfo =
    "add_payment_info"

Add Payment Info event.

This event signifies that a user has submitted their payment information. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterPaymentType (String) (optional)
AnalyticsParameterValue (Double) (optional)

EventAddShippingInfo

string EventAddShippingInfo =
    "add_shipping_info"

Add Shipping Info event.

This event signifies that a user has submitted their shipping information. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterShippingTier (String) (optional)
AnalyticsParameterValue (Double) (optional)

EventAddToCart

string EventAddToCart = "add_to_cart"

E-Commerce Add To Cart event.

This event signifies that an item(s) was added to a cart for purchase. Add this event to a funnel with AnalyticsEventPurchase to gauge the effectiveness of your checParameter(kout, If you supply the AnalyticsParameterValue parameter), you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

EventAddToWishlist

string EventAddToWishlist =
    "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. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

EventAppOpen

string EventAppOpen = "app_open"

App Open event.

By logging this event when an App becomes active, 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.

EventBeginCheckout

string EventBeginCheckout =
    "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 AnalyticsEventPurchase event to gauge the effectiveness of your checkout process. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

EventCampaignDetails

string EventCampaignDetails =
    "campaign_details"

Campaign Detail event.

Log this event to supply the referral details of a re-engagement campaign. Note: you must supply at least one of the required parameters AnalyticsParameterSource, AnalyticsParameterMedium or AnalyticsParameterCampaign. Params:

AnalyticsParameterSource (String)
AnalyticsParameterMedium (String)
AnalyticsParameterCampaign (String)
AnalyticsParameterTerm (String) (optional)
AnalyticsParameterContent (String) (optional)
AnalyticsParameterAdNetworkClickID (String) (optional)
AnalyticsParameterCP1 (String) (optional)
AnalyticsParameterCampaignID (String) (optional)
AnalyticsParameterCreativeFormat (String) (optional)
AnalyticsParameterMarketingTactic (String) (optional)
AnalyticsParameterSourcePlatform (String) (optional)

EventEarnVirtualCurrency

string EventEarnVirtualCurrency = "earn_virtual_currency"

Earn Virtual Currency event.

This event tracks the awarding of virtual currency in your app. Log this along with AnalyticsEventSpendVirtualCurrency to better understand your virtual economy. Params:

AnalyticsParameterVirtualCurrencyName (String)
AnalyticsParameterValue (Int or Double)

EventGenerateLead

string EventGenerateLead =
    "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 AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterValue (Double) (optional)

EventJoinGroup

string EventJoinGroup = "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:

AnalyticsParameterGroupID (String)

EventLevelEnd

string EventLevelEnd = "level_end"

Level End event.

Log this event when the user finishes a level. Params:

AnalyticsParameterLevelName (String)
AnalyticsParameterSuccess (String)

EventLevelStart

string EventLevelStart = "level_start"

Level Start event.

Log this event when the user starts a new level. Params:

AnalyticsParameterLevelName (String)

EventLevelUp

string EventLevelUp = "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:

AnalyticsParameterLevel (Int)
AnalyticsParameterCharacter (String) (optional)

EventLogin

string EventLogin = "login"

Apps with a login feature can report this event to signify that a user has logged in.

EventPostScore

string EventPostScore = "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:

AnalyticsParameterScore (Int)
AnalyticsParameterLevel (Int) (optional)
AnalyticsParameterCharacter (String) (optional)

EventPurchase

string EventPurchase = "purchase"

E-Commerce Purchase event.

This event signifies that an item(s) was purchased by a user. Note: This is different from the in-app purchase event, which is reported automatically for App Store-based apps. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterAffiliation (String) (optional)
AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterEndDate (String) (optional)
AnalyticsParameterItemID (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterShipping (Double) (optional)
AnalyticsParameterStartDate (String) (optional)
AnalyticsParameterTax (Double) (optional)
AnalyticsParameterTransactionID (String) (optional)
AnalyticsParameterValue (Double) (optional)

EventRefund

string EventRefund = "refund"

E-Commerce Refund event.

This event signifies that a refund was issued. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterAffiliation (String) (optional)
AnalyticsParameterCoupon (String) (optional)
AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterShipping (Double) (optional)
AnalyticsParameterTax (Double) (optional)
AnalyticsParameterTransactionID (String) (optional)
AnalyticsParameterValue (Double) (optional)

EventRemoveFromCart

string EventRemoveFromCart =
    "remove_from_cart"

E-Commerce Remove from Cart event.

This event signifies that an item(s) was removed from a cart. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

EventScreenView

string EventScreenView = "screen_view"

Screen View event.

This event signifies a screen view. Use this when a screen transition occurs. This event can be logged irrespective of whether automatic screen tracking is enabled. Params:

AnalyticsParameterScreenClass (String) (optional)
AnalyticsParameterScreenName (String) (optional)

EventSearch

string EventSearch = "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:

AnalyticsParameterSearchTerm (String)
AnalyticsParameterStartDate (String) (optional)
AnalyticsParameterEndDate (String) (optional)
AnalyticsParameterNumberOfNights (Int) (optional) for hotel bookings
AnalyticsParameterNumberOfRooms (Int) (optional) for hotel bookings
AnalyticsParameterNumberOfPassengers (Int) (optional) for travel bookings
AnalyticsParameterOrigin (String) (optional)
AnalyticsParameterDestination (String) (optional)
AnalyticsParameterTravelClass (String) (optional) for travel bookings

EventSelectContent

string EventSelectContent =
    "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:

AnalyticsParameterContentType (String)
AnalyticsParameterItemID (String)

EventSelectItem

string EventSelectItem = "select_item"

Select Item event.

This event signifies that an item was selected by a user from a list. Use the appropriate parameters to contextualize the event. Use this event to discover the most popular items selected. Params:

AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterItemListID (String) (optional)
AnalyticsParameterItemListName (String) (optional)

EventSelectPromotion

string EventSelectPromotion =
    "select_promotion"

Select promotion event.

This event signifies that a user has selected a promotion offer. Use the appropriate parameters to contextualize the event, such as the item(s) for which the promotion applies. Params:

AnalyticsParameterCreativeName (String) (optional)
AnalyticsParameterCreativeSlot (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterLocationID (String) (optional)
AnalyticsParameterPromotionID (String) (optional)
AnalyticsParameterPromotionName (String) (optional)

EventShare

string EventShare = "share"

Share event.

Apps with social features can log the Share event to identify the most viral content. Params:

AnalyticsParameterContentType (String)
AnalyticsParameterItemID (String)

EventSignUp

string EventSignUp = "sign_up"

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:

AnalyticsParameterMethod (String)

EventSpendVirtualCurrency

string EventSpendVirtualCurrency = "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:

AnalyticsParameterItemName (String)
AnalyticsParameterVirtualCurrencyName (String)
AnalyticsParameterValue (Int or Double)

EventTutorialBegin

string EventTutorialBegin =
    "tutorial_begin"

Tutorial Begin event.

This event signifies the start of the on-boarding process in your app. Use this in a funnel with AnalyticsEventTutorialComplete to understand how many users complete this process and move on to the full app experience.

EventTutorialComplete

string EventTutorialComplete =
    "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 AnalyticsEventTutorialBegin to gauge the completion rate of your on-boarding process.

EventUnlockAchievement

string EventUnlockAchievement =
    "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:

AnalyticsParameterAchievementID (String)

EventViewCart

string EventViewCart = "view_cart"

E-commerce View Cart event.

This event signifies that a user has viewed their cart. Use this to analyze your purchase funnel. Note: If you supply the AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

EventViewItem

string EventViewItem = "view_item"

View Item event.

This event signifies that a user has viewed an item. 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 AnalyticsParameterValue parameter, you must also supply the AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:

AnalyticsParameterCurrency (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterValue (Double) (optional)

EventViewItemList

string EventViewItemList =
    "view_item_list"

View Item List event.

Log this event when a user sees a list of items or offerings. Params:

AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterItemListID (String) (optional)
AnalyticsParameterItemListName (String) (optional)

EventViewPromotion

string EventViewPromotion =
    "view_promotion"

View Promotion event.

This event signifies that a promotion was shown to a user. Add this event to a funnel with the AnalyticsEventAddToCart and AnalyticsEventPurchase to gauge your conversion process. Params:

AnalyticsParameterCreativeName (String) (optional)
AnalyticsParameterCreativeSlot (String) (optional)
AnalyticsParameterItems ([[String: Any]]) (optional)
AnalyticsParameterLocationID (String) (optional)
AnalyticsParameterPromotionID (String) (optional)
AnalyticsParameterPromotionName (String) (optional)

EventViewSearchResults

string EventViewSearchResults =
    "view_search_results"

View Search Results event.

Log this event when the user has been presented with the results of a search. Params:

AnalyticsParameterSearchTerm (String)