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
`kParameterAchievementID = "achievement_id"`	`const char *const` Game achievement ID (String).
`kParameterAdFormat = "ad_format"`	`const char *const` The ad format (e.g.
`kParameterAdNetworkClickID = "aclid"`	`const char *const` Ad Network Click ID (String).
`kParameterAdPlatform = "ad_platform"`	`const char *const` The ad platform (e.g.
`kParameterAdSource = "ad_source"`	`const char *const` The ad source (e.g.
`kParameterAdUnitName = "ad_unit_name"`	`const char *const` The ad unit name (e.g.
`kParameterAffiliation = "affiliation"`	`const char *const` A product affiliation to designate a supplying company or brick and mortar store location (String).
`kParameterCP1 = "cp1"`	`const char *const` Campaign custom parameter (String).
`kParameterCampaign = "campaign"`	`const char *const` The individual campaign name, slogan, promo code, etc.
`kParameterCampaignID = "campaign_id"`	`const char *const` Campaign ID (String).
`kParameterCharacter = "character"`	`const char *const` Character used in game (String).
`kParameterContent = "content"`	`const char *const` Campaign content (String).
`kParameterContentType = "content_type"`	`const char *const` Type of content selected (String).
`kParameterCoupon = "coupon"`	`const char *const` Coupon code used for a purchase (String).
`kParameterCreativeFormat = "creative_format"`	`const char *const` Creative Format (String).
`kParameterCreativeName = "creative_name"`	`const char *const` The name of a creative used in a promotional spot (String).
`kParameterCreativeSlot = "creative_slot"`	`const char *const` The name of a creative slot (String).
`kParameterCurrency = "currency"`	`const char *const` Currency of the purchase or items associated with the event, in 3-letter ISO_4217 format (String).
`kParameterDestination = "destination"`	`const char *const` Flight or Travel destination (String).
`kParameterDiscount = "discount"`	`const char *const` Monetary value of discount associated with a purchase (Double).
`kParameterEndDate = "end_date"`	`const char *const` The arrival date, check-out date or rental end date for the item.
`kParameterExtendSession = "extend_session"`	`const char *const` 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.
`kParameterFlightNumber = "flight_number"`	`const char *const` Flight number for travel events (String).
`kParameterGroupID = "group_id"`	`const char *const` Group/clan/guild ID (String).
`kParameterIndex = "index"`	`const char *const` The index of the item in a list (Int).
`kParameterItemBrand = "item_brand"`	`const char *const` Item brand (String).
`kParameterItemCategory = "item_category"`	`const char *const` Item category (context-specific) (String).
`kParameterItemCategory2 = "item_category2"`	`const char *const` Item Category (context-specific) (String).
`kParameterItemCategory3 = "item_category3"`	`const char *const` Item Category (context-specific) (String).
`kParameterItemCategory4 = "item_category4"`	`const char *const` Item Category (context-specific) (String).
`kParameterItemCategory5 = "item_category5"`	`const char *const` Item Category (context-specific) (String).
`kParameterItemID = "item_id"`	`const char *const` Item ID (context-specific) (String).
`kParameterItemListID = "item_list_id"`	`const char *const` The ID of the list in which the item was presented to the user (String).
`kParameterItemListName = "item_list_name"`	`const char *const` The name of the list in which the item was presented to the user (String).
`kParameterItemName = "item_name"`	`const char *const` Item Name (context-specific) (String).
`kParameterItemVariant = "item_variant"`	`const char *const` Item variant (String).
`kParameterItems = "items"`	`const char *const` The list of items involved in the transaction expressed as `[[String: Any]]`.
`kParameterLevel = "level"`	`const char *const` Level in game (Int).
`kParameterLevelName = "level_name"`	`const char *const` The name of a level in a game (String).
`kParameterLocation = "location"`	`const char *const` Location (String).
`kParameterLocationID = "location_id"`	`const char *const` The location associated with the event.
`kParameterMarketingTactic = "marketing_tactic"`	`const char *const` Marketing Tactic (String).
`kParameterMedium = "medium"`	`const char *const` The advertising or marParameter(keting, cpc, banner, email), push.
`kParameterMethod = "method"`	`const char *const` A particular approach used in an operation; for example, "facebook" or "email" in the context of a sign_up or login event.
`kParameterNumberOfNights = "number_of_nights"`	`const char *const` Number of nights staying at hotel (Int).
`kParameterNumberOfPassengers = "number_of_passengers"`	`const char *const` Number of passengers traveling (Int).
`kParameterNumberOfRooms = "number_of_rooms"`	`const char *const` Number of rooms for travel events (Int).
`kParameterOrigin = "origin"`	`const char *const` Flight or Travel origin (String).
`kParameterPaymentType = "payment_type"`	`const char *const` The chosen method of payment (String).
`kParameterPrice = "price"`	`const char *const` Purchase price (Double).
`kParameterPromotionID = "promotion_id"`	`const char *const` The ID of a product promotion (String).
`kParameterPromotionName = "promotion_name"`	`const char *const` The name of a product promotion (String).
`kParameterQuantity = "quantity"`	`const char *const` Purchase quantity (Int).
`kParameterScore = "score"`	`const char *const` Score in game (Int).
`kParameterScreenClass = "screen_class"`	`const char *const` Current screen class, such as the class name of the UIViewController, logged with screen_view event and added to every event (String).
`kParameterScreenName = "screen_name"`	`const char *const` Current screen name, such as the name of the UIViewController, logged with screen_view event and added to every event (String).
`kParameterSearchTerm = "search_term"`	`const char *const` The search string/keywords used (String).
`kParameterShipping = "shipping"`	`const char *const` Shipping cost associated with a transaction (Double).
`kParameterShippingTier = "shipping_tier"`	`const char *const` The shipping tier (e.g.
`kParameterSource = "source"`	`const char *const` The origin of your traffic, such as an Ad network (for example, google) or partner (urban airship).
`kParameterSourcePlatform = "source_platform"`	`const char *const` Source Platform (String).
`kParameterStartDate = "start_date"`	`const char *const` The departure date, check-in date or rental start date for the item.
`kParameterSuccess = "success"`	`const char *const` The result of an operation.
`kParameterTax = "tax"`	`const char *const` Tax cost associated with a transaction (Double).
`kParameterTerm = "term"`	`const char *const` If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword (String).
`kParameterTransactionID = "transaction_id"`	`const char *const` The unique identifier of a transaction (String).
`kParameterTravelClass = "travel_class"`	`const char *const` Travel class (String).
`kParameterValue = "value"`	`const char *const` A context-specific numeric value which is accumulated automatically for each event type.
`kParameterVirtualCurrencyName = "virtual_currency_name"`	`const char *const` Name of virtual currency type (String).

Variables

kParameterAchievementID

const char *const kParameterAchievementID =
    "achievement_id"

Game achievement ID (String).

let params = [
  AnalyticsParameterAchievementID : "10_matches_won",
  // ...
]

kParameterAdFormat

const char *const kParameterAdFormat =
    "ad_format"

The ad format (e.g.

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

let params = [
  AnalyticsParameterAdFormat : "Banner",
  // ...
]

kParameterAdNetworkClickID

const char *const kParameterAdNetworkClickID = "aclid"

Ad Network Click ID (String).

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

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

kParameterAdPlatform

const char *const kParameterAdPlatform =
    "ad_platform"

The ad platform (e.g.

MoPub, IronSource) (String).

let params = [
  AnalyticsParameterAdPlatform : "MoPub",
  // ...
]

kParameterAdSource

const char *const kParameterAdSource =
    "ad_source"

The ad source (e.g.

AdColony) (String).

let params = [
  AnalyticsParameterAdSource : "AdColony",
  // ...
]

kParameterAdUnitName

const char *const kParameterAdUnitName =
    "ad_unit_name"

The ad unit name (e.g.

Banner_03) (String).

let params = [
  AnalyticsParameterAdUnitName : "Banner_03",
  // ...
]

kParameterAffiliation

const char *const kParameterAffiliation =
    "affiliation"

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

let params = [
  AnalyticsParameterAffiliation : "Google Store",
  // ...
]

kParameterCP1

const char *const kParameterCP1 = "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",
  // ...
]

kParameterCampaign

const char *const kParameterCampaign =
    "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",
  // ...
]

kParameterCampaignID

const char *const kParameterCampaignID =
    "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",
  // ...
]

kParameterCharacter

const char *const kParameterCharacter =
    "character"

Character used in game (String).

let params = [
  AnalyticsParameterCharacter : "beat_boss",
  // ...
]

kParameterContent

const char *const kParameterContent = "content"

Campaign content (String).

kParameterContentType

const char *const kParameterContentType =
    "content_type"

Type of content selected (String).

let params = [
  AnalyticsParameterContentType : "news article",
  // ...
]

kParameterCoupon

const char *const kParameterCoupon = "coupon"

Coupon code used for a purchase (String).

let params = [
  AnalyticsParameterCoupon : "SUMMER_FUN",
  // ...
]

kParameterCreativeFormat

const char *const kParameterCreativeFormat =
    "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",
  // ...
]

kParameterCreativeName

const char *const kParameterCreativeName =
    "creative_name"

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

let params = [
  AnalyticsParameterCreativeName : "Summer Sale",
  // ...
]

kParameterCreativeSlot

const char *const kParameterCreativeSlot =
    "creative_slot"

The name of a creative slot (String).

let params = [
  AnalyticsParameterCreativeSlot : "summer_banner2",
  // ...
]

kParameterCurrency

const char *const kParameterCurrency =
    "currency"

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

let params = [
  AnalyticsParameterCurrency : "USD",
  // ...
]

kParameterDestination

const char *const kParameterDestination =
    "destination"

Flight or Travel destination (String).

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

kParameterDiscount

const char *const kParameterDiscount =
    "discount"

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

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

kParameterEndDate

const char *const kParameterEndDate = "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",
  // ...
]

kParameterExtendSession

const char *const kParameterExtendSession =
    "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,
  // ...
]

