Event transmission¶
What is an event?¶
An event is a unit that records specific actions performed by a user within the game as data. It contains “who did what, when, and what” and is the most basic unit of analysis.
- Example: User purchases an item →
item_purchaseevent occurs - Example: User clears a specific stage →
stage_clearevent occurs - Example: User logs in to the app →
loginevent occurs
For information on how to transmit events, refer to Event log transmission.
Event Naming Rules¶
We recommend naming events used in eventName according to the rules below.
- Recommended characters: English letters (a–z, A–Z, case-sensitive), numbers (0–9), underscore (
_) - Separator: Separate words with an underscore (
_), not a space - Format: A
noun_verbformat that clearly describes the event is recommended - Examples:
item_purchase,level_up,tutorial_complete,stage_start
Warning
Event names that do not follow the rules above may be limited in how they can be used for analysis.
What are attributes?¶
Attributes are details recorded with an event when it occurs. Events alone can only tell you “what happened,” but attributes allow you to figure out “under what conditions and with what values” it happened.
- Example: Attributes of the
item_purchaseevent → Item ID, payment amount, currency unit - Example: Attributes of the
stage_clearevent → Stage number, clear time, character used
For information on how to transmit attributes with an event, see Event attribute transmission.
Attribute Naming Rules¶
We recommend naming the keys of custom attributes (eventAttributes) according to the rules below.
- Recommended characters: English letters (a–z, A–Z, case-sensitive), numbers (0–9), underscore (
_) - First character: Start with an English letter
- Separator: Separate words with an underscore (
_), not a space - Examples:
item_id,contentsType,stage_level
Warning
- Attribute keys that do not follow the rules above may be limited in how they can be used for analysis.
attributes,eventAttributes, andhiveAttributesare reserved words. Attributes that use them as names are isolated. For details, see Event attribute transmission.
An example of an event designed according to the event structure can be found in Event template.
Precautions & Tips¶
- Event names and attribute names are difficult to change once distributed. Please review the naming convention for Event attribute transmission before sending.
- Do not create multiple events for the same purpose with multiple names, and first check whether there is an event name already defined in Event template.
Related Menu¶
- Event — Event and attribute registration/management
- Engine common settings — Engine settings for using SDK (optional)
- Event attribute transmission — Detailed rules for required/automatically collected/custom-defined attributes
- Event template — List of default automatically collected events by category
- Event log transmission — Transmission method via Hive SDK v4, Fluentd, HTTP