Set User Properties

User properties are attributes you define to describe segments of your userbase, such as language preference or geographic location.

Analytics automatically logs some user properties; you don't need to add any code to enable them. If your app needs to collect additional data, you can set up to 25 different Analytics User Properties in your app.

Before you begin

If this is your first time adding Analytics to your app, complete the following procedures:

Connect your app in the Firebase console

  1. Install the Firebase SDK.
  2. In the Firebase console, add your app to your Firebase project.

Add Analytics to your app

  1. Add the dependency for Firebase to your Podfile:
    pod 'Firebase/Core'
  2. Run pod install and open the created .xcworkspace file.
  3. Import the Firebase module:

    Objective-C

    @import Firebase;
    

    Swift

    import Firebase
    
  4. Configure a FIRApp shared instance, typically in your application's application:didFinishLaunchingWithOptions: method:

    Objective-C

    // Use Firebase library to configure APIs
    [FIRApp configure];
    

    Swift

    // Use Firebase library to configure APIs
    FIRApp.configure()
    

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:

  1. Register the property in the Analytics page of the Firebase console.

  2. Add code to set an Analytics user property with the setUserPropertyString() method. You can use the name and value of your choosing for each property.

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

Objective-C

[FIRAnalytics setUserPropertyString:food forName:@"favorite_food"];

Swift

FIRAnalytics.setUserPropertyString(food, forName: "favorite_food")

You can access this data as follows:

  1. In the Firebase console, open your project.
  2. Select Analytics from the menu to view the Analytics reporting dashboard.

The User Properties tab shows a list of user properties that you have defined for your app. You can use these properties as a filter on many of the reports available in Firebase Analytics. Read more about the Analytics reporting dashboard in the Firebase Help Center.

Send feedback about...

Need help? Visit our support page.