Standardized Events

Overview

This document outlines the standardized events used in VNGGames Analytics’s standardized events concept. These events are categorized by functionality, platform compatibility, and provide necessary parameters for seamless integration.

Platform Prefixes

The platform prefixes are used to indicate the destination platform for the event data. These prefixes ensure that the events are appropriately routed and identified by the respective analytics or engagement platforms. For example, events prefixed with frb are sent to Firebase, while those with af are sent to AppsFlyer. By using these prefixes, Game Studios (GS) can maintain a standardized approach to event tracking across multiple platforms.

Platform	Prefix
Firebase	frb
Facebook	fb
AppsFlyer	af
Data Platform	dp
CleverTap	clt
Thinking Data	td

💡

Notice: Events are sent based on the platform selected by the Game Studio (GS). By default, Firebase, AppsFlyer, and Data Platform are used.

Predefined Parameters

Predefined parameters are default parameters automatically collected and sent by the VNGGames SDK with each event, alongside the input parameters provided for each function.

⚠️

Warning: Do not use parameter names that match the predefined ones listed below, as it may lead to missing or overwritten data.

Parameter	Description
`device_id`	Device identifier
`package`	App identifier
`device_info`	Device details: Operating system, device model, and OS version
`timestamp`	Current timestamp (UTC)
`session_id`	Unique identifier for the session or flow
`sdk_version`	Version of the VNGGames SDK
`network_type`	Name of the network type (e.g., WiFi, 4G)
`login_info`	User login information
`game_version`	Game version (Version_Build)
`response_info`	Additional response details, if any
`appsflyer_id`	AppsFlyer App ID
`frb_installation_id`	Firebase installation ID
`frb_app_instance_id`	Firebase app instance ID
`user_info`	Information about the user

Public Events

Public events are events that can be triggered using the public interface provided by the SDK. These events depend on the game’s requirements and are used to capture specific user actions or behaviors within the game.

💡

Notice: All events triggered by the VNGGames SDK APIs will start with the vgsdk_ prefix and follow the formula: vgsdk_{platform prefix}_{event name}.

For example: vgsdk_af_app_open

For custom usages: If you are using your own APIs for tracking, consider defining your own prefix based on your needs to ensure consistency and clarity across your events.

Registration flow events

App launch

Event Name	Description	Parameters
`app_open`	User opens app/game	`extra_data : Object` : Additional information in key - value format
`splash_screen`	User enters splash screen	`extra_data : Object` : Additional information in key - value format

Resource download

Event Name	Description	Parameters
`get_configuration`	Game gets the configuration file from server	`extra_data : Object` : Additional information in key - value format
`check_configuration_start`	Game starts check configuration	`extra_data : Object` : Additional information in key - value format
`check_configuration_finish`	Game finish check configuration	`extra_data : Object` : Additional information in key - value format
`cdn_download_start`	Game starts downloading CDN	`size : String` : total size need that need to be downloaded in MB `extra_data : Object` : Additional information in key - value format
`cdn_download_25`	CDN progress was finished 25%	`size : String` : total size need that need to be downloaded in MB `extra_data : Object` : Additional information in key - value format
`cdn_download_50`	CDN progress was finished 50%	`size : String` : total size need that need to be downloaded in MB `extra_data : Object` : Additional information in key - value format
`cdn_download_75`	CDN progress was finished 75%	`size : String` : total size need that need to be downloaded in MB `extra_data : Object` : Additional information in key - value format
`cdn_download_finish`	Game finishes downloading CDN	`size : String` : total size need that need to be downloaded in MB `extra_data : Object` : Additional information in key - value format
`extract_resource_start`	Game starts extracting resources	`size : String` : total size need that need to be extracted in MB `extra_data : Object` : Additional information in key - value format
`extract_resource_end`	Game finishes extracting resources	`size : String` : total size need that need to be extracted in MB `extra_data : Object` : Additional information in key - value format

Resource processing

Event Name	Description	Parameters
`extract_resource_start`	Game starts extracting resources	`size : String` : total size need that need to be extracted in MB `extra_data : Object` : Additional information in key - value format
`extract_resource_end`	Game finishes extracting resources	`size : String` : total size need that need to be extracted in MB `extra_data : Object` : Additional information in key - value format

New register user (NRU)

Access server

