Documentation

Support

Analytics

Analytics

Create a custom event

Create custom events to track player actions that are unique to your game, and implement them in your game code.
Read time 2 minutesLast updated 19 hours ago
Unity Analytics comes with standard events that work without the need for additional configuration. However, you can create custom events to record player actions that are unique to your game. These must be created on the Unity Dashboard and then implemented in your game code.

Create a custom event through the Unity Dashboard

  1. Go to the Event Manager and select Add New > Custom Event.
  2. Enter an event name and description.
    • The first character of your event name must be a letter.
    • The event name must consist only of English alphanumeric and underscore characters (
      a-z
      , 
      A-Z
      , 
      0-9
      or 
      _
      ).
  3. Select Assign Parameter to add parameters to your event. You can add existing parameters or create new ones here by selecting Assign Parameter > Create New Parameter. A parameter needs a name, description and data type.
    • The first character of your parameter name must be a letter.
    • The name must consist only of English alphanumeric and underscore characters.
    • There is a set of reserved parameter names that cannot be used in custom event definitions (refer to the list of reserved parameter names).
    • Parameters are unique within an environment. The recommended best practice is to test your schema and its parameters in a test environment. Use the copy mechanism to propagate event definitions between environments.
  4. Ensure your event is set to Enabled.
To copy this event to another environment, refer to Copy custom events to another environment.

Create a matching 
Event
class in your game

The Analytics SDK is designed to help you match your game code with your event schemas as defined in the Unity Dashboard. While we provide helper classes for all of the standard events that you might encounter, you must make your own helper classes to support the custom events that are unique to your game. This is done through making sub-classes of the abstract 
Event
class, giving you type safety when working with the same event across multiple locations, and can help you to prevent validation errors when the events are uploaded. The following code is an example of how to make a sub-class of 
Event
, for an event called 
myEvent
that has individual parameters of each of the four available types: 
public class MyEvent : Unity.Services.Analytics.Event{	public MyEvent() : base("myEvent")	{	}	public string FabulousString { set { SetParameter("fabulousString", value); } }	public int SparklingInt { set { SetParameter("sparklingInt", value); } }	public float SpectacularFloat { set { SetParameter("spectacularFloat", value); } }	public bool PeculiarBool { set { SetParameter("peculiarBool", value); } }}
The 
Event
base class provides the 
SetParameter(...)
methods, which take in the string parameter name from your event schema and a value type. Wrapping this in write-only properties or type-safe methods ensures that repeated uses of the same event are less likely to introduce mistakes, and that changes to the underlying schema or the way you populate events can be made with the benefit of refactoring tools. Since the names of parameters in events are case sensitive, and their values must match the types defined in the Event Manager, this gives you one place to manage the mapping between what the game can supply and what is expected by the Analytics back-end. Once you have created your event schema and helper class and activated the SDK, you can use the 
AnalyticsService.Instance.Record(...)
method to record an event. For more information, refer to Record event.