Log Events

Events provide insight on what is happening in your app, such as user actions, system events, or errors.

Google Analytics for Firebase automatically logs some events for you; you don't need to add any code to receive them. If your app needs to collect additional data, you can log up to 500 different Analytics event types in your app. There is no limit on the total volume of events your app logs. Note that event names are case-sensitive and that logging two events whose names differ only in case will result in two distinct events.

Before you begin

Before you can use the Google Analytics for Firebase, you will need to create a Firebase project, and add the Firebase Unity SDK packages to your Unity project.

Setup:

Prerequisites

Android

iOS

  • Unity 5.0 or later
  • Xcode 7.0 or later

If you don't have a Unity project already, you can download one of our quickstart samples and experiment with a specific Firebase feature. If you're using a quickstart, remember to get the bundle identifier from the project settings; you need it for the next step.

Set up your app in the Firebase console

To add Firebase to your app, you need a Firebase project and a Firebase configuration file for your app.

Create a Firebase project in the Firebase console if you don't already have one. If you already have an existing Google project associated with your mobile app, click Import Google Project. Otherwise, click Add project.

Android

  1. Click Add Firebase to your Android app and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just download the config file.
  2. When prompted, enter your app's package name. It's important to enter the package name your app is using; this can only be set when you add an app to your Firebase project.
  3. Download a google-services.json file when instructed. You can redownload this file again at any time.
  4. Copy this file to anywhere inside your project's assets folder.

IOs

  1. Click Add Firebase to your iOS app and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just download the config file.
  2. When prompted, enter your app's bundle ID. It's important to enter the bundle ID your app is using; this can only be set when you add an app to your Firebase project.
  3. Download a GoogleService-Info.plist file when instructed. You can redownload this file again at any time.
  4. Add the GoogleService-Info.plist file to the project.

  5. Drag the GoogleService-Info.plist downloaded from the Firebase console into any folder in the Unity project.

Add the Firebase Unity SDK to your app

  1. Download the Firebase Unity SDK.
  2. Select the Assets > Import Package > Custom Package menu item.
  3. Import the FirebaseAnalytics.unitypackage package from the Firebase Unity SDK, downloaded previously.
  4. When the Import Unity Package window appears, click the Import button.

Build your app

Android

  1. Select the File > Build Settings menu option.
  2. Select Android in the Platform list.
  3. Click Switch Platform to select Android as the target platform.
  4. Wait for the spinner (compiling) icon in the bottom right corner of the Unity status bar to stop.
  5. Click Build and Run.

iOS

  1. Select the File > Build Settings menu option.
  2. Select iOS in the Platform list.
  3. Click Switch Platform to select iOS as the target platform.
  4. Wait for the spinner (compiling) icon in the bottom right corner of the Unity status bar to stop.
  5. Click Build and Run.

Log events

After you have initialized the Firebase.Analytics.FirebaseAnalytics module, you can use it to log events with the LogEvent() method.

To help you get started, the Analytics SDK defines a number of suggested events that are common among different types of apps, including retail and ecommerce, travel, and gaming apps. To learn more about these events and when to use them, browse the Events and properties articles in the Firebase Help Center.

You can find implementation details for suggested event types in the following locations:

  • Suggested events: see the list of Event constants.
  • Prescribed parameters: see the list of Parameters constants.

The following example demonstrates how to log a suggested SELECT_CONTENT Event:

    // Log an event with multiple parameters, passed as an array:

Firebase.Analytics.FirebaseAnalytics.LogEvent(
  Firebase.Analytics.FirebaseAnalytics.EventSelectContent,
  new Firebase.Analytics.Parameter[] {
      new Firebase.Analytics.Parameter(
        Firebase.Analytics.FirebaseAnalytics.ParameterItemId, id),
      new Firebase.Analytics.Parameter(
        Firebase.Analytics.FirebaseAnalytics.ParameterItemName, "name"),
      new Firebase.Analytics.Parameter(
        Firebase.Analytics.FirebaseAnalytics.UserPropertySignUpMethod, "Google"),
      new Firebase.Analytics.Parameter(
        "favorite_food", mFavoriteFood),
      new Firebase.Analytics.Parameter(
        "user_id", mUserId),
  }
);

In addition to the prescribed parameters, you can add the following parameters to any event:

  • Custom parameters: Custom parameters are not represented directly in your Analytics reports, but they can be used as filters in Audience definitions that can be applied to every report. Custom parameters are also included in data exported to BigQuery if your app is linked to a BigQuery project.

  • VALUE Parameter: VALUE is a general purpose parameter that is useful for accumulating a key metric that pertains to an Analytics Event. Examples include revenue, distance, time and points.

If your application has specific needs not covered by a suggested Analytics Event type, you can log your own custom Analytics Events as shown in this example:

Firebase.Analytics.FirebaseAnalytics.LogEvent("custom_progress_event", "percent", 0.4f);

View events in the log output

Android

You can enable verbose logging in the Android Studio Debug Log, to help verify that events are being logged properly by the SDK. This includes both automatically and manually logged events.

You can enable verbose logging with a series of adb commands:

adb shell setprop log.tag.FA VERBOSE
adb shell setprop log.tag.FA-SVC VERBOSE
adb logcat -v time -s FA FA-SVC

This command displays your events in the Android Studio logcat, helping you immediately verify that events are being sent.

iOS

Events are logged to the console, and can be viewed while running the app through XCode.

View analytics events in the dashboard

You can view aggregrated statistics about your Analytics Events in the Firebase console dashboards. These dashboards update periodically throughout the day. For immediate testing, use the logcat output as described in the previous section.

To access this data in the Firebase console:

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

The Events tab shows the event reports that are automatically created for each distinct type of Analytics Event logged by your app. Read more about the Analytics reporting dashboard in the Firebase Help Center.

Send feedback about...

Need help? Visit our support page.