react-native-firebase / analytics/lib/modular
analytics/lib/modular
getAnalytics()
getAnalytics(
app?):Analytics
Defined in: analytics/lib/modular.ts:50
Returns an Analytics instance for the given app.
getAppInstanceId()
getAppInstanceId(
analytics):Promise<string|null>
Defined in: analytics/lib/modular.ts:445
Retrieve the app instance id of the application.
getGoogleAnalyticsClientId()
getGoogleAnalyticsClientId(
analytics):Promise<string>
Defined in: analytics/lib/modular.ts:70
Retrieves a unique Google Analytics identifier for the web client.
getSessionId()
getSessionId(
analytics):Promise<number|null>
Defined in: analytics/lib/modular.ts:455
Retrieves the session id from the client. On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
initializeAnalytics()
initializeAnalytics(
app,_options?):Analytics
Defined in: analytics/lib/modular.ts:60
Returns an Analytics instance for the given app.
initiateOnDeviceConversionMeasurementWithEmailAddress()
initiateOnDeviceConversionMeasurementWithEmailAddress(
analytics,emailAddress):Promise<void>
Defined in: analytics/lib/modular.ts:922
start privacy-sensitive on-device conversion management. This is iOS-only.
emailAddress
string
Email address, properly formatted complete with domain name e.g, 'user@example.com'.
initiateOnDeviceConversionMeasurementWithHashedEmailAddress()
initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
analytics,hashedEmailAddress):Promise<void>
Defined in: analytics/lib/modular.ts:943
start privacy-sensitive on-device conversion management. This is iOS-only. This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
hashedEmailAddress
string
sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com'
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber()
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
analytics,hashedPhoneNumber):Promise<void>
Defined in: analytics/lib/modular.ts:983
start privacy-sensitive on-device conversion management. This is iOS-only. This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
hashedPhoneNumber
string
sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
initiateOnDeviceConversionMeasurementWithPhoneNumber()
initiateOnDeviceConversionMeasurementWithPhoneNumber(
analytics,phoneNumber):Promise<void>
Defined in: analytics/lib/modular.ts:962
start privacy-sensitive on-device conversion management. This is iOS-only.
phoneNumber
string
Phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
isSupported()
isSupported():
Promise<boolean>
Defined in: analytics/lib/modular.ts:1003
Checks four different things.
- Checks if it's not a browser extension environment.
- Checks if cookies are enabled in current browser.
- Checks if IndexedDB is supported by the browser environment.
- Checks if the current browser context is valid for using IndexedDB.open().
logAddPaymentInfo()
logAddPaymentInfo(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:506
E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user. Note: This is different from the in-app purchase event, which is reported automatically for Google Play-based apps.
logAddShippingInfo()
logAddShippingInfo(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:525
Add Payment Info event. This event signifies that a user has submitted their payment information to your app.
logAddToCart()
logAddToCart(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:536
E-Commerce Add To Cart event.
logAddToWishlist()
logAddToWishlist(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:547
E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist.
logAppOpen()
logAppOpen(
analytics):Promise<void>
Defined in: analytics/lib/modular.ts:558
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.
logBeginCheckout()
logBeginCheckout(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:566
E-Commerce Begin Checkout event. This event signifies that a user has begun the process of checking out.
logCampaignDetails()
logCampaignDetails(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:577
Log this event to supply the referral details of a re-engagement campaign.
logEarnVirtualCurrency()
logEarnVirtualCurrency(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:588
Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:83
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:96
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:109
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:120
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:131
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:144
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:155
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:166
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:176
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:185
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:197
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:214
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:230
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:241
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:252
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:269
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:279
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:291
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:305
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:316
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:327
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:336
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:345
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:356
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:367
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:378
Log a custom event with optional params.
Call Signature
logEvent(
analytics,name,params,options?):Promise<void>
Defined in: analytics/lib/modular.ts:392
Log a custom event with optional params.
Call Signature
logEvent<
T>(analytics,name,params?,options?):Promise<void>
Defined in: analytics/lib/modular.ts:402
Log a custom event with optional params.
logGenerateLead()
logGenerateLead(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:599
Generate Lead event. Log this event when a lead has been generated in the app.
logJoinGroup()
logJoinGroup(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:610
Join Group event. Log this event when a user joins a group such as a guild, team or family.
logLevelEnd()
logLevelEnd(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:621
Level End event.
logLevelStart()
logLevelStart(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:629
Level Start event.
logLevelUp()
logLevelUp(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:640
Level Up event. This event signifies that a player has leveled up in your gaming app.
logLogin()
logLogin(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:648
Login event. Apps with a login feature can report this event to signify that a user has logged in.
logPostScore()
logPostScore(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:656
Post Score event. Log this event when the user posts a score in your gaming app.
logPurchase()
logPurchase(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:684
E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user.
logRefund()
logRefund(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:695
E-Commerce Refund event. This event signifies that a refund was issued.
logRemoveFromCart()
logRemoveFromCart(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:706
Remove from cart event.
logScreenView()
logScreenView(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:517
Sets or clears the screen name and class the user is currently viewing.
logSearch()
logSearch(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:720
Search event. Apps that support search features can use this event to contextualize search operations by supplying the appropriate, corresponding parameters.
logSelectContent()
logSelectContent(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:670
Select Content event. This general purpose event signifies that a user has selected some content of a certain type in an app.
logSelectItem()
logSelectItem(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:731
Select Item event. This event signifies that an item was selected by a user from a list.
logSelectPromotion()
logSelectPromotion(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:759
Select promotion event. This event signifies that a user has selected a promotion offer.
logSetCheckoutOption()
logSetCheckoutOption(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:745
Set checkout option event.
logShare()
logShare(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:773
Share event. Apps with social features can log the Share event to identify the most viral content.
logSignUp()
logSignUp(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:784
Sign Up event. This event indicates that a user has signed up for an account in your app.
logSpendVirtualCurrency()
logSpendVirtualCurrency(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:795
Spend Virtual Currency event. This event tracks the sale of virtual goods in your app.
logTutorialBegin()
logTutorialBegin(
analytics):Promise<void>
Defined in: analytics/lib/modular.ts:808
Tutorial Begin event. This event signifies the start of the on-boarding process in your app.
logTutorialComplete()
logTutorialComplete(
analytics):Promise<void>
Defined in: analytics/lib/modular.ts:818
Tutorial End event. Use this event to signify the user's completion of your app's on-boarding process.
logUnlockAchievement()
logUnlockAchievement(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:829
Unlock Achievement event. Log this event when the user has unlocked an achievement in your game.
logViewCart()
logViewCart(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:843
E-commerce View Cart event. This event signifies that a user has viewed their cart.
logViewItem()
logViewItem(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:854
View Item event. This event signifies that some content was shown to the user.
logViewItemList()
logViewItemList(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:865
View Item List event. Log this event when the user has been presented with a list of items of a certain category.
logViewPromotion()
logViewPromotion(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:879
View Promotion event. This event signifies that a promotion was shown to a user.
logViewSearchResults()
logViewSearchResults(
analytics,params):Promise<void>
Defined in: analytics/lib/modular.ts:893
View Search Results event. Log this event when the user has been presented with the results of a search.
resetAnalyticsData()
resetAnalyticsData(
analytics):Promise<void>
Defined in: analytics/lib/modular.ts:497
Clears all analytics data for this instance from the device and resets the app instance ID.
setAnalyticsCollectionEnabled()
setAnalyticsCollectionEnabled(
analytics,enabled):Promise<void>
Defined in: analytics/lib/modular.ts:422
If true, allows the device to collect analytical data and send it to Firebase. Useful for GDPR.
setConsent()
setConsent(
analytics,consentSettings):Promise<void>
Defined in: analytics/lib/modular.ts:1013
Sets the applicable end user consent state for this app.
setDefaultEventParameters()
setDefaultEventParameters(
analytics,params?):Promise<void>
Defined in: analytics/lib/modular.ts:907
Adds parameters that will be set on every event logged from the SDK, including automatic ones.
setSessionTimeoutDuration()
setSessionTimeoutDuration(
analytics,milliseconds?):Promise<void>
Defined in: analytics/lib/modular.ts:433
Sets the duration of inactivity that terminates the current session.
settings()
settings(
_options):void
Defined in: analytics/lib/modular.ts:1024
Configures Firebase Analytics to use custom gtag or dataLayer names.
Intended to be used if gtag.js script has been installed on this page independently of Firebase Analytics, and is using non-default names for either the gtag function or for dataLayer. Must be called before calling getAnalytics() or it won't have any effect. Web only.
setUserId()
setUserId(
analytics,id):Promise<void>
Defined in: analytics/lib/modular.ts:464
Gives a user a unique identification.
setUserProperties()
setUserProperties(
analytics,properties,options?):Promise<void>
Defined in: analytics/lib/modular.ts:485
Sets multiple key/value pairs of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.
setUserProperty()
setUserProperty(
analytics,name,value):Promise<void>
Defined in: analytics/lib/modular.ts:472
Sets a key/value pair of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.