Event Name	Description	Parameters
`agree_all_term`	User clicks to agree all the term of game (privacy policies, Term of Usage…)	`extra_data : Object` : Additional information in key - value format
`joined_server`	User selected and accessed to game	`server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format

Create role

Event Name	Description	Parameters
`named_role`	User inputs the name during create role process	`server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format
`create_role_success`	Role succesfully created	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format

Tutorial

Event Name	Description	Parameters
`tutorial_start`	Game starts tutorial	`role_id : String` : ID of created role `server_id : String` : ID of selected server `progress : String` : The % of tutorial completion, starts with 0% `extra_data : Object` : Additional information in key - value format
`tutorial_progress_25`	Tutorial progress is 25%	`role_id : String` : ID of created role `server_id : String` : ID of selected server `progress : String` : The % of tutorial completion from 0% - 25% `extra_data : Object` : Additional information in key - value format
`tutorial_progress_50`	Tutorial progress is 50%	`role_id : String` : ID of created role `server_id : String` : ID of selected server `progress : String` : The % of tutorial completion from 26% - 50% `extra_data : Object` : Additional information in key - value format
`tutorial_progress_75`	Tutorial progress is 75%	`role_id : String` : ID of created role `server_id : String` : ID of selected server `progress : String` : The % of tutorial completion from 51% - 75% `extra_data : Object` : Additional information in key - value format
`tutorial_finish`	Tutorial finish, progress is 100%	`role_id : String` : ID of created role `server_id : String` : ID of selected server `progress : String` : The % of tutorial completion, 100% `extra_data : Object` : Additional information in key - value format

Main & Daily activities

Main quest

Event Name	Description	Parameters
`main_quest`	User plays main quest	`role_id : String` : ID of created role `server_id : String` : ID of selected server `main_quest_id : String` : the ID of main quest `extra_data : Object` : Additional information in key - value format

Daily quest

Event Name	Description	Parameters
`daily_quest`	User plays daily quest	`role_id : String` : ID of created role `server_id : String` : ID of selected server `daily_questId : String` : the ID of daily quest `extra_data : Object` : Additional information in key - value format
`grant_daily_reward`	User receives daily reward	`role_id : String` : ID of created role `server_id : String` : ID of selected server `daily_rewardId : String` : the ID of daily reward `extra_data : Object` : Additional information in key - value format

Daily activities

Event Name	Description	Parameters
`buy_item`	User buys in-game item	`role_id : String` : ID of created role `server_id : String` : ID of selected server `item_id : String` : the ID of the item `item_name : String` : the name of the item `item_price : String` : the price of the item `item_currency : String` : the currency of the price `item_quantity : String` : the quantity of item that user spend (if item is currency, then this value is amount) `extra_data : Object` : Additional information in key - value format
`spend_item`	User spends item (including spend in-game currency like gold, diamond…)	`role_id : String` : ID of created role `server_id : String` : ID of selected server `item_id : String` : the ID of the item `item_name : String` : the name of the item `item_price : String` : the price of the item `item_currency : String` : the currency of the price `item_quantity : String` : the quantity of item that user spend (if item is currency, then this value is amount) `extra_data : Object` : Additional information in key - value format

Gacha

Event Name	Description	Parameters
`gacha`	User plays gacha	`role_id : String` : ID of created role `server_id : String` : ID of selected server `gacha_type : String` : the type of gacha `extra_data : Object` : Additional information in key - value format

Leveling

Event Name	Description	Parameters
`level_up`	User levels up	`role_id : String` : ID of created role `server_id : String` : ID of selected server `current_level : String` : the current level of user at this time `extra_data : Object` : Additional information in key - value format

Purchase

In-app Purchase

Event Name	Description	Parameters
`open_iap_shop`	User opens the IAP shop	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format
`clicktobuy_item_iap`	User clicks on the IAP item	`role_id : String` : ID of created role `server_id : String` : ID of selected server `item_id : String` : the ID of the item `item_name : String` : the name of the item `item_price : String` : the price of the item `item_currency : String` : the currency of the price `extra_data : Object` : Additional information in key - value format
`iap_purchased_item`	User purchased the IAP item successfully	`role_id : String` : ID of created role `server_id : String` : ID of selected server `item_id : String` : the ID of the item `item_name : String` : the name of the item `item_price : String` : the price of the item `item_currency : String` : the currency of the price `extra_data : Object` : Additional information in key - value format
`iap_purchase_canceled_item`	User canceled the purchase	`role_id : String` : ID of created role `server_id : String` : ID of selected server `item_id : String` : the ID of the item `item_name : String` : the name of the item `item_price : String` : the price of the item `item_currency : String` : the currency of the price `extra_data : Object` : Additional information in key - value format

