/// @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 for standard Google Analytics properties and up to 500 characters /// long for Google Analytics 360 properties. The "firebase_", "google_", and "ga_" prefixes are /// reserved and should not be used. #import /// Game achievement ID (String). ///
///     let params = [
///       AnalyticsParameterAchievementID : "10_matches_won",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) = @"achievement_id"; /// The ad format (e.g. Banner, Interstitial, Rewarded, Native, Rewarded Interstitial, Instream). /// (String). ///
///     let params = [
///       AnalyticsParameterAdFormat : "Banner",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAdFormat NS_SWIFT_NAME(AnalyticsParameterAdFormat) = @"ad_format"; /// Ad Network Click ID (String). Used for network-specific click IDs which vary in format. ///
///     let params = [
///       AnalyticsParameterAdNetworkClickID : "1234567",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAdNetworkClickID NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid"; /// The ad platform (e.g. MoPub, IronSource) (String). ///
///     let params = [
///       AnalyticsParameterAdPlatform : "MoPub",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAdPlatform NS_SWIFT_NAME(AnalyticsParameterAdPlatform) = @"ad_platform"; /// The ad source (e.g. AdColony) (String). ///
///     let params = [
///       AnalyticsParameterAdSource : "AdColony",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAdSource NS_SWIFT_NAME(AnalyticsParameterAdSource) = @"ad_source"; /// The ad unit name (e.g. Banner_03) (String). ///
///     let params = [
///       AnalyticsParameterAdUnitName : "Banner_03",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAdUnitName NS_SWIFT_NAME(AnalyticsParameterAdUnitName) = @"ad_unit_name"; /// A product affiliation to designate a supplying company or brick and mortar store location /// (String).
///     let params = [
///       AnalyticsParameterAffiliation : "Google Store",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterAffiliation NS_SWIFT_NAME(AnalyticsParameterAffiliation) = @"affiliation"; /// Campaign custom parameter (String). Used as a method of capturing custom data in a campaign. /// Use varies by network. ///
///     let params = [
///       AnalyticsParameterCP1 : "custom_data",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCP1 NS_SWIFT_NAME(AnalyticsParameterCP1) = @"cp1"; /// 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 /// (String). ///
///     let params = [
///       AnalyticsParameterCampaign : "winter_promotion",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) = @"campaign"; /// Campaign ID (String). Used for keyword analysis to identify a specific product promotion or /// strategic campaign. This is a required key for GA4 data import. ///
///     let params = [
///       AnalyticsParameterCampaignID : "7877652710",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCampaignID NS_SWIFT_NAME(AnalyticsParameterCampaignID) = @"campaign_id"; /// Character used in game (String). ///
///     let params = [
///       AnalyticsParameterCharacter : "beat_boss",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCharacter NS_SWIFT_NAME(AnalyticsParameterCharacter) = @"character"; /// Campaign content (String). static NSString *const kFIRParameterContent NS_SWIFT_NAME(AnalyticsParameterContent) = @"content"; /// Type of content selected (String). ///
///     let params = [
///       AnalyticsParameterContentType : "news article",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterContentType NS_SWIFT_NAME(AnalyticsParameterContentType) = @"content_type"; /// Coupon code used for a purchase (String). ///
///     let params = [
///       AnalyticsParameterCoupon : "SUMMER_FUN",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCoupon NS_SWIFT_NAME(AnalyticsParameterCoupon) = @"coupon"; /// Creative Format (String). Used to identify the high-level classification of the type of ad /// served by a specific campaign. ///
///     let params = [
///       AnalyticsParameterCreativeFormat : "display",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCreativeFormat NS_SWIFT_NAME(AnalyticsParameterCreativeFormat) = @"creative_format"; /// The name of a creative used in a promotional spot (String). ///
///     let params = [
///       AnalyticsParameterCreativeName : "Summer Sale",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCreativeName NS_SWIFT_NAME(AnalyticsParameterCreativeName) = @"creative_name"; /// The name of a creative slot (String). ///
///     let params = [
///       AnalyticsParameterCreativeSlot : "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 (String). ///
///     let params = [
///       AnalyticsParameterCurrency : "USD",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterCurrency NS_SWIFT_NAME(AnalyticsParameterCurrency) = @"currency"; /// Flight or Travel destination (String). ///
///     let params = [
///       AnalyticsParameterDestination : "Mountain View, CA",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterDestination NS_SWIFT_NAME(AnalyticsParameterDestination) = @"destination"; /// Monetary value of discount associated with a purchase (Double). ///
///     let params = [
///       AnalyticsParameterDiscount : 2.0,
///       AnalyticsParameterCurrency : "USD",  // e.g. $2.00 USD
///       // ...
///     ]
/// 
static NSString *const kFIRParameterDiscount NS_SWIFT_NAME(AnalyticsParameterDiscount) = @"discount"; /// The arrival date, check-out date or rental end date for the item. This should be in /// YYYY-MM-DD format (String). ///
///     let params = [
///       AnalyticsParameterEndDate : "2015-09-14",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterEndDate NS_SWIFT_NAME(AnalyticsParameterEndDate) = @"end_date"; /// 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 1 to extend the current /// session or to start a new session; any other value will not extend or start a session. ///
///     let params = [
///       AnalyticsParameterExtendSession : 1,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterExtendSession NS_SWIFT_NAME(AnalyticsParameterExtendSession) = @"extend_session"; /// Flight number for travel events (String). ///
///     let params = [
///       AnalyticsParameterFlightNumber : "ZZ800",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterFlightNumber NS_SWIFT_NAME(AnalyticsParameterFlightNumber) = @"flight_number"; /// Group/clan/guild ID (String). ///
///     let params = [
///       AnalyticsParameterGroupID : "g1",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterGroupID NS_SWIFT_NAME(AnalyticsParameterGroupID) = @"group_id"; /// The index of the item in a list (Int). ///
///     let params = [
///       AnalyticsParameterIndex : 5,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterIndex NS_SWIFT_NAME(AnalyticsParameterIndex) = @"index"; /// Item brand (String). ///
///     let params = [
///       AnalyticsParameterItemBrand : "Google",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemBrand NS_SWIFT_NAME(AnalyticsParameterItemBrand) = @"item_brand"; /// Item category (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemCategory : "pants",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemCategory NS_SWIFT_NAME(AnalyticsParameterItemCategory) = @"item_category"; /// Item Category (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemCategory2 : "pants",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemCategory2 NS_SWIFT_NAME(AnalyticsParameterItemCategory2) = @"item_category2"; /// Item Category (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemCategory3 : "pants",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemCategory3 NS_SWIFT_NAME(AnalyticsParameterItemCategory3) = @"item_category3"; /// Item Category (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemCategory4 : "pants",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemCategory4 NS_SWIFT_NAME(AnalyticsParameterItemCategory4) = @"item_category4"; /// Item Category (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemCategory5 : "pants",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemCategory5 NS_SWIFT_NAME(AnalyticsParameterItemCategory5) = @"item_category5"; /// Item ID (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemID : "SKU_12345",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemID NS_SWIFT_NAME(AnalyticsParameterItemID) = @"item_id"; /// The ID of the list in which the item was presented to the userĀ (String). ///
///     let params = [
///       AnalyticsParameterItemListID : "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 (String). ///
///     let params = [
///       AnalyticsParameterItemListName : "Related products",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemListName NS_SWIFT_NAME(AnalyticsParameterItemListName) = @"item_list_name"; /// Item Name (context-specific) (String). ///
///     let params = [
///       AnalyticsParameterItemName : "jeggings",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemName NS_SWIFT_NAME(AnalyticsParameterItemName) = @"item_name"; /// Item variant (String). ///
///     let params = [
///       AnalyticsParameterItemVariant : "Black",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterItemVariant NS_SWIFT_NAME(AnalyticsParameterItemVariant) = @"item_variant"; /// The list of items involved in the transaction expressed as `[[String: Any]]`. ///
///     let params = [
///       AnalyticsParameterItems : [
///         [AnalyticsParameterItemName : "jeggings", AnalyticsParameterItemCategory : "pants"],
///         [AnalyticsParameterItemName : "boots", AnalyticsParameterItemCategory : "shoes"],
///       ],
///     ]
/// 
static NSString *const kFIRParameterItems NS_SWIFT_NAME(AnalyticsParameterItems) = @"items"; /// Level in game (Int). ///
///     let params = [
///       AnalyticsParameterLevel : 42,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterLevel NS_SWIFT_NAME(AnalyticsParameterLevel) = @"level"; /// The name of a level in a game (String). ///
///     let params = [
///       AnalyticsParameterLevelName : "room_1",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterLevelName NS_SWIFT_NAME(AnalyticsParameterLevelName) = @"level_name"; /// Location (String). The Google Place ID /// that corresponds to the associated event. Alternatively, you can supply your own custom /// Location ID. ///
///     let params = [
///       AnalyticsParameterLocation : "ChIJiyj437sx3YAR9kUWC8QkLzQ",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterLocation NS_SWIFT_NAME(AnalyticsParameterLocation) = @"location"; /// 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.(String). ///
///     let params = [
///       AnalyticsParameterLocationID : "ChIJiyj437sx3YAR9kUWC8QkLzQ",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterLocationID NS_SWIFT_NAME(AnalyticsParameterLocationID) = @"location_id"; /// Marketing Tactic (String). Used to identify the targeting criteria applied to a specific /// campaign. ///
///     let params = [
///       AnalyticsParameterMarketingTactic : "Remarketing",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterMarketingTactic NS_SWIFT_NAME(AnalyticsParameterMarketingTactic) = @"marketing_tactic"; /// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended /// (String). ///
///     let params = [
///       AnalyticsParameterMedium : "email",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium"; /// A particular approach used in an operation; for example, "facebook" or "email" in the context /// of a sign_up or login event. (String). ///
///     let params = [
///       AnalyticsParameterMethod : "google",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterMethod NS_SWIFT_NAME(AnalyticsParameterMethod) = @"method"; /// Number of nights staying at hotel (Int). ///
///     let params = [
///       AnalyticsParameterNumberOfNights : 3,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterNumberOfNights NS_SWIFT_NAME(AnalyticsParameterNumberOfNights) = @"number_of_nights"; /// Number of passengers traveling (Int). ///
///     let params = [
///       AnalyticsParameterNumberOfPassengers : 11,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterNumberOfPassengers NS_SWIFT_NAME(AnalyticsParameterNumberOfPassengers) = @"number_of_passengers"; /// Number of rooms for travel events (Int). ///
///     let params = [
///       AnalyticsParameterNumberOfRooms : 2,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterNumberOfRooms NS_SWIFT_NAME(AnalyticsParameterNumberOfRooms) = @"number_of_rooms"; /// Flight or Travel origin (String). ///
///     let params = [
///       AnalyticsParameterOrigin : "Mountain View, CA",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterOrigin NS_SWIFT_NAME(AnalyticsParameterOrigin) = @"origin"; /// The chosen method of payment (String). ///
///     let params = [
///       AnalyticsParameterPaymentType : "Visa",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterPaymentType NS_SWIFT_NAME(AnalyticsParameterPaymentType) = @"payment_type"; /// Purchase price (Double). ///
///     let params = [
///       AnalyticsParameterPrice : 1.0,
///       AnalyticsParameterCurrency : "USD",  // e.g. $1.00 USD
///       // ...
///     ]
/// 
static NSString *const kFIRParameterPrice NS_SWIFT_NAME(AnalyticsParameterPrice) = @"price"; /// The ID of a product promotion (String). ///
///     let params = [
///       AnalyticsParameterPromotionID : "ABC123",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterPromotionID NS_SWIFT_NAME(AnalyticsParameterPromotionID) = @"promotion_id"; /// The name of a product promotion (String). ///
///     let params = [
///       AnalyticsParameterPromotionName : "Summer Sale",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterPromotionName NS_SWIFT_NAME(AnalyticsParameterPromotionName) = @"promotion_name"; /// Purchase quantity (Int). ///
///     let params = [
///       AnalyticsParameterQuantity : 1,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterQuantity NS_SWIFT_NAME(AnalyticsParameterQuantity) = @"quantity"; /// Score in game (Int). ///
///     let params = [
///       AnalyticsParameterScore : 4200,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterScore NS_SWIFT_NAME(AnalyticsParameterScore) = @"score"; /// Current screen class, such as the class name of the UIViewController, logged with screen_view /// event and added to every event (String). ///
///     let params = [
///       AnalyticsParameterScreenClass : "LoginViewController",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterScreenClass NS_SWIFT_NAME(AnalyticsParameterScreenClass) = @"screen_class"; /// Current screen name, such as the name of the UIViewController, logged with screen_view event and /// added to every event (String). ///
///     let params = [
///       AnalyticsParameterScreenName : "LoginView",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterScreenName NS_SWIFT_NAME(AnalyticsParameterScreenName) = @"screen_name"; /// The search string/keywords used (String). ///
///     let params = [
///       AnalyticsParameterSearchTerm : "periodic table",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterSearchTerm NS_SWIFT_NAME(AnalyticsParameterSearchTerm) = @"search_term"; /// Shipping cost associated with a transaction (Double). ///
///     let params = [
///       AnalyticsParameterShipping : 5.99,
///       AnalyticsParameterCurrency : "USD",  // e.g. $5.99 USD
///       // ...
///     ]
/// 
static NSString *const kFIRParameterShipping NS_SWIFT_NAME(AnalyticsParameterShipping) = @"shipping"; /// The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item /// (String). ///
///     let params = [
///       AnalyticsParameterShippingTier : "Ground",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterShippingTier NS_SWIFT_NAME(AnalyticsParameterShippingTier) = @"shipping_tier"; /// 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 (String). ///
///     let params = [
///       AnalyticsParameterSource : "InMobi",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source"; /// Source Platform (String). Used to identify the platform responsible for directing traffic to a /// given Analytics property (e.g., a buying platform where budgets, targeting criteria, etc. are /// set, a platform for managing organic traffic data, etc.). ///
///     let params = [
///       AnalyticsParameterSourcePlatform : "sa360",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterSourcePlatform NS_SWIFT_NAME(AnalyticsParameterSourcePlatform) = @"source_platform"; /// The departure date, check-in date or rental start date for the item. This should be in /// YYYY-MM-DD format (String). ///
///     let params = [
///       AnalyticsParameterStartDate : "2015-09-14",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterStartDate NS_SWIFT_NAME(AnalyticsParameterStartDate) = @"start_date"; /// The result of an operation. Specify 1 to indicate success and 0 to indicate failure (Int). ///
///     let params = [
///       AnalyticsParameterSuccess : 1,
///       // ...
///     ]
/// 
static NSString *const kFIRParameterSuccess NS_SWIFT_NAME(AnalyticsParameterSuccess) = @"success"; /// Tax cost associated with a transaction (Double). ///
///     let params = [
///       AnalyticsParameterTax : 2.43,
///       AnalyticsParameterCurrency : "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 /// (String). ///
///     let params = [
///       AnalyticsParameterTerm : "game",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterTerm NS_SWIFT_NAME(AnalyticsParameterTerm) = @"term"; /// The unique identifier of a transaction (String). ///
///     let params = [
///       AnalyticsParameterTransactionID : "T12345",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterTransactionID NS_SWIFT_NAME(AnalyticsParameterTransactionID) = @"transaction_id"; /// Travel class (String). ///
///     let params = [
///       AnalyticsParameterTravelClass : "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 Int or /// Double. /// Notes: Values for pre-defined currency-related events (such as @c AnalyticsEventAddToCart) /// should be supplied using Double and must be accompanied by a @c AnalyticsParameterCurrency /// 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 AnalyticsParameterCurrency parameter, or supplying an invalid /// currency code for conversion events will cause that /// conversion to be omitted from reporting. ///
///     let params = [
///       AnalyticsParameterValue : 3.99,
///       AnalyticsParameterCurrency : "USD",  // e.g. $3.99 USD
///       // ...
///     ]
/// 
static NSString *const kFIRParameterValue NS_SWIFT_NAME(AnalyticsParameterValue) = @"value"; /// Name of virtual currency type (String). ///
///     let params = [
///       AnalyticsParameterVirtualCurrencyName : "virtual_currency_name",
///       // ...
///     ]
/// 
static NSString *const kFIRParameterVirtualCurrencyName NS_SWIFT_NAME(AnalyticsParameterVirtualCurrencyName) = @"virtual_currency_name";