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