SDK对接文档

主题

WARNING

💡 模块名:GameHelper.WXDataNexus

描述 ​

腾讯DN是腾讯自家的归因，仅可用于微信渠道，与引力归因互不干涉。 请根据对接同事的需求，选用正确的归因组件。对于微信带内购的产品，必须使用DN归因。

当需求包含AMS归因时，请确认提供的SDK包含TencentDN.js, 请务必将其与SDK一同进行构建。如没有该文件请反馈给对接人员。


概念理解 ​

回流用户时间：距离用户最近一次登录游戏的时间，以天为单位。

SDK默认的回流用户时间为30天。 对接同学会配置好相应的回流天数，在线参数为tencentDN_reactive。


调试模式 - 重要 ​

本模块会自动初始化，但需要根据包的类型，更改GameHelper.init传参的guiyinDebugMode属性，该属性默认为false.

自测包 ​

进行非发布包的测试时，请将GameHelper.init传参的guiyinDebugMode设置为《true》.

仅有在设置了归因调试开关后，才能在后台进行数据验证!!!

javascript
GameHelper.init({
    ...
    guiyinDebugMode: true, // 归因的调试开关，自测包要打开进行验收，上线包必须关闭
    ...
})

SDK会有如下提醒


正式包 ​

归因验证完毕后，最后的正式包必须将将GameHelper.init传参的guiyinDebugMode设置为《false》

javascript
GameHelper.init({
    ...
    guiyinDebugMode: false, // 归因的调试开关，自测包要打开进行验收，上线包必须关闭
    ...
})

SDK的自动上报 ​

SDK会自动上报如下事件，业务层无需关注代码实现，仅需进行验证即可：

DN事件名/打印条目说明含义
REGISTER用户注册真实新增用户
RE_ACTIVE用户回流符合回流用户时间的回流用户
PURCHASE付费用户完成内购
ADD_TO_WISHLIST收藏点击微信的收藏按钮

业务手动上报 ​

请根据策划/发布的要求，在对应的点位，使用GameHelper.WXDataNexus.reportEvent方法，上报所有需要的事件。一般而言，只要游戏有对应点位的功能，则必须上报

创建角色 ​

当游戏有角色的概念时，在角色创建完成时上报。

  • 如果有角色名称的概念，则需要在eventParams里传入name属性。

  • 对应DN日志/后台的【CREATE_ROLE】打印/条目

typescript
// 有角色名的概念
GameHelper.WXDataNexus.reportEvent({
    eventType: GameHelper.WXDataNexus.EVENT_TYPE.CREATE_ROLE,
    eventParams: {
        name: "吗喽",
     },
});

// 没有角色名的概念
GameHelper.WXDataNexus.reportEvent({
    eventType: GameHelper.WXDataNexus.EVENT_TYPE.CREATE_ROLE,
    eventParams: {},
});

引导结束 ​

当游戏有引导教程的概念时，需要在引导完成时进行上报

  • 对应DN日志/后台的【TUTORIAL_FINISH】打印/条目
typescript
GameHelper.WXDataNexus.reportEvent({
    eventType: GameHelper.WXDataNexus.EVENT_TYPE.TUTORIAL_FINISH,
    eventParams: {},
});

用户升级 ​

当游戏有 <完成游戏等级提升>的概念时进行上报.

  • 可自行在eventParams添加需要的属性。 一般来说必传level字段, 代表用户升级后的等级。可根据需要传其他DIY字段

  • 对应DN日志/后台的【UPDATE_LEVEL】打印/条目

typescript
GameHelper.WXDataNexus.reportEvent({
    eventType: GameHelper.WXDataNexus.EVENT_TYPE.UPDATE_LEVEL,
    eventParams: {
        level: 6, // 当前用户等级
        diy1: "someparam1", // 可选额外传写自定义的参数
        diy2: 888, // 可选额外传写自定义的参数
    },
});

浏览商城/游戏活动 ​

当用户在小游戏内浏览商城页面、或者浏览活动时上报。一般是在打开相应UI时上报。

  • eventParams添加item属性

    • 商城："Mall"

    • 活动: "Activity"

  • eventParams添加其他需要的属性(可选)

  • 对应DN日志/后台的【VIEW_CONTENT】打印/条目

typescript
GameHelper.WXDataNexus.reportEvent({
    eventType: GameHelper.WXDataNexus.EVENT_TYPE.VIEW_CONTENT,
    eventParams: {
        item: "Mall", // 假设这里看的是商城 - !!!必须带该属性
        // item: "Activity", // 假设这里看的是活动 - !!!必须带该属性
        diy1: "someparam1", // 可选额外传写自定义的参数
        diy2: 888, // 可选额外传写自定义的参数
    },
});

测试验证 - 研发 ​

验证回流用户天数定义 ​

SDK默认回流天数为30，如果发布在远程配置配了tencentDN_reactive则会使用。需验证回流天数与项目要用的一致。如果任务没特别说明就是30。可通过调用步骤3的归因初始化后的打印得知，例如下面的例子是14天：


用户注册事件 ​

当用户是首次玩游戏，也就是咱们口中的新增用户，此时会自动上报一次【REGISTER】事件。后续启动均不会上报！！所以请使用新账号玩游戏验证该点，测试账号不能登陆过游戏，请一切准备就绪后再测。一般来说游戏验证一次即可。

判断为新用户时，模块有如下打印：[TencentDN]--newUser。然后验证事件上报

【1】验证可在控制台看到如下打印

【guiyinDebugMode需要打开】


用户回流事件 ​

如果为老用户，模块有如下打印：[TencentDN]--existingUser

如果同时满足回流用户天数，则SDK会自动上报【RE_ACTIVE】事件。该情况比较难测试，可以让对接同学配置在线参数为0或1，测完记得把在线参数改回去。 一般来说游戏验证一次即可。

验证可在控制台看到如下打印

【guiyinDebugMode需要打开】


收藏验证 ​

当收藏小游戏时，可以触发【ADD_TO_WISHLIST】事件上报。验证可在控制台看到如下打印

收藏会有两条事件，是正常情况

【guiyinDebugMode需要打开】



支付验证 ​

当完成支付时，需要验证【PURCHASE】事件，以及其金额是否正确。例如下列例子是上报的6元。

【guiyinDebugMode需要打开】


其他归因事件上报 ​

对于栏目4的事件，请在对应点位触发时，立即进行如下验证

验证可在控制台看到如下打印。 上报行为类型为对应分栏的【XXX】的部分。例如下图所示的为【UPDATE_LEVEL】

【guiyinDebugMode需要打开】


测试验证 - 测试 ​

测试需要验证栏目4和5，所有符合条件的事件

日志打印 ​

如果研发将本模块的debugMode打开，验证数据时可以选择查看。

正式包必须为关闭状态，控制台不允许出现下列的打印


网络请求 ​

当对应点位触发时，验证可在NETWORK看到一条新网络请求。关键字为miniprogram(请求体为密文，只能看到多一条)。网络请求的响应必须为code: 0, message: ok。

真机测试请直接看DN后台。


后台验证 ​

登录https://datanexus.qq.com/web/monitor/logs。进入到对应的产品。

参考下图，进入到《日志查询》栏目，然后再右上角选好时间即可。


如果对应的事件有上报事件属性(例如支付的金额)，点击对应条目的(JSON)。然后查看action_param里面的值即可



点我快速对接