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