Firebase.Analytics.FirebaseAnalytics

FirebaseAnalytics API.

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.
EventCheckoutProgress
static string
Checkout progress.
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.
EventRemoveFromCart
static string
Remove from cart event.
EventSearch
static string
Search event.
EventSelectContent
static string
Select Content event.
EventSetCheckoutOption
static string
Set checkout option.
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).
ParameterAffiliation
static string
The store or affiliation from which this transaction occurred (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).
ParameterCheckoutOption
static string
Some option on a step in an ecommerce flow (string).
ParameterCheckoutStep
static string
The checkout step (1..N) (unsigned 64-bit integer).
ParameterContent
static string
Campaign content (string).
ParameterContentType
static string
Type of content selected (string).
ParameterCoupon
static string
Coupon code for a purchasable item (string).
ParameterCreativeName
static string
The name of a creative used in a promotional spot (string).
ParameterCreativeSlot
static string
The name of a creative slot (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
ParameterIndex
static string
Index of an item in a list (signed 64-bit integer).
ParameterItemBrand
static string
Item brand (string).
ParameterItemCategory
static string
Item category (string).
ParameterItemId
static string
ParameterItemList
static string
The list in which the item was presented to the user (string).
ParameterItemLocationId
static string
ParameterItemName
static string
Item name (string).
ParameterItemVariant
static string
Item variant (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
Log an event with one string parameter.
LogEvent(string name, string parameterName, double parameterValue)
void
Log an event with one float parameter.
LogEvent(string name, string parameterName, long parameterValue)
void
Log an event with one 64-bit integer parameter.
LogEvent(string name, string parameterName, int parameterValue)
void
Log an event with one integer parameter (stored as a 64-bit integer).
LogEvent(string name)
void
Log an event with no parameters.
LogEvent(string name, params Parameter[] parameters)
unsafe void
Log an event with associated parameters.
SetAnalyticsCollectionEnabled(bool enabled)
void
Sets whether analytics collection is enabled for this app on this device.
SetCurrentScreen(string screenName, string screenClass)
void
Sets the current screen name and screen class, which specifies the current visual context in your app.
SetUserId(string userId)
void
Sets the user ID property.
SetUserProperty(string name, string property)
void
Set a user property to the given value.

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 bookings
  • ParameterNumberOfRooms (signed 64-bit integer) (optional) for hotel bookings
  • ParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • ParameterOrigin (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)

EventCheckoutProgress

static string EventCheckoutProgress

Checkout progress.

Params:

  • ParameterCheckoutStep (unsigned 64-bit integer)
  • ParameterCheckoutOption (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 bookings
  • ParameterNumberOfRooms (signed 64-bit integer) (optional) for hotel bookings
  • ParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • ParameterOrigin (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)

EventRemoveFromCart

static string EventRemoveFromCart

Remove from cart event.

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)

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 bookings
  • ParameterNumberOfRooms (signed 64-bit integer) (optional) for hotel bookings
  • ParameterNumberOfPassengers (signed 64-bit integer) (optional) for travel bookings
  • ParameterOrigin (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)

EventSetCheckoutOption

static string EventSetCheckoutOption

Set checkout option.

Params:

  • ParameterCheckoutStep (unsigned 64-bit integer)
  • ParameterCheckoutOption (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 signifi