kParameterFlightNumber

const char *const kParameterFlightNumber =
    "flight_number"

Flight number for travel events (String).

let params = [
  AnalyticsParameterFlightNumber : "ZZ800",
  // ...
]

kParameterGroupID

const char *const kParameterGroupID = "group_id"

Group/clan/guild ID (String).

let params = [
  AnalyticsParameterGroupID : "g1",
  // ...
]

kParameterIndex

const char *const kParameterIndex = "index"

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

let params = [
  AnalyticsParameterIndex : 5,
  // ...
]

kParameterItemBrand

const char *const kParameterItemBrand =
    "item_brand"

Item brand (String).

let params = [
  AnalyticsParameterItemBrand : "Google",
  // ...
]

kParameterItemCategory

const char *const kParameterItemCategory =
    "item_category"

Item category (context-specific) (String).

let params = [
  AnalyticsParameterItemCategory : "pants",
  // ...
]

kParameterItemCategory2

const char *const kParameterItemCategory2 =
    "item_category2"

Item Category (context-specific) (String).

let params = [
  AnalyticsParameterItemCategory2 : "pants",
  // ...
]

kParameterItemCategory3

const char *const kParameterItemCategory3 =
    "item_category3"

Item Category (context-specific) (String).

let params = [
  AnalyticsParameterItemCategory3 : "pants",
  // ...
]

