A/B testing is a powerful tool to test different variables on various user segments in parallel to see which variable has the most impact on your game. A/B tests can be very useful for fine-tuning retention, monetization, or balancing mechanics. This sample simulates an A/B test to evaluate how much experience it should take to gain a level.
To use this sample use case, you must download and install the UGS Use Cases project in your Unity project.
To see this use case in action, open the samples menu and navigate to AB Test Level Difficulty. To open this scene directly and interact with the use case:
- In the Unity Editor Project window, select Assets > Use Case Samples > AB Test Level Difficulty, then double-click
ABTestLevelDifficultySample.unityto open the sample scene.
- Press Play to enter Play mode.
When a player signs in, the screen displays their level and an XP meter that tracks their current XP and the total amount of XP required to level up. In this case, the amount of total XP to level up is either 100, 80, 60, 50, or 30, depending on which test group the player is randomly assigned. For diagnostic purposes, the player's test group is also displayed (A, B, C, D, or E).
ABTestLevelDifficultySceneManager.cs script performs the following initialization tasks in its
- Initializes Unity Services.
- Sends a
SceneOpenedcustom event to the Analytics service. This, along with the
SceneSessionLengthcustom event (sent when you click the scene's back button), tracks the player's session length as an example of how you can implement analytics to evaluate the results of your test.
- Signs in the player anonymously using the Authentication service. If you’ve previously initialized any of the other sample scenes, Authentication will use your cached Player ID instead of creating a new one. If not, your initial level (1) and XP (0) are saved in Cloud Save instead of loading existing data.
- Retrieves and updates the player's currency balances from the Economy service.
- Queries the Remote Config service to fetch the appropriate test group name and corresponding XP threshold for leveling up.
All of this updated data is displayed in the scene, and the Gain XP button becomes interactive.
When you click the Gain XP button, the simulated player gains 10 XP. When the XP bar is full (according to the test group threshold), the simulated player levels up and receives currency. The following occurs:
OnClickmethod sends an
ActionButtonPressedcustom event to the Analytics service and makes a call to the Cloud Code
This server-authoritative call fetches the player's information from the Cloud Save and Remote Config services, increases the XP by the amount specified by Remote Config (in this case, 10), then tests whether the new player XP total equals or exceeds the level-up threshold.
- If the player did not level up, their new XP is saved in Cloud Save and returned to the client, which updates the values and shows text that indicates how much XP increased.
- If the player did level up, it calls the Economy service to distribute the level-up rewards (in this case, 100 Coins), and calls Cloud Save to save the increased player level and new player XP before it returns that information to the client code.
The client code opens a level-up dialog and updates the relevant data in the scene UI. Note that this step provides an opportunity to show players different art based on their segmentation, and a convenient way to retrieve additional data for a specific currency at runtime.
Note: In this example, a cross-reference dictionary located in Remote Config and initialized at start-up converts the rewarded currency ID (in this case,
COIN) to an Addressables address, which you can use to display the sprite (in this case,
Sprites/Currency/Coin). A simpler approach to displaying different art according to a player’s segmentation is to attach additional information to the custom data associated with Currencies in the Economy configuration data. However, here the data was added to the Campaigns to demonstrate the flexibility of the Remote Config service.
Sign In As New Player
Click Sign In As New Player to simulate a new player with a new randomly assigned test group that starts with 0 XP. The following occurs:
- The button’s
OnClickmethod deletes the current anonymous player ID, resets all cached values to their empty or default states, and then initiates a new sign-in with the Authentication service that follows the same flow as when the scene first loads.
- As with the Gain XP button, it sends an
ActionButtonPressedcustom event to the Analytics service.
- Each time you click the Sign In As New Player button, the Authentication service creates a new anonymous player ID, to which the Remote Config service assigns a new A/B test group.
If you press the back button (the arrow in the top-left corner of the scene) to return to the "Start Here" or samples menu scene, it triggers a
SceneSessionLength custom Analytics event, which captures the amount of time spent in this scene.
To replicate this use case, you'll need the following Unity packages in your project:
|Analytics||Sends events that track the player's in-game interactions, retention metrics, and other information that you can use to analyze and improve the game experience.|
|Authentication||Automatically signs in the player as an anonymous user to keep track of their data server-side.|
|Cloud Code||Stores validation logic for increasing XP and leveling up the player server-side.|
|Cloud Save||Provides a server-authoritative way to save player data and the game state. In this example, the service stores the player's level and XP.|
|Economy||Retrieves the starting and updated currency balances at runtime.|
|Game Overrides||Assigns players to different groups based on the requested distribution values. Players receive a different configuration of XP needed to level up depending on which group they're in.|
|Remote Config||Provides key-value pairs that you can map and change server-side, either manually or based on specific Game Overrides. Also stores data associated with currency icon Addressable addresses.|
Note: Although it is listed as a package and requires separate dashboard configuration, Game Overrides doesn't actually have an SDK to install from Package Manager. It is a server-side offering that affects values returned from other services.
To use these services in your game, activate each service for your Organization and project in the Unity Cloud Dashboard.
To replicate this sample scene's setup in the Unity Cloud Dashboard, you must:
- Create custom events and parameters for the Analytics service.
- Publish a script to Cloud Code.
- Create a Currency for the Economy service.
- Configure values and Game Overrides for the Remote Config service.
Important: This sample demonstrates the code that is needed to trigger Analytics events. However, additional code might be necessary to meet legal requirements such as GDPR, CCPA, and PIPL. For more information, see the documentation on managing data privacy.
Configure and enable the following custom Analytics events:
|Event name||Description||Custom parameters|
|Sent each time you load the scene.|
|Sent each time you click a button in the scene.|
|Sent to indicate the time between loading the scene and clicking the back button (effectively how much time the player spent in the scene). In this example, you could use this data to understand how much real-world time it takes each test group to level up.|
Configure the following custom parameters to support your custom events:
|string||The A/B group and A/B Test ID the player is assigned to. The string format is "|
|string||The name of the button that the player clicked.|
|string||Groups the name of the button clicked with the player's A/B group. The string format is "|
|string||Groups the name of the button clicked with the current scene's name. The string format is "|
|string||Groups the name of the button clicked with the scene's name and the player's A/B group. The string format is "|
|string||The name of the scene where the event is triggered.|
|string||The amount of time spent in the scene when the event is triggered.|
|string||Groups the time spent in the scene when the event is triggered with the player's A/B group. The string format is "|
|string||Groups the time spent in the scene when the event is triggered with the scene's name. The string format is " |
|string||Groups the time spent in the scene when the event is triggered with the scene's name and the player's A/B group. The string format is |
Note: This extended list of potential parameters allows for a more flexible analysis of different parameter groupings in the Data Explorer in the Unity Cloud Dashboard. Alternatively, you can send only the ungrouped parameters (for example,
sceneName) and perform any kind of grouped analysis you want by using the Data Export feature within the Data Explorer.
Publish the following script in the Unity Cloud Dashboard:
|Script||Parameters||Description||Location in project|
Increments the player's XP and checks to see if the cumulative XP exceeds the level-up threshold defined by their A/B test group.
Note: The Cloud Code scripts included in the
Cloud Code folder are local copies because you cannot view the sample project's dashboard. Changes to these scripts do not affect the behavior of this sample because they are not automatically uploaded to the Cloud Code service.
Configure the following resource in the Unity Cloud Dashboard:
|Resource type||Resource name||ID||Description|
|Currency||Coin||The currency that is distributed as a reward for the player leveling up.|
Set up the following config values in the Unity Cloud Dashboard:
|string||The identifier for which test user group the player is in.|
|string||The identifier for which AB Test is actively being run for this user.|
|int||The amount of XP needed in order for the player to level up.|
|int||The amount the player's XP will increase by each time they gain XP.|
|JSON||A cross reference from |
Configure the following Overrides in the Unity Cloud Dashboard:
|Details||Name the Override “|
|Targeting||Select Audiences with 100% of audiences targeted.|
Select Choose content type > Config Overrides.
Enter override values for the following keys for variant 1:
Enter override values for the following keys for variant 2:
Enter override values for the following keys for variant 3:
Enter override values for the following keys for variant 4:
Enter override values for the following keys for variant 5:
Set the following start and end dates:
After finishing creating the Game Override, click Enable.