/// @file FIRParameterNames.h /// /// Predefined event parameter names. /// /// Params supply information that contextualize Events. You can associate up to 25 unique Params /// with each Event type. Some Params are suggested below for certain common Events, but you are /// not limited to these. You may supply extra Params for suggested Events or custom Params for /// Custom events. Param names can be up to 40 characters long, may only contain alphanumeric /// characters and underscores ("_"), and must start with an alphabetic character. Param values can /// be up to 100 characters long. The "firebase_", "google_", and "ga_" prefixes are reserved and /// should not be used. #import /// Game achievement ID (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterAchievementID : @"10_matches_won",
///       // ...
///     };
/// 
static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) = @"achievement_id"; /// Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format. ///
///     NSDictionary *params = @{
///       kFIRParameterAdNetworkClickID : @"1234567",
///       // ...
///     };
/// 
static NSString *const kFIRParameterAdNetworkClickID NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid"; /// A product affiliation to designate a supplying company or brick and mortar store location /// (NSString).
///     NSDictionary *params = @{
///       kFIRParameterAffiliation : @"Google Store",
///       // ...
///     };
/// 
static NSString *const kFIRParameterAffiliation NS_SWIFT_NAME(AnalyticsParameterAffiliation) = @"affiliation"; /// The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to /// capture campaign information, otherwise can be populated by developer. Highly Recommended /// (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCampaign : @"winter_promotion",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) = @"campaign"; /// Character used in game (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCharacter : @"beat_boss",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCharacter NS_SWIFT_NAME(AnalyticsParameterCharacter) = @"character"; /// The checkout step (1..N) (unsigned 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterCheckoutStep : @"1",
///       // ...
///     };
/// 
/// This constant has been deprecated. static NSString *const kFIRParameterCheckoutStep NS_SWIFT_NAME(AnalyticsParameterCheckoutStep) = @"checkout_step"; /// Some option on a step in an ecommerce flow (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCheckoutOption : @"Visa",
///       // ...
///     };
/// 
/// This constant has been deprecated. static NSString *const kFIRParameterCheckoutOption NS_SWIFT_NAME(AnalyticsParameterCheckoutOption) = @"checkout_option"; /// Campaign content (NSString). static NSString *const kFIRParameterContent NS_SWIFT_NAME(AnalyticsParameterContent) = @"content"; /// Type of content selected (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterContentType : @"news article",
///       // ...
///     };
/// 
static NSString *const kFIRParameterContentType NS_SWIFT_NAME(AnalyticsParameterContentType) = @"content_type"; /// Coupon code used for a purchase (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCoupon : @"SUMMER_FUN",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCoupon NS_SWIFT_NAME(AnalyticsParameterCoupon) = @"coupon"; /// Campaign custom parameter (NSString). Used as a method of capturing custom data in a campaign. /// Use varies by network. ///
///     NSDictionary *params = @{
///       kFIRParameterCP1 : @"custom_data",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCP1 NS_SWIFT_NAME(AnalyticsParameterCP1) = @"cp1"; /// The name of a creative used in a promotional spot (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCreativeName : @"Summer Sale",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCreativeName NS_SWIFT_NAME(AnalyticsParameterCreativeName) = @"creative_name"; /// The name of a creative slot (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCreativeSlot : @"summer_banner2",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCreativeSlot NS_SWIFT_NAME(AnalyticsParameterCreativeSlot) = @"creative_slot"; /// Currency of the purchase or items associated with the event, in 3-letter /// ISO_4217 format (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterCurrency : @"USD",
///       // ...
///     };
/// 
static NSString *const kFIRParameterCurrency NS_SWIFT_NAME(AnalyticsParameterCurrency) = @"currency"; /// Flight or Travel destination (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterDestination : @"Mountain View, CA",
///       // ...
///     };
/// 
static NSString *const kFIRParameterDestination NS_SWIFT_NAME(AnalyticsParameterDestination) = @"destination"; /// The arrival date, check-out date or rental end date for the item. This should be in /// YYYY-MM-DD format (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterEndDate : @"2015-09-14",
///       // ...
///     };
/// 
static NSString *const kFIRParameterEndDate NS_SWIFT_NAME(AnalyticsParameterEndDate) = @"end_date"; /// Flight number for travel events (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterFlightNumber : @"ZZ800",
///       // ...
///     };
/// 
static NSString *const kFIRParameterFlightNumber NS_SWIFT_NAME(AnalyticsParameterFlightNumber) = @"flight_number"; /// Group/clan/guild ID (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterGroupID : @"g1",
///       // ...
///     };
/// 
static NSString *const kFIRParameterGroupID NS_SWIFT_NAME(AnalyticsParameterGroupID) = @"group_id"; /// The index of the item in a list (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterIndex : @(5),
///       // ...
///     };
/// 
static NSString *const kFIRParameterIndex NS_SWIFT_NAME(AnalyticsParameterIndex) = @"index"; /// Item brand (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemBrand : @"Google",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemBrand NS_SWIFT_NAME(AnalyticsParameterItemBrand) = @"item_brand"; /// Item category (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemCategory : @"pants",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemCategory NS_SWIFT_NAME(AnalyticsParameterItemCategory) = @"item_category"; /// Item ID (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemID : @"SKU_12345",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemID NS_SWIFT_NAME(AnalyticsParameterItemID) = @"item_id"; /// The Google Place ID (NSString) that /// corresponds to the associated item. Alternatively, you can supply your own custom Location ID. ///
///     NSDictionary *params = @{
///       kFIRParameterItemLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
///       // ...
///     };
/// 
/// This constant has been deprecated. Use @c kFIRParameterLocationID constant instead. static NSString *const kFIRParameterItemLocationID NS_SWIFT_NAME(AnalyticsParameterItemLocationID) = @"item_location_id"; /// Item Name (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemName : @"jeggings",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemName NS_SWIFT_NAME(AnalyticsParameterItemName) = @"item_name"; /// The list in which the item was presented to the user (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemList : @"Search Results",
///       // ...
///     };
/// 
/// This constant has been deprecated. Use @c kFIRParameterItemListName constant instead. static NSString *const kFIRParameterItemList NS_SWIFT_NAME(AnalyticsParameterItemList) = @"item_list"; /// Item variant (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemVariant : @"Black",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemVariant NS_SWIFT_NAME(AnalyticsParameterItemVariant) = @"item_variant"; /// Level in game (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterLevel : @(42),
///       // ...
///     };
/// 
static NSString *const kFIRParameterLevel NS_SWIFT_NAME(AnalyticsParameterLevel) = @"level"; /// Location (NSString). The Google Place ID /// that corresponds to the associated event. Alternatively, you can supply your own custom /// Location ID. ///
///     NSDictionary *params = @{
///       kFIRParameterLocation : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
///       // ...
///     };
/// 
static NSString *const kFIRParameterLocation NS_SWIFT_NAME(AnalyticsParameterLocation) = @"location"; /// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended /// (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterMedium : @"email",
///       // ...
///     };
/// 
static NSString *const kFIRParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium"; /// Number of nights staying at hotel (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterNumberOfNights : @(3),
///       // ...
///     };
/// 
static NSString *const kFIRParameterNumberOfNights NS_SWIFT_NAME(AnalyticsParameterNumberOfNights) = @"number_of_nights"; /// Number of passengers traveling (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterNumberOfPassengers : @(11),
///       // ...
///     };
/// 
static NSString *const kFIRParameterNumberOfPassengers NS_SWIFT_NAME(AnalyticsParameterNumberOfPassengers) = @"number_of_passengers"; /// Number of rooms for travel events (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterNumberOfRooms : @(2),
///       // ...
///     };
/// 
static NSString *const kFIRParameterNumberOfRooms NS_SWIFT_NAME(AnalyticsParameterNumberOfRooms) = @"number_of_rooms"; /// Flight or Travel origin (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterOrigin : @"Mountain View, CA",
///       // ...
///     };
/// 
static NSString *const kFIRParameterOrigin NS_SWIFT_NAME(AnalyticsParameterOrigin) = @"origin"; /// Purchase price (double as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterPrice : @(1.0),
///       kFIRParameterCurrency : @"USD",  // e.g. $1.00 USD
///       // ...
///     };
/// 
static NSString *const kFIRParameterPrice NS_SWIFT_NAME(AnalyticsParameterPrice) = @"price"; /// Purchase quantity (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterQuantity : @(1),
///       // ...
///     };
/// 
static NSString *const kFIRParameterQuantity NS_SWIFT_NAME(AnalyticsParameterQuantity) = @"quantity"; /// Score in game (signed 64-bit integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterScore : @(4200),
///       // ...
///     };
/// 
static NSString *const kFIRParameterScore NS_SWIFT_NAME(AnalyticsParameterScore) = @"score"; /// The search string/keywords used (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterSearchTerm : @"periodic table",
///       // ...
///     };
/// 
static NSString *const kFIRParameterSearchTerm NS_SWIFT_NAME(AnalyticsParameterSearchTerm) = @"search_term"; /// Shipping cost associated with a transaction (double as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterShipping : @(5.99),
///       kFIRParameterCurrency : @"USD",  // e.g. $5.99 USD
///       // ...
///     };
/// 
static NSString *const kFIRParameterShipping NS_SWIFT_NAME(AnalyticsParameterShipping) = @"shipping"; /// Sign up method (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterSignUpMethod : @"google",
///       // ...
///     };
/// 
/// /// This constant has been deprecated. Use Method constant instead. static NSString *const kFIRParameterSignUpMethod NS_SWIFT_NAME(AnalyticsParameterSignUpMethod) = @"sign_up_method"; /// A particular approach used in an operation; for example, "facebook" or "email" in the context /// of a sign_up or login event. (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterMethod : @"google",
///       // ...
///     };
/// 
static NSString *const kFIRParameterMethod NS_SWIFT_NAME(AnalyticsParameterMethod) = @"method"; /// The origin of your traffic, such as an Ad network (for example, google) or partner (urban /// airship). Identify the advertiser, site, publication, etc. that is sending traffic to your /// property. Highly recommended (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterSource : @"InMobi",
///       // ...
///     };
/// 
static NSString *const kFIRParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source"; /// The departure date, check-in date or rental start date for the item. This should be in /// YYYY-MM-DD format (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterStartDate : @"2015-09-14",
///       // ...
///     };
/// 
static NSString *const kFIRParameterStartDate NS_SWIFT_NAME(AnalyticsParameterStartDate) = @"start_date"; /// Tax cost associated with a transaction (double as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterTax : @(2.43),
///       kFIRParameterCurrency : @"USD",  // e.g. $2.43 USD
///       // ...
///     };
/// 
static NSString *const kFIRParameterTax NS_SWIFT_NAME(AnalyticsParameterTax) = @"tax"; /// If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword /// (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterTerm : @"game",
///       // ...
///     };
/// 
static NSString *const kFIRParameterTerm NS_SWIFT_NAME(AnalyticsParameterTerm) = @"term"; /// The unique identifier of a transaction (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterTransactionID : @"T12345",
///       // ...
///     };
/// 
static NSString *const kFIRParameterTransactionID NS_SWIFT_NAME(AnalyticsParameterTransactionID) = @"transaction_id"; /// Travel class (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterTravelClass : @"business",
///       // ...
///     };
/// 
static NSString *const kFIRParameterTravelClass NS_SWIFT_NAME(AnalyticsParameterTravelClass) = @"travel_class"; /// A context-specific numeric value which is accumulated automatically for each event type. This is /// a general purpose parameter that is useful for accumulating a key metric that pertains to an /// event. Examples include revenue, distance, time and points. Value should be specified as signed /// 64-bit integer or double as NSNumber. Notes: Values for pre-defined currency-related events /// (such as @c kFIREventAddToCart) should be supplied using double as NSNumber and must be /// accompanied by a @c kFIRParameterCurrency parameter. The valid range of accumulated values is /// [-9,223,372,036,854.77, 9,223,372,036,854.77]. Supplying a non-numeric value, omitting the /// corresponding @c kFIRParameterCurrency parameter, or supplying an invalid /// currency code for conversion events will cause that /// conversion to be omitted from reporting. ///
///     NSDictionary *params = @{
///       kFIRParameterValue : @(3.99),
///       kFIRParameterCurrency : @"USD",  // e.g. $3.99 USD
///       // ...
///     };
/// 
static NSString *const kFIRParameterValue NS_SWIFT_NAME(AnalyticsParameterValue) = @"value"; /// Name of virtual currency type (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterVirtualCurrencyName : @"virtual_currency_name",
///       // ...
///     };
/// 
static NSString *const kFIRParameterVirtualCurrencyName NS_SWIFT_NAME(AnalyticsParameterVirtualCurrencyName) = @"virtual_currency_name"; /// The name of a level in a game (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterLevelName : @"room_1",
///       // ...
///     };
/// 
static NSString *const kFIRParameterLevelName NS_SWIFT_NAME(AnalyticsParameterLevelName) = @"level_name"; /// The result of an operation. Specify 1 to indicate success and 0 to indicate failure (unsigned /// integer as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterSuccess : @(1),
///       // ...
///     };
/// 
static NSString *const kFIRParameterSuccess NS_SWIFT_NAME(AnalyticsParameterSuccess) = @"success"; /// Indicates that the associated event should either extend the current session /// or start a new session if no session was active when the event was logged. /// Specify YES to extend the current session or to start a new session; any /// other value will not extend or start a session. ///
///     NSDictionary *params = @{
///       kFIRParameterExtendSession : @YES,
///       // ...
///     };
/// 
static NSString *const kFIRParameterExtendSession NS_SWIFT_NAME(AnalyticsParameterExtendSession) = @"extend_session"; /// Monetary value of discount associated with a purchase (double as NSNumber). ///
///     NSDictionary *params = @{
///       kFIRParameterDiscount : @(2.0),
///       kFIRParameterCurrency : @"USD",  // e.g. $2.00 USD
///       // ...
///     };
/// 
static NSString *const kFIRParameterDiscount NS_SWIFT_NAME(AnalyticsParameterDiscount) = @"discount"; /// Item Category (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemCategory2 : @"pants",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemCategory2 NS_SWIFT_NAME(AnalyticsParameterItemCategory2) = @"item_category2"; /// Item Category (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemCategory3 : @"pants",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemCategory3 NS_SWIFT_NAME(AnalyticsParameterItemCategory3) = @"item_category3"; /// Item Category (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemCategory4 : @"pants",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemCategory4 NS_SWIFT_NAME(AnalyticsParameterItemCategory4) = @"item_category4"; /// Item Category (context-specific) (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemCategory5 : @"pants",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemCategory5 NS_SWIFT_NAME(AnalyticsParameterItemCategory5) = @"item_category5"; /// The ID of the list in which the item was presented to the userĀ (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemListID : @"ABC123",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemListID NS_SWIFT_NAME(AnalyticsParameterItemListID) = @"item_list_id"; /// The name of the list in which the item was presented to the user (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterItemListName : @"Related products",
///       // ...
///     };
/// 
static NSString *const kFIRParameterItemListName NS_SWIFT_NAME(AnalyticsParameterItemListName) = @"item_list_name"; /// The list of items involved in the transaction. (NSArray). ///
///     NSDictionary *params = @{
///       kFIRParameterItems : @[
///         @{kFIRParameterItemName : @"jeggings", kFIRParameterItemCategory : @"pants"},
///         @{kFIRParameterItemName : @"boots", kFIRParameterItemCategory : @"shoes"},
///       ],
///     };
/// 
static NSString *const kFIRParameterItems NS_SWIFT_NAME(AnalyticsParameterItems) = @"items"; /// The location associated with the event. Preferred to be the Google /// Place ID that corresponds to the /// associated item but could be overridden to a custom location ID string.(NSString).
///     NSDictionary *params = @{
///       kFIRParameterLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
///       // ...
///     };
/// 
static NSString *const kFIRParameterLocationID NS_SWIFT_NAME(AnalyticsParameterLocationID) = @"location_id"; /// The chosen method of payment (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterPaymentType : @"Visa",
///       // ...
///     };
/// 
static NSString *const kFIRParameterPaymentType NS_SWIFT_NAME(AnalyticsParameterPaymentType) = @"payment_type"; /// The ID of a product promotion (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterPromotionID : @"ABC123",
///       // ...
///     };
/// 
static NSString *const kFIRParameterPromotionID NS_SWIFT_NAME(AnalyticsParameterPromotionID) = @"promotion_id"; /// The name of a product promotion (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterPromotionName : @"Summer Sale",
///       // ...
///     };
/// 
static NSString *const kFIRParameterPromotionName NS_SWIFT_NAME(AnalyticsParameterPromotionName) = @"promotion_name"; /// The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item /// (NSString). ///
///     NSDictionary *params = @{
///       kFIRParameterShippingTier : @"Ground",
///       // ...
///     };
/// 
static NSString *const kFIRParameterShippingTier NS_SWIFT_NAME(AnalyticsParameterShippingTier) = @"shipping_tier";