kParameterItemCategory4

const char *const kParameterItemCategory4 =
    "item_category4"

Item Category (context-specific) (String).

let params = [
  AnalyticsParameterItemCategory4 : "pants",
  // ...
]

kParameterItemCategory5

const char *const kParameterItemCategory5 =
    "item_category5"

Item Category (context-specific) (String).

let params = [
  AnalyticsParameterItemCategory5 : "pants",
  // ...
]

kParameterItemID

const char *const kParameterItemID = "item_id"

Item ID (context-specific) (String).

let params = [
  AnalyticsParameterItemID : "SKU_12345",
  // ...
]

kParameterItemListID

const char *const kParameterItemListID =
    "item_list_id"

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

let params = [
  AnalyticsParameterItemListID : "ABC123",
  // ...
]

kParameterItemListName

const char *const kParameterItemListName =
    "item_list_name"

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

let params = [
  AnalyticsParameterItemListName : "Related products",
  // ...
]

kParameterItemName

const char *const kParameterItemName =
    "item_name"

Item Name (context-specific) (String).

let params = [
  AnalyticsParameterItemName : "jeggings",
  // ...
]

kParameterItemVariant

const char *const kParameterItemVariant =
    "item_variant"

Item variant (String).

let params = [
  AnalyticsParameterItemVariant : "Black",
  // ...
]

kParameterItems

const char *const kParameterItems = "items"

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

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

kParameterLevel

const char *const kParameterLevel = "level"

Level in game (Int).

let params = [
  AnalyticsParameterLevel : 42,
  // ...
]

kParameterLevelName

const char *const kParameterLevelName =
    "level_name"

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

let params = [
  AnalyticsParameterLevelName : "room_1",
  // ...
]

kParameterLocation

const char *const kParameterLocation =
    "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",
  // ...
]

