Set user properties

User properties are attributes you define to describe segments of your user base, such as language preference or geographic location. These can be used to define audiences for your app. This guide shows you how to set user properties in your app.

Analytics automatically logs some user properties; you don't need to add any code to enable them. If you need to collect additional data, you can set up to 25 different user properties per project. Note that user property names are case-sensitive and that setting two user properties whose names differ only in case results in two distinct user properties being logged.

You can't use a small set of user property names reserved by Google:

  • Age
  • Gender
  • Interest

Before you begin

Make sure that you've set up your project and can access Analytics as described in Get Started with Analytics.

Set user properties

You can set Analytics user properties to describe the users of your app. You can make use of user properties by creating custom definitions, then using them to apply comparisons in your reports or as audience evaluation criteria.

To set a user property, follow these steps:

  1. Create a custom definition for the user property in the Custom Definitions page of Analytics in the Firebase console. For more information, see Custom dimensions and metrics.
  2. Set a user property in your app with the setUserProperty() method.

The following example shows how to add a hypothetical "favorite food" property, which assigns the value in the string food to the active user:

Web version 9

import { getAnalytics, setUserProperties } from "firebase/analytics";

const analytics = getAnalytics();
setUserProperties(analytics, { favorite_food: 'apples' });

Web version 8

firebase.analytics().setUserProperties({favorite_food: 'apples'});

You can access this data from the Custom Definitions page of Analytics in the Firebase console. The page shows a list of user properties that you have defined for your app. You can use these properties in comparisons on many of the reports available in Google Analytics. Read more about the Analytics reporting dashboard in the Firebase Help Center.