Unity Documentation

https://docs.unity.com
Admin
The official documentation for Unity, a powerful real-time 3D development platform used for creating...
Tokens:6,107,570
Snippets:48,682
Trust Score:10
Update:22 hours ago
Show doc for...
Tokens:
Raw
### Unity CLI install examples

Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference

Multiple examples of the 'unity install' command: installing a specific version, using the 'lts' alias, specifying a changeset, installing modules with child modules, and installing multiple modules.

```bash
unity install 6000.3.7f1
```

```bash
unity install lts
```

```bash
unity install 6000.3.7f1 -c 9b001d489a54
```

```bash
unity install 6000.3.7f1 -m android --cm
```

```bash
unity install lts -m ios android webgl
```

--------------------------------

### install-modules examples

Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference

Examples of using install-modules: installing specific modules, listing available modules, installing all modules, and installing with child modules disabled.

```bash
unity install-modules -e 6000.3.7f1 -m ios android
```

```bash
unity install-modules -e 6000.3.7f1 -l
```

```bash
unity install-modules -e 6000.3.7f1 --all
```

```bash
unity install-modules -e 6000.3.7f1 -m android --no-cm
```

--------------------------------

### GameUI help example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Example command to launch GameUI with the '--help' argument to display help.

```text
    $> gameui.exe --help
```

--------------------------------

### Response example for Get a build target

Source: https://docs.unity.com/en-us/oas-build-automation-client/2.0.0

Example JSON response for a successful GET request. Contains build target details such as connectionId, guid, name, platform, settings, and SCM configuration.

```json
{ "connectionId": "string", "guid": "string", "name": "John Doe", "createdBy": "user@example.com", "platform": "webgl", "targetType": "normal", "buildtargetid": "ios", "enabled": true, "generateProjectPreview3D": false, "scenePreview": false, "settings": { "autoBuildLatest": "inherit", "autoBuild": true, "unityVersion": "2022.3.0f1", "autoDetectUnityVersion": true, "fallbackPatchVersion": true, "ccdEnabled": true, "ccdBucketId": "my-bucket-name", "ccdEnvironmentId": "production", "ccdApiKey": "api-key-12345", "ccdStripRemotePath": true, "ccdPreserveBucket": true, "ccdCreateRelease": true, "executablename": "MyApp", "buildProfilePath": "~/buildprofiles/buildprofile.json", "scm": { "type": "git", "url": "url", "url_buildjob": "https://git.internal.example.com/org/repo.git", "user": "user", "pass": "pass", "fingerprint": "fingerprint", "p4authtype": "p4authtype", "authType": "UPWorkingMode", "plasticAccessToken": "plasticAccessToken", "shallowclone": true, "windowsGitBinary": "cygwin", "useEncryption": true, "encryptionKey": "a1b2c3d4e5f6g7h8i9j0", "encryptionMethod": "AES128", "plasticEnvironment": "prd", "oauth": { "scm_provider": "scm_provider", "temp_state": "temp_state", "github": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "gitlab": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0 }, "bitbucket": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "workspace": "my-workspace" }, "azure": { "repository": { "owner": null, "clone_url": null, "archived_clone_url": null, "forks": null, "watchers": null, "full_name": null, "name": null, "scm": null, "provider_id": null }, "token": "token", "refreshToken": "refreshToken", "expiration": "2025-12-31T23:59:59.000Z", "expirationInterval": 0, "azureOrg": "azureOrg", "azureProject": "azureProject" } }, "isUnityCloudDrive": true, "repo": "repo", "branch": "branch", "subdirectory": "subdirectory", "client": "client" }, "platform": { "bundleId": "bundleId", "xcodeVersion": "xcodeVersion" }, "buildSchedule": { "isEnabled": false, "date": "2000-01-23T04:56:07.000+00:00", "repeatCycle": "once", 
```

--------------------------------

### Set up version control with unity vcs setup

Source: https://docs.unity.com/en-us/unity-cli/use-unity-cli

Run 'unity vcs setup' in the project's directory to create a repository and push the first commit. It detects available information and asks only for what it can't detect.

