Steamworks Unity SDK integration guide

The Adjust Unity Steamworks SDK enables you to record session, events, and more in your Unity Steam game. You can also check out the example app on GitHub.

Integrate the Adjust SDK

This guide outlines how to integrate, initialize, and use the Adjust module for session and event tracking and obtaining attribution information on the Windows and macOS platforms.

Prerequisites

Before you start, make sure you have the following:

Unity Environment: Unity Engine installed on your system (2020.3 LTS or later recommended).
Steamworks Unity SDK: Integrated and configured with SteamManager.
Steam client: Installed with an active user and running during testing.
Newtonsoft.Json library: Follow the installation guide.

Add the Adjust SDK

Download or clone the Adjust Steamworks SDK.
Drag and drop the provided Adjust folder into your Unity project, for example Assets/Plugins/ (any path under Assets/ works).

Initialize the Adjust SDK

The following arguments are required during initialization:

Arguments

appToken (string, required): Your unique Adjust app token, available in the Adjust dashboard.
environment (string, required): Specifies the environment, e.g., AdjustConfig.EnvironmentSandbox for testing or AdjustConfig.EnvironmentProduction for production.
monoBehaviour (MonoBehaviour, required): A MonoBehaviour instance used for running coroutines.

1
using UnityEngine;
2

3
public class AdjustIntegration : MonoBehaviour
4
{
5
    void Start()
6
    {
7
        AdjustConfig adjustConfig = new AdjustConfig("your_app_token", AdjustConfig.EnvironmentSandbox, this);
8

9
        // Adjust SDK initialization
10
        Adjust.InitSdk(adjustConfig, response =>
11
        {
12
            if (response != null)
13
            {
14
                Debug.Log($"Adjust SDK Initialized. Response Code: {response.ResponseCode}, Response: {response.ResponseBody}, JsonResponse: {response.GetSerializedJsonResponse()}");
15
            }
16
            else
17
            {
18
                Debug.LogError("Adjust SDK initialization failed.");
19
            }
20
        });
21
    }
22
}

Record Events

Use AdjustEvent to record in‑game actions. You can attach revenue, currency, callback parameters, and partner parameters.

1
void TrackEvent()
2
{
3
    // Create an AdjustEvent object with an event token
4
    AdjustEvent adjustEvent = new AdjustEvent("34vgg9");
5

6
    // Add Revenue and Currency
7
    adjustEvent.SetRevenue(150, "USD");
8

9
    // Add custom callback parameters
10
    adjustEvent.AddCallbackParameter("foo", "bar");
11

12
    // Add partner parameters
13
    adjustEvent.AddPartnerParameter("john", "doe");
14

15
    // Track an event
16
    Adjust.TrackEvent(adjustEvent, response =>
17
    {
18
        if (response != null)
19
        {
20
            Debug.Log($"Event Tracking Response: Response Code: {response.ResponseCode}, Response: {response.ResponseBody}, JsonResponse: {response.GetSerializedJsonResponse()}");
21
        }
22
        else
23
        {
24
            Debug.LogError("Event tracking failed or returned no response.");
25
        }
26
    });
27
}

Get attribution information

To retrieve attribution data, use the GetAttribution method. The AdjustAttributionData class contains details about the current attribution status of the device. Any values that aren’t populated for the user are returned as a null value.

1
void GetAttribution()
2
{
3
    Adjust.GetAttribution(response =>
4
    {
5
        if (response != null)
6
        {
7
            Debug.Log($"Attribution Response: Response Code: {response.ResponseCode}, Response: {response.ResponseBody}, JsonResponse: {response.GetSerializedJsonResponse()}");
8

9
           // Extract and log attribution data
10
            if (response.AttributionData != null)
11
            {
12
                Debug.Log($"Tracker Token: {response.AttributionData.TrackerToken}");
13
                Debug.Log($"Tracker Name: {response.AttributionData.TrackerName}");
14
                Debug.Log($"Network: {response.AttributionData.Network}");
15
                Debug.Log($"Campaign: {response.AttributionData.Campaign}");
16
                Debug.Log($"AdGroup: {response.AttributionData.Adgroup}");
17
                Debug.Log($"Creative: {response.AttributionData.Creative}");
18
                Debug.Log($"ClickLabel: {response.AttributionData.ClickLabel}");
19
            }
20
        }
21
        else
22
        {
23
            Debug.LogError("GetAttribution failed or returned no response.");
24
        }
25
    });
26
}

Store Type

You can use the Adjust SDK to record information about the store from which an app was installed on a user’s device. Adjust supports a predefined list of store types defined here.

Use AdjustStoreInfo to set store information using the SDK configuration object. The Adjust SDK reads and tracks this data during initialization.

To configure this, follow the instructions below:

AdjustConfig adjustConfig = new AdjustConfig("your_app_token", AdjustConfig.EnvironmentSandbox, this);

var storeInfo = new AdjustStoreInfo("NameOfTheStore");
storeInfo.StoreAppId = "AppIdForTheStore";
adjustConfig.SetStoreInfo(storeInfo);

// Adjust SDK initialization
Adjust.InitSdk(adjustConfig, response =>
{
    if (response != null)
      {
         Debug.Log($"Adjust SDK Initialized. Response Code: {response.ResponseCode}, Response: {response.ResponseBody}, JsonResponse: {response.GetSerializedJsonResponse()}");
      }
      else
      {
         Debug.LogError("Adjust SDK initialization failed.");
      }
});