# 准备工作
# 下载SDK文件
请前往前文《更新日志》章节中查看SDK版本更新日志,点击相应版本号链接下载SDK文件;建议新接入游戏始终下载并使用最新版本,以确保可以使用当前SDK集成的所有功能!
# 导入SDK文件
注意事项
请游戏客户端务必在游戏入口文件 game.js
中(game.js
一般位于微信小游戏项目工程的根目录下),于微信官方适配文件 weapp-adapte.js
引入之后,其它初始化或资源加载环节之前优先导入并执行SDK初始化!该注意事项为运营需求,并非SDK自身限制,尽早完成SDK初始化,方可使用SDK的数据统计接口,在游戏的初始化或资源加载环节完成部分日志上报,以便更加细粒度的分析用户的转化行为和流失情况。
参考如下示例代码导入(本文档假设已将SDK文件下载并解压至微信小游戏项目工程的根目录下):
game.js
// 请务必确保SDK导入、SDK初始化,以及所有游戏逻辑代码等,均在 weapp-adapter.js 适配文件导入后再执行
// 有关 weapp-adapter.js 的详细说明,可阅读:https://developers.weixin.qq.com/minigame/dev/guide/runtime/adapter.html
// 导入微信小游戏SDK核心文件
import DHMiniSDK from "./dh-mini-sdk-for-wx-x.x.x";
// 双引号内的内容为SDK文件相对于项目工程根目录的路径,请根据实际情况自行修改,该示例假设已将SDK文件下载到根目录下
// 若使用 import 语句导入SDK文件时,微信开发者工具控制台输出报错:SyntaxError: Cannot use import statement outside a module
// 那么请开启微信开发者工具的“将 JS 编译成 ES5”功能,设置路径:微信开发者工具 > 右上角“详情” > 本地设置 > 勾选“将 JS 编译成 ES5”
// 或使用 require 语句导入SDK文件:const DHMiniSDK = require("./dh-mini-sdk-for-wx-x.x.x");
// 请于其它初始化或资源加载(如游戏引擎导入、游戏资源加载等)环节之前优先导入并执行SDK初始化
// 相关参数表请咨询运营人员提供
const sdkInstance = new DHMiniSDK({
...
});
# 添加安全域名
请登录《微信公众平台》 (opens new window)后台,进入“开发 > 开发管理 > 开发设置”,在“服务器域名(request
合法域名)”一栏中添加如下安全域名:
- 登录服务:请联系运营人员提供
- 支付服务(支付下单):请联系运营人员提供
- 支付服务(H5网页支付,适用于iOS、Android设备):请联系运营人员提供
- 支付服务(米大师支付,仅适用于Android设备):请联系运营人员提供
- 问卷调查服务:请联系运营人员提供
- H5客服服务:请联系运营人员提供
- 游戏圈服务:请联系运营人员提供
- 数据上报服务:请联系运营人员提供
- 日志上报服务:请联系运营人员提供
- 热云SDK数据上报服务(仅在启用热云数据上报时添加):https://log.reyun.com、https://openid.reyun.com
- 引力引擎SDK数据上报服务(仅在启用引力引擎数据上报时添加):https://backend.gravity-engine.com
- 腾讯广告SDK数据上报服务(仅在启用腾讯广告数据上报时添加):https://api.datanexus.qq.com
- 冰柠乐渠道SDK数据服务(仅在上架至冰柠乐渠道时添加):https://cps.moyangmoyang.com
注意事项
添加安全域名时请务必注意区分发行主体,切勿擅自使用!另,以上安全域名对应SDK初始化参数中的 requests
选项,请提前添加好,否则SDK相关的服务端接口请求将不被微信允许!
# 用户隐私保护指引设置
请登录《微信公众平台》 (opens new window)后台,进入“设置 > 基本设置 > 服务内容声明 > 用户隐私保护指引”,填写并披露用户隐私保护指引,否则将导致获取用户微信昵称、头像/获取游戏圈数据/剪切板等接口无权被调用,可参考《XXXX小程序隐私保护指引》 (opens new window)模板进行填写。
请登录《微信公众平台》 (opens new window)后台,进入“设置 > 基本设置 > 服务内容声明 > 隐私授权弹窗”,点击设置并开启隐私授权弹窗,否则获取用户微信昵称、头像/获取游戏圈数据/剪切板等接口调用时将返回错误提示:xxxxxx:fail please go to mp open official popup or use wx.onNeedPrivacyAuthorization to announce your privacy。
# 基础库最低可用版本
综合《微信基础库版本分布情况》 (opens new window)及《微信小游戏API版本支持说明》 (opens new window)表中所述,SDK侧建议运营登录《微信公众平台》 (opens new window)后台,进入“设置 > 基本设置 > 版本设置 > 基础库最低可用版本”,设置最低可用版本为 2.11.2
;若游戏侧未针对相关SDK接口或微信官方接口做兼容处理,则务必将最低可用版本上升为 2.25.4
,以保证SDK当前集成接口均能正常使用,避免因报错而影响游戏进程。
# 提供微信小游戏的 AppID 和 AppSecret 等信息
请登录《微信公众平台》 (opens new window)后台获取游戏的 AppID
和 AppSecret
,并提供给SDK开放平台相关对接人员(可在相关对接沟通群咨询)。请注意保管 AppID
和 AppSecret
等信息,如果秘钥发生变更,务必通知平台进行替换!
# 向SDK开放平台索要游戏的 AppID 等信息
向SDK开放平台索要游戏的 appId
、channel
、mainChannel
和 secondChannel
等信息(可在相关对接沟通群咨询)。
# 腾讯广告平台相关设置和参数
- 在《微信公众平台》 (opens new window)设置用户隐私保护指引,并填写第三方SDK信息;
- 在《微信公众平台》 (opens new window)“服务器域名(
request
合法域名)”栏目中添加合法域名:https://api.datanexus.qq.com; - 在《腾讯广告平台》 (opens new window)“工具箱 > 申请微信AppID”页面申请关联小游戏AppID,关联后才能将上报数据和腾讯广告打通;
- 在《腾讯广告平台》 (opens new window)“数据源接入 > 新建数据源”,创建好后点击【查看密钥】获取
数据源ID
和加密密钥secret_key
等参数; - 在《腾讯广告平台》 (opens new window)创建数据源后,在“资产分发 > 分发详情”的弹窗中开启【转化归因】;
更多详细内容请查看《腾讯广告小游戏 SDK 开发指引》 (opens new window)的 3.1.1 ~ 3.13
章节说明。