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

stringParameterAchievementID="achievement_id"

Game achievement ID (String).

letparams=[AnalyticsParameterAchievementID:"10_matches_won",// ...]

ParameterAdFormat

stringParameterAdFormat="ad_format"

The ad format (e.g.

Banner, Interstitial, Rewarded, Native, Rewarded Interstitial, Instream). (String).

letparams=[AnalyticsParameterAdFormat:"Banner",// ...]

ParameterAdNetworkClickID

stringParameterAdNetworkClickID="aclid"

Ad Network Click ID (String).

Used for network-specific click IDs which vary in format.

letparams=[AnalyticsParameterAdNetworParameter(kClickID,"1234567"),// ...]

ParameterAdPlatform

stringParameterAdPlatform="ad_platform"

The ad platform (e.g.

MoPub, IronSource) (String).

letparams=[AnalyticsParameterAdPlatform:"MoPub",// ...]

ParameterAdSource

stringParameterAdSource="ad_source"

The ad source (e.g.

AdColony) (String).

letparams=[AnalyticsParameterAdSource:"AdColony",// ...]

ParameterAdUnitName

stringParameterAdUnitName="ad_unit_name"

The ad unit name (e.g.

Banner_03) (String).

letparams=[AnalyticsParameterAdUnitName:"Banner_03",// ...]

ParameterAffiliation

stringParameterAffiliation="affiliation"

A product affiliation to designate a supplying company or brick and mortar store location (String).

letparams=[AnalyticsParameterAffiliation:"Google Store",// ...]

ParameterCP1

stringParameterCP1="cp1"

Campaign custom parameter (String).

Used as a method of capturing custom data in a campaign. Use varies by network.

letparams=[AnalyticsParameterCP1:"custom_data",// ...]

ParameterCampaign

stringParameterCampaign="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).

letparams=[AnalyticsParameterCampaign:"winter_promotion",// ...]

ParameterCampaignID

stringParameterCampaignID="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.

letparams=[AnalyticsParameterCampaignID:"7877652710",// ...]

ParameterCharacter

stringParameterCharacter="character"

Character used in game (String).

letparams=[AnalyticsParameterCharacter:"beat_boss",// ...]

ParameterContent

stringParameterContent="content"

Campaign content (String).

ParameterContentType

stringParameterContentType="content_type"

Type of content selected (String).

letparams=[AnalyticsParameterContentType:"news article",// ...]

ParameterCoupon

stringParameterCoupon="coupon"

Coupon code used for a purchase (String).

letparams=[AnalyticsParameterCoupon:"SUMMER_FUN",// ...]

ParameterCreativeFormat

stringParameterCreativeFormat="creative_format"

Creative Format (String).

Used to identify the high-level classification of the type of ad served by a specific campaign.

letparams=[AnalyticsParameterCreativeFormat:"display",// ...]

ParameterCreativeName

stringParameterCreativeName="creative_name"

The name of a creative used in a promotional spot (String).

letparams=[AnalyticsParameterCreativeName:"Summer Sale",// ...]

ParameterCreativeSlot

stringParameterCreativeSlot="creative_slot"

The name of a creative slot (String).

letparams=[AnalyticsParameterCreativeSlot:"summer_banner2",// ...]

ParameterCurrency

stringParameterCurrency="currency"

Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format (String).

letparams=[AnalyticsParameterCurrency:"USD",// ...]

ParameterDestination

stringParameterDestination="destination"

Flight or Travel destination (String).

letparams=[AnalyticsParameterDestination:"Mountain View, CA",// ...]

ParameterDiscount

stringParameterDiscount="discount"

Monetary value of discount associated with a purchase (Double).

letparams=[AnalyticsParameterDiscount:2.0,AnalyticsParameterCurrency:"USD",// e.g. $2.00 USD// ...]

ParameterEndDate

stringParameterEndDate="end_date"

The arrival date, check-out date or rental end date for the item.

This should be in YYYY-MM-DD format (String).

letparams=[AnalyticsParameterEndDate:"2015-09-14",// ...]

ParameterExtendSession

stringParameterExtendSession="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.

letparams=[AnalyticsParameterExtendSession:1,// ...]

ParameterFlightNumber

stringParameterFlightNumber="flight_number"

Flight number for travel events (String).

letparams=[AnalyticsParameterFlightNumber:"ZZ800",// ...]

ParameterGroupID

stringParameterGroupID="group_id"

Group/clan/guild ID (String).

letparams=[AnalyticsParameterGroupID:"g1",// ...]

ParameterIndex

stringParameterIndex="index"

The index of the item in a list (Int).

letparams=[AnalyticsParameterIndex:5,// ...]

ParameterItemBrand

stringParameterItemBrand="item_brand"

Item brand (String).

letparams=[AnalyticsParameterItemBrand:"Google",// ...]

ParameterItemCategory

stringParameterItemCategory="item_category"

Item category (context-specific) (String).

letparams=[AnalyticsParameterItemCategory:"pants",// ...]

ParameterItemCategory2

stringParameterItemCategory2="item_category2"

Item Category (context-specific) (String).

letparams=[AnalyticsParameterItemCategory2:"pants",// ...]

ParameterItemCategory3

stringParameterItemCategory3="item_category3"

Item Category (context-specific) (String).

letparams=[AnalyticsParameterItemCategory3:"pants",// ...]

ParameterItemCategory4

stringParameterItemCategory4="item_category4"

Item Category (context-specific) (String).

letparams=[AnalyticsParameterItemCategory4:"pants",// ...]

ParameterItemCategory5

stringParameterItemCategory5="item_category5"

Item Category (context-specific) (String).

letparams=[AnalyticsParameterItemCategory5:"pants",// ...]

ParameterItemID

stringParameterItemID="item_id"

Item ID (context-specific) (String).

letparams=[AnalyticsParameterItemID:"SKU_12345",// ...]

ParameterItemListID

stringParameterItemListID="item_list_id"

The ID of the list in which the item was presented to the user (String).

letparams=[AnalyticsParameterItemListID:"ABC123",// ...]

ParameterItemListName

stringParameterItemListName="item_list_name"

The name of the list in which the item was presented to the user (String).

letparams=[AnalyticsParameterItemListName:"Related products",// ...]

ParameterItemName

stringParameterItemName="item_name"

Item Name (context-specific) (String).

letparams=[AnalyticsParameterItemName:"jeggings",// ...]

ParameterItemVariant

stringParameterItemVariant="item_variant"

Item variant (String).

letparams=[AnalyticsParameterItemVariant:"Black",// ...]

ParameterItems

stringParameterItems="items"

The list of items involved in the transaction expressed as [[String: Any]].

letparams=[AnalyticsParameterItems:[[AnalyticsParameterItemName : "jeggings", AnalyticsParameterItemCategory : "pants"],[AnalyticsParameterItemName : "boots", AnalyticsParameterItemCategory : "shoes"],],]

ParameterLevel

stringParameterLevel="level"

Level in game (Int).

letparams=[AnalyticsParameterLevel:42,// ...]

ParameterLevelName

stringParameterLevelName="level_name"

The name of a level in a game (String).

letparams=[AnalyticsParameterLevelName:"room_1",// ...]

ParameterLocation

stringParameterLocation="location"

Location (String).

The Google Place ID that corresponds to the associated event. Alternatively, you can supply your own custom Location ID.

letparams=[AnalyticsParameterLocation:"ChIJiyj437sx3YAR9kUWC8QkLzQ",// ...]

ParameterLocationID

stringParameterLocationID="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).

letparams=[AnalyticsParameterLocationID:"ChIJiyj437sx3YAR9kUWC8QkLzQ",// ...]

ParameterMarketingTactic

stringParameterMarketingTactic="marketing_tactic"

Marketing Tactic (String).

Used to identify the targeting criteria applied to a specific campaign.

letparams=[AnalyticsParameterMarParameter(ketingTactic,"Remarketing"),// ...]

ParameterMedium

stringParameterMedium="medium"

The advertising or marParameter(keting, cpc, banner, email), push.

Highly recommended (String).

letparams=[AnalyticsParameterMedium:"email",// ...]

ParameterMethod

stringParameterMethod="method"

A particular approach used in an operation; for example, "facebook" or "email" in the context of a sign_up or login event.

(String).

letparams=[AnalyticsParameterMethod:"google",// ...]

ParameterNumberOfNights

stringParameterNumberOfNights="number_of_nights"

Number of nights staying at hotel (Int).

letparams=[AnalyticsParameterNumberOfNights:3,// ...]

ParameterNumberOfPassengers

stringParameterNumberOfPassengers="number_of_passengers"

Number of passengers traveling (Int).

letparams=[AnalyticsParameterNumberOfPassengers:11,// ...]

ParameterNumberOfRooms

stringParameterNumberOfRooms="number_of_rooms"

Number of rooms for travel events (Int).

letparams=[AnalyticsParameterNumberOfRooms:2,// ...]

ParameterOrigin

stringParameterOrigin="origin"

Flight or Travel origin (String).

letparams=[AnalyticsParameterOrigin:"Mountain View, CA",// ...]

ParameterPaymentType

stringParameterPaymentType="payment_type"

The chosen method of payment (String).

letparams=[AnalyticsParameterPaymentType:"Visa",// ...]

ParameterPrice

stringParameterPrice="price"

Purchase price (Double).

letparams=[AnalyticsParameterPrice:1.0,AnalyticsParameterCurrency:"USD",// e.g. $1.00 USD// ...]

ParameterPromotionID

stringParameterPromotionID="promotion_id"

The ID of a product promotion (String).

letparams=[AnalyticsParameterPromotionID:"ABC123",// ...]

ParameterPromotionName

stringParameterPromotionName="promotion_name"

The name of a product promotion (String).

letparams=[AnalyticsParameterPromotionName:"Summer Sale",// ...]

ParameterQuantity

stringParameterQuantity="quantity"

Purchase quantity (Int).

letparams=[AnalyticsParameterQuantity:1,// ...]

ParameterScore

stringParameterScore="score"

Score in game (Int).

letparams=[AnalyticsParameterScore:4200,// ...]

ParameterScreenClass

stringParameterScreenClass="screen_class"

Current screen class, such as the class name of the UIViewController, logged with screen_view event and added to every event (String).

letparams=[AnalyticsParameterScreenClass:"LoginViewController",// ...]

ParameterScreenName

stringParameterScreenName="screen_name"

Current screen name, such as the name of the UIViewController, logged with screen_view event and added to every event (String).

letparams=[AnalyticsParameterScreenName:"LoginView",// ...]

ParameterSearchTerm

stringParameterSearchTerm="search_term"

The search string/keywords used (String).

letparams=[AnalyticsParameterSearchTerm:"periodic table",// ...]

ParameterShipping

stringParameterShipping="shipping"

Shipping cost associated with a transaction (Double).

letparams=[AnalyticsParameterShipping:5.99,AnalyticsParameterCurrency:"USD",// e.g. $5.99 USD// ...]

ParameterShippingTier

stringParameterShippingTier="shipping_tier"

The shipping tier (e.g.

Ground, Air, Next-day) selected for delivery of the purchased item (String).

letparams=[AnalyticsParameterShippingTier:"Ground",// ...]

ParameterSource

stringParameterSource="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).

letparams=[AnalyticsParameterSource:"InMobi",// ...]

ParameterSourcePlatform

stringParameterSourcePlatform="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.).

letparams=[AnalyticsParameterSourcePlatform:"sa360",// ...]

ParameterStartDate

stringParameterStartDate="start_date"

The departure date, check-in date or rental start date for the item.

This should be in YYYY-MM-DD format (String).

letparams=[AnalyticsParameterStartDate:"2015-09-14",// ...]

ParameterSuccess

stringParameterSuccess="success"

The result of an operation.

Specify 1 to indicate success and 0 to indicate failure (Int).

letparams=[AnalyticsParameterSuccess:1,// ...]

ParameterTax

stringParameterTax="tax"

Tax cost associated with a transaction (Double).

letparams=[AnalyticsParameterTax:2.43,AnalyticsParameterCurrency:"USD",// e.g. $2.43 USD// ...]

ParameterTerm

stringParameterTerm="term"

If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword (String).

letparams=[AnalyticsParameterTerm:"game",// ...]

ParameterTransactionID

stringParameterTransactionID="transaction_id"

The unique identifier of a transaction (String).

letparams=[AnalyticsParameterTransactionID:"T12345",// ...]

ParameterTravelClass

stringParameterTravelClass="travel_class"

Travel class (String).

letparams=[AnalyticsParameterTravelClass:"business",// ...]

ParameterValue

stringParameterValue="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.

letparams=[AnalyticsParameterValue:3.99,AnalyticsParameterCurrency:"USD",// e.g. $3.99 USD// ...]

ParameterVirtualCurrencyName

stringParameterVirtualCurrencyName="virtual_currency_name"

Name of virtual currency type (String).

letparams=[AnalyticsParameterVirtualCurrencyName:"virtual_currency_name",// ...]