# 初始化
# 接口说明
使用 new DHMiniSDK(options)
进行SDK初始化,初始化完成后将返回一个实例对象,可通过该实例对象访问相关属性,或调用相关服务API,如系统信息、用户信息、执行登录、发起支付等。
new DHMiniSDK(options);
注意事项
请游戏客户端务必在游戏入口文件 game.js
中(game.js
一般位于快手小游戏项目工程的根目录下),于其它初始化或资源加载环节之前优先导入并执行SDK初始化!该注意事项为运营需求,并非SDK自身限制,尽早完成SDK初始化,方可使用SDK的数据统计接口,在游戏的初始化或资源加载环节完成部分日志上报,以便更加细粒度的分析用户的转化行为和流失情况。
# 参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
requests | object | 是 | -- | 服务接口地址 |
requests.login | string | 是 | -- | 登录服务接口地址,请参考上文《添加安全域名》栏目中填写 |
requests.pay | string | 是 | -- | 支付服务接口地址,请参考上文《添加安全域名》栏目中填写 |
requests.log | string | 是 | -- | 数据上报服务接口地址,请参考上文《添加安全域名》栏目中填写 |
requests.errorLog | string | 是 | -- | 日志上报服务接口地址,请参考上文《添加安全域名》栏目中填写 |
gameAppId | string | 是 | -- | 游戏在快手侧的 AppID ;可登录《快手开放平台控制台》后台,进入“开发 > 开发设置”栏目中查看 |
appId | string | 是 | -- | 游戏在SDK开放平台侧的 AppID |
appVersion | string | 是 | -- | 游戏的版本号,如 2.0.4.10 |
packageName | string | 是 | -- | 游戏的应用包名,如 com.example.abc |
channel | number | 是 | -- | 游戏渠道包ID,默认固定传 3499 |
mainChannel | number | 是 | -- | 推广主渠道ID,默认固定传 101138 |
secondChannel | number | 是 | -- | 推广次渠道ID,默认固定传 101139 |
heartbeatEnable | boolean | 否 | true | 是否开启心跳数据上报,若开启,则SDK将每隔一分钟向服务器发送一条心跳数据 |
gravityEngineAccessToken | string | 否 | -- | 游戏的引力引擎 Access Token (于引力引擎控制台创建产品时生成的Access Token,在引力控制台“设置 > 应用列表”中找到Access Token列进行复制,首次使用需要先创建应用)(注意,若填写此项则表示启用SDK内部集成的引力引擎数据上报服务;启用引力引擎数据上报需要将 https://backend.gravity-engine.com 添加为 request 合法域名) |
gravityEngineDebug | boolean | 否 | -- | 显式开启或关闭引力引擎数据上报的调试模式,默认根据游戏当前的体验环境自动设置,正式版下为 false ,开发版或体验版下为 true ;开启调试模式后,可以在引力控制台“设置 > 元数据 > 事件流”中查看实时数据上报结果 |
gravityEnginePayEventEnable | boolean | 否 | true | 引力引擎付费事件是否采用客户端上报,默认采用(注意,若引力引擎付费事件上报采用服务端上报,请务必将此参数设为 false ,并于SDK中台系统配置服务端上报相关参数,否则可能导致双端付费事件上报丢失或重复!!!) |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 导入SDK文件
import DHMiniSDK from "./dh-mini-sdk-for-kuaishou-x.x.x";
// 双引号内的内容为SDK文件相对于项目工程根目录的路径,请根据实际情况自行修改,该示例假设已将SDK文件下载到根目录下
// 请于其它初始化或资源加载(如游戏引擎导入、游戏资源加载等)环节之前优先导入并执行SDK初始化
// 相关参数表请咨询运营人员提供
const sdkInstance = new DHMiniSDK({
requests: {
login: "xxxxxxxxxxxxxxxxxxxx", // 登录服务接口地址
pay: "xxxxxxxxxxxxxxxxxxxx", // 支付服务接口地址
log: "xxxxxxxxxxxxxxxxxxxx", // 数据上报服务接口地址
errorLog: "xxxxxxxxxxxxxxxxxxxx" // 日志上报服务接口地址
},
gameAppId: "xxxxxxxxxx", // 游戏在快手侧的 AppID
appId: "xxxxxxxxxx", // 游戏在SDK开放平台侧的 AppID
appVersion: "x.x.x.xx", // 游戏的版本号
packageName: "xxx.xxxxxxx.xxx", // 游戏的应用包名
channel: 3499, // 游戏渠道包ID
mainChannel: 101138, // 推广主渠道ID
secondChannel: 101139, // 推广次渠道ID
heartbeatEnable: true, // 是否开启心跳数据上报,若开启,则SDK将每隔一分钟向服务器发送一条心跳数据
gravityEngineAccessToken: "xxxxxxxxxx", // 游戏的引力引擎 Access Token,不启用引力引擎数据上报时请置空或移除该参数
gravityEnginePayEventEnable: true // 注意,此参数为 true 时表示引力引擎付费事件由客户端上报,为 false 时表示引力引擎付费事件由服务端上报;默认为 true,设为 false 时,请于SDK中台系统配置服务端上报相关参数
});
console.log(sdkInstance); // SDK实例对象
console.log(sdkInstance.system); // 系统信息
console.log(sdkInstance.system.platform); // 客户端设备类型,如android、ios等
console.log(sdkInstance.deviceId); // 设备唯一标识
console.log(sdkInstance.deviceOS); // 设备类型,如minigame_android、minigame_ios等
console.log(sdkInstance.gameAppId); // 游戏在快手侧的 AppID
console.log(sdkInstance.appId); // 游戏在SDK开放平台侧的 AppID
console.log(sdkInstance.appVersion); // 游戏的版本号
console.log(sdkInstance.packageName); // 游戏的应用包名
console.log(sdkInstance.channel); // 游戏渠道包ID
console.log(sdkInstance.mainChannel); // 推广主渠道ID
console.log(sdkInstance.secondChannel); // 推广次渠道ID
console.log(sdkInstance.userInfo); // 用户信息,仅在登录成功后可用
console.log(sdkInstance.userInfo.accountId); // 用户账号ID
console.log(sdkInstance.userInfo.loginType); // 用户登录方式
console.log(sdkInstance.userInfo.token); // 用户登录Token
console.log(sdkInstance.userInfo.userExtraInfo.openId); // 用户快手唯一标识(openId)