最近更新时间：2023.11.23 11:32:43
首次发布时间：2023.01.04 19:24:52
本文记录火山引擎云游戏服务端 OpenAPI 功能变更和相关文档的动态。
本次发布包含以下新增接口：
接口名称 | 变更说明 |
|---|---|
| ExitUserQueue | （手游）在请求参数中，新增（DeviceId）可选参数，支持用户指定设备退出游戏排队 |
| ExitUserQueue | （端游）新增接口：用户主动退出游戏排队 |
| GetDailyMaxQueueLength | （端游）新增接口：在游戏排队场景下，查询指定业务某个资源套餐前一日的最大队列长度 |
本次发布包含以下新增接口：
接口名称 | 变更说明 |
|---|---|
| CreateProduct | （手游）在当前账号下，创建云游戏业务 |
| DeleteProduct | （手游）删除已创建的云游戏业务 |
| CreatePrePaidOrder | （手游）订购预付费实例资源 |
| CreatePostPaidOrder | （手游）订购后付费实例资源 |
| CreateProduct | （端游）在当前账号下，创建云游戏业务 |
| DeleteProduct | （端游）删除已创建的云游戏业务 |
| CreatePrePaidOrder | （端游）订购预付费实例资源 |
| CreatePostPaidOrder | （端游）订购后付费实例资源 |
| UpdateAppliedResource | （端游）修改已订购后付费资源套餐的实例数量 |
本次发布包含以下新增接口：
接口名称 | 变更说明 |
|---|---|
| GetCgUsedNum | 查询指定时间内业务维度或游戏维度累计使用资源总量 |
本次发布包含以下新增接口：
接口名称 | 变更说明 |
|---|---|
| GamePreStart | 启动云端游戏服务，但不进行推流 |
| GetGameSessionStatus | 查询云端游戏服务状态 |
本次发布包含以下新增接口：
接口名称 | 变更说明 |
|---|---|
| DetailParseTask | 在返回结果中，增加“上传文件类型”字段（file_type）和“游戏数据包信息”（data_package）相关说明 |
| CreateGame | 在“游戏版本信息”（game_version）请求体中，增加“上传文件类型”（file_type）、“obb数据包解压路径”（data_storage）、“游戏数据包信息”（data_package）可选参数 |
本次发布包含以下新增接口和接口变更：
接口名称 | 变更说明 |
|---|---|
| CaptureScreen | 对当前云端游戏发起截图请求（异步任务）。 |
本次发布包含以下新增接口和接口变更：
接口名称 | 变更说明 |
|---|---|
| CancelFrameworkAppVersion | （新增接口）取消版本程序版本发布 |
| ListGame | 在返回结果中，增加“默认伴随程序列表”字段（inner_fw_id_list） |
| ListFrameworkApp | 在返回结果中，增加“伴随程序当前版本ID”字段（current_version） |
| ListGameFrameworkApp | 在返回结果中，增加“伴随程序的上传来源”字段（fw_source），标识伴随程序是由客户上传或默认上传 |
本次发布包含以下接口变更：
可订购的实例资源套餐 ID（configuration_code 参数）增加 ARMSoC_Standard（基础型）。
本次发布包含以下新增接口：
接口名称 | 接口功能 |
|---|---|
| HotUpdateGame | 对指定游戏进行热更操作。 |
| HotUpdateGameStatus | 查询游戏热更任务执行的结果。 |
本次发布包含以下接口变更：
接口名称 | 接口功能 |
|---|---|
| ListGame | 在返回结果中，增加游戏默认键位映射配置字段（default_key_mapping_list） |
| DetailGame | 在返回结果中，增加游戏默认键位映射配置字段（default_key_mapping_list） |
| CreateDeployStrategy | 在请求参数中增加通过指定部署策略列表（strategy_list），支持按优先级为游戏配置多个实例套餐资源（通过 configuration_code 参数配置一个实例套餐资源的功能将被逐步废弃） |
| UpdateDeployStrategy | 在请求参数中增加通过指定部署策略列表（strategy_list），支持按优先级为游戏配置多个实例套餐资源（通过 configuration_code 参数配置一个实例套餐资源的功能将被逐步废弃） |
| ListDeployStrategy | 更新返回结果说明和返回示例 |
| PreAllocateResource | 在返回结果中，增加预锁定的实例资源套餐 ID 字段（configuration_code） |
本次发布包含以下新增功能和变更：
game_status 新增游戏上架状态值 “5”（表示游戏新版本发布取消）。本次发布包含以下新增功能和变更：
device_id（客户端用户设备 ID）。详细信息，参考 PreAllocateResource。client_user_id（自定义客户端用户 ID）。详细信息，参考 PreAllocateResource。本次发布包含以下新增功能和变更：
custom_game_id）。在调用以下接口时，可选择指定 game_id 或 custom_game_id 进行相关操作：
发布第一版 OpenAPI 文档。