SDK对接文档

主题

WARNING

💡 模块名:GameHelper.TouFangGuiYin

1. 描述 ​

归因系统基于引力引擎开发，对游戏的投放买量提供统计数据支持，从而实现流量调优。请仅在有"引力归因"使用需求时，接入本模块。

归因需求主要分为3类(用户注册、广告归因、支付归因)，SDK均已自动接入

请按照下列步骤进行接入和自测，尤其要注意步骤2.2和2.8！

2. 接入说明 ​

2.1 准备工作 ​

  1. 首先，需确保已放入gravityengine.mg.cocoscreator.min.js文件，请勿勾选"导入为插件"，并打入包中。

引力归因功能需要依赖gravityengine.mg.cocoscreator.min.js文件工作。

该文件仅当对接同学提供了引力功能时，才会随SDK包一起提供(放在SDKlibs下)。如需要引力归因功能，但又没有在包里找到，请联系对接同学重新出包。

如使用Cocos3.5及以上引擎，在游戏运行时因该文件报红fail to instantiate...，请更改文件后缀名为ts即可

2.2 设置调试模式-测试包 ​

为了获取控制台自测日志，以及能在后台检查归因上报情况，自测包必须在GameHelper.init进行整体SDK初始化时，传入guiyinDebugMode为true。引力组件会自动运行，并根据guiyinDebugMode传入的值设置调试状态

指的是多加一个guiyinDebugMode参数，不是再调用一遍方法！！！GameHelper.init每次启动仅可调用一遍

javascript
GameHelper.init({
    ...
    guiyinDebugMode: true,
    ...
})

2.3 用户注册-自动 ​

研发无需调用任何代码。SDK会在自动上报用户注册。

2.4 广告归因-自动 ​

研发无需调用任何代码。SDK会在广告展示时机进行自动归因。

2.5 支付归因-自动 ​

研发无需调用任何代码。SDK会在支付成功以及补单成功的时机，进行自动归因

2.6 研发自测 ​

在调试包的情况下, 研发需在客户端验证引力上报已成功。在开发者调试工具中，寻找引力引擎上报的XHR(很好判断，链接很长并包含gravity关键字)，确认其response没有啥错误码。

对于快手等无法看调试器网络请求的渠道，可以根据情况选择 《抓包》or《直接进行2.7测试验证》。研发自测仅是预先检查降低错误可能性。

2.6.1 用户注册验证 ​

在SDK启动后，调试器会出现一串引力的网络上报请求。请求地址都包含gravity关键字

确认这些请求的响应体没有错误码

2.6.2 广告归因验证 ​

在广告展示时，调试器会出现一条引力上报报文。其请求体中可查看到$AdShow字样。确认这些请求的响应体没有错误码(与2.6.1一样)

2.6.3 支付归因验证 ​

在支付成功或者补单成功时，调试器会出现一条引力上报报文。其请求体中可查看到$PayEvent字样。确认这些请求的响应体没有错误码(与2.6.1一样)

2.7 测试验证 ​

请在确保研发自测通过时，保持guiyinDebugMode为true提交给对接人员，进行后台验证即可。

验证结果以引力后台为准。

2.8 删除调试模式-正式包 ​

在测试完成后，必须删除GameHelper.init的guiyinDebugMode参数。否则上线后将没有任何归因数据！

点我快速对接