配置游戏伴随程序--云游戏-火山引擎

文档中心

立即注册

导航

配置游戏伴随程序

最近更新时间：2025.01.20 15:42:49首次发布时间：2022.07.28 15:09:50

为指定游戏配置伴随程序。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ManageGameFrameworkApp
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10

Body 参数

字段	类型	必填	说明
game_id	String	是	游戏 ID，可通过调用 ListGame 接口获取
framework_app_id_list	`List<String>`	是	伴随程序 ID 列表，可通过调用 ListFrameworkApp 接口获取（如果传入空的列表，则清除游戏已配置的伴随程序）

返回结果

通用返回参数，参考 ResponseMetadata 结构说明。

字段	类型	说明
Result	String	游戏伴随程序配置成功，返回 success

示例

请求示例

POST https://open.volcengineapi.com?Action=ManageGameFrameworkApp
&Version=2022-02-10
&<通过header传入的公共请求参数>

{
    "game_id": "7064461037747xxxxxx",
    "framework_app_id_list": ["7122432503851xxxxxx","7122432503851xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ManageGameFrameworkApp",
        "Region": "cn-north-1",
        "RequestId": "20220216160857010225243081062C84F2",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": "success"
}