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 | 描述 |
---|---|
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 | 描述 | 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. | 可选 |
useGoogleService |
Set the value of the field Does your game use Google Play Services? in the UDP console. | 可选 |
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}
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.