Added Android code
[wl-app.git] / iOS / Pods / FirebaseAnalytics / Frameworks / FirebaseAnalytics.framework / Headers / FIRParameterNames.h
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
13 #import <Foundation/Foundation.h>
14
15 /// Game achievement ID (NSString).
16 /// <pre>
17 ///     NSDictionary *params = @{
18 ///       kFIRParameterAchievementID : @"10_matches_won",
19 ///       // ...
20 ///     };
21 /// </pre>
22 static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) =
23     @"achievement_id";
24
25 /// Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format.
26 /// <pre>
27 ///     NSDictionary *params = @{
28 ///       kFIRParameterAdNetworkClickID : @"1234567",
29 ///       // ...
30 ///     };
31 /// </pre>
32 static NSString *const kFIRParameterAdNetworkClickID
33     NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid";
34
35 /// The store or affiliation from which this transaction occurred (NSString).
36 /// <pre>
37 ///     NSDictionary *params = @{
38 ///       kFIRParameterAffiliation : @"Google Store",
39 ///       // ...
40 ///     };
41 /// </pre>
42 static NSString *const kFIRParameterAffiliation NS_SWIFT_NAME(AnalyticsParameterAffiliation) =
43     @"affiliation";
44
45 /// The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to
46 /// capture campaign information, otherwise can be populated by developer. Highly Recommended
47 /// (NSString).
48 /// <pre>
49 ///     NSDictionary *params = @{
50 ///       kFIRParameterCampaign : @"winter_promotion",
51 ///       // ...
52 ///     };
53 /// </pre>
54 static NSString *const kFIRParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) =
55     @"campaign";
56
57 /// Character used in game (NSString).
58 /// <pre>
59 ///     NSDictionary *params = @{
60 ///       kFIRParameterCharacter : @"beat_boss",
61 ///       // ...
62 ///     };
63 /// </pre>
64 static NSString *const kFIRParameterCharacter NS_SWIFT_NAME(AnalyticsParameterCharacter) =
65     @"character";
66
67 /// The checkout step (1..N) (unsigned 64-bit integer as NSNumber).
68 /// <pre>
69 ///     NSDictionary *params = @{
70 ///       kFIRParameterCheckoutStep : @"1",
71 ///       // ...
72 ///     };
73 /// </pre>
74 static NSString *const kFIRParameterCheckoutStep NS_SWIFT_NAME(AnalyticsParameterCheckoutStep) =
75     @"checkout_step";
76
77 /// Some option on a step in an ecommerce flow (NSString).
78 /// <pre>
79 ///     NSDictionary *params = @{
80 ///       kFIRParameterCheckoutOption : @"Visa",
81 ///       // ...
82 ///     };
83 /// </pre>
84 static NSString *const kFIRParameterCheckoutOption
85     NS_SWIFT_NAME(AnalyticsParameterCheckoutOption) = @"checkout_option";
86
87 /// Campaign content (NSString).
88 static NSString *const kFIRParameterContent NS_SWIFT_NAME(AnalyticsParameterContent) = @"content";
89
90 /// Type of content selected (NSString).
91 /// <pre>
92 ///     NSDictionary *params = @{
93 ///       kFIRParameterContentType : @"news article",
94 ///       // ...
95 ///     };
96 /// </pre>
97 static NSString *const kFIRParameterContentType NS_SWIFT_NAME(AnalyticsParameterContentType) =
98     @"content_type";
99
100 /// Coupon code for a purchasable item (NSString).
101 /// <pre>
102 ///     NSDictionary *params = @{
103 ///       kFIRParameterCoupon : @"zz123",
104 ///       // ...
105 ///     };
106 /// </pre>
107 static NSString *const kFIRParameterCoupon NS_SWIFT_NAME(AnalyticsParameterCoupon) = @"coupon";
108
109 /// Campaign custom parameter (NSString). Used as a method of capturing custom data in a campaign.
110 /// Use varies by network.
111 /// <pre>
112 ///     NSDictionary *params = @{
113 ///       kFIRParameterCP1 : @"custom_data",
114 ///       // ...
115 ///     };
116 /// </pre>
117 static NSString *const kFIRParameterCP1 NS_SWIFT_NAME(AnalyticsParameterCP1) = @"cp1";
118
119 /// The name of a creative used in a promotional spot (NSString).
120 /// <pre>
121 ///     NSDictionary *params = @{
122 ///       kFIRParameterCreativeName : @"Summer Sale",
123 ///       // ...
124 ///     };
125 /// </pre>
126 static NSString *const kFIRParameterCreativeName NS_SWIFT_NAME(AnalyticsParameterCreativeName) =
127     @"creative_name";
128
129 /// The name of a creative slot (NSString).
130 /// <pre>
131 ///     NSDictionary *params = @{
132 ///       kFIRParameterCreativeSlot : @"summer_banner2",
133 ///       // ...
134 ///     };
135 /// </pre>
136 static NSString *const kFIRParameterCreativeSlot NS_SWIFT_NAME(AnalyticsParameterCreativeSlot) =
137     @"creative_slot";
138
139 /// Purchase currency in 3-letter <a href="http://en.wikipedia.org/wiki/ISO_4217#Active_codes">
140 /// ISO_4217</a> format (NSString).
141 /// <pre>
142 ///     NSDictionary *params = @{
143 ///       kFIRParameterCurrency : @"USD",
144 ///       // ...
145 ///     };
146 /// </pre>
147 static NSString *const kFIRParameterCurrency NS_SWIFT_NAME(AnalyticsParameterCurrency) =
148     @"currency";
149
150 /// Flight or Travel destination (NSString).
151 /// <pre>
152 ///     NSDictionary *params = @{
153 ///       kFIRParameterDestination : @"Mountain View, CA",
154 ///       // ...
155 ///     };
156 /// </pre>
157 static NSString *const kFIRParameterDestination NS_SWIFT_NAME(AnalyticsParameterDestination) =
158     @"destination";
159
160 /// The arrival date, check-out date or rental end date for the item. This should be in
161 /// YYYY-MM-DD format (NSString).
162 /// <pre>
163 ///     NSDictionary *params = @{
164 ///       kFIRParameterEndDate : @"2015-09-14",
165 ///       // ...
166 ///     };
167 /// </pre>
168 static NSString *const kFIRParameterEndDate NS_SWIFT_NAME(AnalyticsParameterEndDate) = @"end_date";
169
170 /// Flight number for travel events (NSString).
171 /// <pre>
172 ///     NSDictionary *params = @{
173 ///       kFIRParameterFlightNumber : @"ZZ800",
174 ///       // ...
175 ///     };
176 /// </pre>
177 static NSString *const kFIRParameterFlightNumber NS_SWIFT_NAME(AnalyticsParameterFlightNumber) =
178     @"flight_number";
179
180 /// Group/clan/guild ID (NSString).
181 /// <pre>
182 ///     NSDictionary *params = @{
183 ///       kFIRParameterGroupID : @"g1",
184 ///       // ...
185 ///     };
186 /// </pre>
187 static NSString *const kFIRParameterGroupID NS_SWIFT_NAME(AnalyticsParameterGroupID) = @"group_id";
188
189 /// Index of an item in a list (signed 64-bit integer as NSNumber).
190 /// <pre>
191 ///     NSDictionary *params = @{
192 ///       kFIRParameterIndex : @(1),
193 ///       // ...
194 ///     };
195 /// </pre>
196 static NSString *const kFIRParameterIndex NS_SWIFT_NAME(AnalyticsParameterIndex) = @"index";
197
198 /// Item brand (NSString).
199 /// <pre>
200 ///     NSDictionary *params = @{
201 ///       kFIRParameterItemBrand : @"Google",
202 ///       // ...
203 ///     };
204 /// </pre>
205 static NSString *const kFIRParameterItemBrand NS_SWIFT_NAME(AnalyticsParameterItemBrand) =
206     @"item_brand";
207
208 /// Item category (NSString).
209 /// <pre>
210 ///     NSDictionary *params = @{
211 ///       kFIRParameterItemCategory : @"t-shirts",
212 ///       // ...
213 ///     };
214 /// </pre>
215 static NSString *const kFIRParameterItemCategory NS_SWIFT_NAME(AnalyticsParameterItemCategory) =
216     @"item_category";
217
218 /// Item ID (NSString).
219 /// <pre>
220 ///     NSDictionary *params = @{
221 ///       kFIRParameterItemID : @"p7654",
222 ///       // ...
223 ///     };
224 /// </pre>
225 static NSString *const kFIRParameterItemID NS_SWIFT_NAME(AnalyticsParameterItemID) = @"item_id";
226
227 /// The Google <a href="https://developers.google.com/places/place-id">Place ID</a> (NSString) that
228 /// corresponds to the associated item. Alternatively, you can supply your own custom Location ID.
229 /// <pre>
230 ///     NSDictionary *params = @{
231 ///       kFIRParameterItemLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
232 ///       // ...
233 ///     };
234 /// </pre>
235 static NSString *const kFIRParameterItemLocationID
236     NS_SWIFT_NAME(AnalyticsParameterItemLocationID) = @"item_location_id";
237
238 /// Item name (NSString).
239 /// <pre>
240 ///     NSDictionary *params = @{
241 ///       kFIRParameterItemName : @"abc",
242 ///       // ...
243 ///     };
244 /// </pre>
245 static NSString *const kFIRParameterItemName NS_SWIFT_NAME(AnalyticsParameterItemName) =
246     @"item_name";
247
248 /// The list in which the item was presented to the user (NSString).
249 /// <pre>
250 ///     NSDictionary *params = @{
251 ///       kFIRParameterItemList : @"Search Results",
252 ///       // ...
253 ///     };
254 /// </pre>
255 static NSString *const kFIRParameterItemList NS_SWIFT_NAME(AnalyticsParameterItemList) =
256     @"item_list";
257
258 /// Item variant (NSString).
259 /// <pre>
260 ///     NSDictionary *params = @{
261 ///       kFIRParameterItemVariant : @"Red",
262 ///       // ...
263 ///     };
264 /// </pre>
265 static NSString *const kFIRParameterItemVariant NS_SWIFT_NAME(AnalyticsParameterItemVariant) =
266     @"item_variant";
267
268 /// Level in game (signed 64-bit integer as NSNumber).
269 /// <pre>
270 ///     NSDictionary *params = @{
271 ///       kFIRParameterLevel : @(42),
272 ///       // ...
273 ///     };
274 /// </pre>
275 static NSString *const kFIRParameterLevel NS_SWIFT_NAME(AnalyticsParameterLevel) = @"level";
276
277 /// Location (NSString). The Google <a href="https://developers.google.com/places/place-id">Place ID
278 /// </a> that corresponds to the associated event. Alternatively, you can supply your own custom
279 /// Location ID.
280 /// <pre>
281 ///     NSDictionary *params = @{
282 ///       kFIRParameterLocation : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
283 ///       // ...
284 ///     };
285 /// </pre>
286 static NSString *const kFIRParameterLocation NS_SWIFT_NAME(AnalyticsParameterLocation) =
287     @"location";
288
289 /// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended
290 /// (NSString).
291 /// <pre>
292 ///     NSDictionary *params = @{
293 ///       kFIRParameterMedium : @"email",
294 ///       // ...
295 ///     };
296 /// </pre>
297 static NSString *const kFIRParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium";
298
299 /// Number of nights staying at hotel (signed 64-bit integer as NSNumber).
300 /// <pre>
301 ///     NSDictionary *params = @{
302 ///       kFIRParameterNumberOfNights : @(3),
303 ///       // ...
304 ///     };
305 /// </pre>
306 static NSString *const kFIRParameterNumberOfNights
307     NS_SWIFT_NAME(AnalyticsParameterNumberOfNights) = @"number_of_nights";
308
309 /// Number of passengers traveling (signed 64-bit integer as NSNumber).
310 /// <pre>
311 ///     NSDictionary *params = @{
312 ///       kFIRParameterNumberOfPassengers : @(11),
313 ///       // ...
314 ///     };
315 /// </pre>
316 static NSString *const kFIRParameterNumberOfPassengers
317     NS_SWIFT_NAME(AnalyticsParameterNumberOfPassengers) = @"number_of_passengers";
318
319 /// Number of rooms for travel events (signed 64-bit integer as NSNumber).
320 /// <pre>
321 ///     NSDictionary *params = @{
322 ///       kFIRParameterNumberOfRooms : @(2),
323 ///       // ...
324 ///     };
325 /// </pre>
326 static NSString *const kFIRParameterNumberOfRooms NS_SWIFT_NAME(AnalyticsParameterNumberOfRooms) =
327     @"number_of_rooms";
328
329 /// Flight or Travel origin (NSString).
330 /// <pre>
331 ///     NSDictionary *params = @{
332 ///       kFIRParameterOrigin : @"Mountain View, CA",
333 ///       // ...
334 ///     };
335 /// </pre>
336 static NSString *const kFIRParameterOrigin NS_SWIFT_NAME(AnalyticsParameterOrigin) = @"origin";
337
338 /// Purchase price (double as NSNumber).
339 /// <pre>
340 ///     NSDictionary *params = @{
341 ///       kFIRParameterPrice : @(1.0),
342 ///       kFIRParameterCurrency : @"USD",  // e.g. $1.00 USD
343 ///       // ...
344 ///     };
345 /// </pre>
346 static NSString *const kFIRParameterPrice NS_SWIFT_NAME(AnalyticsParameterPrice) = @"price";
347
348 /// Purchase quantity (signed 64-bit integer as NSNumber).
349 /// <pre>
350 ///     NSDictionary *params = @{
351 ///       kFIRParameterQuantity : @(1),
352 ///       // ...
353 ///     };
354 /// </pre>
355 static NSString *const kFIRParameterQuantity NS_SWIFT_NAME(AnalyticsParameterQuantity) =
356     @"quantity";
357
358 /// Score in game (signed 64-bit integer as NSNumber).
359 /// <pre>
360 ///     NSDictionary *params = @{
361 ///       kFIRParameterScore : @(4200),
362 ///       // ...
363 ///     };
364 /// </pre>
365 static NSString *const kFIRParameterScore NS_SWIFT_NAME(AnalyticsParameterScore) = @"score";
366
367 /// The search string/keywords used (NSString).
368 /// <pre>
369 ///     NSDictionary *params = @{
370 ///       kFIRParameterSearchTerm : @"periodic table",
371 ///       // ...
372 ///     };
373 /// </pre>
374 static NSString *const kFIRParameterSearchTerm NS_SWIFT_NAME(AnalyticsParameterSearchTerm) =
375     @"search_term";
376
377 /// Shipping cost (double as NSNumber).
378 /// <pre>
379 ///     NSDictionary *params = @{
380 ///       kFIRParameterShipping : @(9.50),
381 ///       kFIRParameterCurrency : @"USD",  // e.g. $9.50 USD
382 ///       // ...
383 ///     };
384 /// </pre>
385 static NSString *const kFIRParameterShipping NS_SWIFT_NAME(AnalyticsParameterShipping) =
386     @"shipping";
387
388 /// Sign up method (NSString).
389 /// <pre>
390 ///     NSDictionary *params = @{
391 ///       kFIRParameterSignUpMethod : @"google",
392 ///       // ...
393 ///     };
394 /// </pre>
395 static NSString *const kFIRParameterSignUpMethod NS_SWIFT_NAME(AnalyticsParameterSignUpMethod) =
396     @"sign_up_method";
397
398 /// The origin of your traffic, such as an Ad network (for example, google) or partner (urban
399 /// airship). Identify the advertiser, site, publication, etc. that is sending traffic to your
400 /// property. Highly recommended (NSString).
401 /// <pre>
402 ///     NSDictionary *params = @{
403 ///       kFIRParameterSource : @"InMobi",
404 ///       // ...
405 ///     };
406 /// </pre>
407 static NSString *const kFIRParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source";
408
409 /// The departure date, check-in date or rental start date for the item. This should be in
410 /// YYYY-MM-DD format (NSString).
411 /// <pre>
412 ///     NSDictionary *params = @{
413 ///       kFIRParameterStartDate : @"2015-09-14",
414 ///       // ...
415 ///     };
416 /// </pre>
417 static NSString *const kFIRParameterStartDate NS_SWIFT_NAME(AnalyticsParameterStartDate) =
418     @"start_date";
419
420 /// Tax amount (double as NSNumber).
421 /// <pre>
422 ///     NSDictionary *params = @{
423 ///       kFIRParameterTax : @(1.0),
424 ///       kFIRParameterCurrency : @"USD",  // e.g. $1.00 USD
425 ///       // ...
426 ///     };
427 /// </pre>
428 static NSString *const kFIRParameterTax NS_SWIFT_NAME(AnalyticsParameterTax) = @"tax";
429
430 /// If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword
431 /// (NSString).
432 /// <pre>
433 ///     NSDictionary *params = @{
434 ///       kFIRParameterTerm : @"game",
435 ///       // ...
436 ///     };
437 /// </pre>
438 static NSString *const kFIRParameterTerm NS_SWIFT_NAME(AnalyticsParameterTerm) = @"term";
439
440 /// A single ID for a ecommerce group transaction (NSString).
441 /// <pre>
442 ///     NSDictionary *params = @{
443 ///       kFIRParameterTransactionID : @"ab7236dd9823",
444 ///       // ...
445 ///     };
446 /// </pre>
447 static NSString *const kFIRParameterTransactionID NS_SWIFT_NAME(AnalyticsParameterTransactionID) =
448     @"transaction_id";
449
450 /// Travel class (NSString).
451 /// <pre>
452 ///     NSDictionary *params = @{
453 ///       kFIRParameterTravelClass : @"business",
454 ///       // ...
455 ///     };
456 /// </pre>
457 static NSString *const kFIRParameterTravelClass NS_SWIFT_NAME(AnalyticsParameterTravelClass) =
458     @"travel_class";
459
460 /// A context-specific numeric value which is accumulated automatically for each event type. This is
461 /// a general purpose parameter that is useful for accumulating a key metric that pertains to an
462 /// event. Examples include revenue, distance, time and points. Value should be specified as signed
463 /// 64-bit integer or double as NSNumber. Notes: Values for pre-defined currency-related events
464 /// (such as @c kFIREventAddToCart) should be supplied using double as NSNumber and must be
465 /// accompanied by a @c kFIRParameterCurrency parameter. The valid range of accumulated values is
466 /// [-9,223,372,036,854.77, 9,223,372,036,854.77]. Supplying a non-numeric value, omitting the
467 /// corresponding @c kFIRParameterCurrency parameter, or supplying an invalid
468 /// <a href="https://goo.gl/qqX3J2">currency code</a> for conversion events will cause that
469 /// conversion to be omitted from reporting.
470 /// <pre>
471 ///     NSDictionary *params = @{
472 ///       kFIRParameterValue : @(3.99),
473 ///       kFIRParameterCurrency : @"USD",  // e.g. $3.99 USD
474 ///       // ...
475 ///     };
476 /// </pre>
477 static NSString *const kFIRParameterValue NS_SWIFT_NAME(AnalyticsParameterValue) = @"value";
478
479 /// Name of virtual currency type (NSString).
480 /// <pre>
481 ///     NSDictionary *params = @{
482 ///       kFIRParameterVirtualCurrencyName : @"virtual_currency_name",
483 ///       // ...
484 ///     };
485 /// </pre>
486 static NSString *const kFIRParameterVirtualCurrencyName
487     NS_SWIFT_NAME(AnalyticsParameterVirtualCurrencyName) = @"virtual_currency_name";
488
489 /// The name of a level in a game (NSString).
490 /// <pre>
491 ///     NSDictionary *params = @{
492 ///       kFIRParameterLevelName : @"room_1",
493 ///       // ...
494 ///     };
495 /// </pre>
496 static NSString *const kFIRParameterLevelName NS_SWIFT_NAME(AnalyticsParameterLevelName) =
497     @"level_name";
498
499 /// The result of an operation. Specify 1 to indicate success and 0 to indicate failure (unsigned
500 /// integer as NSNumber).
501 /// <pre>
502 ///     NSDictionary *params = @{
503 ///       kFIRParameterSuccess : @(1),
504 ///       // ...
505 ///     };
506 /// </pre>
507 static NSString *const kFIRParameterSuccess NS_SWIFT_NAME(AnalyticsParameterSuccess) = @"success";