```bash
unity vcs setup
```

--------------------------------

### Response example for get retention policies

Source: https://docs.unity.com/en-us/oas-build-automation-client/2.0.0

Example JSON response showing a list of retention policies. Each policy includes guid, type, retentionValue, retainLogs, and enabled fields.

```json
[ { "guid": "550e8400-e29b-41d4-a716-446655440000", "type": "timeLimitDays", "retentionValue": 30, "retainLogs": false, "enabled": true }]
```

--------------------------------

### Implementation example: enable, init, and launch test suite (Objective-C)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/ios/integration-test-suite

Shows the full flow: set the test suite flag, build an LPMInitRequest with app key and optional user ID, initialize LevelPlay, and launch the test suite in the completion handler after successful initialization.

```objectivec
[LevelPlay setMetaDataWithKey:@"is_test_suite" value:@"enable"];LPMInitRequestBuilder *requestBuilder = [[LPMInitRequestBuilder alloc] initWithAppKey:@"appKey"];[requestBuilder withUserId:@"UserId"]; // optionalLPMInitRequest *initRequest = [requestBuilder build];[LevelPlay initWithRequest:initRequest completion:^(LPMConfiguration *_Nullable config, NSError *_Nullable error) {    if (error) {        // Handle initialization error    } else {        // Initialization successful — launch test suite        [LevelPlay launchTestSuite:self];    }}];
```

--------------------------------

### Response Example for Get Scores By PlayerIds for Archived Leaderboard

Source: https://docs.unity.com/en-us/oas-leaderboards-admin/1.0.0

Example JSON response showing the version object with id, start, and end fields. This is the expected response body for a successful request.

```json
{ "version": { "id": "20230213175322850781977", "start": "2024-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z" }}
```

--------------------------------

### Example server launch output

Source: https://docs.unity.com/en-us/licensing-server/quick-start-web

Example output when the licensing server starts successfully. The URL shown is used to test the server.

```text
Server Version: 1.6.0.19b28b6Successfully started the licensing server: http://10.211.55.4:8080/v1/admin/statusPress Ctrl+C to shut down...
```

--------------------------------

### SKAN Report Response Example

Source: https://docs.unity.com/en-us/oas-statistics/2.0.0

Example JSON response from the SKAN Report endpoint, showing an array of data objects with timestamp, appId, appName, unityAppId, starts, installs, and spend fields.

```json
{ "data": [ { "timestamp": "2024-01-15", "appId": "30ed569d57fe1f324a15fbe7", "appName": "App #1", "unityAppId": "7f2c8a91-4d3b-4e1f-9a2c-6b5d4e3f2a10", "starts": 2894, "installs": 40, "spend": 62.5 }, { "timestamp": "2024-01-15", "appId": "30ed569d57fe1f324a15fbe8", "appName": "App #2", "unityAppId": "3b9e1c7f-8a2d-4f6e-b4c1-0d9e8f7a6b5c", "starts": 1258, "installs": 16, "spend": 23.95 } ]}
```

--------------------------------

### JSON response example for compatible build targets

Source: https://docs.unity.com/en-us/oas-build-automation-client/2.0.0

Example response body for the GET compatibletargets endpoint. Shows the structure of a build target object including connectionId, guid, name, platform, settings, and SCM configuration.

