Firebase.Analytics.FirebaseAnalytics

Summary

See the developer guides for general information on using Firebase Analytics in your apps.

Properties
`EventAdImpression`	`static string`
`EventAddPaymentInfo`	`static string`
`EventAddShippingInfo`	`static string`
`EventAddToCart`	`static string`
`EventAddToWishlist`	`static string`
`EventAppOpen`	`static string`
`EventBeginCheckout`	`static string`
`EventCampaignDetails`	`static string`
`EventEarnVirtualCurrency`	`static string`
`EventGenerateLead`	`static string`
`EventJoinGroup`	`static string`
`EventLevelEnd`	`static string`
`EventLevelStart`	`static string`
`EventLevelUp`	`static string`
`EventLogin`	`static string`
`EventPostScore`	`static string`
`EventPurchase`	`static string`
`EventRefund`	`static string`
`EventRemoveFromCart`	`static string`
`EventScreenView`	`static string`
`EventSearch`	`static string`
`EventSelectContent`	`static string`
`EventSelectItem`	`static string`
`EventSelectPromotion`	`static string`
`EventShare`	`static string`
`EventSignUp`	`static string`
`EventSpendVirtualCurrency`	`static string`
`EventTutorialBegin`	`static string`
`EventTutorialComplete`	`static string`
`EventUnlockAchievement`	`static string`
`EventViewCart`	`static string`
`EventViewItem`	`static string`
`EventViewItemList`	`static string`
`EventViewPromotion`	`static string`
`EventViewSearchResults`	`static string`
`ParameterAchievementId`	`static string`
`ParameterAdFormat`	`static string`
`ParameterAdNetworkClickID`	`static string`
`ParameterAdPlatform`	`static string`
`ParameterAdSource`	`static string`
`ParameterAdUnitName`	`static string`
`ParameterAffiliation`	`static string`
`ParameterCP1`	`static string`
`ParameterCampaign`	`static string`
`ParameterCampaignID`	`static string`
`ParameterCharacter`	`static string`
`ParameterContent`	`static string`
`ParameterContentType`	`static string`
`ParameterCoupon`	`static string`
`ParameterCreativeFormat`	`static string`
`ParameterCreativeName`	`static string`
`ParameterCreativeSlot`	`static string`
`ParameterCurrency`	`static string`
`ParameterDestination`	`static string`
`ParameterDiscount`	`static string`
`ParameterEndDate`	`static string`
`ParameterExtendSession`	`static string`
`ParameterFlightNumber`	`static string`
`ParameterGroupId`	`static string`
`ParameterIndex`	`static string`
`ParameterItemBrand`	`static string`
`ParameterItemCategory`	`static string`
`ParameterItemCategory2`	`static string`
`ParameterItemCategory3`	`static string`
`ParameterItemCategory4`	`static string`
`ParameterItemCategory5`	`static string`
`ParameterItemId`	`static string`
`ParameterItemListID`	`static string`
`ParameterItemListName`	`static string`
`ParameterItemName`	`static string`
`ParameterItemVariant`	`static string`
`ParameterItems`	`static string`
`ParameterLevel`	`static string`
`ParameterLevelName`	`static string`
`ParameterLocation`	`static string`
`ParameterLocationID`	`static string`
`ParameterMarketingTactic`	`static string`
`ParameterMedium`	`static string`
`ParameterMethod`	`static string`
`ParameterNumberOfNights`	`static string`
`ParameterNumberOfPassengers`	`static string`
`ParameterNumberOfRooms`	`static string`
`ParameterOrigin`	`static string`
`ParameterPaymentType`	`static string`
`ParameterPrice`	`static string`
`ParameterPromotionID`	`static string`
`ParameterPromotionName`	`static string`
`ParameterQuantity`	`static string`
`ParameterScore`	`static string`
`ParameterScreenClass`	`static string`
`ParameterScreenName`	`static string`
`ParameterSearchTerm`	`static string`
`ParameterShipping`	`static string`
`ParameterShippingTier`	`static string`
`ParameterSource`	`static string`
`ParameterSourcePlatform`	`static string`
`ParameterStartDate`	`static string`
`ParameterSuccess`	`static string`
`ParameterTax`	`static string`
`ParameterTerm`	`static string`
`ParameterTransactionId`	`static string`
`ParameterTravelClass`	`static string`
`ParameterValue`	`static string`
`ParameterVirtualCurrencyName`	`static string`
`UserPropertyAllowAdPersonalizationSignals`	`static string`
`UserPropertySignUpMethod`	`static string`

