| 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 | ||
| 15 | /// Add Payment Info event. This event signifies that a user has submitted their payment | |
| 16 | /// information. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the | |
| 17 | /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: | |
| 18 | /// | |
| 19 | /// <ul> | |
| 20 | /// <li>@c kFIRParameterCoupon (NSString) (optional)</li> | |
| 21 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 22 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 23 | /// <li>@c kFIRParameterPaymentType (NSString) (optional)</li> | |
| 24 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 25 | /// </ul> | |
| 26 | static NSString *const kFIREventAddPaymentInfo NS_SWIFT_NAME(AnalyticsEventAddPaymentInfo) = | |
| 27 | @"add_payment_info"; | |
| 28 | ||
| 29 | /// E-Commerce Add To Cart event. This event signifies that an item(s) was added to a cart for | |
| 30 | /// purchase. Add this event to a funnel with @c kFIREventPurchase to gauge the effectiveness of | |
| 31 | /// your checkout process. Note: If you supply the @c kFIRParameterValue parameter, you must also | |
| 32 | /// supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed | |
| 33 | /// accurately. Params: | |
| 34 | /// | |
| 35 | /// <ul> | |
| 36 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 37 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 38 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 39 | /// </ul> | |
| 40 | static NSString *const kFIREventAddToCart NS_SWIFT_NAME(AnalyticsEventAddToCart) = @"add_to_cart"; | |
| 41 | ||
| 42 | /// E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist. Use | |
| 43 | /// this event to identify popular gift items. Note: If you supply the @c kFIRParameterValue | |
| 44 | /// parameter, you must also supply the @c kFIRParameterCurrency parameter so that revenue metrics | |
| 45 | /// can be computed accurately. Params: | |
| 46 | /// | |
| 47 | /// <ul> | |
| 48 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 49 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 50 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 51 | /// </ul> | |
| 52 | static NSString *const kFIREventAddToWishlist NS_SWIFT_NAME(AnalyticsEventAddToWishlist) = | |
| 53 | @"add_to_wishlist"; | |
| 54 | ||
| 55 | /// Ad Impression event. This event signifies when a user sees an ad impression. Note: If you supply | |
| 56 | /// the @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency parameter | |
| 57 | /// so that revenue metrics can be computed accurately. Params: | |
| 58 | /// | |
| 59 | /// <ul> | |
| 60 | /// <li>@c kFIRParameterAdPlatform (NSString) (optional)</li> | |
| 61 | /// <li>@c kFIRParameterAdFormat (NSString) (optional)</li> | |
| 62 | /// <li>@c kFIRParameterAdSource (NSString) (optional)</li> | |
| 63 | /// <li>@c kFIRParameterAdUnitName (NSString) (optional)</li> | |
| 64 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 65 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 66 | /// </ul> | |
| 67 | static NSString *const kFIREventAdImpression NS_SWIFT_NAME(AnalyticsEventAdImpression) = | |
| 68 | @"ad_impression"; | |
| 69 | ||
| 70 | /// App Open event. By logging this event when an App becomes active, developers can understand how | |
| 71 | /// often users leave and return during the course of a Session. Although Sessions are automatically | |
| 72 | /// reported, this event can provide further clarification around the continuous engagement of | |
| 73 | /// app-users. | |
| 74 | static NSString *const kFIREventAppOpen NS_SWIFT_NAME(AnalyticsEventAppOpen) = @"app_open"; | |
| 75 | ||
| 76 | /// E-Commerce Begin Checkout event. This event signifies that a user has begun the process of | |
| 77 | /// checking out. Add this event to a funnel with your @c kFIREventPurchase event to gauge the | |
| 78 | /// effectiveness of your checkout process. Note: If you supply the @c kFIRParameterValue parameter, | |
| 79 | /// you must also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be | |
| 80 | /// computed accurately. Params: | |
| 81 | /// | |
| 82 | /// <ul> | |
| 83 | /// <li>@c kFIRParameterCoupon (NSString) (optional)</li> | |
| 84 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 85 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 86 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 87 | /// </ul> | |
| 88 | static NSString *const kFIREventBeginCheckout NS_SWIFT_NAME(AnalyticsEventBeginCheckout) = | |
| 89 | @"begin_checkout"; | |
| 90 | ||
| 91 | /// Campaign Detail event. Log this event to supply the referral details of a re-engagement | |
| 92 | /// campaign. Note: you must supply at least one of the required parameters kFIRParameterSource, | |
| 93 | /// kFIRParameterMedium or kFIRParameterCampaign. Params: | |
| 94 | /// | |
| 95 | /// <ul> | |
| 96 | /// <li>@c kFIRParameterSource (NSString)</li> | |
| 97 | /// <li>@c kFIRParameterMedium (NSString)</li> | |
| 98 | /// <li>@c kFIRParameterCampaign (NSString)</li> | |
| 99 | /// <li>@c kFIRParameterTerm (NSString) (optional)</li> | |
| 100 | /// <li>@c kFIRParameterContent (NSString) (optional)</li> | |
| 101 | /// <li>@c kFIRParameterAdNetworkClickID (NSString) (optional)</li> | |
| 102 | /// <li>@c kFIRParameterCP1 (NSString) (optional)</li> | |
| 103 | /// </ul> | |
| 104 | static NSString *const kFIREventCampaignDetails NS_SWIFT_NAME(AnalyticsEventCampaignDetails) = | |
| 105 | @"campaign_details"; | |
| 106 | ||
| 107 | /// Checkout progress. Params: | |
| 108 | /// | |
| 109 | /// <ul> | |
| 110 | /// <li>@c kFIRParameterCheckoutStep (unsigned 64-bit integer as NSNumber)</li> | |
| 111 | /// <li>@c kFIRParameterCheckoutOption (NSString) (optional)</li> | |
| 112 | /// </ul> | |
| 113 | /// <b>This constant has been deprecated.</b> | |
| 114 | static NSString *const kFIREventCheckoutProgress NS_SWIFT_NAME(AnalyticsEventCheckoutProgress) = | |
| 115 | @"checkout_progress"; | |
| 116 | ||
| 117 | /// Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log | |
| 118 | /// this along with @c kFIREventSpendVirtualCurrency to better understand your virtual economy. | |
| 119 | /// Params: | |
| 120 | /// | |
| 121 | /// <ul> | |
| 122 | /// <li>@c kFIRParameterVirtualCurrencyName (NSString)</li> | |
| 123 | /// <li>@c kFIRParameterValue (signed 64-bit integer or double as NSNumber)</li> | |
| 124 | /// </ul> | |
| 125 | static NSString *const kFIREventEarnVirtualCurrency | |
| 126 | NS_SWIFT_NAME(AnalyticsEventEarnVirtualCurrency) = @"earn_virtual_currency"; | |
| 127 | ||
| 128 | /// E-Commerce Purchase event. This event signifies that an item was purchased by a user. Note: | |
| 129 | /// This is different from the in-app purchase event, which is reported automatically for App | |
| 130 | /// Store-based apps. Note: If you supply the @c kFIRParameterValue parameter, you must also | |
| 131 | /// supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed | |
| 132 | /// accurately. Params: | |
| 133 | /// | |
| 134 | /// <ul> | |
| 135 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 136 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 137 | /// <li>@c kFIRParameterTransactionID (NSString) (optional)</li> | |
| 138 | /// <li>@c kFIRParameterTax (double as NSNumber) (optional)</li> | |
| 139 | /// <li>@c kFIRParameterShipping (double as NSNumber) (optional)</li> | |
| 140 | /// <li>@c kFIRParameterCoupon (NSString) (optional)</li> | |
| 141 | /// <li>@c kFIRParameterLocation (NSString) (optional)</li> | |
| 142 | /// <li>@c kFIRParameterStartDate (NSString) (optional)</li> | |
| 143 | /// <li>@c kFIRParameterEndDate (NSString) (optional)</li> | |
| 144 | /// <li>@c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for | |
| 145 | /// hotel bookings</li> | |
| 146 | /// <li>@c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for | |
| 147 | /// hotel bookings</li> | |
| 148 | /// <li>@c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) | |
| 149 | /// for travel bookings</li> | |
| 150 | /// <li>@c kFIRParameterOrigin (NSString) (optional)</li> | |
| 151 | /// <li>@c kFIRParameterDestination (NSString) (optional)</li> | |
| 152 | /// <li>@c kFIRParameterTravelClass (NSString) (optional) for travel bookings</li> | |
| 153 | /// </ul> | |
| 154 | /// <b>This constant has been deprecated. Use @c kFIREventPurchase constant instead.</b> | |
| 155 | static NSString *const kFIREventEcommercePurchase NS_SWIFT_NAME(AnalyticsEventEcommercePurchase) = | |
| 156 | @"ecommerce_purchase"; | |
| 157 | ||
| 158 | /// Generate Lead event. Log this event when a lead has been generated in the app to understand the | |
| 159 | /// efficacy of your install and re-engagement campaigns. Note: If you supply the | |
| 160 | /// @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency | |
| 161 | /// parameter so that revenue metrics can be computed accurately. Params: | |
| 162 | /// | |
| 163 | /// <ul> | |
| 164 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 165 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 166 | /// </ul> | |
| 167 | static NSString *const kFIREventGenerateLead NS_SWIFT_NAME(AnalyticsEventGenerateLead) = | |
| 168 | @"generate_lead"; | |
| 169 | ||
| 170 | /// Join Group event. Log this event when a user joins a group such as a guild, team or family. Use | |
| 171 | /// this event to analyze how popular certain groups or social features are in your app. Params: | |
| 172 | /// | |
| 173 | /// <ul> | |
| 174 | /// <li>@c kFIRParameterGroupID (NSString)</li> | |
| 175 | /// </ul> | |
| 176 | static NSString *const kFIREventJoinGroup NS_SWIFT_NAME(AnalyticsEventJoinGroup) = @"join_group"; | |
| 177 | ||
| 178 | /// Level End event. Log this event when the user finishes a level. Params: | |
| 179 | /// | |
| 180 | /// <ul> | |
| 181 | /// <li>@c kFIRParameterLevelName (NSString)</li> | |
| 182 | /// <li>@c kFIRParameterSuccess (NSString)</li> | |
| 183 | /// </ul> | |
| 184 | static NSString *const kFIREventLevelEnd NS_SWIFT_NAME(AnalyticsEventLevelEnd) = @"level_end"; | |
| 185 | ||
| 186 | /// Level Start event. Log this event when the user starts a new level. Params: | |
| 187 | /// | |
| 188 | /// <ul> | |
| 189 | /// <li>@c kFIRParameterLevelName (NSString)</li> | |
| 190 | /// </ul> | |
| 191 | static NSString *const kFIREventLevelStart NS_SWIFT_NAME(AnalyticsEventLevelStart) = @"level_start"; | |
| 192 | ||
| 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 kFIRParameterLevel (signed 64-bit integer as NSNumber)</li> | |
| 199 | /// <li>@c kFIRParameterCharacter (NSString) (optional)</li> | |
| 200 | /// </ul> | |
| 201 | static NSString *const kFIREventLevelUp NS_SWIFT_NAME(AnalyticsEventLevelUp) = @"level_up"; | |
| 202 | ||
| 203 | /// Login event. Apps with a login feature can report this event to signify that a user has logged | |
| 204 | /// in. | |
| 205 | static NSString *const kFIREventLogin NS_SWIFT_NAME(AnalyticsEventLogin) = @"login"; | |
| 206 | ||
| 207 | /// Post Score event. Log this event when the user posts a score in your gaming app. This event can | |
| 208 | /// help you understand how users are actually performing in your game and it can help you correlate | |
| 209 | /// high scores with certain audiences or behaviors. Params: | |
| 210 | /// | |
| 211 | /// <ul> | |
| 212 | /// <li>@c kFIRParameterScore (signed 64-bit integer as NSNumber)</li> | |
| 213 | /// <li>@c kFIRParameterLevel (signed 64-bit integer as NSNumber) (optional)</li> | |
| 214 | /// <li>@c kFIRParameterCharacter (NSString) (optional)</li> | |
| 215 | /// </ul> | |
| 216 | static NSString *const kFIREventPostScore NS_SWIFT_NAME(AnalyticsEventPostScore) = @"post_score"; | |
| 217 | ||
| 218 | /// Present Offer event. This event signifies that the app has presented a purchase offer to a user. | |
| 219 | /// Add this event to a funnel with the kFIREventAddToCart and kFIREventEcommercePurchase to gauge | |
| 220 | /// your conversion process. Note: If you supply the @c kFIRParameterValue parameter, you must | |
| 221 | /// also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed | |
| 222 | /// accurately. Params: | |
| 223 | /// | |
| 224 | /// <ul> | |
| 225 | /// <li>@c kFIRParameterQuantity (signed 64-bit integer as NSNumber)</li> | |
| 226 | /// <li>@c kFIRParameterItemID (NSString)</li> | |
| 227 | /// <li>@c kFIRParameterItemName (NSString)</li> | |
| 228 | /// <li>@c kFIRParameterItemCategory (NSString)</li> | |
| 229 | /// <li>@c kFIRParameterItemLocationID (NSString) (optional)</li> | |
| 230 | /// <li>@c kFIRParameterPrice (double as NSNumber) (optional)</li> | |
| 231 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 232 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 233 | /// </ul> | |
| 234 | /// <b>This constant has been deprecated. Use @c kFIREventViewPromotion constant instead.</b> | |
| 235 | static NSString *const kFIREventPresentOffer NS_SWIFT_NAME(AnalyticsEventPresentOffer) = | |
| 236 | @"present_offer"; | |
| 237 | ||
| 238 | /// E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded. | |
| 239 | /// Note: If you supply the @c kFIRParameterValue parameter, you must also supply the | |
| 240 | /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. | |
| 241 | /// Params: | |
| 242 | /// | |
| 243 | /// <ul> | |
| 244 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 245 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 246 | /// <li>@c kFIRParameterTransactionID (NSString) (optional)</li> | |
| 247 | /// </ul> | |
| 248 | /// <b>This constant has been deprecated. Use @c kFIREventRefund constant instead.</b> | |
| 249 | static NSString *const kFIREventPurchaseRefund NS_SWIFT_NAME(AnalyticsEventPurchaseRefund) = | |
| 250 | @"purchase_refund"; | |
| 251 | ||
| 252 | /// E-Commerce Remove from Cart event. This event signifies that an item(s) was removed from a cart. | |
| 253 | /// Note: If you supply the @c kFIRParameterValue parameter, you must also supply the @c | |
| 254 | /// kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: | |
| 255 | /// | |
| 256 | /// <ul> | |
| 257 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 258 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 259 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 260 | /// </ul> | |
| 261 | static NSString *const kFIREventRemoveFromCart NS_SWIFT_NAME(AnalyticsEventRemoveFromCart) = | |
| 262 | @"remove_from_cart"; | |
| 263 | ||
| 264 | /// Screen View event. This event signifies a screen view. Use this when a screen transition occurs. | |
| 265 | /// This event can be logged irrespective of whether automatic screen tracking is enabled. Params: | |
| 266 | /// | |
| 267 | /// <ul> | |
| 268 | /// <li>@c kFIRParameterScreenClass (NSString) (optional)</li> | |
| 269 | /// <li>@c kFIRParameterScreenName (NSString) (optional)</li> | |
| 270 | /// </ul> | |
| 271 | static NSString *const kFIREventScreenView NS_SWIFT_NAME(AnalyticsEventScreenView) = @"screen_view"; | |
| 272 | ||
| 273 | /// Search event. Apps that support search features can use this event to contextualize search | |
| 274 | /// operations by supplying the appropriate, corresponding parameters. This event can help you | |
| 275 | /// identify the most popular content in your app. Params: | |
| 276 | /// | |
| 277 | /// <ul> | |
| 278 | /// <li>@c kFIRParameterSearchTerm (NSString)</li> | |
| 279 | /// <li>@c kFIRParameterStartDate (NSString) (optional)</li> | |
| 280 | /// <li>@c kFIRParameterEndDate (NSString) (optional)</li> | |
| 281 | /// <li>@c kFIRParameterNumberOfNights (signed 64-bit integer as NSNumber) (optional) for | |
| 282 | /// hotel bookings</li> | |
| 283 | /// <li>@c kFIRParameterNumberOfRooms (signed 64-bit integer as NSNumber) (optional) for | |
| 284 | /// hotel bookings</li> | |
| 285 | /// <li>@c kFIRParameterNumberOfPassengers (signed 64-bit integer as NSNumber) (optional) | |
| 286 | /// for travel bookings</li> | |
| 287 | /// <li>@c kFIRParameterOrigin (NSString) (optional)</li> | |
| 288 | /// <li>@c kFIRParameterDestination (NSString) (optional)</li> | |
| 289 | /// <li>@c kFIRParameterTravelClass (NSString) (optional) for travel bookings</li> | |
| 290 | /// </ul> | |
| 291 | static NSString *const kFIREventSearch NS_SWIFT_NAME(AnalyticsEventSearch) = @"search"; | |
| 292 | ||
| 293 | /// Select Content event. This general purpose event signifies that a user has selected some content | |
| 294 | /// of a certain type in an app. The content can be any object in your app. This event can help you | |
| 295 | /// identify popular content and categories of content in your app. Params: | |
| 296 | /// | |
| 297 | /// <ul> | |
| 298 | /// <li>@c kFIRParameterContentType (NSString)</li> | |
| 299 | /// <li>@c kFIRParameterItemID (NSString)</li> | |
| 300 | /// </ul> | |
| 301 | static NSString *const kFIREventSelectContent NS_SWIFT_NAME(AnalyticsEventSelectContent) = | |
| 302 | @"select_content"; | |
| 303 | ||
| 304 | /// Set checkout option. Params: | |
| 305 | /// | |
| 306 | /// <ul> | |
| 307 | /// <li>@c kFIRParameterCheckoutStep (unsigned 64-bit integer as NSNumber)</li> | |
| 308 | /// <li>@c kFIRParameterCheckoutOption (NSString)</li> | |
| 309 | /// </ul> | |
| 310 | /// <b>This constant has been deprecated.</b> | |
| 311 | static NSString *const kFIREventSetCheckoutOption NS_SWIFT_NAME(AnalyticsEventSetCheckoutOption) = | |
| 312 | @"set_checkout_option"; | |
| 313 | ||
| 314 | /// Share event. Apps with social features can log the Share event to identify the most viral | |
| 315 | /// content. Params: | |
| 316 | /// | |
| 317 | /// <ul> | |
| 318 | /// <li>@c kFIRParameterContentType (NSString)</li> | |
| 319 | /// <li>@c kFIRParameterItemID (NSString)</li> | |
| 320 | /// </ul> | |
| 321 | static NSString *const kFIREventShare NS_SWIFT_NAME(AnalyticsEventShare) = @"share"; | |
| 322 | ||
| 323 | /// Sign Up event. This event indicates that a user has signed up for an account in your app. The | |
| 324 | /// parameter signifies the method by which the user signed up. Use this event to understand the | |
| 325 | /// different behaviors between logged in and logged out users. Params: | |
| 326 | /// | |
| 327 | /// <ul> | |
| 328 | /// <li>@c kFIRParameterSignUpMethod (NSString)</li> | |
| 329 | /// </ul> | |
| 330 | static NSString *const kFIREventSignUp NS_SWIFT_NAME(AnalyticsEventSignUp) = @"sign_up"; | |
| 331 | ||
| 332 | /// Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can | |
| 333 | /// help you identify which virtual goods are the most popular objects of purchase. Params: | |
| 334 | /// | |
| 335 | /// <ul> | |
| 336 | /// <li>@c kFIRParameterItemName (NSString)</li> | |
| 337 | /// <li>@c kFIRParameterVirtualCurrencyName (NSString)</li> | |
| 338 | /// <li>@c kFIRParameterValue (signed 64-bit integer or double as NSNumber)</li> | |
| 339 | /// </ul> | |
| 340 | static NSString *const kFIREventSpendVirtualCurrency | |
| 341 | NS_SWIFT_NAME(AnalyticsEventSpendVirtualCurrency) = @"spend_virtual_currency"; | |
| 342 | ||
| 343 | /// Tutorial Begin event. This event signifies the start of the on-boarding process in your app. Use | |
| 344 | /// this in a funnel with kFIREventTutorialComplete to understand how many users complete this | |
| 345 | /// process and move on to the full app experience. | |
| 346 | static NSString *const kFIREventTutorialBegin NS_SWIFT_NAME(AnalyticsEventTutorialBegin) = | |
| 347 | @"tutorial_begin"; | |
| 348 | ||
| 349 | /// Tutorial End event. Use this event to signify the user's completion of your app's on-boarding | |
| 350 | /// process. Add this to a funnel with kFIREventTutorialBegin to gauge the completion rate of your | |
| 351 | /// on-boarding process. | |
| 352 | static NSString *const kFIREventTutorialComplete NS_SWIFT_NAME(AnalyticsEventTutorialComplete) = | |
| 353 | @"tutorial_complete"; | |
| 354 | ||
| 355 | /// Unlock Achievement event. Log this event when the user has unlocked an achievement in your | |
| 356 | /// game. Since achievements generally represent the breadth of a gaming experience, this event can | |
| 357 | /// help you understand how many users are experiencing all that your game has to offer. Params: | |
| 358 | /// | |
| 359 | /// <ul> | |
| 360 | /// <li>@c kFIRParameterAchievementID (NSString)</li> | |
| 361 | /// </ul> | |
| 362 | static NSString *const kFIREventUnlockAchievement NS_SWIFT_NAME(AnalyticsEventUnlockAchievement) = | |
| 363 | @"unlock_achievement"; | |
| 364 | ||
| 365 | /// View Item event. This event signifies that a user has viewed an item. Use the appropriate | |
| 366 | /// parameters to contextualize the event. Use this event to discover the most popular items viewed | |
| 367 | /// in your app. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the | |
| 368 | /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: | |
| 369 | /// | |
| 370 | /// <ul> | |
| 371 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 372 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 373 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 374 | /// </ul> | |
| 375 | static NSString *const kFIREventViewItem NS_SWIFT_NAME(AnalyticsEventViewItem) = @"view_item"; | |
| 376 | ||
| 377 | /// View Item List event. Log this event when a user sees a list of items or offerings. Params: | |
| 378 | /// | |
| 379 | /// <ul> | |
| 380 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 381 | /// <li>@c kFIRParameterItemListID (NSString) (optional)</li> | |
| 382 | /// <li>@c kFIRParameterItemListName (NSString) (optional)</li> | |
| 383 | /// </ul> | |
| 384 | static NSString *const kFIREventViewItemList NS_SWIFT_NAME(AnalyticsEventViewItemList) = | |
| 385 | @"view_item_list"; | |
| 386 | ||
| 387 | /// View Search Results event. Log this event when the user has been presented with the results of a | |
| 388 | /// search. Params: | |
| 389 | /// | |
| 390 | /// <ul> | |
| 391 | /// <li>@c kFIRParameterSearchTerm (NSString)</li> | |
| 392 | /// </ul> | |
| 393 | static NSString *const kFIREventViewSearchResults NS_SWIFT_NAME(AnalyticsEventViewSearchResults) = | |
| 394 | @"view_search_results"; | |
| 395 | ||
| 396 | /// Add Shipping Info event. This event signifies that a user has submitted their shipping | |
| 397 | /// information. Note: If you supply the @c kFIRParameterValue parameter, you must also supply the | |
| 398 | /// @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. Params: | |
| 399 | /// | |
| 400 | /// <ul> | |
| 401 | /// <li>@c kFIRParameterCoupon (NSString) (optional)</li> | |
| 402 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 403 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 404 | /// <li>@c kFIRParameterShippingTier (NSString) (optional)</li> | |
| 405 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 406 | /// </ul> | |
| 407 | static NSString *const kFIREventAddShippingInfo NS_SWIFT_NAME(AnalyticsEventAddShippingInfo) = | |
| 408 | @"add_shipping_info"; | |
| 409 | ||
| 410 | /// E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user. Note: | |
| 411 | /// This is different from the in-app purchase event, which is reported automatically for App | |
| 412 | /// Store-based apps. Note: If you supply the @c kFIRParameterValue parameter, you must also supply | |
| 413 | /// the @c kFIRParameterCurrency parameter so that revenue metrics can be computed accurately. | |
| 414 | /// Params: | |
| 415 | /// | |
| 416 | /// <ul> | |
| 417 | /// <li>@c kFIRParameterAffiliation (NSString) (optional)</li> | |
| 418 | /// <li>@c kFIRParameterCoupon (NSString) (optional)</li> | |
| 419 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 420 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 421 | /// <li>@c kFIRParameterShipping (double as NSNumber) (optional)</li> | |
| 422 | /// <li>@c kFIRParameterTax (double as NSNumber) (optional)</li> | |
| 423 | /// <li>@c kFIRParameterTransactionID (NSString) (optional)</li> | |
| 424 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 425 | /// </ul> | |
| 426 | static NSString *const kFIREventPurchase NS_SWIFT_NAME(AnalyticsEventPurchase) = @"purchase"; | |
| 427 | ||
| 428 | /// E-Commerce Refund event. This event signifies that a refund was issued. Note: If you supply the | |
| 429 | /// @c kFIRParameterValue parameter, you must also supply the @c kFIRParameterCurrency parameter so | |
| 430 | /// that revenue metrics can be computed accurately. Params: | |
| 431 | /// | |
| 432 | /// <ul> | |
| 433 | /// <li>@c kFIRParameterAffiliation (NSString) (optional)</li> | |
| 434 | /// <li>@c kFIRParameterCoupon (NSString) (optional)</li> | |
| 435 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 436 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 437 | /// <li>@c kFIRParameterShipping (double as NSNumber) (optional)</li> | |
| 438 | /// <li>@c kFIRParameterTax (double as NSNumber) (optional)</li> | |
| 439 | /// <li>@c kFIRParameterTransactionID (NSString) (optional)</li> | |
| 440 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 441 | /// </ul> | |
| 442 | static NSString *const kFIREventRefund NS_SWIFT_NAME(AnalyticsEventRefund) = @"refund"; | |
| 443 | ||
| 444 | /// Select Item event. This event signifies that an item was selected by a user from a list. Use the | |
| 445 | /// appropriate parameters to contextualize the event. Use this event to discover the most popular | |
| 446 | /// items selected. Params: | |
| 447 | /// | |
| 448 | /// <ul> | |
| 449 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 450 | /// <li>@c kFIRParameterItemListID (NSString) (optional)</li> | |
| 451 | /// <li>@c kFIRParameterItemListName (NSString) (optional)</li> | |
| 452 | /// </ul> | |
| 453 | static NSString *const kFIREventSelectItem NS_SWIFT_NAME(AnalyticsEventSelectItem) = @"select_item"; | |
| 454 | ||
| 455 | /// Select promotion event. This event signifies that a user has selected a promotion offer. Use the | |
| 456 | /// appropriate parameters to contextualize the event, such as the item(s) for which the promotion | |
| 457 | /// applies. Params: | |
| 458 | /// | |
| 459 | /// <ul> | |
| 460 | /// <li>@c kFIRParameterCreativeName (NSString) (optional)</li> | |
| 461 | /// <li>@c kFIRParameterCreativeSlot (NSString) (optional)</li> | |
| 462 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 463 | /// <li>@c kFIRParameterLocationID (NSString) (optional)</li> | |
| 464 | /// <li>@c kFIRParameterPromotionID (NSString) (optional)</li> | |
| 465 | /// <li>@c kFIRParameterPromotionName (NSString) (optional)</li> | |
| 466 | /// </ul> | |
| 467 | static NSString *const kFIREventSelectPromotion NS_SWIFT_NAME(AnalyticsEventSelectPromotion) = | |
| 468 | @"select_promotion"; | |
| 469 | ||
| 470 | /// E-commerce View Cart event. This event signifies that a user has viewed their cart. Use this to | |
| 471 | /// analyze your purchase funnel. Note: If you supply the @c kFIRParameterValue parameter, you must | |
| 472 | /// also supply the @c kFIRParameterCurrency parameter so that revenue metrics can be computed | |
| 473 | /// accurately. Params: | |
| 474 | /// | |
| 475 | /// <ul> | |
| 476 | /// <li>@c kFIRParameterCurrency (NSString) (optional)</li> | |
| 477 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 478 | /// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li> | |
| 479 | /// </ul> | |
| 480 | static NSString *const kFIREventViewCart NS_SWIFT_NAME(AnalyticsEventViewCart) = @"view_cart"; | |
| 481 | ||
| 482 | /// View Promotion event. This event signifies that a promotion was shown to a user. Add this event | |
| 483 | /// to a funnel with the @c kFIREventAddToCart and @c kFIREventPurchase to gauge your conversion | |
| 484 | /// process. Params: | |
| 485 | /// | |
| 486 | /// <ul> | |
| 487 | /// <li>@c kFIRParameterCreativeName (NSString) (optional)</li> | |
| 488 | /// <li>@c kFIRParameterCreativeSlot (NSString) (optional)</li> | |
| 489 | /// <li>@c kFIRParameterItems (NSArray) (optional)</li> | |
| 490 | /// <li>@c kFIRParameterLocationID (NSString) (optional)</li> | |
| 491 | /// <li>@c kFIRParameterPromotionID (NSString) (optional)</li> | |
| 492 | /// <li>@c kFIRParameterPromotionName (NSString) (optional)</li> | |
| 493 | /// </ul> | |
| 494 | static NSString *const kFIREventViewPromotion NS_SWIFT_NAME(AnalyticsEventViewPromotion) = | |
| 495 | @"view_promotion"; | |
