| NOTE |
|---|
| Unity Distribution Portal is obsolete. |
The UDP API lets you upload binary files to the UDP console. This lets you use a CI system to build your app and push the output directly to UDP. See Managing and publishing your game on the UDP console.
The following file types are supported:
The API is structured as follows: https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx[&obbType=xxxx]
The table below describes the parameters of the API.
| Parameter | Description |
|---|---|
orgId |
The organization ID of the game for which you want to upload binary files. |
clientId |
The client ID of the game for which you want to upload binary files. |
token |
The authorization token generated in the UDP console, on the Developer API page. |
obbType |
The OBB file type you want to upload. The following values are valid: - mainObb- patchObbYou only need to specify this query parameter when you upload a OBB file. |
You can use form keys in the POST method to specify values when uploading your build to UDP. The values correspond to the Binary section of the Game Information tab.
The table below describes the form keys.
| Form key | Description | Mandatory / Optional |
|---|---|---|
uploadFile |
Specify the path to the file to upload. | Mandatory |
whatsNew |
Set the value of the field What’s New in the UDP console. | Optional |
useGoogleService |
Set the value of the field Does your game use Google Play Services? in the UDP console. | Optional |
If you don’t specify optional keys, UDP uses the values of the latest version of your game.
If you provide an invalid authentication token, you will get an error message with status code 401.
{"errorCode":"NotAuthenticated","message":"not authenticated error","target":"","details":null}
If you provide an invalid organization ID or an invalid client ID, you will get an error message with status code 400.
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"Invalid OrgId or ClientId","details":null}
If you provide an invalid file type, you will get an error message with status code 400.
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid: please provide the right binary file(APK, AAB or OBB)","target":"file type","details":null}
If you provide an invalid OBB type, you will get an error message with status code 400.
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"obbType","details":null}
If you provide an invalid content type, you will get an error message with status code 400.
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"content type","details":null}