Firebase
view | history | commit | commitdiff
lpw
2024-04-15 8fa52d6d93a9c60f5a09b5fd1c80b3a9c35046d0
commit | author | age
df1e8e 1 /// @file FIRParameterNames.h
L 2 ///
3 /// Predefined event parameter names.
4 ///
5 /// Params supply information that contextualize Events. You can associate up to 25 unique Params
6 /// with each Event type. Some Params are suggested below for certain common Events, but you are
7 /// not limited to these. You may supply extra Params for suggested Events or custom Params for
8 /// Custom events. Param names can be up to 40 characters long, may only contain alphanumeric
9 /// characters and underscores ("_"), and must start with an alphabetic character. Param values can
8fa52d 10 /// be up to 100 characters long for standard Google Analytics properties and up to 500 characters
L 11 /// long for Google Analytics 360 properties. The "firebase_", "google_", and "ga_" prefixes are
12 /// reserved and should not be used.
df1e8e 13
L 14 #import <Foundation/Foundation.h>
15
aca600 16 /// Game achievement ID (String).
df1e8e 17 /// <pre>
aca600 18 ///     let params = [
L 19 ///       AnalyticsParameterAchievementID : "10_matches_won",
df1e8e 20 ///       // ...
aca600 21 ///     ]
df1e8e 22 /// </pre>
L 23 static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) =
24     @"achievement_id";
25
26 /// The ad format (e.g. Banner, Interstitial, Rewarded, Native, Rewarded Interstitial, Instream).
aca600 27 /// (String).
df1e8e 28 /// <pre>
aca600 29 ///     let params = [
L 30 ///       AnalyticsParameterAdFormat : "Banner",
df1e8e 31 ///       // ...
aca600 32 ///     ]
df1e8e 33 /// </pre>
L 34 static NSString *const kFIRParameterAdFormat NS_SWIFT_NAME(AnalyticsParameterAdFormat) =
35     @"ad_format";
36
aca600 37 /// Ad Network Click ID (String). Used for network-specific click IDs which vary in format.
df1e8e 38 /// <pre>
aca600 39 ///     let params = [
L 40 ///       AnalyticsParameterAdNetworkClickID : "1234567",
df1e8e 41 ///       // ...
aca600 42 ///     ]
df1e8e 43 /// </pre>
L 44 static NSString *const kFIRParameterAdNetworkClickID
45     NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid";
46
aca600 47 /// The ad platform (e.g. MoPub, IronSource) (String).
df1e8e 48 /// <pre>
aca600 49 ///     let params = [
L 50 ///       AnalyticsParameterAdPlatform : "MoPub",
df1e8e 51 ///       // ...
aca600 52 ///     ]
df1e8e 53 /// </pre>
L 54 static NSString *const kFIRParameterAdPlatform NS_SWIFT_NAME(AnalyticsParameterAdPlatform) =
55     @"ad_platform";
56
aca600 57 /// The ad source (e.g. AdColony) (String).
df1e8e 58 /// <pre>
aca600 59 ///     let params = [
L 60 ///       AnalyticsParameterAdSource : "AdColony",
df1e8e 61 ///       // ...
aca600 62 ///     ]
df1e8e 63 /// </pre>
L 64 static NSString *const kFIRParameterAdSource NS_SWIFT_NAME(AnalyticsParameterAdSource) =
65     @"ad_source";
66
aca600 67 /// The ad unit name (e.g. Banner_03) (String).
df1e8e 68 /// <pre>
aca600 69 ///     let params = [
L 70 ///       AnalyticsParameterAdUnitName : "Banner_03",
df1e8e 71 ///       // ...
aca600 72 ///     ]
df1e8e 73 /// </pre>
L 74 static NSString *const kFIRParameterAdUnitName NS_SWIFT_NAME(AnalyticsParameterAdUnitName) =
75     @"ad_unit_name";
76
77 /// A product affiliation to designate a supplying company or brick and mortar store location
aca600 78 /// (String). <pre>
L 79 ///     let params = [
80 ///       AnalyticsParameterAffiliation : "Google Store",
df1e8e 81 ///       // ...
aca600 82 ///     ]
df1e8e 83 /// </pre>
L 84 static NSString *const kFIRParameterAffiliation NS_SWIFT_NAME(AnalyticsParameterAffiliation) =
85     @"affiliation";
86
aca600 87 /// Campaign custom parameter (String). Used as a method of capturing custom data in a campaign.
L 88 /// Use varies by network.
89 /// <pre>
90 ///     let params = [
91 ///       AnalyticsParameterCP1 : "custom_data",
92 ///       // ...
93 ///     ]
94 /// </pre>
95 static NSString *const kFIRParameterCP1 NS_SWIFT_NAME(AnalyticsParameterCP1) = @"cp1";
96
df1e8e 97 /// The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to
L 98 /// capture campaign information, otherwise can be populated by developer. Highly Recommended
aca600 99 /// (String).
df1e8e 100 /// <pre>
aca600 101 ///     let params = [
L 102 ///       AnalyticsParameterCampaign : "winter_promotion",
df1e8e 103 ///       // ...
aca600 104 ///     ]
df1e8e 105 /// </pre>
L 106 static NSString *const kFIRParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) =
107     @"campaign";
108
aca600 109 /// Campaign ID (String). Used for keyword analysis to identify a specific product promotion or
L 110 /// strategic campaign. This is a required key for GA4 data import.
df1e8e 111 /// <pre>
aca600 112 ///     let params = [
L 113 ///       AnalyticsParameterCampaignID : "7877652710",
df1e8e 114 ///       // ...
aca600 115 ///     ]
L 116 /// </pre>
117 static NSString *const kFIRParameterCampaignID NS_SWIFT_NAME(AnalyticsParameterCampaignID) =
118     @"campaign_id";
119
120 /// Character used in game (String).
121 /// <pre>
122 ///     let params = [
123 ///       AnalyticsParameterCharacter : "beat_boss",
124 ///       // ...
125 ///     ]
df1e8e 126 /// </pre>
L 127 static NSString *const kFIRParameterCharacter NS_SWIFT_NAME(AnalyticsParameterCharacter) =
128     @"character";
129
aca600 130 /// Campaign content (String).
df1e8e 131 static NSString *const kFIRParameterContent NS_SWIFT_NAME(AnalyticsParameterContent) = @"content";
L 132
aca600 133 /// Type of content selected (String).
df1e8e 134 /// <pre>
aca600 135 ///     let params = [
L 136 ///       AnalyticsParameterContentType : "news article",
df1e8e 137 ///       // ...
aca600 138 ///     ]
df1e8e 139 /// </pre>
L 140 static NSString *const kFIRParameterContentType NS_SWIFT_NAME(AnalyticsParameterContentType) =
141     @"content_type";
142
aca600 143 /// Coupon code used for a purchase (String).
df1e8e 144 /// <pre>
aca600 145 ///     let params = [
L 146 ///       AnalyticsParameterCoupon : "SUMMER_FUN",
df1e8e 147 ///       // ...
aca600 148 ///     ]
df1e8e 149 /// </pre>
L 150 static NSString *const kFIRParameterCoupon NS_SWIFT_NAME(AnalyticsParameterCoupon) = @"coupon";
151
aca600 152 /// Creative Format (String). Used to identify the high-level classification of the type of ad
L 153 /// served by a specific campaign.
df1e8e 154 /// <pre>
aca600 155 ///     let params = [
L 156 ///       AnalyticsParameterCreativeFormat : "display",
df1e8e 157 ///       // ...
aca600 158 ///     ]
df1e8e 159 /// </pre>
aca600 160 static NSString *const kFIRParameterCreativeFormat NS_SWIFT_NAME(AnalyticsParameterCreativeFormat) =
L 161     @"creative_format";
df1e8e 162
aca600 163 /// The name of a creative used in a promotional spot (String).
df1e8e 164 /// <pre>
aca600 165 ///     let params = [
L 166 ///       AnalyticsParameterCreativeName : "Summer Sale",
df1e8e 167 ///       // ...
aca600 168 ///     ]
df1e8e 169 /// </pre>
L 170 static NSString *const kFIRParameterCreativeName NS_SWIFT_NAME(AnalyticsParameterCreativeName) =
171     @"creative_name";
172
aca600 173 /// The name of a creative slot (String).
df1e8e 174 /// <pre>
aca600 175 ///     let params = [
L 176 ///       AnalyticsParameterCreativeSlot : "summer_banner2",
df1e8e 177 ///       // ...
aca600 178 ///     ]
df1e8e 179 /// </pre>
L 180 static NSString *const kFIRParameterCreativeSlot NS_SWIFT_NAME(AnalyticsParameterCreativeSlot) =
181     @"creative_slot";
182
183 /// Currency of the purchase or items associated with the event, in 3-letter
aca600 184 /// <a href="http://en.wikipedia.org/wiki/ISO_4217#Active_codes"> ISO_4217</a> format (String).
df1e8e 185 /// <pre>
aca600 186 ///     let params = [
L 187 ///       AnalyticsParameterCurrency : "USD",
df1e8e 188 ///       // ...
aca600 189 ///     ]
df1e8e 190 /// </pre>
L 191 static NSString *const kFIRParameterCurrency NS_SWIFT_NAME(AnalyticsParameterCurrency) =
192     @"currency";
193
aca600 194 /// Flight or Travel destination (String).
df1e8e 195 /// <pre>
aca600 196 ///     let params = [
L 197 ///       AnalyticsParameterDestination : "Mountain View, CA",
df1e8e 198 ///       // ...
aca600 199 ///     ]
df1e8e 200 /// </pre>
L 201 static NSString *const kFIRParameterDestination NS_SWIFT_NAME(AnalyticsParameterDestination) =
202     @"destination";
203
aca600 204 /// Monetary value of discount associated with a purchase (Double).
df1e8e 205 /// <pre>
aca600 206 ///     let params = [
L 207 ///       AnalyticsParameterDiscount : 2.0,
208 ///       AnalyticsParameterCurrency : "USD",  // e.g. $2.00 USD
df1e8e 209 ///       // ...
aca600 210 ///     ]
L 211 /// </pre>
212 static NSString *const kFIRParameterDiscount NS_SWIFT_NAME(AnalyticsParameterDiscount) =
213     @"discount";
214
215 /// The arrival date, check-out date or rental end date for the item. This should be in
216 /// YYYY-MM-DD format (String).
217 /// <pre>
218 ///     let params = [
219 ///       AnalyticsParameterEndDate : "2015-09-14",
220 ///       // ...
221 ///     ]
df1e8e 222 /// </pre>
L 223 static NSString *const kFIRParameterEndDate NS_SWIFT_NAME(AnalyticsParameterEndDate) = @"end_date";
224
aca600 225 /// Indicates that the associated event should either extend the current session or start a new
L 226 /// session if no session was active when the event was logged. Specify 1 to extend the current
227 /// session or to start a new session; any other value will not extend or start a session.
df1e8e 228 /// <pre>
aca600 229 ///     let params = [
L 230 ///       AnalyticsParameterExtendSession : 1,
df1e8e 231 ///       // ...
aca600 232 ///     ]
L 233 /// </pre>
234 static NSString *const kFIRParameterExtendSession NS_SWIFT_NAME(AnalyticsParameterExtendSession) =
235     @"extend_session";
236
237 /// Flight number for travel events (String).
238 /// <pre>
239 ///     let params = [
240 ///       AnalyticsParameterFlightNumber : "ZZ800",
241 ///       // ...
242 ///     ]
df1e8e 243 /// </pre>
L 244 static NSString *const kFIRParameterFlightNumber NS_SWIFT_NAME(AnalyticsParameterFlightNumber) =
245     @"flight_number";
246
aca600 247 /// Group/clan/guild ID (String).
df1e8e 248 /// <pre>
aca600 249 ///     let params = [
L 250 ///       AnalyticsParameterGroupID : "g1",
df1e8e 251 ///       // ...
aca600 252 ///     ]
df1e8e 253 /// </pre>
L 254 static NSString *const kFIRParameterGroupID NS_SWIFT_NAME(AnalyticsParameterGroupID) = @"group_id";
255
aca600 256 /// The index of the item in a list (Int).
df1e8e 257 /// <pre>
aca600 258 ///     let params = [
L 259 ///       AnalyticsParameterIndex : 5,
df1e8e 260 ///       // ...
aca600 261 ///     ]
df1e8e 262 /// </pre>
L 263 static NSString *const kFIRParameterIndex NS_SWIFT_NAME(AnalyticsParameterIndex) = @"index";
264
aca600 265 /// Item brand (String).
df1e8e 266 /// <pre>
aca600 267 ///     let params = [
L 268 ///       AnalyticsParameterItemBrand : "Google",
df1e8e 269 ///       // ...
aca600 270 ///     ]
df1e8e 271 /// </pre>
L 272 static NSString *const kFIRParameterItemBrand NS_SWIFT_NAME(AnalyticsParameterItemBrand) =
273     @"item_brand";
274
aca600 275 /// Item category (context-specific) (String).
df1e8e 276 /// <pre>
aca600 277 ///     let params = [
L 278 ///       AnalyticsParameterItemCategory : "pants",
df1e8e 279 ///       // ...
aca600 280 ///     ]
df1e8e 281 /// </pre>
L 282 static NSString *const kFIRParameterItemCategory NS_SWIFT_NAME(AnalyticsParameterItemCategory) =
283     @"item_category";
284
aca600 285 /// Item Category (context-specific) (String).
df1e8e 286 /// <pre>
aca600 287 ///     let params = [
L 288 ///       AnalyticsParameterItemCategory2 : "pants",
df1e8e 289 ///       // ...
aca600 290 ///     ]
L 291 /// </pre>
292 static NSString *const kFIRParameterItemCategory2 NS_SWIFT_NAME(AnalyticsParameterItemCategory2) =
293     @"item_category2";
294
295 /// Item Category (context-specific) (String).
296 /// <pre>
297 ///     let params = [
298 ///       AnalyticsParameterItemCategory3 : "pants",
299 ///       // ...
300 ///     ]
301 /// </pre>
302 static NSString *const kFIRParameterItemCategory3 NS_SWIFT_NAME(AnalyticsParameterItemCategory3) =
303     @"item_category3";
304
305 /// Item Category (context-specific) (String).
306 /// <pre>
307 ///     let params = [
308 ///       AnalyticsParameterItemCategory4 : "pants",
309 ///       // ...
310 ///     ]
311 /// </pre>
312 static NSString *const kFIRParameterItemCategory4 NS_SWIFT_NAME(AnalyticsParameterItemCategory4) =
313     @"item_category4";
314
315 /// Item Category (context-specific) (String).
316 /// <pre>
317 ///     let params = [
318 ///       AnalyticsParameterItemCategory5 : "pants",
319 ///       // ...
320 ///     ]
321 /// </pre>
322 static NSString *const kFIRParameterItemCategory5 NS_SWIFT_NAME(AnalyticsParameterItemCategory5) =
323     @"item_category5";
324
325 /// Item ID (context-specific) (String).
326 /// <pre>
327 ///     let params = [
328 ///       AnalyticsParameterItemID : "SKU_12345",
329 ///       // ...
330 ///     ]
df1e8e 331 /// </pre>
L 332 static NSString *const kFIRParameterItemID NS_SWIFT_NAME(AnalyticsParameterItemID) = @"item_id";
333
aca600 334 /// The ID of the list in which the item was presented to the user (String).
df1e8e 335 /// <pre>
aca600 336 ///     let params = [
L 337 ///       AnalyticsParameterItemListID : "ABC123",
df1e8e 338 ///       // ...
aca600 339 ///     ]
df1e8e 340 /// </pre>
aca600 341 static NSString *const kFIRParameterItemListID NS_SWIFT_NAME(AnalyticsParameterItemListID) =
L 342     @"item_list_id";
df1e8e 343
aca600 344 /// The name of the list in which the item was presented to the user (String).
df1e8e 345 /// <pre>
aca600 346 ///     let params = [
L 347 ///       AnalyticsParameterItemListName : "Related products",
df1e8e 348 ///       // ...
aca600 349 ///     ]
L 350 /// </pre>
351 static NSString *const kFIRParameterItemListName NS_SWIFT_NAME(AnalyticsParameterItemListName) =
352     @"item_list_name";
353
354 /// Item Name (context-specific) (String).
355 /// <pre>
356 ///     let params = [
357 ///       AnalyticsParameterItemName : "jeggings",
358 ///       // ...
359 ///     ]
df1e8e 360 /// </pre>
L 361 static NSString *const kFIRParameterItemName NS_SWIFT_NAME(AnalyticsParameterItemName) =
362     @"item_name";
363
aca600 364 /// Item variant (String).
df1e8e 365 /// <pre>
aca600 366 ///     let params = [
L 367 ///       AnalyticsParameterItemVariant : "Black",
df1e8e 368 ///       // ...
aca600 369 ///     ]
df1e8e 370 /// </pre>
L 371 static NSString *const kFIRParameterItemVariant NS_SWIFT_NAME(AnalyticsParameterItemVariant) =
372     @"item_variant";
373
aca600 374 /// The list of items involved in the transaction expressed as `[[String: Any]]`.
df1e8e 375 /// <pre>
aca600 376 ///     let params = [
L 377 ///       AnalyticsParameterItems : [
378 ///         [AnalyticsParameterItemName : "jeggings", AnalyticsParameterItemCategory : "pants"],
379 ///         [AnalyticsParameterItemName : "boots", AnalyticsParameterItemCategory : "shoes"],
380 ///       ],
381 ///     ]
382 /// </pre>
383 static NSString *const kFIRParameterItems NS_SWIFT_NAME(AnalyticsParameterItems) = @"items";
384
385 /// Level in game (Int).
386 /// <pre>
387 ///     let params = [
388 ///       AnalyticsParameterLevel : 42,
df1e8e 389 ///       // ...
aca600 390 ///     ]
df1e8e 391 /// </pre>
L 392 static NSString *const kFIRParameterLevel NS_SWIFT_NAME(AnalyticsParameterLevel) = @"level";
393
aca600 394 /// The name of a level in a game (String).
L 395 /// <pre>
396 ///     let params = [
397 ///       AnalyticsParameterLevelName : "room_1",
398 ///       // ...
399 ///     ]
400 /// </pre>
401 static NSString *const kFIRParameterLevelName NS_SWIFT_NAME(AnalyticsParameterLevelName) =
402     @"level_name";
403
404 /// Location (String). The Google <a href="https://developers.google.com/places/place-id">Place ID
df1e8e 405 /// </a> that corresponds to the associated event. Alternatively, you can supply your own custom
L 406 /// Location ID.
407 /// <pre>
aca600 408 ///     let params = [
L 409 ///       AnalyticsParameterLocation : "ChIJiyj437sx3YAR9kUWC8QkLzQ",
df1e8e 410 ///       // ...
aca600 411 ///     ]
df1e8e 412 /// </pre>
L 413 static NSString *const kFIRParameterLocation NS_SWIFT_NAME(AnalyticsParameterLocation) =
414     @"location";
415
aca600 416 /// The location associated with the event. Preferred to be the Google
L 417 /// <a href="https://developers.google.com/places/place-id">Place ID</a> that corresponds to the
418 /// associated item but could be overridden to a custom location ID string.(String).
df1e8e 419 /// <pre>
aca600 420 ///     let params = [
L 421 ///       AnalyticsParameterLocationID : "ChIJiyj437sx3YAR9kUWC8QkLzQ",
df1e8e 422 ///       // ...
aca600 423 ///     ]
L 424 /// </pre>
425 static NSString *const kFIRParameterLocationID NS_SWIFT_NAME(AnalyticsParameterLocationID) =
426     @"location_id";
427
428 /// Marketing Tactic (String). Used to identify the targeting criteria applied to a specific
429 /// campaign.
430 /// <pre>
431 ///     let params = [
432 ///       AnalyticsParameterMarketingTactic : "Remarketing",
433 ///       // ...
434 ///     ]
435 /// </pre>
436 static NSString *const kFIRParameterMarketingTactic
437     NS_SWIFT_NAME(AnalyticsParameterMarketingTactic) = @"marketing_tactic";
438
439 /// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended
440 /// (String).
441 /// <pre>
442 ///     let params = [
443 ///       AnalyticsParameterMedium : "email",
444 ///       // ...
445 ///     ]
df1e8e 446 /// </pre>
L 447 static NSString *const kFIRParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium";
448
aca600 449 /// A particular approach used in an operation; for example, "facebook" or "email" in the context
L 450 /// of a sign_up or login event. (String).
df1e8e 451 /// <pre>
aca600 452 ///     let params = [
L 453 ///       AnalyticsParameterMethod : "google",
df1e8e 454 ///       // ...
aca600 455 ///     ]
L 456 /// </pre>
457 static NSString *const kFIRParameterMethod NS_SWIFT_NAME(AnalyticsParameterMethod) = @"method";
458
459 /// Number of nights staying at hotel (Int).
460 /// <pre>
461 ///     let params = [
462 ///       AnalyticsParameterNumberOfNights : 3,
463 ///       // ...
464 ///     ]
df1e8e 465 /// </pre>
L 466 static NSString *const kFIRParameterNumberOfNights
467     NS_SWIFT_NAME(AnalyticsParameterNumberOfNights) = @"number_of_nights";
468
aca600 469 /// Number of passengers traveling (Int).
df1e8e 470 /// <pre>
aca600 471 ///     let params = [
L 472 ///       AnalyticsParameterNumberOfPassengers : 11,
df1e8e 473 ///       // ...
aca600 474 ///     ]
df1e8e 475 /// </pre>
L 476 static NSString *const kFIRParameterNumberOfPassengers
477     NS_SWIFT_NAME(AnalyticsParameterNumberOfPassengers) = @"number_of_passengers";
478
aca600 479 /// Number of rooms for travel events (Int).
df1e8e 480 /// <pre>
aca600 481 ///     let params = [
L 482 ///       AnalyticsParameterNumberOfRooms : 2,
df1e8e 483 ///       // ...
aca600 484 ///     ]
df1e8e 485 /// </pre>
L 486 static NSString *const kFIRParameterNumberOfRooms NS_SWIFT_NAME(AnalyticsParameterNumberOfRooms) =
487     @"number_of_rooms";
488
aca600 489 /// Flight or Travel origin (String).
df1e8e 490 /// <pre>
aca600 491 ///     let params = [
L 492 ///       AnalyticsParameterOrigin : "Mountain View, CA",
df1e8e 493 ///       // ...
aca600 494 ///     ]
df1e8e 495 /// </pre>
L 496 static NSString *const kFIRParameterOrigin NS_SWIFT_NAME(AnalyticsParameterOrigin) = @"origin";
497
aca600 498 /// The chosen method of payment (String).
df1e8e 499 /// <pre>
aca600 500 ///     let params = [
L 501 ///       AnalyticsParameterPaymentType : "Visa",
df1e8e 502 ///       // ...
aca600 503 ///     ]
L 504 /// </pre>
505 static NSString *const kFIRParameterPaymentType NS_SWIFT_NAME(AnalyticsParameterPaymentType) =
506     @"payment_type";
507
508 /// Purchase price (Double).
509 /// <pre>
510 ///     let params = [
511 ///       AnalyticsParameterPrice : 1.0,
512 ///       AnalyticsParameterCurrency : "USD",  // e.g. $1.00 USD
513 ///       // ...
514 ///     ]
df1e8e 515 /// </pre>
L 516 static NSString *const kFIRParameterPrice NS_SWIFT_NAME(AnalyticsParameterPrice) = @"price";
517
aca600 518 /// The ID of a product promotion (String).
df1e8e 519 /// <pre>
aca600 520 ///     let params = [
L 521 ///       AnalyticsParameterPromotionID : "ABC123",
df1e8e 522 ///       // ...
aca600 523 ///     ]
L 524 /// </pre>
525 static NSString *const kFIRParameterPromotionID NS_SWIFT_NAME(AnalyticsParameterPromotionID) =
526     @"promotion_id";
527
528 /// The name of a product promotion (String).
529 /// <pre>
530 ///     let params = [
531 ///       AnalyticsParameterPromotionName : "Summer Sale",
532 ///       // ...
533 ///     ]
534 /// </pre>
535 static NSString *const kFIRParameterPromotionName NS_SWIFT_NAME(AnalyticsParameterPromotionName) =
536     @"promotion_name";
537
538 /// Purchase quantity (Int).
539 /// <pre>
540 ///     let params = [
541 ///       AnalyticsParameterQuantity : 1,
542 ///       // ...
543 ///     ]
df1e8e 544 /// </pre>
L 545 static NSString *const kFIRParameterQuantity NS_SWIFT_NAME(AnalyticsParameterQuantity) =
546     @"quantity";
547
aca600 548 /// Score in game (Int).
df1e8e 549 /// <pre>
aca600 550 ///     let params = [
L 551 ///       AnalyticsParameterScore : 4200,
df1e8e 552 ///       // ...
aca600 553 ///     ]
df1e8e 554 /// </pre>
L 555 static NSString *const kFIRParameterScore NS_SWIFT_NAME(AnalyticsParameterScore) = @"score";
556
557 /// Current screen class, such as the class name of the UIViewController, logged with screen_view
aca600 558 /// event and added to every event (String).
L 559 /// <pre>
560 ///     let params = [
561 ///       AnalyticsParameterScreenClass : "LoginViewController",
df1e8e 562 ///       // ...
aca600 563 ///     ]
df1e8e 564 /// </pre>
L 565 static NSString *const kFIRParameterScreenClass NS_SWIFT_NAME(AnalyticsParameterScreenClass) =
566     @"screen_class";
567
568 /// Current screen name, such as the name of the UIViewController, logged with screen_view event and
aca600 569 /// added to every event (String).
L 570 /// <pre>
571 ///     let params = [
572 ///       AnalyticsParameterScreenName : "LoginView",
df1e8e 573 ///       // ...
aca600 574 ///     ]
df1e8e 575 /// </pre>
L 576 static NSString *const kFIRParameterScreenName NS_SWIFT_NAME(AnalyticsParameterScreenName) =
577     @"screen_name";
578
aca600 579 /// The search string/keywords used (String).
df1e8e 580 /// <pre>
aca600 581 ///     let params = [
L 582 ///       AnalyticsParameterSearchTerm : "periodic table",
df1e8e 583 ///       // ...
aca600 584 ///     ]
df1e8e 585 /// </pre>
L 586 static NSString *const kFIRParameterSearchTerm NS_SWIFT_NAME(AnalyticsParameterSearchTerm) =
587     @"search_term";
588
aca600 589 /// Shipping cost associated with a transaction (Double).
df1e8e 590 /// <pre>
aca600 591 ///     let params = [
L 592 ///       AnalyticsParameterShipping : 5.99,
593 ///       AnalyticsParameterCurrency : "USD",  // e.g. $5.99 USD
df1e8e 594 ///       // ...
aca600 595 ///     ]
df1e8e 596 /// </pre>
L 597 static NSString *const kFIRParameterShipping NS_SWIFT_NAME(AnalyticsParameterShipping) =
598     @"shipping";
599
aca600 600 /// The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item
L 601 /// (String).
df1e8e 602 /// <pre>
aca600 603 ///     let params = [
L 604 ///       AnalyticsParameterShippingTier : "Ground",
df1e8e 605 ///       // ...
aca600 606 ///     ]
df1e8e 607 /// </pre>
aca600 608 static NSString *const kFIRParameterShippingTier NS_SWIFT_NAME(AnalyticsParameterShippingTier) =
L 609     @"shipping_tier";
df1e8e 610
L 611 /// The origin of your traffic, such as an Ad network (for example, google) or partner (urban
612 /// airship). Identify the advertiser, site, publication, etc. that is sending traffic to your
aca600 613 /// property. Highly recommended (String).
df1e8e 614 /// <pre>
aca600 615 ///     let params = [
L 616 ///       AnalyticsParameterSource : "InMobi",
df1e8e 617 ///       // ...
aca600 618 ///     ]
df1e8e 619 /// </pre>
L 620 static NSString *const kFIRParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source";
621
aca600 622 /// Source Platform (String). Used to identify the platform responsible for directing traffic to a
L 623 /// given Analytics property (e.g., a buying platform where budgets, targeting criteria, etc. are
624 /// set, a platform for managing organic traffic data, etc.).
df1e8e 625 /// <pre>
aca600 626 ///     let params = [
L 627 ///       AnalyticsParameterSourcePlatform : "sa360",
df1e8e 628 ///       // ...
aca600 629 ///     ]
L 630 /// </pre>
631 static NSString *const kFIRParameterSourcePlatform NS_SWIFT_NAME(AnalyticsParameterSourcePlatform) =
632     @"source_platform";
633
634 /// The departure date, check-in date or rental start date for the item. This should be in
635 /// YYYY-MM-DD format (String).
636 /// <pre>
637 ///     let params = [
638 ///       AnalyticsParameterStartDate : "2015-09-14",
639 ///       // ...
640 ///     ]
df1e8e 641 /// </pre>
L 642 static NSString *const kFIRParameterStartDate NS_SWIFT_NAME(AnalyticsParameterStartDate) =
643     @"start_date";
644
aca600 645 /// The result of an operation. Specify 1 to indicate success and 0 to indicate failure (Int).
df1e8e 646 /// <pre>
aca600 647 ///     let params = [
L 648 ///       AnalyticsParameterSuccess : 1,
df1e8e 649 ///       // ...
aca600 650 ///     ]
L 651 /// </pre>
652 static NSString *const kFIRParameterSuccess NS_SWIFT_NAME(AnalyticsParameterSuccess) = @"success";
653
654 /// Tax cost associated with a transaction (Double).
655 /// <pre>
656 ///     let params = [
657 ///       AnalyticsParameterTax : 2.43,
658 ///       AnalyticsParameterCurrency : "USD",  // e.g. $2.43 USD
659 ///       // ...
660 ///     ]
df1e8e 661 /// </pre>
L 662 static NSString *const kFIRParameterTax NS_SWIFT_NAME(AnalyticsParameterTax) = @"tax";
663
664 /// If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword
aca600 665 /// (String).
df1e8e 666 /// <pre>
aca600 667 ///     let params = [
L 668 ///       AnalyticsParameterTerm : "game",
df1e8e 669 ///       // ...
aca600 670 ///     ]
df1e8e 671 /// </pre>
L 672 static NSString *const kFIRParameterTerm NS_SWIFT_NAME(AnalyticsParameterTerm) = @"term";
673
aca600 674 /// The unique identifier of a transaction (String).
df1e8e 675 /// <pre>
aca600 676 ///     let params = [
L 677 ///       AnalyticsParameterTransactionID : "T12345",
df1e8e 678 ///       // ...
aca600 679 ///     ]
df1e8e 680 /// </pre>
L 681 static NSString *const kFIRParameterTransactionID NS_SWIFT_NAME(AnalyticsParameterTransactionID) =
682     @"transaction_id";
683
aca600 684 /// Travel class (String).
df1e8e 685 /// <pre>
aca600 686 ///     let params = [
L 687 ///       AnalyticsParameterTravelClass : "business",
df1e8e 688 ///       // ...
aca600 689 ///     ]
df1e8e 690 /// </pre>
L 691 static NSString *const kFIRParameterTravelClass NS_SWIFT_NAME(AnalyticsParameterTravelClass) =
692     @"travel_class";
693
694 /// A context-specific numeric value which is accumulated automatically for each event type. This is
695 /// a general purpose parameter that is useful for accumulating a key metric that pertains to an
aca600 696 /// event. Examples include revenue, distance, time and points. Value should be specified as Int or
L 697 /// Double.
698 /// Notes: Values for pre-defined currency-related events (such as @c AnalyticsEventAddToCart)
699 /// should be supplied using Double and must be accompanied by a @c AnalyticsParameterCurrency
700 /// parameter. The valid range of accumulated values is
df1e8e 701 /// [-9,223,372,036,854.77, 9,223,372,036,854.77]. Supplying a non-numeric value, omitting the
aca600 702 /// corresponding @c AnalyticsParameterCurrency parameter, or supplying an invalid
df1e8e 703 /// <a href="https://goo.gl/qqX3J2">currency code</a> for conversion events will cause that
L 704 /// conversion to be omitted from reporting.
705 /// <pre>
aca600 706 ///     let params = [
L 707 ///       AnalyticsParameterValue : 3.99,
708 ///       AnalyticsParameterCurrency : "USD",  // e.g. $3.99 USD
df1e8e 709 ///       // ...
aca600 710 ///     ]
df1e8e 711 /// </pre>
L 712 static NSString *const kFIRParameterValue NS_SWIFT_NAME(AnalyticsParameterValue) = @"value";
713
aca600 714 /// Name of virtual currency type (String).
df1e8e 715 /// <pre>
aca600 716 ///     let params = [
L 717 ///       AnalyticsParameterVirtualCurrencyName : "virtual_currency_name",
df1e8e 718 ///       // ...
aca600 719 ///     ]
df1e8e 720 /// </pre>
L 721 static NSString *const kFIRParameterVirtualCurrencyName
722     NS_SWIFT_NAME(AnalyticsParameterVirtualCurrencyName) = @"virtual_currency_name";