React Native Firebase
    Preparing search index...

    Functions

    getAnalytics

    Returns an Analytics instance for the given app.

    getAppInstanceId

    Retrieve the app instance id of the application.

    getGoogleAnalyticsClientId

    Retrieves a unique Google Analytics identifier for the web client.

    getSessionId

    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

    Returns an Analytics instance for the given app.

    initiateOnDeviceConversionMeasurementWithEmailAddress

    start privacy-sensitive on-device conversion management. This is iOS-only.

    initiateOnDeviceConversionMeasurementWithHashedEmailAddress

    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 https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials

    initiateOnDeviceConversionMeasurementWithHashedPhoneNumber

    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 https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials

    initiateOnDeviceConversionMeasurementWithPhoneNumber

    start privacy-sensitive on-device conversion management. This is iOS-only.

    isSupported

    Checks four different things.

    1. Checks if it's not a browser extension environment.
    2. Checks if cookies are enabled in current browser.
    3. Checks if IndexedDB is supported by the browser environment.
    4. Checks if the current browser context is valid for using IndexedDB.open().
    logAddPaymentInfo

    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

    Add Payment Info event. This event signifies that a user has submitted their payment information to your app.

    logAddToCart

    E-Commerce Add To Cart event.

    logAddToWishlist

    E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist.

    logAppOpen

    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

    E-Commerce Begin Checkout event. This event signifies that a user has begun the process of checking out.

    logCampaignDetails

    Log this event to supply the referral details of a re-engagement campaign.

    logEarnVirtualCurrency

    Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app.

    logEvent

    Log a custom event with optional params.

    logGenerateLead

    Generate Lead event. Log this event when a lead has been generated in the app.

    logJoinGroup

    Join Group event. Log this event when a user joins a group such as a guild, team or family.

    logLevelEnd

    Level End event.

    logLevelStart

    Level Start event.

    logLevelUp

    Level Up event. This event signifies that a player has leveled up in your gaming app.

    logLogin

    Login event. Apps with a login feature can report this event to signify that a user has logged in.

    logPostScore

    Post Score event. Log this event when the user posts a score in your gaming app.

    logPurchase

    E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user.

    logRefund

    E-Commerce Refund event. This event signifies that a refund was issued.

    logRemoveFromCart

    Remove from cart event.

    logScreenView

    Sets or clears the screen name and class the user is currently viewing.

    logSearch

    Search event. Apps that support search features can use this event to contextualize search operations by supplying the appropriate, corresponding parameters.

    logSelectContent

    Select Content event. This general purpose event signifies that a user has selected some content of a certain type in an app.

    logSelectItem

    Select Item event. This event signifies that an item was selected by a user from a list.

    logSelectPromotion

    Select promotion event. This event signifies that a user has selected a promotion offer.

    logSetCheckoutOption

    Set checkout option event.

    logShare

    Share event. Apps with social features can log the Share event to identify the most viral content.

    logSignUp

    Sign Up event. This event indicates that a user has signed up for an account in your app.

    logSpendVirtualCurrency

    Spend Virtual Currency event. This event tracks the sale of virtual goods in your app.

    logTransaction

    Logs verified in-app purchase events in Google Analytics for Firebase after a purchase is successful. Modular API only; iOS only (StoreKit 2). Throws on Android and web before reaching native.

    logTutorialBegin

    Tutorial Begin event. This event signifies the start of the on-boarding process in your app.

    logTutorialComplete

    Tutorial End event. Use this event to signify the user's completion of your app's on-boarding process.

    logUnlockAchievement

    Unlock Achievement event. Log this event when the user has unlocked an achievement in your game.

    logViewCart

    E-commerce View Cart event. This event signifies that a user has viewed their cart.

    logViewItem

    View Item event. This event signifies that some content was shown to the user.

    logViewItemList

    View Item List event. Log this event when the user has been presented with a list of items of a certain category.

    logViewPromotion

    View Promotion event. This event signifies that a promotion was shown to a user.

    logViewSearchResults

    View Search Results event. Log this event when the user has been presented with the results of a search.

    resetAnalyticsData

    Clears all analytics data for this instance from the device and resets the app instance ID.

    setAnalyticsCollectionEnabled

    If true, allows the device to collect analytical data and send it to Firebase. Useful for GDPR.

    setConsent

    Sets the applicable end user consent state for this app.

    setDefaultEventParameters

    Adds parameters that will be set on every event logged from the SDK, including automatic ones.

    setSessionTimeoutDuration

    Sets the duration of inactivity that terminates the current session.

    settings

    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

    Gives a user a unique identification.

    setUserProperties

    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

    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.