/// @file FIREventNames.h /// /// Predefined event names. /// /// 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. #import /// Add Payment Info event. This event signifies that a user has submitted their payment /// information. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: /// /// static NSString *const kFIREventAddPaymentInfo NS_SWIFT_NAME(AnalyticsEventAddPaymentInfo) = @"add_payment_info"; /// 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 @c kFIREventPurchase to gauge the effectiveness of /// your checkout process. Note: If you supply the @c kFIRParameterValue parameter, you must also /// supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed /// accurately. Params: /// /// static NSString *const kFIREventAddToCart NS_SWIFT_NAME(AnalyticsEventAddToCart) = @"add_to_cart"; /// 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 @c kFIRParameterValue /// parameter, you must also supply the @c kFIRParameterCurrency parameter so that revenue metrics /// can be computed accurately. Params: /// /// static NSString *const kFIREventAddToWishlist NS_SWIFT_NAME(AnalyticsEventAddToWishlist) = @"add_to_wishlist"; /// 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. static NSString *const kFIREventAppOpen NS_SWIFT_NAME(AnalyticsEventAppOpen) = @"app_open"; /// 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 @c kFIREventPurchase event to gauge the /// effectiveness of your checkout process. Note: If you supply the @c kFIRParameterValue parameter, /// you must also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be /// computed accurately. Params: /// /// static NSString *const kFIREventBeginCheckout NS_SWIFT_NAME(AnalyticsEventBeginCheckout) = @"begin_checkout"; /// 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 kFIRParameterSource, /// kFIRParameterMedium or kFIRParameterCampaign. Params: /// /// static NSString *const kFIREventCampaignDetails NS_SWIFT_NAME(AnalyticsEventCampaignDetails) = @"campaign_details"; /// Checkout progress. Params: /// /// /// This constant has been deprecated. static NSString *const kFIREventCheckoutProgress NS_SWIFT_NAME(AnalyticsEventCheckoutProgress) = @"checkout_progress"; /// Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log /// this along with @c kFIREventSpendVirtualCurrency to better understand your virtual economy. /// Params: /// /// static NSString *const kFIREventEarnVirtualCurrency NS_SWIFT_NAME(AnalyticsEventEarnVirtualCurrency) = @"earn_virtual_currency"; /// 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 App /// Store-based apps. Note: If you supply the @c kFIRParameterValue parameter, you must also /// supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed /// accurately. Params: /// /// /// This constant has been deprecated. Use @c kFIREventPurchase constant instead. static NSString *const kFIREventEcommercePurchase NS_SWIFT_NAME(AnalyticsEventEcommercePurchase) = @"ecommerce_purchase"; /// 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 /// @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency /// parameter so that revenue metrics can be computed accurately. Params: /// /// static NSString *const kFIREventGenerateLead NS_SWIFT_NAME(AnalyticsEventGenerateLead) = @"generate_lead"; /// 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: /// /// static NSString *const kFIREventJoinGroup NS_SWIFT_NAME(AnalyticsEventJoinGroup) = @"join_group"; /// Level End event. Log this event when the user finishes a level. Params: /// /// static NSString *const kFIREventLevelEnd NS_SWIFT_NAME(AnalyticsEventLevelEnd) = @"level_end"; /// Level Start event. Log this event when the user starts a new level. Params: /// /// static NSString *const kFIREventLevelStart NS_SWIFT_NAME(AnalyticsEventLevelStart) = @"level_start"; /// 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: /// /// static NSString *const kFIREventLevelUp NS_SWIFT_NAME(AnalyticsEventLevelUp) = @"level_up"; /// Login event. Apps with a login feature can report this event to signify that a user has logged /// in. static NSString *const kFIREventLogin NS_SWIFT_NAME(AnalyticsEventLogin) = @"login"; /// 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: /// /// static NSString *const kFIREventPostScore NS_SWIFT_NAME(AnalyticsEventPostScore) = @"post_score"; /// 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 kFIREventAddToCart and kFIREventEcommercePurchase to gauge /// your conversion process. Note: If you supply the @c kFIRParameterValue parameter, you must /// also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed /// accurately. Params: /// /// /// This constant has been deprecated. Use @c kFIREventViewPromotion constant instead. static NSString *const kFIREventPresentOffer NS_SWIFT_NAME(AnalyticsEventPresentOffer) = @"present_offer"; /// E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded. /// Note: If you supply the @c kFIRParameterValue parameter, you must also supply the /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. /// Params: /// /// /// This constant has been deprecated. Use @c kFIREventRefund constant instead. static NSString *const kFIREventPurchaseRefund NS_SWIFT_NAME(AnalyticsEventPurchaseRefund) = @"purchase_refund"; /// E-Commerce Remove from Cart event. This event signifies that an item(s) was removed from a cart. /// Note: If you supply the @c kFIRParameterValue parameter, you must also supply the @c /// kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: /// /// static NSString *const kFIREventRemoveFromCart NS_SWIFT_NAME(AnalyticsEventRemoveFromCart) = @"remove_from_cart"; /// 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: /// /// static NSString *const kFIREventScreenView NS_SWIFT_NAME(AnalyticsEventScreenView) = @"screen_view"; /// 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: /// /// static NSString *const kFIREventSearch NS_SWIFT_NAME(AnalyticsEventSearch) = @"search"; /// 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: /// /// static NSString *const kFIREventSelectContent NS_SWIFT_NAME(AnalyticsEventSelectContent) = @"select_content"; /// Set checkout option. Params: /// /// /// This constant has been deprecated. static NSString *const kFIREventSetCheckoutOption NS_SWIFT_NAME(AnalyticsEventSetCheckoutOption) = @"set_checkout_option"; /// Share event. Apps with social features can log the Share event to identify the most viral /// content. Params: /// /// static NSString *const kFIREventShare NS_SWIFT_NAME(AnalyticsEventShare) = @"share"; /// 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: /// /// static NSString *const kFIREventSignUp NS_SWIFT_NAME(AnalyticsEventSignUp) = @"sign_up"; /// 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: /// /// static NSString *const kFIREventSpendVirtualCurrency NS_SWIFT_NAME(AnalyticsEventSpendVirtualCurrency) = @"spend_virtual_currency"; /// Tutorial Begin event. This event signifies the start of the on-boarding process in your app. Use /// this in a funnel with kFIREventTutorialComplete to understand how many users complete this /// process and move on to the full app experience. static NSString *const kFIREventTutorialBegin NS_SWIFT_NAME(AnalyticsEventTutorialBegin) = @"tutorial_begin"; /// 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 kFIREventTutorialBegin to gauge the completion rate of your /// on-boarding process. static NSString *const kFIREventTutorialComplete NS_SWIFT_NAME(AnalyticsEventTutorialComplete) = @"tutorial_complete"; /// 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: /// /// static NSString *const kFIREventUnlockAchievement NS_SWIFT_NAME(AnalyticsEventUnlockAchievement) = @"unlock_achievement"; /// 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 @c kFIRParameterValue parameter, you must also supply the /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: /// /// static NSString *const kFIREventViewItem NS_SWIFT_NAME(AnalyticsEventViewItem) = @"view_item"; /// View Item List event. Log this event when a user sees a list of items or offerings. Params: /// /// static NSString *const kFIREventViewItemList NS_SWIFT_NAME(AnalyticsEventViewItemList) = @"view_item_list"; /// View Search Results event. Log this event when the user has been presented with the results of a /// search. Params: /// /// static NSString *const kFIREventViewSearchResults NS_SWIFT_NAME(AnalyticsEventViewSearchResults) = @"view_search_results"; /// Add Shipping Info event. This event signifies that a user has submitted their shipping /// information. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: /// /// static NSString *const kFIREventAddShippingInfo NS_SWIFT_NAME(AnalyticsEventAddShippingInfo) = @"add_shipping_info"; /// 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 @c kFIRParameterValue parameter, you must also supply /// the @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. /// Params: /// /// static NSString *const kFIREventPurchase NS_SWIFT_NAME(AnalyticsEventPurchase) = @"purchase"; /// E-Commerce Refund event. This event signifies that a refund was issued. Note: If you supply the /// @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency parameter so /// that revenue metrics can be computed accurately. Params: /// /// static NSString *const kFIREventRefund NS_SWIFT_NAME(AnalyticsEventRefund) = @"refund"; /// 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: /// /// static NSString *const kFIREventSelectItem NS_SWIFT_NAME(AnalyticsEventSelectItem) = @"select_item"; /// 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: /// /// static NSString *const kFIREventSelectPromotion NS_SWIFT_NAME(AnalyticsEventSelectPromotion) = @"select_promotion"; /// 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 @c kFIRParameterValue parameter, you must /// also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed /// accurately. Params: /// /// static NSString *const kFIREventViewCart NS_SWIFT_NAME(AnalyticsEventViewCart) = @"view_cart"; /// View Promotion event. This event signifies that a promotion was shown to a user. Add this event /// to a funnel with the @c kFIREventAddToCart and @c kFIREventPurchase to gauge your conversion /// process. Params: /// /// static NSString *const kFIREventViewPromotion NS_SWIFT_NAME(AnalyticsEventViewPromotion) = @"view_promotion";