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. The "firebase_", "google_", and "ga_" prefixes are reserved and should not be used.

Variables

kParameterAchievementID = "achievement_id"
const char *const
Game achievement ID (string).
kParameterAdNetworkClickID = "aclid"
const char *const
Ad Network Click ID (string).
kParameterAffiliation = "affiliation"
const char *const
The store or affiliation from which this transaction occurred (string).
kParameterCP1 = "cp1"
const char *const
Campaign custom parameter (string).
kParameterCampaign = "campaign"
const char *const
The individual campaign name, slogan, promo code, etc.
kParameterCharacter = "character"
const char *const
Character used in game (string).
kParameterCheckoutOption = "checkout_option"
const char *const
Some option on a step in an ecommerce flow (string).
kParameterCheckoutStep = "checkout_step"
const char *const
The checkout step (1..N) (unsigned 64-bit integer).
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 for a purchasable item (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
Purchase currency in 3-letter ISO_4217 format (string).
kParameterDestination = "destination"
const char *const
Flight or Travel destination (string).
kParameterEndDate = "end_date"
const char *const
The arrival date, check-out date or rental end date for the item.
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
Index of an item in a list (signed 64-bit integer).
kParameterItemBrand = "item_brand"
const char *const
Item brand (string).
kParameterItemCategory = "item_category"
const char *const
Item category (string).
kParameterItemID = "item_id"
const char *const
Item ID (string).
kParameterItemList = "item_list"
const char *const
The list in which the item was presented to the user (string).
kParameterItemLocationID = "item_location_id"
const char *const
The Google Place ID (string) that corresponds to the associated item.
kParameterItemName = "item_name"
const char *const
Item name (string).
kParameterItemVariant = "item_variant"
const char *const
Item variant (string).
kParameterLevel = "level"
const char *const
Level in game (signed 64-bit integer).
kParameterLocation = "location"
const char *const
Location (string).
kParameterMedium = "medium"
const char *const
The advertising or marParameter(keting, cpc, banner, email), push.
kParameterNumberOfNights = "number_of_nights"
const char *const
Number of nights staying at hotel (signed 64-bit integer).
kParameterNumberOfPassengers = "number_of_passengers"
const char *const
Number of passengers traveling (signed 64-bit integer).
kParameterNumberOfRooms = "number_of_rooms"
const char *const
Number of rooms for travel events (signed 64-bit integer).
kParameterOrigin = "origin"
const char *const
Flight or Travel origin (string).
kParameterPrice = "price"
const char *const
Purchase price (double).
kParameterQuantity = "quantity"
const char *const
Purchase quantity (signed 64-bit integer).
kParameterScore = "score"
const char *const
Score in game (signed 64-bit integer).
kParameterSearchTerm = "search_term"
const char *const
The search string/keywords used (string).
kParameterShipping = "shipping"
const char *const
Shipping cost (double).
kParameterSignUpMethod = "sign_up_method"
const char *const
Sign up method (string).
kParameterSource = "source"
const char *const
The origin of your traffic, such as an Ad network (for example, google) or partner (urban airship).
kParameterStartDate = "start_date"
const char *const
The departure date, check-in date or rental start date for the item.
kParameterTax = "tax"
const char *const
Tax amount (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
A single ID for a ecommerce group 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).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterAchievementID, "10_matches_won"),
   // ...
 };

kParameterAdNetworkClickID

const char *const kParameterAdNetworkClickID = "aclid"

Ad Network Click ID (string).

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

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterAdNetworkClickID, "1234567"),
   // ...
 };

kParameterAffiliation

const char *const kParameterAffiliation = "affiliation"

The store or affiliation from which this transaction occurred (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterAffiliation, "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.

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCP1, "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).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCampaign, "winter_promotion"),
   // ...
 };

kParameterCharacter

const char *const kParameterCharacter = "character"

Character used in game (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCharacter, "beat_boss"),
   // ...
 };

kParameterCheckoutOption

const char *const kParameterCheckoutOption = "checkout_option"

