游戏注册--云游戏-火山引擎

文档中心

立即注册

导航

游戏注册

最近更新时间：2025.01.20 15:42:48首次发布时间：2022.03.01 17:31:35

在指定业务下，注册游戏。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	String	是	云游戏业务 ID，可在「云游戏控制台-业务管理」中获取
game_name	String	是	游戏名称
custom_game_id	String	否	用户自定义游戏 ID（同账号下必须唯一），以大写字母开头，最大长度为128位的非空字符串，支持的字符集范围为: 大写字母 A ~ Z 小写字母 a ~ z 数字 0 ~ 9 下划线 "_" 减号 "-"
channel_id	String	否	业务颁发的渠道 ID
game_rotation	String	否	游戏的横竖屏： landscape（横屏显示） portrait（竖屏显示）
user_config_path_list	String[]	否	保存用户游戏配置文件的路径列表
game_version	CreateGameVersion	是	游戏版本信息，参考以下 CreateGameVersion 结构说明

CreateGameVersion 结构说明

字段	类型	必填	说明
download_url	String	是	游戏包下载地址，支持 HTTP 和 HTTPS
package_name	String	是	游戏包名称，可通过调用 DetailParseTask 接口获取（需保证传入信息的准确性，否则启动游戏可能失败）
version_code	Int64	是	游戏版本号，可通过调用 DetailParseTask 接口获取（需保证传入信息的准确性，否则启动游戏可能失败）
md5	String	是	游戏文件 MD5，可通过调用 DetailParseTask 接口获取（需保证传入信息的准确性，否则启动游戏可能失败）
package_size	Int64	是	文件大小，单位 byte，可通过调用 DetailParseTask 接口获取（对应 file_size 字段），限制最大值为 2199023254528（即 2147483647KB）
file_type	String	否	上传文件类型，可通过调用 DetailParseTask 接口获取（需保证文件类型正确，否则影响游戏上架）： .apk（APK 类型，默认） .zip（APK+数据包类型） .tgz（APK+数据包类型） .tar（APK+数据包类型）
data_storage	Object	否	游戏数据包存储信息，参考以下 DataStorage 结构说明
data_package	Object	否	游戏数据包文件信息，参考以下 DataPackage 结构说明

DataStorage 结构说明

字段	类型	必填	说明
obb_path	string	否	OBB 数据包文件解压路径：说明：如不指定，则使用默认路径 `/sdcard/Android/obb/包名` 如指定路径，则打包路径为 `/sdcard/Android/obb/包名/$path`（例：`obb_path = /ab`，则打包路径为 `/sdcard/Android/obb/包名/ab`）多个 OBB 数据包文件的解压路径相同

字段

类型

必填

说明

obb_path

string

否

OBB 数据包文件解压路径：
说明：

如不指定，则使用默认路径 /sdcard/Android/obb/包名
如指定路径，则打包路径为 /sdcard/Android/obb/包名/$path（例：obb_path = /ab，则打包路径为 /sdcard/Android/obb/包名/ab）
多个 OBB 数据包文件的解压路径相同

DataPackage 结构说明

字段	类型	必填	说明
file_name	String	是	数据包文件名
size	Int64	否	OBB 数据包文件大小，单位 byte
md5	String	否	数据包文件文件 MD5

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
game_id	String	如果游戏创建成功，返回新创建的游戏 ID 如果游戏已经存在，返回已存在的游戏 ID
is_new	Boolean	游戏是否新建成功： true（新创建的游戏） false（游戏已存在，可增加对应的文案提示）

字段

类型

说明

game_id

String

如果游戏创建成功，返回新创建的游戏 ID
如果游戏已经存在，返回已存在的游戏 ID

is_new

Boolean

游戏是否新建成功：

true（新创建的游戏）
false（游戏已存在，可增加对应的文案提示）

示例

请求示例

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

{
    "product_id": "16308002740xxxxxxxx",
    "game_name": "游戏名",
    "custom_game_id": "game01",
    "game_rotation": "landscape",
    "game_version": {
        "download_url": "https://xxx-file.xxx.com/cloudgame/xxxxxx.tar?x-expires=258xxxxxx&x-signature=xxxxxx",
        "package_name": "com.mygame.test1",
        "version_code": 1,
        "md5": "6ba27946c00acf6f9b8039f0xxxxxxxx",
        "package_size": 111844670,
        "file_type":".tgz",
        "data_storage": {
            "obb_path":"/obb"
        },
        "data_package": [
            {
                "file_name": "main.mygame.test1.obb",
                "size": 58723043,
                "md5": "37b718e6f250a7926e72b0f7xxxxxxxx"
            }
        ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateGame",
        "Region": "cn-north-1",
        "RequestId": "20220216115400010225110011010B9483",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "game_id": "7064470096059xxxxxx",
        "is_new": true
    }
}