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_" prefix is 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).
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).
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).
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).
kParameterItemCategory = "item_category"
const char *const
Item category (string).
kParameterItemID = "item_id"
const char *const
Item ID (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).
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"),
   // ...
 };

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"),
   // ...
 };

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"),
   // ...
 };

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"),
   // ...
 };

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"),
   // ...
 };

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"),
   // ...
 };

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 firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterNumberOfRooms, 2),
   // ...
 };

kParameterOrigin

const char *const kParameterOrigin = "origin"

Flight or Travel origin (string). 

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

kParameterPrice

const char *const kParameterPrice = "price"

Purchase price (double). 

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterPrice, 1.0),
   Parameter(kParameterCurrency, "USD"),  // e.g. $1.00 USD
   // ...
 };

kParameterQuantity

const char *const kParameterQuantity = "quantity"

Purchase quantity (signed 64-bit integer). 

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

kParameterScore

const char *const kParameterScore = "score"

Score in game (signed 64-bit integer). 

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

kParameterSearchTerm

const char *const kParameterSearchTerm = "search_term"

The search string/keywords used (string). 

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterSearchTerm, "periodic table"),
   // ...
 };

kParameterShipping

const char *const kParameterShipping = "shipping"

Shipping cost (double). 

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

kParameterSignUpMethod

const char *const kParameterSignUpMethod = "sign_up_method"

Sign up method (string). 

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

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

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

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

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

kParameterTax

const char *const kParameterTax = "tax"

Tax amount (double). 

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterTax, 1.0),
   Parameter(kParameterCurrency, "USD"),  // e.g. $1.00 USD
   // ...
 };

kParameterTerm

const char *const kParameterTerm = "term"

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

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

kParameterTransactionID

const char *const kParameterTransactionID = "transaction_id"

A single ID for a ecommerce group transaction (string). 

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

kParameterTravelClass

const char *const kParameterTravelClass = "travel_class"

Travel class (string). 

using namespace firebase::analytics;
Parameter parameters[] = {
   Parameter(kParameterTravelClass, "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 signed 64-bit integer or double. Notes: Currency-related values should be supplied using doubleand must be accompanied by a kParameterCurrency parameter. The valid range of accumulated values is [-9,223,372,036,854.77, 9,223,372,036,854.77].

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

kParameterVirtualCurrencyName

const char *const kParameterVirtualCurrencyName =
    "virtual_currency_name"

Name of virtual currency type (string). 

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

Send feedback about...

This page
Documentation feedback
Firebase
Firebase
Product feedback
Need help? Visit our support page.