Public static functions
`ExportFix()`	`void`
`GetAnalyticsInstanceIdAsync()`	`System.Threading.Tasks.Task< string >`
`GetSessionIdAsync()`	`System.Threading.Tasks.Task< long >`
`InitiateOnDeviceConversionMeasurementWithEmailAddress(string emailAddress)`	`void`
`InitiateOnDeviceConversionMeasurementWithHashedEmailAddress(byte[] hashedEmailAddress)`	`void` Initiates on-device conversion measurement given a sha256-hashed user email address.
`InitiateOnDeviceConversionMeasurementWithHashedPhoneNumber(byte[] hashedPhoneNumber)`	`void` Initiates on-device conversion measurement given a sha256-hashed phone number in E.164 format.
`InitiateOnDeviceConversionMeasurementWithPhoneNumber(string phoneNumber)`	`void`
`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.
`ResetAnalyticsData()`	`void`
`SetAnalyticsCollectionEnabled(bool enabled)`	`void`
`SetConsent(System.Collections.Generic.IDictionary< ConsentType, ConsentStatus > consentSettings)`	`void` Sets the applicable end user consent state (e.g., for device identifiers) for this app on this device.
`SetSessionTimeoutDuration(System.TimeSpan timeSpan)`	`void` Sets the duration of inactivity that terminates the current session.
`SetUserId(string userId)`	`void`
`SetUserProperty(string name, string property)`	`void`

Properties

EventAdImpression

static string EventAdImpression

EventAddPaymentInfo

static string EventAddPaymentInfo

EventAddShippingInfo

static string EventAddShippingInfo

EventAddToCart

static string EventAddToCart

EventAddToWishlist

static string EventAddToWishlist

EventAppOpen

static string EventAppOpen

EventBeginCheckout

static string EventBeginCheckout

EventCampaignDetails

static string EventCampaignDetails

EventEarnVirtualCurrency

static string EventEarnVirtualCurrency

EventGenerateLead

static string EventGenerateLead

EventJoinGroup

static string EventJoinGroup

EventLevelEnd

static string EventLevelEnd

EventLevelStart

static string EventLevelStart

EventLevelUp

static string EventLevelUp

EventLogin

static string EventLogin

EventPostScore

static string EventPostScore

EventPurchase

static string EventPurchase

EventRefund

static string EventRefund

EventRemoveFromCart

static string EventRemoveFromCart

EventScreenView

static string EventScreenView

EventSearch

static string EventSearch

EventSelectContent

static string EventSelectContent

EventSelectItem

static string EventSelectItem

EventSelectPromotion

static string EventSelectPromotion

EventShare

static string EventShare

EventSignUp

static string EventSignUp

EventSpendVirtualCurrency

static string EventSpendVirtualCurrency

EventTutorialBegin

static string EventTutorialBegin

EventTutorialComplete

static string EventTutorialComplete

EventUnlockAchievement

static string EventUnlockAchievement

EventViewCart

static string EventViewCart

EventViewItem

static string EventViewItem

EventViewItemList

static string EventViewItemList

EventViewPromotion

static string EventViewPromotion

EventViewSearchResults

static string EventViewSearchResults

ParameterAchievementId

static string ParameterAchievementId

ParameterAdFormat

static string ParameterAdFormat

ParameterAdNetworkClickID

static string ParameterAdNetworkClickID

ParameterAdPlatform

static string ParameterAdPlatform

ParameterAdSource

static string ParameterAdSource

ParameterAdUnitName

static string ParameterAdUnitName

ParameterAffiliation

static string ParameterAffiliation

ParameterCP1

static string ParameterCP1

ParameterCampaign

static string ParameterCampaign

ParameterCampaignID

static string ParameterCampaignID

ParameterCharacter

static string ParameterCharacter

ParameterContent

static string ParameterContent

ParameterContentType

static string ParameterContentType

ParameterCoupon

static string ParameterCoupon

ParameterCreativeFormat

static string ParameterCreativeFormat

ParameterCreativeName

static string ParameterCreativeName

ParameterCreativeSlot

static string ParameterCreativeSlot

ParameterCurrency

static string ParameterCurrency

ParameterDestination

static string ParameterDestination

ParameterDiscount

static string ParameterDiscount

ParameterEndDate

static string ParameterEndDate

ParameterExtendSession

static string ParameterExtendSession

ParameterFlightNumber

static string ParameterFlightNumber

ParameterGroupId

static string ParameterGroupId

ParameterIndex

static string ParameterIndex

ParameterItemBrand

static string ParameterItemBrand

ParameterItemCategory

static string ParameterItemCategory

ParameterItemCategory2

static string ParameterItemCategory2

ParameterItemCategory3

static string ParameterItemCategory3

ParameterItemCategory4

static string ParameterItemCategory4

ParameterItemCategory5

static string ParameterItemCategory5

ParameterItemId

static string ParameterItemId

ParameterItemListID

static string ParameterItemListID

ParameterItemListName

static string ParameterItemListName

ParameterItemName

static string ParameterItemName

ParameterItemVariant

static string ParameterItemVariant

ParameterItems

static string ParameterItems

ParameterLevel

static string ParameterLevel

ParameterLevelName

static string ParameterLevelName

ParameterLocation

static string ParameterLocation

ParameterLocationID

static string ParameterLocationID

ParameterMarketingTactic

static string ParameterMarketingTactic

ParameterMedium

static string ParameterMedium

ParameterMethod

static string ParameterMethod

ParameterNumberOfNights

static string ParameterNumberOfNights

ParameterNumberOfPassengers

static string ParameterNumberOfPassengers

ParameterNumberOfRooms

static string ParameterNumberOfRooms

ParameterOrigin

static string ParameterOrigin

ParameterPaymentType

static string ParameterPaymentType

ParameterPrice

static string ParameterPrice

ParameterPromotionID

static string ParameterPromotionID

ParameterPromotionName

static string ParameterPromotionName

ParameterQuantity

static string ParameterQuantity

ParameterScore

static string ParameterScore

ParameterScreenClass

static string ParameterScreenClass

ParameterScreenName

static string ParameterScreenName

ParameterSearchTerm

static string ParameterSearchTerm

ParameterShipping

static string ParameterShipping

ParameterShippingTier

static string ParameterShippingTier

ParameterSource

static string ParameterSource

ParameterSourcePlatform

static string ParameterSourcePlatform

ParameterStartDate

static string ParameterStartDate

ParameterSuccess

static string ParameterSuccess

ParameterTax

static string ParameterTax

ParameterTerm

static string ParameterTerm

ParameterTransactionId

static string ParameterTransactionId

ParameterTravelClass

static string ParameterTravelClass

ParameterValue

static string ParameterValue

ParameterVirtualCurrencyName

static string ParameterVirtualCurrencyName

UserPropertyAllowAdPersonalizationSignals

static string UserPropertyAllowAdPersonalizationSignals

UserPropertySignUpMethod

static string UserPropertySignUpMethod

Public static functions

ExportFix

void ExportFix()

GetAnalyticsInstanceIdAsync

System.Threading.Tasks.Task< string > GetAnalyticsInstanceIdAsync()

GetSessionIdAsync

System.Threading.Tasks.Task< long > GetSessionIdAsync()

InitiateOnDeviceConversionMeasurementWithEmailAddress

void InitiateOnDeviceConversionMeasurementWithEmailAddress(
  string emailAddress
)

InitiateOnDeviceConversionMeasurementWithHashedEmailAddress

void InitiateOnDeviceConversionMeasurementWithHashedEmailAddress(
  byte[] hashedEmailAddress
)

Initiates on-device conversion measurement given a sha256-hashed user email address.

Requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.

Details

Parameters

hashedEmailAddress

User email address as a UTF8-encoded string normalized and hashed according to the instructions at https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3.

InitiateOnDeviceConversionMeasurementWithHashedPhoneNumber

void InitiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
  byte[] hashedPhoneNumber
)

Initiates on-device conversion measurement given a sha256-hashed phone number in E.164 format.

Requires dependency GoogleAppMeasurementOnDeviceConversion to be linked in, otherwise it is a no-op.

Details

Parameters

hashedPhoneNumber

UTF8-encoded user phone number in E.164 format and then hashed according to the instructions at https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3.

InitiateOnDeviceConversionMeasurementWithPhoneNumber

void InitiateOnDeviceConversionMeasurementWithPhoneNumber(
  string phoneNumber
)

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

name

Name of the event to log. Should contain 1 to 32 alphanumeric characters or underscores. The name must start with an alphabetic character. Some event names are reserved. See Analytics Events for the list of reserved event names. The "firebase_" prefix is reserved and should not be used. Note that event names are case-sensitive and that logging two events whose names differ only in case will result in two distinct events.

parameters

A parameter array of Parameter instances.

ResetAnalyticsData

void ResetAnalyticsData()

SetAnalyticsCollectionEnabled

void SetAnalyticsCollectionEnabled(
  bool enabled
)

SetConsent

void SetConsent(
  System.Collections.Generic.IDictionary< ConsentType, ConsentStatus > consentSettings
)

Sets the applicable end user consent state (e.g., for device identifiers) for this app on this device.

Use the consent map to specify individual consent type values. Settings are persisted across app sessions. By default consent types are set to "granted".

SetSessionTimeoutDuration

void SetSessionTimeoutDuration(
  System.TimeSpan timeSpan
)

Sets the duration of inactivity that terminates the current session.

Details

Parameters

timeSpan

The duration of inactivity that terminates the current session.

SetUserId

void SetUserId(
  string userId
)

SetUserProperty

void SetUserProperty(
  string name,
  string property
)