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 - patchObb You 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}
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.