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