search
开发文档
开发文档/小游戏开发/API/平台能力/rpk导流到apk
rpk导流到apk更新时间:2025-12-22 19:14:01

qg.createApkInstallGuide().show(Object object)

基础信息说明

调用此接口可在应用内展示安装引导弹窗,通过 style 参数选择三种不同样式,引导用户完成 APK 安装操作。

项目说明
版本要求框架版本号13010001开始支持本方法
前提条件完成RPK和APK游戏登录API的接入
使用限制
相关教程

参数说明

参数Object object

属性名类型必填说明
style
number引导样式类型,取值范围为1~3
1:半屏弹窗
2:悬浮图标
3:中弹窗

引导样式说明

样式1:半屏弹窗

样式2:悬浮图标

样式3:中弹窗

错误码

错误码错误信息错误信息说明
202missing required parameter 'style'. Please provide 'style' with value 1, 2, or 3.请求里缺少必填参数 style,无法正常处理请求
202invalid style, must be 1~3无效的style值,必须是数字1,2,3中的一个
200game view not ready. Ensure the game page is fully loaded before calling this API.游戏页面还没准备好
200internal pre-check failure网络检查失败
200checkCanShowGuide returned null引导弹窗调起限制出现异常错误
200rpk name is null未获取到rpk包名
200not enough launch count用户启动该游戏次数未达标
200not enough play time用户本次游玩该游戏时长未达标
200user disabled show apk install guide用户勾选了不再展示引导弹窗,当前游戏无法通过API调起
200Associate apk is not find未找到当前rpk关联的apk
200Associate apk already installed用户已经下载安装了当前rpk关联的apk
200failed to fetch install guide game info引导弹窗页面信息获取失败

示例代码

qg.createApkInstallGuide().show({
style: Number(styleId), // 必填参数
success: (res) => {
console.log("success:", res);
},
fail: (err) => {
console.error("hello error:", err);
}
});
上一篇:广告
下一篇:桌面图标
文档内容是否有帮助?
有帮助
无帮助