kParameterLocationID

const char *const kParameterLocationID =
    "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",
  // ...
]

kParameterMarketingTactic

const char *const kParameterMarketingTactic = "marketing_tactic"

Marketing Tactic (String).

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

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

kParameterMedium

const char *const kParameterMedium = "medium"

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

Highly recommended (String).

let params = [
  AnalyticsParameterMedium : "email",
  // ...
]

kParameterMethod

const char *const kParameterMethod = "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",
  // ...
]

kParameterNumberOfNights

const char *const kParameterNumberOfNights = "number_of_nights"

Number of nights staying at hotel (Int).

let params = [
  AnalyticsParameterNumberOfNights : 3,
  // ...
]

kParameterNumberOfPassengers

const char *const kParameterNumberOfPassengers = "number_of_passengers"

Number of passengers traveling (Int).

let params = [
  AnalyticsParameterNumberOfPassengers : 11,
  // ...
]

kParameterNumberOfRooms

const char *const kParameterNumberOfRooms =
    "number_of_rooms"

Number of rooms for travel events (Int).

let params = [
  AnalyticsParameterNumberOfRooms : 2,
  // ...
]

kParameterOrigin

const char *const kParameterOrigin = "origin"

Flight or Travel origin (String).

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

kParameterPaymentType

const char *const kParameterPaymentType =
    "payment_type"

The chosen method of payment (String).

let params = [
  AnalyticsParameterPaymentType : "Visa",
  // ...
]

kParameterPrice

const char *const kParameterPrice = "price"

Purchase price (Double).

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

kParameterPromotionID

const char *const kParameterPromotionID =
    "promotion_id"

The ID of a product promotion (String).

let params = [
  AnalyticsParameterPromotionID : "ABC123",
  // ...
]

kParameterPromotionName

const char *const kParameterPromotionName =
    "promotion_name"

The name of a product promotion (String).

let params = [
  AnalyticsParameterPromotionName : "Summer Sale",
  // ...
]

kParameterQuantity

const char *const kParameterQuantity =
    "quantity"

Purchase quantity (Int).

let params = [
  AnalyticsParameterQuantity : 1,
  // ...
]

kParameterScore

const char *const kParameterScore = "score"

Score in game (Int).

let params = [
  AnalyticsParameterScore : 4200,
  // ...
]

kParameterScreenClass

const char *const kParameterScreenClass =
    "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",
  // ...
]

kParameterScreenName

const char *const kParameterScreenName =
    "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",
  // ...
]

kParameterSearchTerm

const char *const kParameterSearchTerm =
    "search_term"

The search string/keywords used (String).

let params = [
  AnalyticsParameterSearchTerm : "periodic table",
  // ...
]

kParameterShipping

const char *const kParameterShipping =
    "shipping"

Shipping cost associated with a transaction (Double).

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

kParameterShippingTier

const char *const kParameterShippingTier =
    "shipping_tier"

The shipping tier (e.g.

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

let params = [
  AnalyticsParameterShippingTier : "Ground",
  // ...
]

kParameterSource

const char *const kParameterSource = "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",
  // ...
]

kParameterSourcePlatform

const char *const kParameterSourcePlatform =
    "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",
  // ...
]

kParameterStartDate

const char *const kParameterStartDate =
    "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",
  // ...
]

kParameterSuccess

const char *const kParameterSuccess = "success"

The result of an operation.

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

let params = [
  AnalyticsParameterSuccess : 1,
  // ...
]

kParameterTax

const char *const kParameterTax = "tax"

Tax cost associated with a transaction (Double).

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

kParameterTerm

const char *const kParameterTerm = "term"

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

let params = [
  AnalyticsParameterTerm : "game",
  // ...
]

kParameterTransactionID

const char *const kParameterTransactionID =
    "transaction_id"

The unique identifier of a transaction (String).

let params = [
  AnalyticsParameterTransactionID : "T12345",
  // ...
]

kParameterTravelClass

const char *const kParameterTravelClass =
    "travel_class"

Travel class (String).

let params = [
  AnalyticsParameterTravelClass : "business",
  // ...
]

kParameterValue

const char *const kParameterValue = "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
  // ...
]

kParameterVirtualCurrencyName

const char *const kParameterVirtualCurrencyName = "virtual_currency_name"

Name of virtual currency type (String).

let params = [
  AnalyticsParameterVirtualCurrencyName : "virtual_currency_name",
  // ...
]