FIREventNames.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  1. /// @file FIREventNames.h
  2. ///
  3. /// Predefined event names.
  4. ///
  5. /// An Event is an important occurrence in your app that you want to measure. You can report up to
  6. /// 500 different types of Events per app and you can associate up to 25 unique parameters with each
  7. /// Event type. Some common events are suggested below, but you may also choose to specify custom
  8. /// Event types that are associated with your specific app. Each event type is identified by a
  9. /// unique name. Event names can be up to 40 characters long, may only contain alphanumeric
  10. /// characters and underscores ("_"), and must start with an alphabetic character. The "firebase_",
  11. /// "google_", and "ga_" prefixes are reserved and should not be used.
  12. #import <Foundation/Foundation.h>
  13. /// Ad Impression event. This event signifies when a user sees an ad impression. Note: If you supply
  14. /// the @c AnalyticsParameterValue parameter, you must also supply the @c AnalyticsParameterCurrency
  15. /// parameter so that revenue metrics can be computed accurately. Params:
  16. ///
  17. /// <ul>
  18. /// <li>@c AnalyticsParameterAdPlatform (String) (optional)</li>
  19. /// <li>@c AnalyticsParameterAdFormat (String) (optional)</li>
  20. /// <li>@c AnalyticsParameterAdSource (String) (optional)</li>
  21. /// <li>@c AnalyticsParameterAdUnitName (String) (optional)</li>
  22. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  23. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  24. /// </ul>
  25. static NSString *const kFIREventAdImpression NS_SWIFT_NAME(AnalyticsEventAdImpression) =
  26. @"ad_impression";
  27. /// Add Payment Info event. This event signifies that a user has submitted their payment
  28. /// information. Note: If you supply the @c AnalyticsParameterValue parameter, you must also supply
  29. /// the @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately.
  30. /// Params:
  31. ///
  32. /// <ul>
  33. /// <li>@c AnalyticsParameterCoupon (String) (optional)</li>
  34. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  35. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  36. /// <li>@c AnalyticsParameterPaymentType (String) (optional)</li>
  37. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  38. /// </ul>
  39. static NSString *const kFIREventAddPaymentInfo NS_SWIFT_NAME(AnalyticsEventAddPaymentInfo) =
  40. @"add_payment_info";
  41. /// Add Shipping Info event. This event signifies that a user has submitted their shipping
  42. /// information. Note: If you supply the @c AnalyticsParameterValue parameter, you must also supply
  43. /// the @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately.
  44. /// Params:
  45. ///
  46. /// <ul>
  47. /// <li>@c AnalyticsParameterCoupon (String) (optional)</li>
  48. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  49. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  50. /// <li>@c AnalyticsParameterShippingTier (String) (optional)</li>
  51. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  52. /// </ul>
  53. static NSString *const kFIREventAddShippingInfo NS_SWIFT_NAME(AnalyticsEventAddShippingInfo) =
  54. @"add_shipping_info";
  55. /// E-Commerce Add To Cart event. This event signifies that an item(s) was added to a cart for
  56. /// purchase. Add this event to a funnel with @c AnalyticsEventPurchase to gauge the effectiveness
  57. /// of your checkout process. Note: If you supply the @c AnalyticsParameterValue parameter, you must
  58. /// also supply the @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed
  59. /// accurately. Params:
  60. ///
  61. /// <ul>
  62. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  63. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  64. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  65. /// </ul>
  66. static NSString *const kFIREventAddToCart NS_SWIFT_NAME(AnalyticsEventAddToCart) = @"add_to_cart";
  67. /// E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist. Use
  68. /// this event to identify popular gift items. Note: If you supply the @c AnalyticsParameterValue
  69. /// parameter, you must also supply the @c AnalyticsParameterCurrency parameter so that revenue
  70. /// metrics can be computed accurately. Params:
  71. ///
  72. /// <ul>
  73. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  74. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  75. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  76. /// </ul>
  77. static NSString *const kFIREventAddToWishlist NS_SWIFT_NAME(AnalyticsEventAddToWishlist) =
  78. @"add_to_wishlist";
  79. /// App Open event. By logging this event when an App becomes active, developers can understand how
  80. /// often users leave and return during the course of a Session. Although Sessions are automatically
  81. /// reported, this event can provide further clarification around the continuous engagement of
  82. /// app-users.
  83. static NSString *const kFIREventAppOpen NS_SWIFT_NAME(AnalyticsEventAppOpen) = @"app_open";
  84. /// E-Commerce Begin Checkout event. This event signifies that a user has begun the process of
  85. /// checking out. Add this event to a funnel with your @c AnalyticsEventPurchase event to gauge the
  86. /// effectiveness of your checkout process. Note: If you supply the @c AnalyticsParameterValue
  87. /// parameter, you must also supply the @c AnalyticsParameterCurrency parameter so that revenue
  88. /// metrics can be computed accurately. Params:
  89. ///
  90. /// <ul>
  91. /// <li>@c AnalyticsParameterCoupon (String) (optional)</li>
  92. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  93. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  94. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  95. /// </ul>
  96. static NSString *const kFIREventBeginCheckout NS_SWIFT_NAME(AnalyticsEventBeginCheckout) =
  97. @"begin_checkout";
  98. /// Campaign Detail event. Log this event to supply the referral details of a re-engagement
  99. /// campaign. Note: you must supply at least one of the required parameters
  100. /// AnalyticsParameterSource, AnalyticsParameterMedium or AnalyticsParameterCampaign. Params:
  101. ///
  102. /// <ul>
  103. /// <li>@c AnalyticsParameterSource (String)</li>
  104. /// <li>@c AnalyticsParameterMedium (String)</li>
  105. /// <li>@c AnalyticsParameterCampaign (String)</li>
  106. /// <li>@c AnalyticsParameterTerm (String) (optional)</li>
  107. /// <li>@c AnalyticsParameterContent (String) (optional)</li>
  108. /// <li>@c AnalyticsParameterAdNetworkClickID (String) (optional)</li>
  109. /// <li>@c AnalyticsParameterCP1 (String) (optional)</li>
  110. /// <li>@c AnalyticsParameterCampaignID (String) (optional)</li>
  111. /// <li>@c AnalyticsParameterCreativeFormat (String) (optional)</li>
  112. /// <li>@c AnalyticsParameterMarketingTactic (String) (optional)</li>
  113. /// <li>@c AnalyticsParameterSourcePlatform (String) (optional)</li>
  114. /// </ul>
  115. static NSString *const kFIREventCampaignDetails NS_SWIFT_NAME(AnalyticsEventCampaignDetails) =
  116. @"campaign_details";
  117. /// Checkout progress. Params:
  118. ///
  119. /// <ul>
  120. /// <li>@c AnalyticsParameterCheckoutStep (Int)</li>
  121. /// <li>@c AnalyticsParameterCheckoutOption (String) (optional)</li>
  122. /// </ul>
  123. /// <b>This constant has been deprecated.</b>
  124. static NSString *const kFIREventCheckoutProgress NS_SWIFT_NAME(AnalyticsEventCheckoutProgress) =
  125. @"checkout_progress";
  126. /// Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log
  127. /// this along with @c AnalyticsEventSpendVirtualCurrency to better understand your virtual economy.
  128. /// Params:
  129. ///
  130. /// <ul>
  131. /// <li>@c AnalyticsParameterVirtualCurrencyName (String)</li>
  132. /// <li>@c AnalyticsParameterValue (Int or Double)</li>
  133. /// </ul>
  134. static NSString *const kFIREventEarnVirtualCurrency
  135. NS_SWIFT_NAME(AnalyticsEventEarnVirtualCurrency) = @"earn_virtual_currency";
  136. /// E-Commerce Purchase event. This event signifies that an item was purchased by a user. Note:
  137. /// This is different from the in-app purchase event, which is reported automatically for App
  138. /// Store-based apps. Note: If you supply the @c AnalyticsParameterValue parameter, you must also
  139. /// supply the @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed
  140. /// accurately. Params:
  141. ///
  142. /// <ul>
  143. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  144. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  145. /// <li>@c AnalyticsParameterTransactionID (String) (optional)</li>
  146. /// <li>@c AnalyticsParameterTax (Double) (optional)</li>
  147. /// <li>@c AnalyticsParameterShipping (Double) (optional)</li>
  148. /// <li>@c AnalyticsParameterCoupon (String) (optional)</li>
  149. /// <li>@c AnalyticsParameterLocation (String) (optional)</li>
  150. /// <li>@c AnalyticsParameterStartDate (String) (optional)</li>
  151. /// <li>@c AnalyticsParameterEndDate (String) (optional)</li>
  152. /// <li>@c AnalyticsParameterNumberOfNights (Int) (optional) for hotel bookings</li>
  153. /// <li>@c AnalyticsParameterNumberOfRooms (Int) (optional) for hotel bookings</li>
  154. /// <li>@c AnalyticsParameterNumberOfPassengers (Int) (optional) for travel bookings</li>
  155. /// <li>@c AnalyticsParameterOrigin (String) (optional)</li>
  156. /// <li>@c AnalyticsParameterDestination (String) (optional)</li>
  157. /// <li>@c AnalyticsParameterTravelClass (String) (optional) for travel bookings</li>
  158. /// </ul>
  159. /// <b>This constant has been deprecated. Use @c AnalyticsEventPurchase constant instead.</b>
  160. static NSString *const kFIREventEcommercePurchase NS_SWIFT_NAME(AnalyticsEventEcommercePurchase) =
  161. @"ecommerce_purchase";
  162. /// Generate Lead event. Log this event when a lead has been generated in the app to understand the
  163. /// efficacy of your install and re-engagement campaigns. Note: If you supply the
  164. /// @c AnalyticsParameterValue parameter, you must also supply the @c AnalyticsParameterCurrency
  165. /// parameter so that revenue metrics can be computed accurately. Params:
  166. ///
  167. /// <ul>
  168. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  169. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  170. /// </ul>
  171. static NSString *const kFIREventGenerateLead NS_SWIFT_NAME(AnalyticsEventGenerateLead) =
  172. @"generate_lead";
  173. /// Join Group event. Log this event when a user joins a group such as a guild, team or family. Use
  174. /// this event to analyze how popular certain groups or social features are in your app. Params:
  175. ///
  176. /// <ul>
  177. /// <li>@c AnalyticsParameterGroupID (String)</li>
  178. /// </ul>
  179. static NSString *const kFIREventJoinGroup NS_SWIFT_NAME(AnalyticsEventJoinGroup) = @"join_group";
  180. /// Level End event. Log this event when the user finishes a level. Params:
  181. ///
  182. /// <ul>
  183. /// <li>@c AnalyticsParameterLevelName (String)</li>
  184. /// <li>@c AnalyticsParameterSuccess (String)</li>
  185. /// </ul>
  186. static NSString *const kFIREventLevelEnd NS_SWIFT_NAME(AnalyticsEventLevelEnd) = @"level_end";
  187. /// Level Start event. Log this event when the user starts a new level. Params:
  188. ///
  189. /// <ul>
  190. /// <li>@c AnalyticsParameterLevelName (String)</li>
  191. /// </ul>
  192. static NSString *const kFIREventLevelStart NS_SWIFT_NAME(AnalyticsEventLevelStart) = @"level_start";
  193. /// Level Up event. This event signifies that a player has leveled up in your gaming app. It can
  194. /// help you gauge the level distribution of your userbase and help you identify certain levels that
  195. /// are difficult to pass. Params:
  196. ///
  197. /// <ul>
  198. /// <li>@c AnalyticsParameterLevel (Int)</li>
  199. /// <li>@c AnalyticsParameterCharacter (String) (optional)</li>
  200. /// </ul>
  201. static NSString *const kFIREventLevelUp NS_SWIFT_NAME(AnalyticsEventLevelUp) = @"level_up";
  202. /// Login event. Apps with a login feature can report this event to signify that a user has logged
  203. /// in.
  204. static NSString *const kFIREventLogin NS_SWIFT_NAME(AnalyticsEventLogin) = @"login";
  205. /// Post Score event. Log this event when the user posts a score in your gaming app. This event can
  206. /// help you understand how users are actually performing in your game and it can help you correlate
  207. /// high scores with certain audiences or behaviors. Params:
  208. ///
  209. /// <ul>
  210. /// <li>@c AnalyticsParameterScore (Int)</li>
  211. /// <li>@c AnalyticsParameterLevel (Int) (optional)</li>
  212. /// <li>@c AnalyticsParameterCharacter (String) (optional)</li>
  213. /// </ul>
  214. static NSString *const kFIREventPostScore NS_SWIFT_NAME(AnalyticsEventPostScore) = @"post_score";
  215. /// Present Offer event. This event signifies that the app has presented a purchase offer to a user.
  216. /// Add this event to a funnel with the @c AnalyticsEventAddToCart and @c
  217. /// AnalyticsEventEcommercePurchase to gauge your conversion process. Note: If you supply the @c
  218. /// AnalyticsParameterValue parameter, you must also supply the @c AnalyticsParameterCurrency
  219. /// parameter so that revenue metrics can be computed accurately. Params:
  220. ///
  221. /// <ul>
  222. /// <li>@c AnalyticsParameterQuantity (Int)</li>
  223. /// <li>@c AnalyticsParameterItemID (String)</li>
  224. /// <li>@c AnalyticsParameterItemName (String)</li>
  225. /// <li>@c AnalyticsParameterItemCategory (String)</li>
  226. /// <li>@c AnalyticsParameterItemLocationID (String) (optional)</li>
  227. /// <li>@c AnalyticsParameterPrice (Double) (optional)</li>
  228. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  229. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  230. /// </ul>
  231. /// <b>This constant has been deprecated. Use @c AnalyticsEventViewPromotion constant instead.</b>
  232. static NSString *const kFIREventPresentOffer NS_SWIFT_NAME(AnalyticsEventPresentOffer) =
  233. @"present_offer";
  234. /// E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user. Note:
  235. /// This is different from the in-app purchase event, which is reported automatically for App
  236. /// Store-based apps. Note: If you supply the @c AnalyticsParameterValue parameter, you must also
  237. /// supply the @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed
  238. /// accurately. Params:
  239. ///
  240. /// <ul>
  241. /// <li>@c AnalyticsParameterAffiliation (String) (optional)</li>
  242. /// <li>@c AnalyticsParameterCoupon (String) (optional)</li>
  243. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  244. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  245. /// <li>@c AnalyticsParameterShipping (Double) (optional)</li>
  246. /// <li>@c AnalyticsParameterTax (Double) (optional)</li>
  247. /// <li>@c AnalyticsParameterTransactionID (String) (optional)</li>
  248. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  249. /// </ul>
  250. static NSString *const kFIREventPurchase NS_SWIFT_NAME(AnalyticsEventPurchase) = @"purchase";
  251. /// E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded.
  252. /// Note: If you supply the @c AnalyticsParameterValue parameter, you must also supply the
  253. /// @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately.
  254. /// Params:
  255. ///
  256. /// <ul>
  257. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  258. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  259. /// <li>@c AnalyticsParameterTransactionID (String) (optional)</li>
  260. /// </ul>
  261. /// <b>This constant has been deprecated. Use @c AnalyticsEventRefund constant instead.</b>
  262. static NSString *const kFIREventPurchaseRefund NS_SWIFT_NAME(AnalyticsEventPurchaseRefund) =
  263. @"purchase_refund";
  264. /// E-Commerce Refund event. This event signifies that a refund was issued. Note: If you supply the
  265. /// @c AnalyticsParameterValue parameter, you must also supply the @c AnalyticsParameterCurrency
  266. /// parameter so that revenue metrics can be computed accurately. Params:
  267. ///
  268. /// <ul>
  269. /// <li>@c AnalyticsParameterAffiliation (String) (optional)</li>
  270. /// <li>@c AnalyticsParameterCoupon (String) (optional)</li>
  271. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  272. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  273. /// <li>@c AnalyticsParameterShipping (Double) (optional)</li>
  274. /// <li>@c AnalyticsParameterTax (Double) (optional)</li>
  275. /// <li>@c AnalyticsParameterTransactionID (String) (optional)</li>
  276. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  277. /// </ul>
  278. static NSString *const kFIREventRefund NS_SWIFT_NAME(AnalyticsEventRefund) = @"refund";
  279. /// E-Commerce Remove from Cart event. This event signifies that an item(s) was removed from a cart.
  280. /// Note: If you supply the @c AnalyticsParameterValue parameter, you must also supply the @c
  281. /// AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
  282. ///
  283. /// <ul>
  284. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  285. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  286. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  287. /// </ul>
  288. static NSString *const kFIREventRemoveFromCart NS_SWIFT_NAME(AnalyticsEventRemoveFromCart) =
  289. @"remove_from_cart";
  290. /// Screen View event. This event signifies a screen view. Use this when a screen transition occurs.
  291. /// This event can be logged irrespective of whether automatic screen tracking is enabled. Params:
  292. ///
  293. /// <ul>
  294. /// <li>@c AnalyticsParameterScreenClass (String) (optional)</li>
  295. /// <li>@c AnalyticsParameterScreenName (String) (optional)</li>
  296. /// </ul>
  297. static NSString *const kFIREventScreenView NS_SWIFT_NAME(AnalyticsEventScreenView) = @"screen_view";
  298. /// Search event. Apps that support search features can use this event to contextualize search
  299. /// operations by supplying the appropriate, corresponding parameters. This event can help you
  300. /// identify the most popular content in your app. Params:
  301. ///
  302. /// <ul>
  303. /// <li>@c AnalyticsParameterSearchTerm (String)</li>
  304. /// <li>@c AnalyticsParameterStartDate (String) (optional)</li>
  305. /// <li>@c AnalyticsParameterEndDate (String) (optional)</li>
  306. /// <li>@c AnalyticsParameterNumberOfNights (Int) (optional) for hotel bookings</li>
  307. /// <li>@c AnalyticsParameterNumberOfRooms (Int) (optional) for hotel bookings</li>
  308. /// <li>@c AnalyticsParameterNumberOfPassengers (Int) (optional) for travel bookings</li>
  309. /// <li>@c AnalyticsParameterOrigin (String) (optional)</li>
  310. /// <li>@c AnalyticsParameterDestination (String) (optional)</li>
  311. /// <li>@c AnalyticsParameterTravelClass (String) (optional) for travel bookings</li>
  312. /// </ul>
  313. static NSString *const kFIREventSearch NS_SWIFT_NAME(AnalyticsEventSearch) = @"search";
  314. /// Select Content event. This general purpose event signifies that a user has selected some content
  315. /// of a certain type in an app. The content can be any object in your app. This event can help you
  316. /// identify popular content and categories of content in your app. Params:
  317. ///
  318. /// <ul>
  319. /// <li>@c AnalyticsParameterContentType (String)</li>
  320. /// <li>@c AnalyticsParameterItemID (String)</li>
  321. /// </ul>
  322. static NSString *const kFIREventSelectContent NS_SWIFT_NAME(AnalyticsEventSelectContent) =
  323. @"select_content";
  324. /// Select Item event. This event signifies that an item was selected by a user from a list. Use the
  325. /// appropriate parameters to contextualize the event. Use this event to discover the most popular
  326. /// items selected. Params:
  327. ///
  328. /// <ul>
  329. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  330. /// <li>@c AnalyticsParameterItemListID (String) (optional)</li>
  331. /// <li>@c AnalyticsParameterItemListName (String) (optional)</li>
  332. /// </ul>
  333. static NSString *const kFIREventSelectItem NS_SWIFT_NAME(AnalyticsEventSelectItem) = @"select_item";
  334. /// Select promotion event. This event signifies that a user has selected a promotion offer. Use the
  335. /// appropriate parameters to contextualize the event, such as the item(s) for which the promotion
  336. /// applies. Params:
  337. ///
  338. /// <ul>
  339. /// <li>@c AnalyticsParameterCreativeName (String) (optional)</li>
  340. /// <li>@c AnalyticsParameterCreativeSlot (String) (optional)</li>
  341. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  342. /// <li>@c AnalyticsParameterLocationID (String) (optional)</li>
  343. /// <li>@c AnalyticsParameterPromotionID (String) (optional)</li>
  344. /// <li>@c AnalyticsParameterPromotionName (String) (optional)</li>
  345. /// </ul>
  346. static NSString *const kFIREventSelectPromotion NS_SWIFT_NAME(AnalyticsEventSelectPromotion) =
  347. @"select_promotion";
  348. /// Set checkout option. Params:
  349. ///
  350. /// <ul>
  351. /// <li>@c AnalyticsParameterCheckoutStep (Int)</li>
  352. /// <li>@c AnalyticsParameterCheckoutOption (String)</li>
  353. /// </ul>
  354. /// <b>This constant has been deprecated.</b>
  355. static NSString *const kFIREventSetCheckoutOption NS_SWIFT_NAME(AnalyticsEventSetCheckoutOption) =
  356. @"set_checkout_option";
  357. /// Share event. Apps with social features can log the Share event to identify the most viral
  358. /// content. Params:
  359. ///
  360. /// <ul>
  361. /// <li>@c AnalyticsParameterContentType (String)</li>
  362. /// <li>@c AnalyticsParameterItemID (String)</li>
  363. /// </ul>
  364. static NSString *const kFIREventShare NS_SWIFT_NAME(AnalyticsEventShare) = @"share";
  365. /// Sign Up event. This event indicates that a user has signed up for an account in your app. The
  366. /// parameter signifies the method by which the user signed up. Use this event to understand the
  367. /// different behaviors between logged in and logged out users. Params:
  368. ///
  369. /// <ul>
  370. /// <li>@c AnalyticsParameterSignUpMethod (String)</li>
  371. /// </ul>
  372. static NSString *const kFIREventSignUp NS_SWIFT_NAME(AnalyticsEventSignUp) = @"sign_up";
  373. /// Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can
  374. /// help you identify which virtual goods are the most popular objects of purchase. Params:
  375. ///
  376. /// <ul>
  377. /// <li>@c AnalyticsParameterItemName (String)</li>
  378. /// <li>@c AnalyticsParameterVirtualCurrencyName (String)</li>
  379. /// <li>@c AnalyticsParameterValue (Int or Double)</li>
  380. /// </ul>
  381. static NSString *const kFIREventSpendVirtualCurrency
  382. NS_SWIFT_NAME(AnalyticsEventSpendVirtualCurrency) = @"spend_virtual_currency";
  383. /// Tutorial Begin event. This event signifies the start of the on-boarding process in your app. Use
  384. /// this in a funnel with @c AnalyticsEventTutorialComplete to understand how many users complete
  385. /// this process and move on to the full app experience.
  386. static NSString *const kFIREventTutorialBegin NS_SWIFT_NAME(AnalyticsEventTutorialBegin) =
  387. @"tutorial_begin";
  388. /// Tutorial End event. Use this event to signify the user's completion of your app's on-boarding
  389. /// process. Add this to a funnel with @c AnalyticsEventTutorialBegin to gauge the completion rate
  390. /// of your on-boarding process.
  391. static NSString *const kFIREventTutorialComplete NS_SWIFT_NAME(AnalyticsEventTutorialComplete) =
  392. @"tutorial_complete";
  393. /// Unlock Achievement event. Log this event when the user has unlocked an achievement in your
  394. /// game. Since achievements generally represent the breadth of a gaming experience, this event can
  395. /// help you understand how many users are experiencing all that your game has to offer. Params:
  396. ///
  397. /// <ul>
  398. /// <li>@c AnalyticsParameterAchievementID (String)</li>
  399. /// </ul>
  400. static NSString *const kFIREventUnlockAchievement NS_SWIFT_NAME(AnalyticsEventUnlockAchievement) =
  401. @"unlock_achievement";
  402. /// E-commerce View Cart event. This event signifies that a user has viewed their cart. Use this to
  403. /// analyze your purchase funnel. Note: If you supply the @c AnalyticsParameterValue parameter, you
  404. /// must also supply the @c AnalyticsParameterCurrency parameter so that revenue metrics can be
  405. /// computed accurately. Params:
  406. ///
  407. /// <ul>
  408. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  409. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  410. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  411. /// </ul>
  412. static NSString *const kFIREventViewCart NS_SWIFT_NAME(AnalyticsEventViewCart) = @"view_cart";
  413. /// View Item event. This event signifies that a user has viewed an item. Use the appropriate
  414. /// parameters to contextualize the event. Use this event to discover the most popular items viewed
  415. /// in your app. Note: If you supply the @c AnalyticsParameterValue parameter, you must also supply
  416. /// the @c AnalyticsParameterCurrency parameter so that revenue metrics can be computed accurately.
  417. /// Params:
  418. ///
  419. /// <ul>
  420. /// <li>@c AnalyticsParameterCurrency (String) (optional)</li>
  421. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  422. /// <li>@c AnalyticsParameterValue (Double) (optional)</li>
  423. /// </ul>
  424. static NSString *const kFIREventViewItem NS_SWIFT_NAME(AnalyticsEventViewItem) = @"view_item";
  425. /// View Item List event. Log this event when a user sees a list of items or offerings. Params:
  426. ///
  427. /// <ul>
  428. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  429. /// <li>@c AnalyticsParameterItemListID (String) (optional)</li>
  430. /// <li>@c AnalyticsParameterItemListName (String) (optional)</li>
  431. /// </ul>
  432. static NSString *const kFIREventViewItemList NS_SWIFT_NAME(AnalyticsEventViewItemList) =
  433. @"view_item_list";
  434. /// View Promotion event. This event signifies that a promotion was shown to a user. Add this event
  435. /// to a funnel with the @c AnalyticsEventAddToCart and @c AnalyticsEventPurchase to gauge your
  436. /// conversion process. Params:
  437. ///
  438. /// <ul>
  439. /// <li>@c AnalyticsParameterCreativeName (String) (optional)</li>
  440. /// <li>@c AnalyticsParameterCreativeSlot (String) (optional)</li>
  441. /// <li>@c AnalyticsParameterItems (Array<Dictionary<String, Any>>) (optional)</li>
  442. /// <li>@c AnalyticsParameterLocationID (String) (optional)</li>
  443. /// <li>@c AnalyticsParameterPromotionID (String) (optional)</li>
  444. /// <li>@c AnalyticsParameterPromotionName (String) (optional)</li>
  445. /// </ul>
  446. static NSString *const kFIREventViewPromotion NS_SWIFT_NAME(AnalyticsEventViewPromotion) =
  447. @"view_promotion";
  448. /// View Search Results event. Log this event when the user has been presented with the results of a
  449. /// search. Params:
  450. ///
  451. /// <ul>
  452. /// <li>@c AnalyticsParameterSearchTerm (String)</li>
  453. /// </ul>
  454. static NSString *const kFIREventViewSearchResults NS_SWIFT_NAME(AnalyticsEventViewSearchResults) =
  455. @"view_search_results";