Firebase. Analytics. FirebaseAnalytics
Summary
See the developer guides for general information on using FirebaseAnalytics in your apps.
Properties |
|
|---|---|
EventAddPaymentInfo
|
static string
Add Payment Info event.
|
EventAddToCart
|
static string
E-Commerce Add To Cart event.
|
EventAddToWishlist
|
static string
E-Commerce Add To Wishlist event.
|
EventAppOpen
|
static string
App Open event.
|
EventBeginCheckout
|
static string
E-Commerce Begin Checkout event.
|
EventCampaignDetails
|
static string
Campaign Detail event.
|
EventEarnVirtualCurrency
|
static string
Earn Virtual Currency event.
|
EventEcommercePurchase
|
static string
E-Commerce Purchase event.
|
EventGenerateLead
|
static string
Generate Lead event.
|
EventJoinGroup
|
static string
Join Group event.
|
EventLevelUp
|
static string
Level Up event.
|
EventLogin
|
static string
Login event.
|
EventPostScore
|
static string
Post Score event.
|
EventPresentOffer
|
static string
Present Offer event.
|
EventPurchaseRefund
|
static string
E-Commerce Purchase Refund event.
|
EventSearch
|
static string
Search event.
|
EventSelectContent
|
static string
Select Content event.
|
EventShare
|
static string
Share event.
|
EventSignUp
|
static string
Sign Up event.
|
EventSpendVirtualCurrency
|
static string
Spend Virtual Currency event.
|
EventTutorialBegin
|
static string
Tutorial Begin event.
|
EventTutorialComplete
|
static string
Tutorial End event.
|
EventUnlockAchievement
|
static string
Unlock Achievement event.
|
EventViewItem
|
static string
View Item event.
|
EventViewItemList
|
static string
View Item List event.
|
EventViewSearchResults
|
static string
View Search Results event.
|
ParameterAchievementId
|
static string
|
ParameterAdNetworkClickID
|
static string
Ad Network Click ID (string).
|
ParameterCP1
|
static string
Campaign custom parameter (string).
|
ParameterCampaign
|
static string
The individual campaign name, slogan, promo code, etc.
|
ParameterCharacter
|
static string
Character used in game (string).
|
ParameterContent
|
static string
Campaign content (string).
|
ParameterContentType
|
static string
Type of content selected (string).
|
ParameterCoupon
|
static string
Coupon code for a purchasable item (string).
|
ParameterCurrency
|
static string
Purchase currency in 3-letter ISO_4217 format (string).
|
ParameterDestination
|
static string
Flight or Travel destination (string).
|
ParameterEndDate
|
static string
The arrival date, check-out date or rental end date for the item.
|
ParameterFlightNumber
|
static string
Flight number for travel events (string).
|
ParameterGroupId
|
static string
|
ParameterItemCategory
|
static string
Item category (string).
|
ParameterItemId
|
static string
|
ParameterItemLocationId
|
static string
|
ParameterItemName
|
static string
Item name (string).
|
ParameterLevel
|
static string
Level in game (signed 64-bit integer).
|
ParameterLocation
|
static string
Location (string).
|
ParameterMedium
|
static string
The advertising or marParameter(eting, cpc, banner, email), push.
|
ParameterNumberOfNights
|
static string
Number of nights staying at hotel (signed 64-bit integer).
|
ParameterNumberOfPassengers
|
static string
Number of passengers traveling (signed 64-bit integer).
|
ParameterNumberOfRooms
|
static string
Number of rooms for travel events (signed 64-bit integer).
|
ParameterOrigin
|
static string
Flight or Travel origin (string).
|
ParameterPrice
|
static string
Purchase price (double).
|
ParameterQuantity
|
static string
Purchase quantity (signed 64-bit integer).
|
ParameterScore
|
static string
Score in game (signed 64-bit integer).
|
ParameterSearchTerm
|
static string
The search string/eywords used (string).
|
ParameterShipping
|
static string
Shipping cost (double).
|
ParameterSignUpMethod
|
static string
Sign up method (string).
|
ParameterSource
|
static string
The origin of your traffic, such as an Ad network (for example, google) or partner (urban airship).
|
ParameterStartDate
|
static string
The departure date, check-in date or rental start date for the item.
|
ParameterTax
|
static string
Tax amount (double).
|
ParameterTerm
|
static string
If you're manually tagging eyword campaigns, you should use utm_term to specify the eyword (string).
|
ParameterTransactionId
|
static string
|
ParameterTravelClass
|
static string
Travel class (string).
|
ParameterValue
|
static string
A context-specific numeric value which is accumulated automatically for each event type.
|
ParameterVirtualCurrencyName
|
static string
Name of currency type (string).
|
UserPropertySignUpMethod
|
static string
The method used to sign in.
|
Public static functions |
|
|---|---|
LogEvent(string name, string parameterName, string parameterValue)
|
void
|
LogEvent(string name, string parameterName, double parameterValue)
|
void
|
LogEvent(string name, string parameterName, long parameterValue)
|
void
|
LogEvent(string name, string parameterName, int parameterValue)
|
void
|
LogEvent(string name)
|
void
|
LogEvent(string name, params Parameter[] parameters)
|
unsafe void
Log an event with associated parameters.
|
SetAnalyticsCollectionEnabled(bool enabled)
|
void
|
SetUserId(string userId)
|
void
|
SetUserProperty(string name, string property)
|
void
|
Properties
EventAddPaymentInfo
static string EventAddPaymentInfo
Add Payment Info event.
This event signifies that a user has submitted their payment information to your app.
EventAddToCart
static string EventAddToCart
E-Commerce Add To Cart event.
This event signifies that an item was added to a cart for purchase. Add this event to a funnel with EventEcommercePurchase to gauge the effectiveness of your checParameter(out, If you supply the ParameterValue parameter), you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterQuantity(signed 64-bit integer)ParameterItemID(string)ParameterItemName(string)ParameterItemCategory(string)ParameterItemLocationID(string) (optional)ParameterPrice(double) (optional)ParameterCurrency(string) (optional)ParameterValue(double) (optional)ParameterOrigin(string) (optional)ParameterDestination(string) (optional)ParameterStartDate(string) (optional)ParameterEndDate(string) (optional)
EventAddToWishlist
static string EventAddToWishlist
E-Commerce Add To Wishlist event.
This event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterQuantity(signed 64-bit integer)ParameterItemID(string)ParameterItemName(string)ParameterItemCategory(string)ParameterItemLocationID(string) (optional)ParameterPrice(double) (optional)ParameterCurrency(string) (optional)ParameterValue(double) (optional)
EventAppOpen
static string EventAppOpen
App Open event.
By logging this event when an App is moved to the foreground, developers can understand how often users leave and return during the course of a Session. Although Sessions are automatically reported, this event can provide further clarification around the continuous engagement of app-users.
EventBeginCheckout
static string EventBeginCheckout
E-Commerce Begin Checkout event.
This event signifies that a user has begun the process of checking out. Add this event to a funnel with your EventEcommercePurchase event to gauge the effectiveness of your checkout process. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterValue(double) (optional)ParameterCurrency(string) (optional)ParameterTransactionID(string) (optional)ParameterStartDate(string) (optional)ParameterEndDate(string) (optional)ParameterNumberOfNights(signed 64-bit integer) (optional) for hotel bookingsParameterNumberOfRooms(signed 64-bit integer) (optional) for hotel bookingsParameterNumberOfPassengers(signed 64-bit integer) (optional) for travel bookingsParameterOrigin(string) (optional)ParameterDestination(string) (optional)ParameterTravelClass(string) (optional) for travel bookings
EventCampaignDetails
static string EventCampaignDetails
Campaign Detail event.
Log this event to supply the referral details of a re-engagement campaign. Note: you must supply at least one of the required parameters ParameterSource, ParameterMedium or ParameterCampaign. Params:
ParameterSource(string)ParameterMedium(string)ParameterCampaign(string)ParameterTerm(string) (optional)ParameterContent(string) (optional)ParameterAdNetworkClickID(string) (optional)ParameterCP1(string) (optional)
EventEarnVirtualCurrency
static string EventEarnVirtualCurrency
Earn Virtual Currency event.
This event tracks the awarding of virtual currency in your app. Log this along with EventSpendVirtualCurrency to better understand your economy. Params:
ParameterVirtualCurrencyName(string)ParameterValue(signed 64-bit integer or double)
EventEcommercePurchase
static string EventEcommercePurchase
E-Commerce Purchase event.
This event signifies that an item was purchased by a user. Note: This is different from the in-app purchase event, which is reported automatically for App Store-based apps. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterCurrency(string) (optional)ParameterValue(double) (optional)ParameterTransactionID(string) (optional)ParameterTax(double) (optional)ParameterShipping(double) (optional)ParameterCoupon(string) (optional)ParameterLocation(string) (optional)ParameterStartDate(string) (optional)ParameterEndDate(string) (optional)ParameterNumberOfNights(signed 64-bit integer) (optional) for hotel bookingsParameterNumberOfRooms(signed 64-bit integer) (optional) for hotel bookingsParameterNumberOfPassengers(signed 64-bit integer) (optional) for travel bookingsParameterOrigin(string) (optional)ParameterDestination(string) (optional)ParameterTravelClass(string) (optional) for travel bookings
EventGenerateLead
static string EventGenerateLead
Generate Lead event.
Log this event when a lead has been generated in the app to understand the efficacy of your install and re-engagement campaigns. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterCurrency(string) (optional)ParameterValue(double) (optional)
EventJoinGroup
static string EventJoinGroup
Join Group event.
Log this event when a user joins a group such as a guild, team or family. Use this event to analyze how popular certain groups or social features are in your app. Params:
ParameterGroupID(string)
EventLevelUp
static string EventLevelUp
Level Up event.
This event signifies that a player has leveled up in your gaming app. It can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass. Params:
ParameterLevel(signed 64-bit integer)ParameterCharacter(string) (optional)
EventLogin
static string EventLogin
Login event.
Apps with a login feature can report this event to signify that a user has logged in.
EventPostScore
static string EventPostScore
Post Score event.
Log this event when the user posts a score in your gaming app. This event can help you understand how users are actually performing in your game and it can help you correlate high scores with certain audiences or behaviors. Params:
ParameterScore(signed 64-bit integer)ParameterLevel(signed 64-bit integer) (optional)ParameterCharacter(string) (optional)
EventPresentOffer
static string EventPresentOffer
Present Offer event.
This event signifies that the app has presented a purchase offer to a user. Add this event to a funnel with the EventAddToCart and EventEcommercePurchase to gauge your conversion process. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterQuantity(signed 64-bit integer)ParameterItemID(string)ParameterItemName(string)ParameterItemCategory(string)ParameterItemLocationID(string) (optional)ParameterPrice(double) (optional)ParameterCurrency(string) (optional)ParameterValue(double) (optional)
EventPurchaseRefund
static string EventPurchaseRefund
E-Commerce Purchase Refund event.
This event signifies that an item purchase was refunded. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterCurrency(string) (optional)ParameterValue(double) (optional)ParameterTransactionID(string) (optional)
EventSearch
static string EventSearch
Search event.
Apps that support search features can use this event to contextualize search operations by supplying the appropriate, corresponding parameters. This event can help you identify the most popular content in your app. Params:
ParameterSearchTerm(string)ParameterStartDate(string) (optional)ParameterEndDate(string) (optional)ParameterNumberOfNights(signed 64-bit integer) (optional) for hotel bookingsParameterNumberOfRooms(signed 64-bit integer) (optional) for hotel bookingsParameterNumberOfPassengers(signed 64-bit integer) (optional) for travel bookingsParameterOrigin(string) (optional)ParameterDestination(string) (optional)ParameterTravelClass(string) (optional) for travel bookings
EventSelectContent
static string EventSelectContent
Select Content event.
This general purpose event signifies that a user has selected some content of a certain type in an app. The content can be any object in your app. This event can help you identify popular content and categories of content in your app. Params:
ParameterContentType(string)ParameterItemID(string)
EventShare
static string EventShare
Share event.
Apps with social features can log the Share event to identify the most viral content. Params:
ParameterContentType(string)ParameterItemID(string)
EventSignUp
static string EventSignUp
Sign Up event.
This event indicates that a user has signed up for an account in your app. The parameter signifies the method by which the user signed up. Use this event to understand the different behaviors between logged in and logged out users. Params:
ParameterSignUpMethod(string)
EventSpendVirtualCurrency
static string EventSpendVirtualCurrency
Spend Virtual Currency event.
This event tracks the sale of virtual goods in your app and can help you identify which goods are the most popular objects of purchase. Params:
ParameterItemName(string)ParameterVirtualCurrencyName(string)ParameterValue(signed 64-bit integer or double)
EventTutorialBegin
static string EventTutorialBegin
Tutorial Begin event.
This event signifies the start of the on-boarding process in your app. Use this in a funnel with EventTutorialComplete to understand how many users complete this process and move on to the full app experience.
EventTutorialComplete
static string EventTutorialComplete
Tutorial End event.
Use this event to signify the user's completion of your app's on-boarding process. Add this to a funnel with EventTutorialBegin to gauge the completion rate of your on-boarding process.
EventUnlockAchievement
static string EventUnlockAchievement
Unlock Achievement event.
Log this event when the user has unlocked an achievement in your game. Since achievements generally represent the breadth of a gaming experience, this event can help you understand how many users are experiencing all that your game has to offer. Params:
ParameterAchievementID(string)
EventViewItem
static string EventViewItem
View Item event.
This event signifies that some content was shown to the user. This content may be a product, a webpage or just a simple image or text. Use the appropriate parameters to contextualize the event. Use this event to discover the most popular items viewed in your app. Note: If you supply the ParameterValue parameter, you must also supply the ParameterCurrency parameter so that revenue metrics can be computed accurately. Params:
ParameterItemID(string)ParameterItemName(string)ParameterItemCategory(string)ParameterItemLocationID(string) (optional)ParameterPrice(double) (optional)ParameterQuantity(signed 64-bit integer) (optional)ParameterCurrency(string) (optional)ParameterValue(double) (optional)ParameterStartDate(string) (optional)ParameterEndDate(string) (optional)ParameterFlightNumber(string) (optional) for travel bookingsParameterNumberOfPassengers(signed 64-bit integer) (optional) for travel bookingsParameterNumberOfNights(signed 64-bit integer) (optional) for travel bookingsParameterNumberOfRooms(signed 64-bit integer) (optional) for travel bookingsParameterOrigin(string) (optional)ParameterDestination(string) (optional)ParameterSearchTerm(string) (optional) for travel bookingsParameterTravelClass(string) (optional) for travel bookings
EventViewItemList
static string EventViewItemList
View Item List event.
Log this event when the user has been presented with a list of items of a certain category. Params:
ParameterItemCategory(string)
EventViewSearchResults
static string EventViewSearchResults
View Search Results event.
Log this event when the user has been presented with the results of a search. Params:
ParameterSearchTerm(string)
ParameterAchievementId
static string ParameterAchievementId
ParameterAdNetworkClickID
static string ParameterAdNetworkClickID
ParameterCP1
static string ParameterCP1
ParameterCampaign
static string ParameterCampaign
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 Firebase.Analytics;
Parameter parameters[] = {
new Parameter(FirebaseAnalytics.ParameterCampaign, "winter_promotion"),
// ...
};
ParameterCharacter
static string ParameterCharacter
ParameterContent
static string ParameterContent
Campaign content (string).
ParameterContentType
static string ParameterContentType
ParameterCoupon
static string ParameterCoupon
ParameterCurrency
static string ParameterCurrency
ParameterDestination
static string ParameterDestination
ParameterEndDate
static string ParameterEndDate
ParameterFlightNumber
static string ParameterFlightNumber
ParameterGroupId
static string ParameterGroupId
ParameterItemCategory
static string ParameterItemCategory
ParameterItemId
static string ParameterItemId
ParameterItemLocationId
static string ParameterItemLocationId
ParameterItemName
static string ParameterItemName
ParameterLevel
static string ParameterLevel
ParameterLocation
static string ParameterLocation
ParameterMedium
static string ParameterMedium
ParameterNumberOfNights
static string ParameterNumberOfNights
ParameterNumberOfPassengers
static string ParameterNumberOfPassengers
ParameterNumberOfRooms
static string ParameterNumberOfRooms
ParameterOrigin
static string ParameterOrigin
ParameterPrice
static string ParameterPrice
ParameterQuantity
static string ParameterQuantity
ParameterScore
static string ParameterScore
ParameterSearchTerm
static string ParameterSearchTerm
ParameterShipping
static string ParameterShipping
ParameterSignUpMethod
static string ParameterSignUpMethod
ParameterSource
static string ParameterSource
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 Firebase.Analytics;
Parameter parameters[] = {
new Parameter(FirebaseAnalytics.ParameterSource, "InMobi"),
// ...
};
ParameterStartDate
static string ParameterStartDate
ParameterTax
static string ParameterTax
ParameterTerm
static string ParameterTerm
ParameterTransactionId
static string ParameterTransactionId
ParameterTravelClass
static string ParameterTravelClass
ParameterValue
static string ParameterValue
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 ey 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 ParameterCurrency parameter. The valid range of accumulated values is [-9,223,372,036,854.77, 9,223,372,036,854.77].
using Firebase.Analytics;
Parameter parameters[] = {
new Parameter(FirebaseAnalytics.ParameterValue, 3.99),
new Parameter(FirebaseAnalytics.ParameterCurrency, "USD"), // e.g. $3.99 USD
// ...
};
ParameterVirtualCurrencyName
static string ParameterVirtualCurrencyName
UserPropertySignUpMethod
static string UserPropertySignUpMethod
The method used to sign in.
For example, "google", "facebook" or "twitter".
Public static functions
LogEvent
void LogEvent( string name, string parameterName, string parameterValue )
LogEvent
void LogEvent( string name, string parameterName, double parameterValue )
LogEvent
void LogEvent( string name, string parameterName, long parameterValue )
LogEvent
void LogEvent( string name, string parameterName, int parameterValue )
LogEvent
void LogEvent( string name )
LogEvent
unsafe void LogEvent( string name, params Parameter[] parameters )
Log an event with associated parameters.
An Event is an important occurrence in your app that you want to measure. You can report up to 500 different types of events per app and you can associate up to 25 unique parameters with each Event type.
Some common events are in the reference guide via the FirebaseAnalytics.Event* constants, but you may also choose to specify custom event types that are associated with your specific app.
| Details | |||||
|---|---|---|---|---|---|
| Parameters |
|
SetAnalyticsCollectionEnabled
void SetAnalyticsCollectionEnabled( bool enabled )
SetUserId
void SetUserId( string userId )
SetUserProperty
void SetUserProperty( string name, string property )