```json
[
  {
    "connectionId": "string",
    "guid": "string",
    "name": "John Doe",
    "createdBy": "user@example.com",
    "platform": "webgl",
    "targetType": "normal",
    "buildtargetid": "ios",
    "enabled": true,
    "generateProjectPreview3D": false,
    "scenePreview": false,
    "settings": {
      "autoBuildLatest": "inherit",
      "autoBuild": true,
      "unityVersion": "2022.3.0f1",
      "autoDetectUnityVersion": true,
      "fallbackPatchVersion": true,
      "ccdEnabled": true,
      "ccdBucketId": "my-bucket-name",
      "ccdEnvironmentId": "production",
      "ccdApiKey": "api-key-12345",
      "ccdStripRemotePath": true,
      "ccdPreserveBucket": true,
      "ccdCreateRelease": true,
      "executablename": "MyApp",
      "buildProfilePath": "~/buildprofiles/buildprofile.json",
      "scm": {
        "type": "git",
        "url": "url",
        "url_buildjob": "https://git.internal.example.com/org/repo.git",
        "user": "user",
        "pass": "pass",
        "fingerprint": "fingerprint",
        "p4authtype": "p4authtype",
        "authType": "UPWorkingMode",
        "plasticAccessToken": "plasticAccessToken",
        "shallowclone": true,
        "windowsGitBinary": "cygwin",
        "useEncryption": true,
        "encryptionKey": "a1b2c3d4e5f6g7h8i9j0",
        "encryptionMethod": "AES128",
        "plasticEnvironment": "prd",
        "oauth": {
          "scm_provider": "scm_provider",
          "temp_state": "temp_state",
          "github": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null
          },
          "gitlab": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null
          },
          "bitbucket": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null,
            "workspace": null
          },
          "azure": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null,
            "azureOrg": null,
            "azureProject": null
          }
        },
        "isUnityCloudDrive": true,
        "repo": "repo",
        "branch": "branch",
        "subdirectory": "subdirectory",
        "client": "client"
      },
      "platform": {
        "bundleId": "bundleId",
        "xcodeVersion": "xcodeVersion"
      },
      "buildSchedule": {
        "isEnabled": false,
        "date": "2000-01-23T04:56:07.000+00:00",
        "repeatCycle": "once",
        "cronScheduleString": "cronScheduleString",

```

--------------------------------

### Welcome message from setup command

Source: https://docs.unity.com/en-us/licensing-server/server-setup-cfg-v2

Expected output after running the setup command, prompting for server name.

```text
Welcome to Unity Licensing Server setup command line interface.This setup will help you configure your license server and generate server registration request file.Enter the server name (e.g. LicenseServer):  [DESKTOP] TestServer
```

--------------------------------

### GET /advertise/stats/v2/organizations/{organizationId}/reports/skan

Source: https://docs.unity.com/en-us/oas-statistics/2.0.0

Retrieves SKAN report data for the specified organization. The response includes metrics such as starts, installs, and spend for each app.

```APIDOC
## GET /advertise/stats/v2/organizations/{organizationId}/reports/skan

### Description
Retrieves SKAN report data for the specified organization. The response includes metrics such as starts, installs, and spend for each app.

### Method
GET

### Endpoint
/advertise/stats/v2/organizations/{organizationId}/reports/skan

### Parameters
#### Path Parameters
- **organizationId** (string) - Required - The unique identifier of the organization.

### Request Example
curl -X GET \\
  -H "Authorization: Basic <YOUR_CREDENTIALS>" \\
  "https://services.api.unity.com/advertise/stats/v2/organizations/{organizationId}/reports/skan"

### Response
#### Success Response (200)
- **data** (array) - List of SKAN report entries.
  - **timestamp** (string) - The date of the report entry (format: YYYY-MM-DD).
  - **appId** (string) - The application ID.
  - **appName** (string) - The name of the application.
  - **unityAppId** (string) - The Unity application ID.
  - **starts** (integer) - Number of starts.
  - **installs** (integer) - Number of installs.
  - **spend** (number) - Total spend amount.

#### Response Example
{
  "data": [
    {
      "timestamp": "2024-01-15",
      "appId": "30ed569d57fe1f324a15fbe7",
      "appName": "App #1",
      "unityAppId": "7f2c8a91-4d3b-4e1f-9a2c-6b5d4e3f2a10",
      "starts": 2894,
      "installs": 40,
      "spend": 62.5
    },
    {
      "timestamp": "2024-01-15",
      "appId": "30ed569d57fe1f324a15fbe8",
      "appName": "App #2",
      "unityAppId": "3b9e1c7f-8a2d-4f6e-b4c1-0d9e8f7a6b5c",
      "starts": 1258,
      "installs": 16,
      "spend": 23.95
    }
  ]
}

### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too Many Requests
- **500** - Internal Server Error
- **503** - Service Unavailable
```

