自定义扩展参数说明--云游戏-火山引擎

文档中心

导航

自定义扩展参数说明

最近更新时间：2025.01.20 15:23:37首次发布时间：2023.04.10 14:06:02

根据业务需要，在申请云游戏服务时，可通过 extra 参数透传的自定义业务参数和相关说明如下：

参数名	类型	用途
enable_archive_upload	String	是否在游戏结束后上传用户存档（用户登录态等信息）： true（上传存档） false（不上传存档）注：如果在云游戏管理后台已配置该功能，以客户端指定的值优先
enable_browser	String	是否开启在云端游戏中点击链接打开游览器的功能： true（开启） false（关闭）注：开启该功能，需要同时在云游戏管理后台启用该功能
debug_info	String	开启日志上传功能所需要的对象存储信息，示例如下： // 火山引擎对象存储配置方法示例： "debug_info":{ "schema":"btd_tos", // 固定值，必填 "config":{ "ak":"your_ak", "sk":"your_sk", "bucket":"your_bucket", "endpoint":"tos-cn-beijing.volces.com", "region": "cn-beijing" }, "key": "test/adc.zip" // 仅支持zip格式 } // 阿里云对象存储配置方法示例： "debug_info":{ "schema":"ali_oss", // 固定值，必填 "config":{ "ak":"your_ak", // 根据sts生成的临时access key "sk":"your_sk", // 根据sts生成的临时secret key "bucket":"your_bucket", "endpoint":"https://oss-cn-hangzhou.aliyuncs.com", "url": "https://xxx.oss-cn-hangzhou.aliyuncs.com", "securityToken": "xxxxx" // (可选)根据sts生成的临时token }, "key": "test/adc.zip" // 仅支持zip格式 } 注：开启日志上传至对象存储功能，需向云游戏技术支持提供火山引擎云游戏业务 ID（可通过云游戏控制台业务配置页面获取）
serviceReserveTime	Int	指定用户退出游戏后服务端保留游戏运行资源的时长（单位：秒）；即调用客户端本地 `stop` 接口将不会引起实例资源退出，需要用户手动调用服务端 GameStop 接口释放实例资源
gameArchiveUrl	String	下载用户游戏存档文件的完整链接，文件格式为 .tar.gz，解压内容： `data/data/<pkgname>/` `sdcard/Android/data/<pkgname>/`
gameArchiveKey	String	使用对象存储时，保存和下载用户游戏存档文件的 Key
gameArchivePathList	String[]	使用对象存储时，保存和下载用户游戏存档文件的绝对路径列表，例如：`["/data/data/com.xx/files/1.txt","/data/data/com.xx/cache/2.txt"]`
userFrameworkApp	String[]	指定运行游戏需要的伴随程序列表，格式为： `"extra":{ "userFrameworkApp":"["com.pkg1","com.pkg2","com.pkg3"]" }` 已上传的伴随程序列表以及伴随程序包名可通过调用服务端伴随程序管理接口获取
characteristics	String	设备类型

参考示例

"extra": {
        "enable_archive_upload": "true",
        "enable_browser": "true",
        "debug_info":{
           "schema":"btd_tos",
           "config":{
              "ak":"your_ak",
              "sk":"your_sk",
              "bucket":"your_bucket",
              "endpoint":"tos-cn-beijing.volces.com",
              "region": "cn-beijing"
            },
            "key": "test/adc.txt"
         },
        "serviceReserveTime": 60,
        "gameArchiveUrl": "https://www.exapmple.com/data",
        "gameArchiveKey": "example.tar.gz",
        "gameArchivePathList": "["/data/data/com.demo/files","/data/data/com.demo/cache/preferences.xml"]",
        "userFrameworkApp":"["com.pkg1","com.pkg2","com.pkg3"]",
        "brand": "SMARTISAN",
        "model": "DT2002C",
        "manufacturer": "SMARTISAN",
        "sn": "49SS4DQGQCH69P4T",
        "baseband": "21C20B379S000C000,21C20B379S000C000",
        "board": "kona",
        "displayId": "QKQ1.200712.002 dev-keys",
        "device": "darwin",
        "fingerprint": "SMARTISAN/aries/aries:10/QKQ1.200712.002/1608592402:user/dev-keys",
        "buildHost": "cn-central-1b-3df00c4f21594110733099-2265614059-gsm4l",
        "bootloader": "1.0.0",
        "imei": "73947934703702",
        "phonenum": "13011111111",
        "imeisv": "2",
        "wifiName": "TPLINK-xxx",
        "characteristics": "tablet"
    }