VIP Upgrade

Event Name	Description	Parameters
`vip_level_up`	User increased VIP level	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format
`buy_vip_reward`	User buys the vip reward based on their VIP level	`role_id : String` : ID of created role `server_id : String` : ID of selected server `item_id : String` : the ID of the item `item_name : String` : the name of the item `item_vip_level : String` : the VIP level that qualified for this item `item_price : String` : the price of the item `item_currency : String` : the currency of the price `extra_data : Object` : Additional information in key - value format

Guild

Event Name	Description	Parameters
`create_guild`	User creates a guild	`role_id : String` : ID of created role `server_id : String` : ID of selected server `guild_id : String` : ID of created guild `guild_name : String` : name of created guild `extra_data : Object` : Additional information in key - value format
`join_guild`	User creates a guild	`role_id : String` : ID of created role `server_id : String` : ID of selected server `guild_id : String` : ID of joined guild `guild_name : String` : name of joined guild `extra_data : Object` : Additional information in key - value format
`quit_guild`	User creates a guild	`role_id : String` : ID of created role `server_id : String` : ID of selected server `guild_id : String` : ID of quit guild `guild_name : String` : name of quit guild `extra_data : Object` : Additional information in key - value format

Friend

Event Name	Description	Parameters
`add_friend_to_list`	User adds friend to their friend list	`role_id : String` : ID of created role `server_id : String` : ID of selected server `platform : String` : platform that user interact to add friend, use one of: `in-game`, `facebook`, `zalo` `extra_data : Object` : Additional information in key - value format
`remove_friend_from_list`	User removes friend from their friend list	`role_id : String` : ID of created role `server_id : String` : ID of selected server `platform : String` : platform that user interact to add friend, use one of: `in-game`, `facebook`, `zalo` `extra_data : Object` : Additional information in key - value format

Event Name	Description	Parameters
`share_to_facebook`	User shares to facebook	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format
`invite_facebook_friend`	User invites a friend on facebook	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format

Misc activities

Event Name	Description	Parameters
`switch_account`	User switches to other account (switch to new role, logout in order to login new acount )	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format
`customer_support`	User creates a guild	`role_id : String` : ID of created role `server_id : String` : ID of selected server `extra_data : Object` : Additional information in key - value format

Private Events

Private events are automatically sent by the VNGGames SDK without requiring explicit calls. These events capture essential data to ensure smooth operation and analytics consistency, and there is no API available for developers to manually trigger these events.

💡

Notice
Private events automatically use all Predefined Parameters.
Any event with the prefix vgsdk not mentioned in the list below is for internal purposes. (Please disregard it)

Order	Event Name	Description
1	`vgsdk_{platform prefix}_install`	Logged whenever the SDK is successfully initialized.
2	`vgsdk_{platform prefix}_show_login_form`	Logged whenever the game calls the SDK’s authentication function. `Show form` `Direct login` `Auto login` `Quick login`
3	`vgsdk_{platform prefix}_detect_country`	Logged whenever the game calls the SDK’s authentication function. `Show form` `Direct login` `Auto login` `Quick login`
4	`vgsdk_{platform prefix}_bootstrap`	Logged whenever the game calls the SDK’s authentication function. `Show form` `Direct login` `Auto login` `Quick login`
5	`vgsdk_{platform prefix}_login_flow`	Logged whenever the user selects a login channel.
6	`vgsdk_{platform prefix}_registration`	Logged whenever the user successfully logs in and the game receives a callback with user information.
#	`vgsdk_{platform prefix}_app_active`	Logged whenever the game is activated.
#	`vgsdk_{platform prefix}_app_inactive`	Logged whenever the game enters the background.
#	`vgsdk_{platform prefix}_crash_detection`	Logged whenever the games crashes.
#	`af_purchase`	Logged to the AppsFlyer platform whenever the user successfully makes a payment through the store.
#	`td_purchase`	Logged to the ThinkingData platform whenever the user successfully makes a payment through the store.
#	ChargedEvent: Check event name from CleverTap dashboard	Logged to the CleverTap platform whenever the user successfully makes a payment through the store.
#	InitiatedCheckout: Check event name from Facebook dashboard	Logged to the Facebook platform whenever the user clicks to buy an item in-game.
#	Purchased: Check event name from Facebook dashboard	Logged to the Facebook platform whenever the user successfully makes a payment through the store.

Use cases CS Portal