FirebaseAnalytics

This is the only Firebase Analytics package for React Native that has universal platform support (iOS, Android, Web, and Electron).

expo-firebase-analytics enables the use of native Google Analytics for Firebase. Google Analytics for Firebase is a free app measurement solution that provides insight on app usage and user engagement. Learn more in the official Firebase Docs.

Platform Compatibility

Android Device	Android Emulator	iOS Device	iOS Simulator	Web

Installation

Terminal

→ expo install expo-firebase-analytics

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

When using the web platform, you'll also need to run expo install firebase, which installs the Firebase JS SDK.

Configuration

With native Firebase SDK

If you are using React Native Firebase in your project, you should use @react-native-firebase/analytics package provided by the library. For more information on how to configure the native Firebase, see using the native Firebase SDK.

Expo Go: Limitations & configuration

The use of Native Firebase Analytics requires that the google-services configuration is bundled and linked into your app. Since Expo Go loads projects on demand, it does not have the google-services configuration linked into its app-bundle.

Instead, Expo Go relies on a JavaScript-based implementation of Firebase Analytics to log events. This means that certain native life-cycle events are not recorded in the standard client, but you can still use logEvent to record events.

You may want to use Firebase Analytics in Expo Go to verify that you are logging events at the time you intend to and with the data that you want to attach without having to do a standalone app build. To set this up, ensure that the Firebase web configuration is set in app.json and that measurementId exists in your firebase config. If measurementId doesn't exist, then you need to enable or update Google Analytics in your Firebase project.

app.json

{
  "expo": {
    "web": {
      "config": {
        "firebase": {
          "apiKey": "AIzaXXXXXXXX-xxxxxxxxxxxxxxxxxxx",
          ...
          "measurementId": "G-XXXXXXXXX"
        }
      }
    }
  }
}

This limitation only applies to the Expo Go app in the App and Play stores; standalone builds, custom clients & bare apps support the full native Firebase Analytics experience.

Optional: Enable AdSupport in Bare Workflow

To get extra features like audiences, campaign attribution, and some user properties, such as Age and Interests, you will need to include AdSupport. This is currently only possible in the Bare Workflow and not enabled by default because Apple & Google are strict with allowing apps to use this library.

To enable the AdSupport framework:

In your Xcode project, select your project's target
Select the General tab for your target
Expand the Linked Frameworks and Libraries section
Click + to add a framework
Select AdSupport.framework

Learn more in the Firebase Docs

Examples

How do people use my app?

You can gain deeper insight into what works and what doesn't by using the logEvent property. Also it's just a lot of fun to see that people actually use the features you work hard on! 😍

/*
 * Say we are in a tinder clone, and a user presses the card to view more
 * information on a user. We should track this event so we can see if people
 * are even using it.
 *
 * If lots of users are opening the card then swiping through photos, just
 * to dismiss again, then we should consider making it possible to look
 * through photos without having to enter the profile.
 */
onPressProfileButton = uid => {
  Analytics.logEvent('ExpandProfile', {
    /*
     * We want to know if the user came from from the swipe card as
     * opposed to from chat or a deep link.
     */
    sender: 'card',
    /*
     * This may be too specific and not very useful, but maybe down the line * we could investigate why a certain user is more popular than others.
     */
    user: uid,
    /*
     * We can use this information later to compare against other events.
     */
    screen: 'profile',
    purpose: 'Viewing more info on a user',
  });
};

React Navigation

You can track the screens your users are interacting with by integrating the best navigation library: react-navigation

API

import * as Analytics from 'expo-firebase-analytics';

To use web analytics, you'll also need to install the peer dependency firebase with expo install firebase.

Classes

`FirebaseAnalyticsJS`

A pure JavaScript Google Firebase Analytics implementation that uses the HTTPS Measurement API 2 to send events to Google Analytics.

This class provides an alternative for the Firebase Analytics module shipped with the Firebase JS SDK. That library uses the gtag.js dependency and requires certain browser features. This prevents the use analytics on other platforms, such as Node-js and react-native.

FirebaseAnalyticsJS provides a bare-bone implementation of the new HTTPS Measurement API 2 protocol (which is undocumented), with an API that follows the Firebase Analytics JS SDK.

FirebaseAnalyticsJS Properties

`config`

Type: FirebaseAnalyticsJSConfig

`url`

Type: string

FirebaseAnalyticsJS Methods

`clearEvents()`

Clears any queued events and cancels the flush timer.

Name	Type	Description
eventName	`string`	-
eventParams (optional)	`undefined`	-

Name	Type	Description
options	`FirebaseAnalyticsJSOptions`	-
eventName	`string`	-
eventParams (optional)	`undefined`	-

Name	Type	Description
options	`FirebaseAnalyticsJSOptions`	-
userPropertyName	`string`	-
userPropertyValue	`any`	-

Name	Type	Description
screenName (optional)	`string`	-
screenClassOverride (optional)	`string`	-

Name	Type	Description
name	`string`	The name of the event. Should contain 1 to 40 alphanumeric characters or underscores. The name must start with an alphabetic character. Some event names are reserved. The `firebase_`, `google_`, and `ga_` prefixes are 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. To manually log screen view events, use the `screen_view` event name.
properties (optional)	`Record<string, any>`	The dictionary of event parameters. Passing `undefined` indicates that the event has no parameters. Parameter names can be up to 40 characters long and must start with an alphabetic character and contain only alphanumeric characters and underscores. Only `String` and `Number` parameter types are supported; and `items` arrays containing dictionaries. `String` parameter values can be up to 100 characters long. The `firebase_`, `google_`, and `ga_` prefixes are reserved and should not be used for parameter names.

Name	Type	Description
screenName (optional)	`string`	The name of the current screen. Should contain 1 to 100 characters. Set to `undefined` to clear the current screen name.
screenClassOverride (optional)	`string`	The name of the screen class. Should contain 1 to 100 characters. By default this is the class name of the current screen (UIViewController on iOS). Set to `undefined` to revert to the default class name.

Name	Type	Description
name	`string`	The name of the user property to set. Should contain 1 to 24 alphanumeric characters or underscores and must start with an alphabetic character. The `firebase_`, `google_`, and `ga_` prefixes are reserved and should not be used for user property names.
value	`null \| string`	The value of the user property. Values can be up to 36 characters long. Setting the value to null removes the user property.