文档中心 | 一键联接，全心服务

更新日期：2025年 04月 27日QuickGame（小游戏）接入文档

<h3> 一、概述 </h3> 1. 目前Quick已支持的小游戏平台有：支付宝、头条、荣耀、快手、美团、QQ、UC、微信、华为、快手、OPPO、vivo、小米、字节(抖音) 2. 小游戏接入资源请联系商务提供。注意：不同平台需要引入不同的sdk资源，但调用方法都是一致的 3. 小游戏产品，SDK后台不用开启实名 4. 各平台配置支付回调地址如下： UC支付回调：https://qkgamesdk.quickapi.net/miniGame/uc_notify 微信支付回调：https://qkgamesdk.quickapi.net/miniGame/weixin_notify 华为支付回调：https://qkgamesdk.quickapi.net/miniGame/huawei_notify QQ支付回调：https://qkgamesdk.quickapi.net/miniGame/qq_notify 支付宝回调：https://qkgamesdk.quickapi.net/miniGame/aligame_notify 荣耀支付回调：https://qkgamesdk.quickapi.net/miniGame/honor_notify 快手回调：https://qkgamesdk.quickapi.net/miniGame/ks_notify OPPO回调：https://qkgamesdk.quickapi.net/miniGame/oppo_notify vivo回调：https://qkgamesdk.quickapi.net/miniGame/vivo_notify 小米回调：https://qkgamesdk.quickapi.net/miniGame/xiaomi_notify 美团回调：https://qkgamesdk.quickapi.net/miniGame/meituan_notify?app=产品code 字节回调：https://qkgamesdk.quickapi.net/miniGame/byte_notify 以上地址需要配置到支付方式的后台也就是小程序的后台 5.客服消息推送地址配置 找到小游戏后台的“开发管理”下的“消息推送” 配置地址为：https://qkgamesdk.quickapi.net/miniGame/wxmini_customer 6. 微信米大师支付强烈建议使用“虚拟支付2.0道具直购”，以避免出现掉单情况，具体配置可参考文档： <a href="https://developers.weixin.qq.com/minigame/dev/guide/open-ability/virtual-payment/goods.html" target="_blank">https://developers.weixin.qq.com/minigame/dev/guide/open-ability/virtual-payment/goods.html</a> 7. 手Q小游戏也是用的米大师支付，同样需要配置道具，请认真阅读如下文档中的提示到的流程： <a href="https://q.qq.com/wiki/develop/game/server/virtual-payment/game_pay.html" target="_blank">https://q.qq.com/wiki/develop/game/server/virtual-payment/game_pay.html</a> <h3> 二、接口调用 </h3> <h4> 1. 初始化 </h4> 调用示例: <pre class="brush:js;toolbar:false">var QGSDK = require('./js/libs/QGSDK'); QGSDK.QGManager.host = 'https://qkgamesdk.quickapi.net'; QGSDK.QGManager.init('54690518598596230042650006549994');</pre> 第一步：引用提供的 SDK 文件 第二步：设定请求的域名地址 第三步：初始化使用的产品 code，产品 code 由运营人员提供 <h1> 微信小游戏广点通转化跟踪sdk的调用说明： </h1> 此功能为选接功能，需要开通广点通数据转化才能接入。 引入广告sdk <pre class="brush:js;toolbar:false">import { SDK } from './js/libs/index.js';</pre> QGSDK.init方法调用之后就可以调用广告sdk的初始化如下，如果不调用如下方法则表示不会开启广告跟踪 <pre class="brush:js;toolbar:false">QGSDK.QGManager.init('54690518598596230042650006549994', function(){ QGSDK.QGManager.adTracking(SDK, true); }); </pre> 第一个参数是广告sdk对象，第二个参数表示开启了debug模式（false关闭debug） QGSDK默认上报了启动，注册，付费，角色相关行为事件 关于回流用户上报的方法说明：需要在调用登录之前调用如下方法 <pre class="brush:js;toolbar:false">QGSDK.QGManager.setFlowDay(30);</pre> 在调用登录之前设置回流周期天数，如果不设置则默认为7天的回流周期 通常可以设定的回流周期为7天或者14天或者30天，同一个游戏只需要设定一个周期。 游戏内新手引导完成后调用如下方法 <pre class="brush:js;toolbar:false">QGSDK.QGManager.adManFinish();</pre> 对于微信小游戏苹果内支付的订单调用上报需要在应用启动之后的一个合理的时机进行调用方法如下 <pre class="brush:js;toolbar:false">QGSDK.QGManager.adManExtraPay();</pre> 收藏行为的上报 <pre class="brush:js;toolbar:false">wx.onAddToFavorites(function(){ QGSDK.QGManager.adManFavorites(); })</pre> 分享行为的上报，传递参数为上报类型app为转发time为分享到朋友圈 <pre class="brush:js;toolbar:false">wx.onShareAppMessage(function(){ QGSDK.QGManager.adManGameShare("app"); //app是转发//time是朋友圈 })</pre> <h1> 引力引擎sdk的接入方案： </h1> 导入引力微信sdk <pre class="brush:js;toolbar:false">import GravityEngine from "./js/libs/gravityengine.mg.wx.min";</pre> 由于引力sdk的实例化需要传入openId所以我们的调用节点是在登录回调中完成 <pre class="brush:js;toolbar:false">QGSDK.QGManager.login(function(res){ QGSDK.QGManager.gravityEngineTracking(GravityEngine, true, function(){ QGSDK.QGManager.gravityInitialize();//初始化 }); })</pre> 广告观看事件上报 <pre class="brush:js;toolbar:false">QGSDK.QGManager.adShowTrack(adType, adUnitId, extra_param) /** * 上报广告展示事件参数如下 * @param adType 广告类型（取值为：reward、banner、native、interstitial、video_feed、video_begin，分别对应激励视频广告、Banner广告、原生模板广告、插屏广告、视频广告、视频贴片广告） * @param adUnitId 广告位ID（一般以adunit开头，注意不要填错，会导致广告收入统计不准！） * @param otherProperties 其他需要携带的自定义参数 */</pre> <h4> </h4> <h4> 2. 登录 </h4> 第三放小程序平台为了使多应用互通，通常会提供unionid unionid获取的前提是开发者平台绑定了当前应用，如果没有绑定就只能返回openid 所以我们建议开发者们首要就在开发者平台绑定应用以获取unionid 开发者在使用小游戏开发工具调试的时候，开发者工具也需要登录才行。 调用示例： <pre class="brush:js;toolbar:false">QGSDK.QGManager.login(function(resData){ conssole.log(resData) }）</pre> 登录回调的数据格式如下： <img src="https://staticsite.quickapi.net/data/newFiles/20250414/20250414144826aHyK954.png" alt="" /> 开发者只需要关心 uid 与 token 即可 Uid 具有唯一性 Token 可以通过接口检验 假如绑定过开发者平台时trueOpenId 为真实的openId 调用示例如下： http://quickgame.sdk.quicksdk.net/webapi/checkUserInfo?uid=88124065&token=@167@142@181@162@176@172@177@168@107@137@138@210@173@172@100@94@167@129@134@187@169@181@141@119@102@131@105@127@177@153@105@138@134@199@222@134@178@99@217@184@108@127@172@214@142@156@171@121@160@120@126@201@167@179@124@171@171@172@164@161@218@126@105@140@104@171@175@158@187@165@187@174@130@158@138@175@137@180@142@134@167@141@141@187@126@156@156@165@157@173@129@131@223@114@174@127@111@175@185@149@214@103@175@219@162@124@175@160 <h4> 3. 支付 </h4> 无论是微信直购还是抖音直购，请将在平台配置好的“道具ID”传入下单参数的goodsId中 调用示例: <pre class="brush:js;toolbar:false">var pay = { cpOrderNo:'游戏订单号'//请传入字符串类型, subject:'一大袋砖石', desc:'血丹 x5', goodsId:'com.test.id5', amount:'1',//订单金额，人民币 extrasParams:'fdsfds', userRoleId:'1', userRoleName:'test', serverId:'1', serverName:'1 区', userLevel:'99', callbackUrl:'http://ddd'游戏支付回调地址 }; QGSDK.QGManager.pay(pay);</pre> 注意：上述示例中的参数都需要且不能传空值，仅callbackUrl如果不需要可以不传，amount单位为“元”’ <h4> 4. 上传角色 </h4> 调用示例: <pre class="brush:js;toolbar:false">var role = { userRoleId:'1', userRoleName:'test', userRoleBalance: 333, serverId:'1', serverName:'1 区', userLevel:'99', }; QGSDK.QGManager.role(role);</pre> 针对接入微信广告跟踪的游戏还需要额外上传一个字段表示当前角色是创建还是升级 <pre class="brush:js;toolbar:false">role.isCreateRole = true||false</pre> true表示创建 false表示升级 <h4> 5. 获取H5游戏地址接口 </h4> 调用示例: <pre class="brush:js;toolbar:false">QGSDK.QGManager.getWebInfo(function(resData){ console.log('getwebinfo'); console.log(resData); });</pre> 这里获取到的 resData 的格式如下: <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420182433wnsz309.png" alt="" /> 获取到的数据在 resData.data 对象下面 Mobile 表示已经绑定到手机，如果没有绑定则为空 playUrl 表示获取到的 h5 游戏地址，如果没有则为空 <h4> 6. 发送验证码 </h4> 调用示例: <pre class="brush:js;toolbar:false">QGSDK.QGManager.sendSMS("1657328588", function(resData){ console.log('sendsmscode'); console.log(resData); });</pre> 第一个参数是手机号，第二个参数是回调函数 如果是成功的调用，返回参数形式如下: resData.data.expires_in 表示短信验证码有效时间 <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420182447nF8L106.png" alt="" /> 比如当前手机号是错误的，那么回调结果可能形式为: <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420181413r1zc597.png" alt="" /> 说明 resData.data 则为空。resData.error 中有 id 与 message 说明 或者如下情形的: <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420181442XvA4938.png" alt="" /> <h4> 7. 绑定手机号 </h4> 调用示例: <pre class="brush:js;toolbar:false">QGSDK.QGManager.bindPhone("1657328588", "139130", function(resData){ console.log('bindphonenumber'); console.log(resData); });</pre> 第一个参数是手机号，第二个参数是验证码，第三个参数是回调函数 如果调用成功，回调参数形式如下: <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420181608d3Ur781.png" alt="" /> 说明 resData.data.status 为 success,并且 resData.error.id 为 0 假如调用失败，如下： <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420181642HuY2570.png" alt="" /> 说明 resData.error.id 大于 0，且 message 有说明错误原因 <h4> 8. 敏感词检测接口 </h4> 调用示例： <pre class="brush:js;toolbar:false">QGSDK.QGManager.checkMessage("你好我叫李焕英", "1", function(res){ console.log('checksecurity'); console.log(res); });</pre> 返回数据结构如下： <img src="https://staticsite.quickapi.net/data/newFiles/20230420/20230420181719jes9571.png" alt="" /> 当result.suggest=="pass"的时候就是检测通过的情况 <h4 style="text-wrap:wrap;"> 9. 心跳接口 </h4> QGSDK.QGManager.tickHeartBeat(timeCheck) timeCheck 时长（秒），用户在线时长以该值累计 <h3> 三、接入常见问题 </h3> 3.1 QQ小游戏接入常见问题 <img src="https://staticsite.quickapi.net/data/newFiles/20250213/20250213113917W5wb949.png" alt="" /> 3.2 微信小游戏上广点通买量需要在SDK后台-功能配置-授权登录参数里配置广点通的参数 <img src="https://staticsite.quickapi.net/data/newFiles/20250311/20250311113858DTyK905.png" alt="" />