Analytics Parameters
Predefined event parameter names.
Summary
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.
Variables |
|
|---|---|
ParameterAchievementID =
"achievement_id"
|
string
Game achievement ID (String).
|
ParameterAdFormat =
"ad_format"
|
string
The ad format (e.g.
|
ParameterAdNetworkClickID = "aclid"
|
string
Ad Network Click ID (String).
|
ParameterAdPlatform =
"ad_platform"
|
string
The ad platform (e.g.
|
ParameterAdSource =
"ad_source"
|
string
The ad source (e.g.
|
ParameterAdUnitName =
"ad_unit_name"
|
string
The ad unit name (e.g.
|
ParameterAffiliation =
"affiliation"
|
string
A product affiliation to designate a supplying company or brick and mortar store location (String).
|
ParameterCP1 = "cp1"
|
string
Campaign custom parameter (String).
|
ParameterCampaign =
"campaign"
|
string
The individual campaign name, slogan, promo code, etc.
|
ParameterCampaignID =
"campaign_id"
|
string
Campaign ID (String).
|
ParameterCharacter =
"character"
|
string
Character used in game (String).
|
ParameterContent = "content"
|
string
Campaign content (String).
|
ParameterContentType =
"content_type"
|
string
Type of content selected (String).
|
ParameterCoupon = "coupon"
|
string
Coupon code used for a purchase (String).
|
ParameterCreativeFormat =
"creative_format"
|
string
Creative Format (String).
|
ParameterCreativeName =
"creative_name"
|
string
The name of a creative used in a promotional spot (String).
|
ParameterCreativeSlot =
"creative_slot"
|
string
The name of a creative slot (String).
|
ParameterCurrency =
"currency"
|
string
Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format (String).
|
ParameterDestination =
"destination"
|
string
Flight or Travel destination (String).
|
ParameterDiscount =
"discount"
|
string
Monetary value of discount associated with a purchase (Double).
|
ParameterEndDate = "end_date"
|
string
The arrival date, check-out date or rental end date for the item.
|
ParameterExtendSession =
"extend_session"
|
string
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.
|
ParameterFlightNumber =
"flight_number"
|
string
Flight number for travel events (String).
|
ParameterGroupID = "group_id"
|
string
Group/clan/guild ID (String).
|
ParameterIndex = "index"
|
string
The index of the item in a list (Int).
|
ParameterItemBrand =
"item_brand"
|
string
Item brand (String).
|
ParameterItemCategory =
"item_category"
|
string
Item category (context-specific) (String).
|
ParameterItemCategory2 =
"item_category2"
|
string
Item Category (context-specific) (String).
|
ParameterItemCategory3 =
"item_category3"
|
string
Item Category (context-specific) (String).
|
ParameterItemCategory4 =
"item_category4"
|
string
Item Category (context-specific) (String).
|
ParameterItemCategory5 =
"item_category5"
|
string
Item Category (context-specific) (String).
|
ParameterItemID = "item_id"
|
string
Item ID (context-specific) (String).
|
ParameterItemListID =
"item_list_id"
|
string
The ID of the list in which the item was presented to the user (String).
|
ParameterItemListName =
"item_list_name"
|
string
The name of the list in which the item was presented to the user (String).
|
ParameterItemName =
"item_name"
|
string
Item Name (context-specific) (String).
|
ParameterItemVariant =
"item_variant"
|
string
Item variant (String).
|
ParameterItems = "items"
|
string
The list of items involved in the transaction expressed as
[[String: Any]]. |
ParameterLevel = "level"
|
string
Level in game (Int).
|
ParameterLevelName =
"level_name"
|
string
The name of a level in a game (String).
|
ParameterLocation =
"location"
|
string
Location (String).
|
ParameterLocationID =
"location_id"
|
string
The location associated with the event.
|
ParameterMarketingTactic = "marketing_tactic"
|
string
Marketing Tactic (String).
|
ParameterMedium = "medium"
|
string
The advertising or marParameter(keting, cpc, banner, email), push.
|
ParameterMethod = "method"
|
string
A particular approach used in an operation; for example, "facebook" or "email" in the context of a sign_up or login event.
|
ParameterNumberOfNights = "number_of_nights"
|
string
Number of nights staying at hotel (Int).
|
ParameterNumberOfPassengers = "number_of_passengers"
|
string
Number of passengers traveling (Int).
|
ParameterNumberOfRooms =
"number_of_rooms"
|
string
Number of rooms for travel events (Int).
|
ParameterOrigin = "origin"
|
string
Flight or Travel origin (String).
|
ParameterPaymentType =
"payment_type"
|
string
The chosen method of payment (String).
|
ParameterPrice = "price"
|
string
Purchase price (Double).
|
ParameterPromotionID =
"promotion_id"
|
string
The ID of a product promotion (String).
|
ParameterPromotionName =
"promotion_name"
|
string
The name of a product promotion (String).
|
ParameterQuantity =
"quantity"
|
string
Purchase quantity (Int).
|
ParameterScore = "score"
|
string
Score in game (Int).
|
ParameterScreenClass =
"screen_class"
|
string
Current screen class, such as the class name of the UIViewController, logged with screen_view event and added to every event (String).
|
ParameterScreenName =
"screen_name"
|
string
Current screen name, such as the name of the UIViewController, logged with screen_view event and added to every event (String).
|
ParameterSearchTerm =
"search_term"
|
string
The search string/keywords used (String).
|
ParameterShipping =
"shipping"
|
string
Shipping cost associated with a transaction (Double).
|
ParameterShippingTier =
"shipping_tier"
|
string
The shipping tier (e.g.
|
ParameterSource = "source"
|
string
The origin of your traffic, such as an Ad network (for example, google) or partner (urban airship).
|
ParameterSourcePlatform =
"source_platform"
|
string
Source Platform (String).
|
ParameterStartDate =
"start_date"
|
string
The departure date, check-in date or rental start date for the item.
|
ParameterSuccess = "success"
|
string
The result of an operation.
|
ParameterTax = "tax"
|
string
Tax cost associated with a transaction (Double).
|
ParameterTerm = "term"
|
string
If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword (String).
|
ParameterTransactionID =
"transaction_id"
|
string
The unique identifier of a transaction (String).
|
ParameterTravelClass =
"travel_class"
|
string
Travel class (String).
|
ParameterValue = "value"
|
string
A context-specific numeric value which is accumulated automatically for each event type.
|
ParameterVirtualCurrencyName = "virtual_currency_name"
|
string
Name of virtual currency type (String).
|
Variables
ParameterAchievementID
string ParameterAchievementID = "achievement_id"
Game achievement ID (String).
let params = [ AnalyticsParameterAchievementID : "10_matches_won", // ... ]
ParameterAdFormat
string ParameterAdFormat = "ad_format"
The ad format (e.g.
Banner, Interstitial, Rewarded, Native, Rewarded Interstitial, Instream). (String).
let params = [ AnalyticsParameterAdFormat : "Banner", // ... ]
ParameterAdNetworkClickID
string ParameterAdNetworkClickID = "aclid"
Ad Network Click ID (String).
Used for network-specific click IDs which vary in format.
let params = [ AnalyticsParameterAdNetworParameter(kClickID, "1234567"), // ... ]
ParameterAdPlatform
string ParameterAdPlatform = "ad_platform"
The ad platform (e.g.
MoPub, IronSource) (String).
let params = [ AnalyticsParameterAdPlatform : "MoPub", // ... ]
ParameterAdSource
string ParameterAdSource = "ad_source"
The ad source (e.g.
AdColony) (String).
let params = [ AnalyticsParameterAdSource : "AdColony", // ... ]
ParameterAdUnitName
string ParameterAdUnitName = "ad_unit_name"
The ad unit name (e.g.
Banner_03) (String).
let params = [ AnalyticsParameterAdUnitName : "Banner_03", // ... ]
ParameterAffiliation
string ParameterAffiliation = "affiliation"
A product affiliation to designate a supplying company or brick and mortar store location (String).
let params = [ AnalyticsParameterAffiliation : "Google Store", // ... ]
ParameterCP1
string ParameterCP1 = "cp1"
Campaign custom parameter (String).
Used as a method of capturing custom data in a campaign. Use varies by network.
let params = [ AnalyticsParameterCP1 : "custom_data", // ... ]
ParameterCampaign
string ParameterCampaign = "campaign"
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", // ... ]
ParameterCampaignID
string ParameterCampaignID = "campaign_id"
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", // ... ]
ParameterCharacter
string ParameterCharacter = "character"
Character used in game (String).
let params = [ AnalyticsParameterCharacter : "beat_boss", // ... ]
ParameterContent
string ParameterContent = "content"
Campaign content (String).
ParameterContentType
string ParameterContentType = "content_type"
Type of content selected (String).
let params = [ AnalyticsParameterContentType : "news article", // ... ]
ParameterCoupon
string ParameterCoupon = "coupon"
Coupon code used for a purchase (String).
let params = [ AnalyticsParameterCoupon : "SUMMER_FUN", // ... ]
ParameterCreativeFormat
string ParameterCreativeFormat = "creative_format"
Creative Format (String).
Used to identify the high-level classification of the type of ad served by a specific campaign.
let params = [ AnalyticsParameterCreativeFormat : "display", // ... ]
ParameterCreativeName
string ParameterCreativeName = "creative_name"
The name of a creative used in a promotional spot (String).
let params = [ AnalyticsParameterCreativeName : "Summer Sale", // ... ]
ParameterCreativeSlot
string ParameterCreativeSlot = "creative_slot"
The name of a creative slot (String).
let params = [ AnalyticsParameterCreativeSlot : "summer_banner2", // ... ]
ParameterCurrency
string ParameterCurrency = "currency"
Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format (String).
let params = [ AnalyticsParameterCurrency : "USD", // ... ]
ParameterDestination
string ParameterDestination = "destination"
Flight or Travel destination (String).
let params = [ AnalyticsParameterDestination : "Mountain View, CA", // ... ]
ParameterDiscount
string ParameterDiscount = "discount"
Monetary value of discount associated with a purchase (Double).
let params = [ AnalyticsParameterDiscount : 2.0, AnalyticsParameterCurrency : "USD", // e.g. $2.00 USD // ... ]
ParameterEndDate
string ParameterEndDate = "end_date"
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", // ... ]
ParameterExtendSession
string ParameterExtendSession = "extend_session"
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, // ... ]
ParameterFlightNumber
string ParameterFlightNumber = "flight_number"
Flight number for travel events (String).
let params = [ AnalyticsParameterFlightNumber : "ZZ800", // ... ]
ParameterGroupID
string ParameterGroupID = "group_id"
Group/clan/guild ID (String).
let params = [ AnalyticsParameterGroupID : "g1", // ... ]
ParameterIndex
string ParameterIndex = "index"
The index of the item in a list (Int).
let params = [ AnalyticsParameterIndex : 5, // ... ]
ParameterItemBrand
string ParameterItemBrand = "item_brand"
Item brand (String).
let params = [ AnalyticsParameterItemBrand : "Google", // ... ]
ParameterItemCategory
string ParameterItemCategory = "item_category"
Item category (context-specific) (String).
let params = [ AnalyticsParameterItemCategory : "pants", // ... ]
ParameterItemCategory2
string ParameterItemCategory2 = "item_category2"
Item Category (context-specific) (String).
let params = [ AnalyticsParameterItemCategory2 : "pants", // ... ]
ParameterItemCategory3
string ParameterItemCategory3 = "item_category3"
Item Category (context-specific) (String).
let params = [ AnalyticsParameterItemCategory3 : "pants", // ... ]
ParameterItemCategory4
string ParameterItemCategory4 = "item_category4"
Item Category (context-specific) (String).
let params = [ AnalyticsParameterItemCategory4 : "pants", // ... ]
ParameterItemCategory5
string ParameterItemCategory5 = "item_category5"
Item Category (context-specific) (String).
let params = [ AnalyticsParameterItemCategory5 : "pants", // ... ]
ParameterItemID
string ParameterItemID = "item_id"
Item ID (context-specific) (String).
let params = [ AnalyticsParameterItemID : "SKU_12345", // ... ]
ParameterItemListID
string ParameterItemListID = "item_list_id"
The ID of the list in which the item was presented to the user (String).
let params = [ AnalyticsParameterItemListID : "ABC123", // ... ]
ParameterItemListName
string ParameterItemListName = "item_list_name"
The name of the list in which the item was presented to the user (String).
let params = [ AnalyticsParameterItemListName : "Related products", // ... ]
ParameterItemName
string ParameterItemName = "item_name"
Item Name (context-specific) (String).
let params = [ AnalyticsParameterItemName : "jeggings", // ... ]
ParameterItemVariant
string ParameterItemVariant = "item_variant"
Item variant (String).
let params = [ AnalyticsParameterItemVariant : "Black", // ... ]
ParameterItems
string ParameterItems = "items"
The list of items involved in the transaction expressed as [[String: Any]].
let params = [ AnalyticsParameterItems : [ [AnalyticsParameterItemName : "jeggings", AnalyticsParameterItemCategory : "pants"], [AnalyticsParameterItemName : "boots", AnalyticsParameterItemCategory : "shoes"], ], ]
ParameterLevel
string ParameterLevel = "level"
Level in game (Int).
let params = [ AnalyticsParameterLevel : 42, // ... ]
ParameterLevelName
string ParameterLevelName = "level_name"
The name of a level in a game (String).
let params = [ AnalyticsParameterLevelName : "room_1", // ... ]
ParameterLocation
string ParameterLocation = "location"
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", // ... ]
ParameterLocationID
string ParameterLocationID = "location_id"
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", // ... ]
ParameterMarketingTactic
string ParameterMarketingTactic = "marketing_tactic"
Marketing Tactic (String).
Used to identify the targeting criteria applied to a specific campaign.
let params = [ AnalyticsParameterMarParameter(ketingTactic, "Remarketing"), // ... ]
ParameterMedium
string ParameterMedium = "medium"
The advertising or marParameter(keting, cpc, banner, email), push.
Highly recommended (String).
let params = [ AnalyticsParameterMedium : "email", // ... ]
ParameterMethod
string ParameterMethod = "method"
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", // ... ]
ParameterNumberOfNights
string ParameterNumberOfNights = "number_of_nights"
Number of nights staying at hotel (Int).
let params = [ AnalyticsParameterNumberOfNights : 3, // ... ]
ParameterNumberOfPassengers
string ParameterNumberOfPassengers = "number_of_passengers"
Number of passengers traveling (Int).
let params = [ AnalyticsParameterNumberOfPassengers : 11, // ... ]
ParameterNumberOfRooms
string ParameterNumberOfRooms = "number_of_rooms"
Number of rooms for travel events (Int).
let params = [ AnalyticsParameterNumberOfRooms : 2, // ... ]
ParameterOrigin
string ParameterOrigin = "origin"
Flight or Travel origin (String).
let params = [ AnalyticsParameterOrigin : "Mountain View, CA", // ... ]
ParameterPaymentType
string ParameterPaymentType = "payment_type"
The chosen method of payment (String).
let params = [ AnalyticsParameterPaymentType : "Visa", // ... ]
ParameterPrice
string ParameterPrice = "price"
Purchase price (Double).
let params = [ AnalyticsParameterPrice : 1.0, AnalyticsParameterCurrency : "USD", // e.g. $1.00 USD // ... ]
ParameterPromotionID
string ParameterPromotionID = "promotion_id"
The ID of a product promotion (String).
let params = [ AnalyticsParameterPromotionID : "ABC123", // ... ]
ParameterPromotionName
string ParameterPromotionName = "promotion_name"
The name of a product promotion (String).
let params = [ AnalyticsParameterPromotionName : "Summer Sale", // ... ]
ParameterQuantity
string ParameterQuantity = "quantity"
Purchase quantity (Int).
let params = [ AnalyticsParameterQuantity : 1, // ... ]
ParameterScore
string ParameterScore = "score"
Score in game (Int).
let params = [ AnalyticsParameterScore : 4200, // ... ]
ParameterScreenClass
string ParameterScreenClass = "screen_class"
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", // ... ]
ParameterScreenName
string ParameterScreenName = "screen_name"
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", // ... ]
ParameterSearchTerm
string ParameterSearchTerm = "search_term"
The search string/keywords used (String).
let params = [ AnalyticsParameterSearchTerm : "periodic table", // ... ]
ParameterShipping
string ParameterShipping = "shipping"
Shipping cost associated with a transaction (Double).
let params = [ AnalyticsParameterShipping : 5.99, AnalyticsParameterCurrency : "USD", // e.g. $5.99 USD // ... ]
ParameterShippingTier
string ParameterShippingTier = "shipping_tier"
The shipping tier (e.g.
Ground, Air, Next-day) selected for delivery of the purchased item (String).
let params = [ AnalyticsParameterShippingTier : "Ground", // ... ]
ParameterSource
string ParameterSource = "source"
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", // ... ]
ParameterSourcePlatform
string ParameterSourcePlatform = "source_platform"
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", // ... ]
ParameterStartDate
string ParameterStartDate = "start_date"
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", // ... ]
ParameterSuccess
string ParameterSuccess = "success"
The result of an operation.
Specify 1 to indicate success and 0 to indicate failure (Int).
let params = [ AnalyticsParameterSuccess : 1, // ... ]
ParameterTax
string ParameterTax = "tax"
Tax cost associated with a transaction (Double).
let params = [ AnalyticsParameterTax : 2.43, AnalyticsParameterCurrency : "USD", // e.g. $2.43 USD // ... ]
ParameterTerm
string ParameterTerm = "term"
If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword (String).
let params = [ AnalyticsParameterTerm : "game", // ... ]
ParameterTransactionID
string ParameterTransactionID = "transaction_id"
The unique identifier of a transaction (String).
let params = [ AnalyticsParameterTransactionID : "T12345", // ... ]
ParameterTravelClass
string ParameterTravelClass = "travel_class"
Travel class (String).
let params = [ AnalyticsParameterTravelClass : "business", // ... ]
ParameterValue
string ParameterValue = "value"
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 AnalyticsEventAddToCart) should be supplied using Double and must be accompanied by a 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 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 // ... ]
ParameterVirtualCurrencyName
string ParameterVirtualCurrencyName = "virtual_currency_name"
Name of virtual currency type (String).
let params = [ AnalyticsParameterVirtualCurrencyName : "virtual_currency_name", // ... ]