GOT Online SDK Integration Guide

GOT Online is a cloud-based performance analysis and continuous optimization platform designed specifically for game developers. It fully supports Android, iOS, Windows, and HarmonyOS NEXT.

By integrating the GameOptim SDK, developers can collect real-time runtime data including:

After uploading the data to the GameOptim platform, developers can efficiently perform:

Unlike traditional one-time performance testing tools, GOT Online provides a continuous performance governance solution across the entire game lifecycle.

Demo Report：https://www.gameoptim.com/main/projectDetail.html?projectGroupId=9033

Requirements

Step 1: Import the SDK

Import the SDK by dragging:

GameOptim_SDKvX.X.X.unitypackage

into the Unity Editor.

Step 2: Enable the SDK

Navigate to:

Tools → GameOptim SDK → Setup

Then press Play in the Editor.

If the GameOptim floating UI appears in the top-right corner of the Game view without errors, the SDK integration is successful.

Step 3: Build a Test Package

Open Build Settings and enable:

Development Build

Build and install the application on the test device.

Once the app launches, the GameOptim SDK control panel will appear at the top of the screen.

Step 4: Run a Test and Upload Data

Select Overview (Overall Performance Analysis) in the GameOptim panel.

Click Start and play the game normally or reproduce the performance issue.

Click Stop to finish data collection.The data will be saved locally on the device.

Then Login → Select Project → Submit → View report on the website

GameOptim provides two Unity packages.

The Vulkan version is compatible with most OpenGL scenarios.

If your project frequently switches between Vulkan and OpenGL, or does not need to support Android 7 and below, the Vulkan package is recommended.

Execute the following in the Unity menu:

Tools → GameOptim SDK → Setup

This operation will:

During normal builds, this step runs automatically in:

OnPreprocessBuild

If SDK-related compilation errors occur (especially when building AssetBundles or CI pipelines), it is recommended to run Setup manually once.

In the Settings panel you can configure Auto Launch.

If enabled (default):

The GameOptim SDK UI loads automatically when the project runs.

If disabled:

The SDK must be initialized manually using the API:

UWAEngine.StaticInit

See Section 7.1.2 Initialization for details.

Follow the standard release process.

To support Real Device Testing Service, the build must be Development.

If building through the BuildPlayer interface, ensure the following option is included:

If testing Mono mode under IL2CPP, enable:

Script Debugging

and include:

When building a final Release version, you can remove the SDK by:

Deleting the UWA_SDK folder, or

Adding the following define in Player Settings:

DISABLE_UWA_SDK

For automated build pipelines, SDK inclusion can be controlled via:

PlayerSettings.SetScriptingDefineSymbolsForGroup

Add the GameOptim annotation code to

TuanjiePlayerAbility.ts

Recommended: Copy the code block to Define Symbols

DISABLE_UWA_SDK

or delete

Assets/UWA/UWA_SDK

Select Mode → Start → Run test scenario → Stop → Upload

If unsure, start with Overview mode.

The GameOptim SDK supports both Development Build and Release Build packaging modes.

Development Build

The Development Build mode supports five testing modes, including:

Note:The Lua module is only applicable to projects that use Lua scripting.

Release Build

The Release Build mode only supports the Minimal version of Overview Mode.

For details, please refer to the official Demo page on the website.

Important Notes

Data availability may depend on:

Please refer to the following data support specifications.

Some metrics are affected by Unity version and build configuration.

Android Platform

Windows Platform

iOS Platform

HarmonyOS NEXT Platform

After clicking Stop:

Login → Submit → View report

If screenshots appear black, temporarily switch Color Space to Gamma and run the test again.

(1) GPU Counter Not Available

If GPU counter data is unavailable, try the following:

Adreno GPU (Android 12 and above)

You can manually enable GPU counters via the following ADB command:

Note:Some manufacturers (e.g., Xiaomi) may restrict this feature at the system level.

Mali GPU

If GPU Counter data cannot be collected:

Try rebooting the device (multiple attempts may be required).