--------------------------------

### Implementation example: enable, init, and launch test suite (Swift)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/ios/integration-test-suite

Shows the full flow: set the test suite flag, build an LPMInitRequest with app key and optional user ID, initialize LevelPlay, and launch the test suite in the completion handler after successful initialization.

```swift
LevelPlay.setMetaDataWithKey("is_test_suite", value: "enable")let requestBuilder = LPMInitRequestBuilder(appKey: "appKey")    .withUserId("UserId") // optionallet initRequest = requestBuilder.build()LevelPlay.initWith(initRequest) { [weak self] config, error in  guard let self = self else { return }  if let error = error {      // Handle error  } else {      LevelPlay.launchTestSuite(self)  }}
```

--------------------------------

### Start and stop audio injection example

Source: https://docs.unity.com/en-us/vivox-unity/speech-to-text/stt-audio-injection

Example of starting audio injection, waiting 10 seconds, then stopping it.

```csharp
VivoxService.Instance.StartAudioInjection(path);
await Task.Delay(10000);
VivoxService.Instance.StopAudioInjection();
await Task.Delay(10000);
```

--------------------------------

### Install PubMatic adapter and SDK

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/ios/networks/guides/pubmatic

Run this command to install the adapter and SDK after adding the Podfile line.

```bash
pod install --repo-update
```

--------------------------------

### Install Plastic Change Tracker service

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/6

Command to install the Plastic Change Tracker service on Windows. After installation, start it with --start or via the service control panel.

```bash
plasticchangetrackerservice.exe --installservice
```

--------------------------------

### Run Unity Licensing Server setup on Linux

Source: https://docs.unity.com/en-us/licensing-server/quick-start-web

Run the setup command in the Linux Terminal to configure the licensing server.

```bash
sudo -H ./Unity.Licensing.Server setup
```

--------------------------------

### Response example for Get the share link

Source: https://docs.unity.com/en-us/oas-build-automation-client/2.0.0

Example response body for the GET request. Contains shareid and shareExpiry fields.

```json
{ "shareid": "shareid", "shareExpiry": "2025-12-31T23:59:59.000Z"}
```

--------------------------------

### install --module option

Source: https://docs.unity.com/en-us/hub/hub-cli-reference

Module ID. You can pass multiple module IDs. Alias: -m. Examples: -m android or -m appletv webgl.

```bash
--module
```

```bash
-m
```

```bash
-m android
```

```bash
-m appletv webgl
```

--------------------------------

### Get SSH Key - Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/2.0.0

Example response body for the Get SSH Key endpoint. Contains the public key and type.

```json
{ "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...", "type": "type"}
```

--------------------------------

### Sample migration output (Windows)

Source: https://docs.unity.com/en-us/licensing-server/migrating

Sample output from running Unity.Licensing.Server.exe setup on Windows when a migration requires confirmation. Shows the prompt 'Are you sure you want to run it now? [y/N]' and the successful migration from 1.10.0 to 1.11.0.

```text
> .\Unity.Licensing.Server.exe setup- - - -Welcome to Unity Licensing Server setup command line interface.This setup will help you configure your license server and generate server registration request file.- - - -Upgrading from 1.10.0 to 1.11.0...This migration can take more than a few minutes. Are you sure you want to run it now? [y/N] yProceeding with migration...Backup installed version 1.10.0...DoneScripts to run: 1.11.0Executing 1.11.0...DoneStamping version 1.11.0...DoneSuccessfully migrated from 1.10.0 to 1.11.0Enter the server name (e.g. LicenseServer):
```

--------------------------------

### Get Code Information - response example

Source: https://docs.unity.com/en-us/services-web-apis/client-auth

Example response from the Get Code Information API. Contains an identifier that identifies the device for extra confirmation.

```json
{
  "identifier": "<string>", // Identifies the device for extra confirmation (Optional)
}
```

--------------------------------

### Example: Creating a session with a client-hosted solution

Source: https://docs.unity.com/en-us/mps-sdk/create-session

