FIRParameterNames.h 25 KB

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