(2) SOC Data Collection Issues

SOC data includes:

Current support:

Supported device models can be found here:

https://www.gameoptim.com/main/supported.html

HISI Chip Requirements

Minimum Android version: Android 10

Some devices may require higher system versions for proper data collection.

Due to Android permission restrictions, the screenshot feature is only supported on Android 5.0 and above.

To support different Android versions, the SDK provides three AAR libraries.

Automatic Selection in Unity

When building from the Unity Editor, the SDK automatically selects the appropriate AAR file.

Manual Configuration (Non-Unity Build Systems)

If using other build pipelines, configure the AAR files manually according to the following rules.

Target API ≥ 29 (Android 10+)

Enable:

Disable:

Enable:

Disable:

uwa_mp.aar

There are two methods to remove the SDK in production builds.

Method 1 (Recommended)

Add the following Scripting Define Symbol:

Scripting Define Symbols += DISABLE_UWA_SDK

Method 2

Manually delete the SDK directory:

Assets/UWA/UWA_SDK

The GameOptim API provides performance monitoring and data collection interfaces for game developers.

It supports deep integration with the GameOptim ecosystem.

The API enables:

If UI-based testing is sufficient, the API is not required.

Typical API usage scenarios:

If Auto Launch is disabled, initialize the SDK manually:

If Direct Mode is used, data collection will only begin after StaticInit following a game restart.

This API allows you to dynamically start and stop the current test via script, without manually clicking the stop button.

This is the core API for automated testing and CI performance recovery.

Note: This effect can also be achieved manually. On mobile devices, you can use four fingers to touch the screen simultaneously; on PCs, you can use the ``` key to hide/show the SDK's GUI interface during testing.

Before starting the test, enable or disable the SDK's log statistics function during the test.

This function can be used to customize the test configurations for all modes via scripts, eliminating the need for manual settings.

For detailed configuration content and usage instructions, please refer to the function comments and descriptions.

This function can be used to mark test intervals, which will overwrite the Unity scene name and become the interval statistics dimension in GOT Online, used to separate the performance of "loading / combat / UI / settlement".

Adds notes to test reports.

This function can be used to: tag multiple sets of key-value pairs, supports multiple calls, but the key cannot be repeated (only the parameters from the first call are retained for calls with the same key). The tagged content can be viewed in the following location in the report.

This function can be used to: measure the CPU time spent on custom code segments, thereby quickly identifying script performance bottlenecks. The parameter sampleName represents the custom function label. GameOptim SDK will measure the CPU overhead of the code segment between PushSample and `PopSample` and display it in the statistics panel of GOT. This API supports nested calls and can also be used in child threads.

UWAEngine.PushSample/PopSample

Finally, in the Overview interface, you can see the custom function labels and their specific execution time (A to E in the image below are all custom function labels).

By statistically analyzing the changes in the values ​​of custom labels in each frame, the trend of key variables can be visualized.

This function can be used to count the number of times a custom tag is marked in each frame, thus allowing the interface to be used to count the number of times a Lua calls a C# interface.

Supports only the Development environment; this function can be used to trigger dump operations in various test modes.

In Lua mode, this function can be used to specify the name of a custom Lua library via a script, such as libgamex.so.

If using the default Lua library (ulua/tolua/slua/xlua), this interface is not required to specify it.

During game runtime, test data is uploaded by passing in account information, project ID, and project name.

This function can be used to set the current version number via a script, which will be displayed in the GOT Online report information.

DISABLE_UWA_SDK

When DISABLE_UWA_SDK is defined in the editor settings, all GameOptim SDK-related code will be disabled during the APK packaging and compilation process, resulting in the absence of GameOptim-related DLLs or SO files in the final APK. This can be used when releasing the official package.

UWAEngine.OnStart

Allows callbacks when tests start or stop.

If disabled, log files will not be generated.

Add a new API to support reporting Lua or Wwise memory usage.

It supports all platforms and can use the reported values ​​as memory values ​​in Lua and wwise.