How It Works
You can receive data about users’ activity, errors and failures in the Launcher operation sent to your endpoint URL as events and analyze it using any analytics tools. All outgoing events are listed below and grouped based on their type.
Events of opening and activating Launcher windows and screens
Event | Description |
---|---|
Game install window | Opening or activating the Game installation window. |
Launcher update window | Opening or activating the Login screen. |
Login screen | Opening or activating the Login screen. |
MailRu login screen | Opening or activating the Mail.ru login screen. |
Steam login screen | Opening or activating the Steam login screen. |
Stone login screen | Opening or activating the Stone login screen. |
Game screen | Opening or activating the Game screen. |
Maintenance window | Opening or activating the Maintenance window. |
Home screen | Opening or activating the Home screen. |
News screen | Opening or activating the News screen. |
One news screen | Opening or activating the One news screen. |
Store screen | Opening or activating the Store screen. |
Store window | Opening or activating the Store window. |
Redeem window | Opening or activating the Key redemption window. |
Settings window | Opening or activating the Settings window. |
Events of interaction between a user and the Launcher start page elements
Event | Description |
---|---|
StartPage Event: Push Install | Clicking the Install button. |
StartPage Event: Push start | Clicking the Play button. |
StartPage Event: Open Game | Opening the game screen. |
StartPage Event: Push Redeem key | Redeeming the key. |
StartPage Event: Open news | Opening News. |
StartPage Event: Open buy | Proceeding to purchase. |
Events of interaction between a user and the Launcher interface elements
Event | Description |
---|---|
UI Event: Push Install | Clicking the Install button. |
UI Event: Push Play | Clicking the Play button. |
UI Event: Push Update | Clicking the Update game button. |
UI Event: Push Maintenance | Clicking the Maintenance button. |
UI Event: Push AdsBanner | Clicking the ads banner. |
UI Event: Push Setting | Clicking the Settings button. |
UI Event: Push Logout | Clicking the Log out button. |
UI Event: Push Uninstall | Clicking the Uninstall button. |
UI Event: Push Repair | Clicking the Repair button. |
UI Event: Push Support | Clicking the Support button. |
UI Event: Push Community | Clicking the Community button. |
UI Event: Push Create Account | Clicking the Create Account button. |
UI Event: Push Forgot Password | Clicking the Forgot Password button. |
UI Event: Push Sign In With Social | Clicking the Sign in with Social button. |
UI Event: Push Sign In | Clicking the Sign in button. |
UI Event: Auto Sign In | Automatic authentication. |
UI Event: Game install window: Changed the installation path | Changing the installation path. |
UI Event: Game install window: Changed the installation drive | Changing the installation drive. |
UI Event: Game install window: Not enough disk space for game install | Error installing the game: not enough disk space. |
User authentication events
Event | Description |
---|---|
Launcher Login Event: Login finish | Successful authentication. |
Launcher Login Event: Login failed | Authentication attempt failed. |
Launcher Login Event: Login social finish | Successful social authentication. |
Launcher Login Event: Login social failed | Social authentication failed. |
Launcher Login Event: Login captcha open | Opening CAPTCHA. |
Launcher Login Event: Login privacy policy open | Opening privacy policy. |
Events of installing, launching, and uninstalling a game and redistributable packages
Event | Description |
---|---|
Game Installation Event: Game installation start | Game installation started. |
Game Installation Event: Game installation stopped | Game installation stopped. |
Game Installation Event: Game installation finished | Game installation finished. |
Game Installation Error: Game installation failed | Game installation failed. |
Game Installation Event: Game updating start | Game updating started. |
Game Installation Event: Game updating stopped | Game updating stopped. |
Game Installation Event: Game updating finished | Game updating finished. |
Game Installation Error: Game updating failed | Game updating failed. |
Game Installation Event: Game repairing start | Game repairing started. |
Game Installation Error: Game repairing failed | Game repairing failed. |
Game Installation Event: Game repairing stopped | Game repairing stopped. |
Game Installation Event: Game repairing finished | Game repairing finished. |
Game Uninstallation Event: Game uninstall start | Game uninstallation started. |
Game Uninstallation Event: Game uninstall finished | Game uninstallation finished. |
Game Event: Game start | Game started. |
Game Event: Game stopped | Game stopped. |
Game Error: Game crashed | Game crashed. |
Redist Event: Redist install start | Redistributable packages installation started. |
Redist Event: Redist install finish | Redistributable packages installation finished. |
Redist Error: Redist install failed | Redistributable packages installation failed. |
Error events when downloading, unpacking, and patching a game, and updating Launcher
Event | Description |
---|---|
Error: Extractor: Can't open file | Error unpacking the game: can’t open the file. |
Error: Extractor: Archive isn't supported | Error unpacking the game: can’t open the archive. |
Error: Extractor: Extraction exception | Error unpacking the game. |
Error: CreateFileAction: Can't save file is already exist | Error creating the file: the file already exists. |
Error: CreateFileAction: Can't save filet | Error saving the file. |
Error: DownloadAction: Network error, code | Network error downloading the game. |
Error: TorrentDownloadAction: Network error, code | Network error downloading the game through the torrent. |
Error: DownloadAction: Can't start download. Destination dir is undefined | Error starting the download: the destination directory is not specified. |
Error: ExtractAction: Unpacking error | Error unpacking Launcher updates. |
Error: CopyFileAction: Can't copy file | Error copying the file. |
Error: MoveFileAction: Can't move file | Error moving the file. |
Error: DeleteFileAction: Can't delete file | Error deleting the file. |
Error: CreateDirAction: Can't create directory | Error creating a directory. |
Error: PatchAction: Can't patch files | Error patching files. |
Error: InstallAction: Failed to start | Error starting game installation. |
Error: CopyDirAction: Can't copy dir | Error copying the directory. |
Error: MoveDirAction: Can't move directory | Error moving the directory. |
Error: RestartLauncherAction: Can't restart launcher | Error restarting Launcher. |
Error: DeleteDirAction: Can't delete dir | Error deleting the directory. |
Error: VerifyAction: Verify file finished with error | Error verifying the file: the file was not verified. |
Error: VerifyAction: Can't find patch rules | Error verifying the file: error finding file verification rules. |
Error: VerifyAction: Can't verify files | Error starting verification. |
Error: LauncherUpdater: Can't open file | Error opening files during the Launcher update. |
Error: LauncherUpdater: Can't extract archive | Error unpacking an archive during the Launcher update. |
Error: Steam: Overlay disabled | Error opening the Steam overlay. |
Store events
Event | Description |
---|---|
Store event: Redeem key successful | Key successfully redeemed. |
Store event: Redeem key failed | Key redemption failed. |
Store event: Buy the virtual item | Buying the virtual item. |
Store event: Buy the game | Buying the game. |
Who Can Use It
Partners who have already integrated Launcher.
How to Get It
Open the Config.json file and add the custom_analytics object. In this object, specify:
- Url — the URL you want to receive events at;
- sendIntervalMsec — the interval of sending events;
- custom_fields — the array of custom fields and their values sent with the event (optional).
Example of the custom_analytics object:
- php
"custom_analytics": {
"Url": "endpoint_URL",
"sendIntervalMsec": 2000,
"custom_fields": [
"custom_field1_name": "custom_field1_value",
"custom_field2_name": "custom_field2_value",
]
}
Example of the event:
- php
{
"EntityType": "title",
"EventId": "launcher1597240611",
"EventName": "UI Event: Push Sign In",
"Timestamp": "2020-08-12T15:56:51Z",
"EventAttributes": "{\"SessionID\": \"138171e4426385405becd842f7265d7a746280ce1597240501\", \"UserId\": \"\"}",
"ReceivedTimestamp": 1597240613.3814895
}
Was this article helpful?
Thank you for your feedback!
We'll review your message and use it to help us improve your experience.