Demonstrates creating a session as a host using SessionOptions with MaxPlayers set to 2 and WithRelayNetwork() (or WithDistributedAuthorityNetwork()). The session ID and join code are logged to the console.

```csharp
async Task StartSessionAsHost(){
    var options = new SessionOptions
    {
      MaxPlayers = 2
    }.WithRelayNetwork(); // or WithDistributedAuthorityNetwork() to use Distributed Authority instead of Relay
    var session = await MultiplayerService.Instance.CreateSessionAsync(options);
    Debug.Log($"Session {session.Id} created! Join code: {session.Code}");
}
```

--------------------------------

### cm support examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/support

Examples of running the support command and its bundle subcommand.

```bash
cm support
```

```bash
cm support bundle
```

```bash
cm support bundle c:\outputfile.zip
```

--------------------------------

### GET groups response example

Source: https://docs.unity.com/en-us/grow/levelplay/platform/api/groups

Example JSON response from the GET groups endpoint, showing group details including instances and country rates.

```json
[  {    "groupId": 12673,    "groupName": "newGroup",    "mediationAdUnitId": "fgx25t56dq201bd2",    "mediationAdUnitName": "interstitial-1",    "adFormat": "interstitial",    "abTest": "A",    "countries": ["FR","US"],    "position": 1,    "segments": [],    "floorPrice": 0.3,    "instances": [      {        "id": 3681,        "name": "",        "networkName": "ironSource",        "isBidder": true      },      {        "id": 2,        "name": "Default",        "isBidder": false,        "networkName": "unityAds",        "groupRate": 5,        "countriesRate": [          {            "countryCode": "FR",            "rate": 1          }        ]      }    ]  }]
```

--------------------------------

### Response example for listing build targets

Source: https://docs.unity.com/en-us/oas-build-automation-client/2.0.0

Shows the JSON response structure returned by the GET /orgs/{orgid}/projects/{projectid}/buildtargets endpoint. It includes fields such as connectionId, guid, name, platform, targetType, buildtargetid, enabled, and settings.

