Events provide insight on what is happening in your app, such as user actions, system events, or errors.
Google Analytics 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 results in two distinct events.
Before you begin
Before you can use Google Analytics, you need to:
Register your Unity project and configure it to use Firebase.
If your Unity project already uses Firebase, then it's already registered and configured for Firebase.
If you don't have a Unity project, you can download a sample app.
Add the Firebase Unity SDK (specifically,
FirebaseAnalytics.unitypackage
) to your Unity project.
Note that adding Firebase to your Unity project involves tasks both in the Firebase console and in your open Unity project (for example, you download Firebase config files from the console, then move them into your Unity project).
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 recommended 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, see Recommended events articles in the Google Analytics Help Center.
You can find implementation details for recommended events 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( 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 aggregated 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:
- In the Firebase console, open your project.
- 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 dashboard.