版本:Unity 6 (6000.0)
语言:English
UDP 参考
UDP SDK 数据收集

UDP API

重要
Unity 分发门户 (UDP) 将于 2025 年 2 月 17 日关闭。届时,UDP Web 控制台和服务将永久停用。要下载您的密钥库以及有关如何直接将游戏重新发布到应用商店的说明,请访问UDP 概述页面。如果您对您的帐户有任何疑问,请通过Unity 客户支持提交工单。

UDP API 允许您将二进制文件上传到 UDP 控制台。这使您可以使用 CI 系统构建您的应用程序并将输出直接推送到 UDP。请参阅在 UDP 控制台上管理和发布您的游戏

支持以下文件类型

  • APK
  • OBB
  • AAB

API 结构

API 的结构如下:https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx[&obbType=xxxx]

下表描述了 API 的参数。

参数 描述
orgId 您要为其上传二进制文件的游戏的组织 ID。
clientId 您要为其上传二进制文件的游戏的客户端 ID。
token 在 UDP 控制台的“开发者 API”页面上生成的授权令牌。
obbType 您要上传的 OBB 文件类型。以下值为有效值
- mainObb
- patchObb
仅当您上传 OBB 文件时才需要指定此查询参数。

表单键

您可以在 POST 方法中使用表单键在将构建上传到 UDP 时指定值。这些值对应于“游戏信息”选项卡的“二进制文件”部分。

下表描述了表单键。

表单键 描述 必填/可选
uploadFile 指定要上传的文件的路径。 必填
whatsNew 设置 UDP 控制台中“新增功能”字段的值。 可选
useGoogleService 设置 UDP 控制台中“您的游戏是否使用 Google Play 服务?”字段的值。 可选

如果您未指定可选键,UDP 将使用您游戏最新版本的相应值。

常见错误消息和错误代码

无效的认证令牌

如果您提供无效的认证令牌,您将收到一条状态代码为 401 的错误消息。

{"errorCode":"NotAuthenticated","message":"not authenticated error","target":"","details":null}

无效的组织 ID 或客户端 ID

如果您提供无效的组织 ID 或无效的客户端 ID,您将收到一条状态代码为 400 的错误消息。

{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"Invalid OrgId or ClientId","details":null}

无效的文件类型

如果您提供无效的文件类型,您将收到一条状态代码为 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}

无效的 OBB 类型

如果您提供无效的 OBB 类型,您将收到一条状态代码为 400 的错误消息。

{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"obbType","details":null}

无效的内容类型

如果您提供无效的内容类型,您将收到一条状态代码为 400 的错误消息。

{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"content type","details":null}
UDP 参考
UDP SDK 数据收集