```json
[
  {
    "connectionId": "string",
    "guid": "string",
    "name": "John Doe",
    "createdBy": "user@example.com",
    "platform": "webgl",
    "targetType": "normal",
    "buildtargetid": "ios",
    "enabled": true,
    "generateProjectPreview3D": false,
    "scenePreview": false,
    "settings": {
      "autoBuildLatest": "inherit",
      "autoBuild": true,
      "unityVersion": "2022.3.0f1",
      "autoDetectUnityVersion": true,
      "fallbackPatchVersion": true,
      "ccdEnabled": true,
      "ccdBucketId": "my-bucket-name",
      "ccdEnvironmentId": "production",
      "ccdApiKey": "api-key-12345",
      "ccdStripRemotePath": true,
      "ccdPreserveBucket": true,
      "ccdCreateRelease": true,
      "executablename": "MyApp",
      "buildProfilePath": "~/buildprofiles/buildprofile.json",
      "scm": {
        "type": "git",
        "url": "url",
        "url_buildjob": "https://git.internal.example.com/org/repo.git",
        "user": "user",
        "pass": "pass",
        "fingerprint": "fingerprint",
        "p4authtype": "p4authtype",
        "authType": "UPWorkingMode",
        "plasticAccessToken": "plasticAccessToken",
        "shallowclone": true,
        "windowsGitBinary": "cygwin",
        "useEncryption": true,
        "encryptionKey": "a1b2c3d4e5f6g7h8i9j0",
        "encryptionMethod": "AES128",
        "plasticEnvironment": "prd",
        "oauth": {
          "scm_provider": "scm_provider",
          "temp_state": "temp_state",
          "github": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null
          },
          "gitlab": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null
          },
          "bitbucket": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null,
            "workspace": null
          },
          "azure": {
            "repository": null,
            "token": null,
            "refreshToken": null,
            "expiration": null,
            "expirationInterval": null,
            "azureOrg": null,
            "azureProject": null
          }
        },
        "isUnityCloudDrive": true,
        "repo": "repo",
        "branch": "branch",
        "subdirectory": "subdirectory",
        "client": "client"
      },
      "platform": {
        "bundleId": "bundleId",
        "xcodeVersion": "xcodeVersion"
      },
      "buildSchedule": {
        "isEnabled": false,
        "date": "2000-01-23T04:56:07.000+00:00",
        "repeatCycle": "once",
        "cronScheduleString": "cronScheduleString",
        "cronScheduleTimezone": "cronScheduleTimezone",
        "cleanBuild": false,
        "skipBuildIfSameCommit": true
      },
      "autoBuildCancellation": false,
      "machineTypeLabel": "Standard_v1",
      "operatingSystemSelected": "mac",
      "operatingSystemVersion": "sonomaSilicon",
      "rubyVersion": "3.2.0",
      "remoteCacheStrategy": "none",
      "windowsGitBinary": "inherit",
      "buildTargetCopyCache": "enabled",
      "architecture": "x86_64",
      "cacheCompressionLevel": "inherit",
      "artifactCompressionLevel": "inherit",
      "ignorePlasticCheckedInLibrary": true,
      "advanced": {
        "cache": {
          "compressionMethod": "compressionMethod"
        },
        "xcode": {
          "useArchiveAndExport": true,
          "customFastlaneConfigPath": "customFastlaneConfigPath",
          "uploadXCArchive": true,
          "uploadXcodeProject": true,
          "shouldNotarize": true
        },
        "android": {
          "buildAppBundle": true,
          "buildAssetPacks": true,
          "androidSDKVersion": "androidSDKVersion"
        },
        "unity": {
          "preExportMethod": "preExportMethod",
          "postExportMethod": "postExportMethod",
          "preBuildScript": "preBuildScript",
          "postBuildScript": "postBuildScript",
          "preBuildScriptFailsBuild": true,
          "postBuildScriptFailsBuild": true,
          "scriptingDefineSymbols": "scriptingDefineSymbols",
          "playerExporter": {
            "sceneList": null,
            "buildOptions": null,
            "export": null
          },
          "playerSettings": {
            "Android": null,
            "Switch": null
          },
          "editorUserBuildSettings": {
            "androidBuildSystem": null,
            "standaloneBuildSubtarget": null,
            "switchCreateRomFile": null,
            "switchEnableRomCompression": null,
            "switchRomCompressionType": null,
            "switchRomCompressionLevel": null,
            "switchRomCompressionConfig": null,
            "switchSaveAdf": null,
            "switchGraphicsDebugging": null,
            "switchEnableHeapInspector": null,
            "switchEnableMemoryTracker": null,
            "switchWaitForMemoryTrackerOnStartup": null,
            "switchEnableDebugPad": null,
            "switchRedirectWritesToHostMount": null,
            "switchScriptingDebuggingTransport": null
          },
          "assetBundles": {
            "buildBundles": null,
            "basePath": null,
            "buildAssetBundleOptions": null,
            "copyToStreamingAssets": null,
            "copyBundlePatterns": null,
            "uploadAssetBundles": null
          },
          "addressables": {
            "buildAddressables": null,
            "uploadAddressables": null,
            "contentUpdate": null,
            "profileName": null
          }
        }
      }
    }
  }
]
```

--------------------------------

### Run SDKSampleApp with command line and sample output

Source: https://docs.unity.com/en-us/vivox-core/text-chat-guide/sdksampleapp/run-sdksampleapp

Run the SDKSampleApp with the -m option for multitenant mode. Replace 'xyzzy' and 'collosal' with your issuer and key. The output shows connect and login requests and events, with the generated username prefixed by the issuer.

```text
SDKSampleApp --server=https://mt1s.www.vivox.com/api2 --realm=mt1s.vivox.com --issuer=xyzzy --key=collosal -m[SDKSampleApp]: connect* Connecting to http://mt1s.www.vivox.com/api2 with connector handle http://mt1s.www.vivox.com/api2...* Issuing req_connector_create with cookie=1* Request req_connector_create with cookie=1 completed.[SDKSampleApp]: login* Logging .xyzzy.sa_c78d1595. in with connector handle http://mt1s.www.vivox.com/api2 and account handle .xyzzy.sa_c78d1595.* Issuing req_account_anonymous_login with cookie=2* evt_account_login_state_change: .xyzzy.sa_c78d1595. login_state_logging_in* Request req_account_anonymous_login with cookie=2 completed.* evt_account_login_state_change: .xyzzy.sa_c78d1595. login_state_logged_in
```