Some option on a step in an ecommerce flow (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCheckoutOption, "Visa"),
   // ...
 };

kParameterCheckoutStep

const char *const kParameterCheckoutStep = "checkout_step"

The checkout step (1..N) (unsigned 64-bit integer).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCheckoutStep, "1"),
   // ...
 };

kParameterContent

const char *const kParameterContent = "content"

Campaign content (string).

kParameterContentType

const char *const kParameterContentType = "content_type"

Type of content selected (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterContentType, "news article"),
   // ...
 };

kParameterCoupon

const char *const kParameterCoupon = "coupon"

Coupon code for a purchasable item (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCoupon, "zz123"),
   // ...
 };

kParameterCreativeName

const char *const kParameterCreativeName = "creative_name"

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

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCreativeName, "Summer Sale"),
   // ...
 };

kParameterCreativeSlot

const char *const kParameterCreativeSlot = "creative_slot"

The name of a creative slot (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCreativeSlot, "summer_banner2"),
   // ...
 };

kParameterCurrency

const char *const kParameterCurrency = "currency"

Purchase currency in 3-letter ISO_4217 format (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterCurrency, "USD"),
   // ...
 };

kParameterDestination

const char *const kParameterDestination = "destination"

Flight or Travel destination (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterDestination, "Mountain View, CA"),
   // ...
 };

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).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterEndDate, "2015-09-14"),
   // ...
 };

kParameterFlightNumber

const char *const kParameterFlightNumber = "flight_number"

Flight number for travel events (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterFlightNumber, "ZZ800"),
   // ...
 };

kParameterGroupID

const char *const kParameterGroupID = "group_id"

Group/clan/guild ID (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterGroupID, "g1"),
   // ...
 };

kParameterIndex

const char *const kParameterIndex = "index"

Index of an item in a list (signed 64-bit integer).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterIndex, 1),
   // ...
 };

kParameterItemBrand

const char *const kParameterItemBrand = "item_brand"

Item brand (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemBrand, "Google"),
   // ...
 };

kParameterItemCategory

const char *const kParameterItemCategory = "item_category"

Item category (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemCategory, "t-shirts"),
   // ...
 };

kParameterItemID

const char *const kParameterItemID = "item_id"

Item ID (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemID, "p7654"),
   // ...
 };

kParameterItemList

const char *const kParameterItemList = "item_list"

The list in which the item was presented to the user (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemList, "Search Results"),
   // ...
 };

kParameterItemLocationID

const char *const kParameterItemLocationID = "item_location_id"

The Google Place ID (string) that corresponds to the associated item.

Alternatively, you can supply your own custom Location ID.

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemLocationID, "ChIJiyj437sx3YAR9kUWC8QkLzQ"),
   // ...
 };

kParameterItemName

const char *const kParameterItemName = "item_name"

Item name (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemName, "abc"),
   // ...
 };

kParameterItemVariant

const char *const kParameterItemVariant = "item_variant"

Item variant (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterItemVariant, "Red"),
   // ...
 };

kParameterLevel

const char *const kParameterLevel = "level"

Level in game (signed 64-bit integer).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterLevel, 42),
   // ...
 };

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.

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterLocation, "ChIJiyj437sx3YAR9kUWC8QkLzQ"),
   // ...
 };

kParameterMedium

const char *const kParameterMedium = "medium"

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

Highly recommended (string).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterMedium, "email"),
   // ...
 };

kParameterNumberOfNights

const char *const kParameterNumberOfNights = "number_of_nights"

Number of nights staying at hotel (signed 64-bit integer).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterNumberOfNights, 3),
   // ...
 };

kParameterNumberOfPassengers

const char *const kParameterNumberOfPassengers = "number_of_passengers"

Number of passengers traveling (signed 64-bit integer).

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterNumberOfPassengers, 11),
   // ...
 };

kParameterNumberOfRooms

const char *const kParameterNumberOfRooms = "number_of_rooms"

Number of rooms for travel events (signed 64-bit integer).

using namespace