Analytics API Reference
This section documents all Firebase Analytics Blueprint nodes provided by the plugin. These nodes allow you to control analytics state, manage user properties, log custom and predefined events, and retrieve the Firebase App Instance ID.
All Analytics nodes require Firebase to be successfully initialized before use.
Analytics State
| Node |
Parameters |
Callbacks / Return |
Description |
| Set Analytics Collection Enabled |
bEnabled (bool) |
– |
Enables or disables Firebase Analytics data collection for the current application instance. Enabled by default and should only be changed if manual control is required. |
| Is Analytics Collection Enabled |
– |
bool |
Returns whether Firebase Analytics data collection is currently enabled. |
| Reset Analytics Data |
– |
– |
Resets all analytics data on the device, including the app instance ID and stored analytics state. |
| Set Session Timeout Duration |
Milliseconds (int64) |
– |
Sets the duration of a session timeout in milliseconds for Firebase Analytics. |
User Properties
| Node |
Parameters |
Callbacks / Return |
Description |
| Set User ID |
UserId (string) |
– |
Sets the Firebase Analytics user ID for the current user. |
| Reset User ID |
– |
– |
Clears the currently assigned Firebase Analytics user ID. |
| Set User Property |
Name (string), Value (string) |
– |
Sets a custom Firebase Analytics user property. |
Event Logging
| Node |
Parameters |
Callbacks / Return |
Description |
| Log Event |
EventName (string) |
– |
Logs a simple analytics event without parameters. |
| Log Event Parameter String |
EventName, Param, Value (string) |
– |
Logs an analytics event with a single string parameter. |
| Log Event Parameter Int |
EventName, Param (string), Value (int64) |
– |
Logs an analytics event with a single integer parameter. |
| Log Event Parameter Float |
EventName, Param (string), Value (float) |
– |
Logs an analytics event with a single float parameter. |
| Log Event Parameter Bool |
EventName, Param (string), bValue (bool) |
– |
Logs an analytics event with a single boolean parameter. |
| Log Event With Parameters |
EventName, StringParams, IntParams, FloatParams, BoolParams |
– |
Logs an analytics event with multiple parameters of different types. All parameter maps are optional. |
Predefined Events
| Node |
Parameters |
Callbacks / Return |
Description |
| Log Login |
Method (string) |
– |
Logs a predefined login event using the specified authentication method. |
| Log Sign Up |
Method (string) |
– |
Logs a predefined sign-up event using the specified authentication method. |
| Log Level Start |
LevelName (string) |
– |
Logs a predefined level start event. |
| Log Level Complete |
LevelName (string) |
– |
Logs a predefined level completion event. |
| Log Level Fail |
LevelName (string) |
– |
Logs a predefined level failure event. |
| Log Tutorial Begin |
– |
– |
Logs a predefined tutorial begin event. |
| Log Tutorial Complete |
– |
– |
Logs a predefined tutorial completion event. |
| Log Purchase |
Currency (string), Value (float), ItemId (string) |
– |
Logs a predefined purchase event with currency, value, and item identifier. |
Default Event Parameters
| Node |
Parameters |
Callbacks / Return |
Description |
| Set Default Event Parameters |
StringParams, IntParams, FloatParams, BoolParams |
– |
Sets default parameters that will be automatically attached to all subsequent analytics events. |
| Clear Default Event Parameters |
– |
– |
Clears all previously set default analytics event parameters. |
App Instance ID
| Node |
Parameters |
Callbacks / Return |
Description |
| Get App Instance ID |
– |
On Success (InstanceID): Called when the App Instance ID is successfully retrieved.
On Error (Error Message): Called if the request fails. |
Asynchronously retrieves the Firebase App Instance ID for the current application installation. |