--------------------------------

### Get Code Info - Response Example

Source: https://docs.unity.com/en-us/oas-player-auth-client/1.0.0

Example response body for a successful 'Get Code Info' request, containing the identifier and expiration of the sign-in code.

```json
{ "identifier": "myDevice", "expiration": "string"}
```

--------------------------------

### Sign in as Bob in SDKSampleApp

Source: https://docs.unity.com/en-us/vivox-core/text-chat-guide/sdksampleapp/log-in-as-bob

Start the SDKSampleApp in a second command prompt with the arguments from 'Run the SDKSampleApp', then sign in as user Bob using the login command with the username '.xyzzy.bob.'. The output shows the connection and login process, ending with a successful login state change.

```text
[SDKSampleApp]: conn* Connecting to http://mt1s.www.vivox.com/api2 with connector handle http://mt1s.www.vivox.com/api2...* Issuing req_connector_create with cookie=1* Request req_connector_create with cookie=1 completed.[SDKSampleApp]: login -u .xyzzy.bob.* Logging .xyzzy.bob. in with connector handle http://mt1s.www.vivox.com/api2 and account handle .xyzzy.bob.* Issuing req_account_anonymous_login with cookie=2* evt_account_login_state_change: .xyzzy.bob. login_state_logging_in* Request req_account_anonymous_login with cookie=2 completed.* evt_account_login_state_change: .xyzzy.bob. login_state_logged_in
```

--------------------------------

### View comprehensive help with examples for a command

Source: https://docs.unity.com/en-us/unity-version-control/cli/help

Run this command to get comprehensive help with examples for a specific command. Replace `<command>` with the actual command name.

```bash
cm <command> –help
```

--------------------------------

### Get entry in release - Response example (JSON)

Source: https://docs.unity.com/en-us/oas-content-delivery-client/1.0.0

Example response body for a successful GET request. Contains entry metadata such as content_hash, content_size, content_type, and path.

```json
{ "content\_hash": "c76580fa26181bfa8d8952826bd334d5", "content\_link": "string", "content\_size": 1234567, "content\_type": "image/jpeg", "current\_versionid": "b9a0657d-b223-4507-9206-ead33ac06c6d", "entryid": "b9a0657d-b223-4507-9206-ead33ac06c6d", "labels": [ "string" ], "last\_modified": "2024-01-01T00:00:00Z", "link": "string", "metadata": {}, "path": "ios/character1.bundle", "updated\_at": "2024-01-01T00:00:00Z"}
```

--------------------------------

### Ad Quality SDK initialization with callbacks

Source: https://docs.unity.com/en-us/grow/ad-quality/additional-configuration

Implements ISAdQualityInitCallback to handle init success and failure, and initializes the SDK with the callback in Awake. Callbacks should be in a separate class where the SDK is initialized. Initialization may take 3-4 seconds on average.

```csharp
public class AdQualityInit : ISAdQualityInitCallback {     public void adQualitySdkInitSuccess() {         Debug.Log("adQualitySdkInitSuccess");     }     public void adQualitySdkInitFailed(ISAdQualityInitError adQualitySdkInitError, string errorMessage) {         Debug.Log($"adQualitySdkInitFailed: {adQualitySdkInitError}, message: {errorMessage}");    } }public class AdQualityDemo : MonoBehaviour {     void Awake() {         AdQualityInit initCallbacks = new AdQualityInit();         ISAdQualityConfig adQualityConfig = new ISAdQualityConfig {             AdQualityInitCallback = initCallbacks         };         IronSourceAdQuality.Initialize(appKey, adQualityConfig);     } }
```
Tokens:
Raw