Analytics Parameters

Game achievement ID (String).

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

The ad format (e.g.

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

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

Ad Network Click ID (String).

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

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

The ad platform (e.g.

MoPub, IronSource) (String).

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

The ad source (e.g.

AdColony) (String).

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

The ad unit name (e.g.

Banner_03) (String).

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

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

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

Campaign custom parameter (String).

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

let params = [
  AnalyticsParameterCP1 : "custom_data",
  // ...
]

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",
  // ...
]

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",
  // ...
]

Character used in game (String).

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

Campaign content (String).

Type of content selected (String).

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

Coupon code used for a purchase (String).

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

Creative Format (String).

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

let params = [
  AnalyticsParameterCreativeFormat : "display",
  // ...
]

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

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

The name of a creative slot (String).

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

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

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

Flight or Travel destination (String).

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

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

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

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",
  // ...
]

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,
  // ...
]

Flight number for travel events (String).

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

Group/clan/guild ID (String).

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

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

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

Item brand (String).

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

Item category (context-specific) (String).

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

Item Category (context-specific) (String).

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

Item Category (context-specific) (String).

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

Item Category (context-specific) (String).

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

Item Category (context-specific) (String).

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

Item ID (context-specific) (String).

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

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

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

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

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

Item Name (context-specific) (String).

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

Item variant (String).

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

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

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

Level in game (Int).

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

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

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

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",
  // ...
]

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",
  // ...
]

Marketing Tactic (String).

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

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

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

Highly recommended (String).

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

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",
  // ...
]

Number of nights staying at hotel (Int).

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

Number of passengers traveling (Int).

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

Number of rooms for travel events (Int).

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

Flight or Travel origin (String).

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

The chosen method of payment (String).

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

Purchase price (Double).

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

The ID of a product promotion (String).

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

The name of a product promotion (String).

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

Purchase quantity (Int).

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

Score in game (Int).

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

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",
  // ...
]

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",
  // ...
]

The search string/keywords used (String).

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

Shipping cost associated with a transaction (Double).

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

The shipping tier (e.g.

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

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

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",
  // ...
]

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",
  // ...
]

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",
  // ...
]

The result of an operation.

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

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

Tax cost associated with a transaction (Double).

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

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

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

The unique identifier of a transaction (String).

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

Travel class (String).

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

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
  // ...
]

Name of virtual currency type (String).

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