Set user properties

Notice

This page is archived and might not reflect the latest version of the FlutterFire plugins. You can find the latest information on firebase.google.com:

https://firebase.google.com/docs/analytics/user-properties?platform=flutter

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 Analytics 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 analyze behaviors of various user segments by applying these properties as filters to your reports.

Set a user property as follows:

Register the property in the User Properties page of Analytics in the Firebase console. For more information, see Set and register a user property.
Add code to set an Analytics User Property with the setUserProperty() method.

The following example adds a hypothetical favorite food property, which assigns the value in favoriteFood to the active user:

await FirebaseAnalytics.instance
  .setUserProperty({
    name: 'favorite_food',
    value: favoriteFood,
  });