FIRParameterNames.h 23 KB

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