# 数据统计
# 1、接口说明
用于上报并记录用户在游戏内的行为日志&事件(如:启动、登录、充值等行为),方便观察数据的变化、快速定位问题的根源,以及追踪程序执行的过程等。
sdk.trackEvent(eventId, eventParams, callback?);
注意事项
在SDK中,默认将上报启动、登录、充值等数据到OSS数据分析平台(创角、充值行为一般由游戏或SDK服务端回传),且不分国内海外。如果游戏需要上报其它更详细的数据至数据分析平台,请阅读数据统计接入文档。
# 2、参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
eventId | string | 是 | -- | 事件ID |
eventParams | object | 是 | -- | 事件参数 |
callback | function | 否 | -- | 事件上报完成时的回调函数,一般无需使用 |
# 3、数据上报
# 3.1、流程统计上报
上报相关流程统计数据(二合一接口,包括行为日志上报、Adjust数据上报),在SDK初始化完成后即可调用,可参考如下示例:
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 事件ID
const eventId = "100100::SDK_CLIENT_LAUNCH"; // 表示SDK客户端上报的启动事件
// 事件参数
const eventParams = {};
// 必填参数
eventParams.logLevel = "d"; // 日志类型,必填;d用于标记普通日志,e用于标记异常日志
eventParams.logContent = "SDK启动"; // 日志内容,必填;可以是描述文本或JSON字符串等任意字符串,如程序执行错误信息或网络请求响应信息等
// 执行上报
sdk.trackEvent(eventId, eventParams);
注意事项
- eventId:事件ID,由运营人员提供,格式为:
六位数字::字符串
,如:100100::SDK_CLIENT_LAUNCH
表示SDK客户端上报的启动事件; - eventParams:必须包含
logLevel
、logContent
字段,其中logLevel
固定为d
或e
。
# 3.2、自定义事件上报(选接)
上报其它自定义事件(除启动、登录、充值等行为以外的自定义事件,如角色升级等);自定义事件的名称、参数无固定格式,非必接,请结合游戏业务需要或运营需求自行上报,可参考如下示例:
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 事件ID
const eventId = "custom"; // 固定值,无需修改
// 事件参数
const eventParams = {};
// 必传参数
eventParams.eventName = "levelUp"; // 自定义事件名称,必填;如这里的levelUp代表角色升级事件
// 可选参数
eventParams.eventObj = "xxxxxx"; // 事件操作对象,如果是按钮点击事件,则对应按钮ID
eventParams.eventResult = "xxxxxx"; // 事件操作结果,如果是按钮点击事件,则返回按钮点击的结果,例如跳转至另一个页面,则填写结果页ID
eventParams.eventCode = "xxxxxx"; // 事件操作原因code码
eventParams.statMode = "1"; // 数据统计方式:1代表按eventName+eventObj+eventCode聚合后统计人数次数,2代表按eventName+eventObj+eventCode取每个用户最新记录,然后统计人数次数
eventParams.extendParamJson = JSON.stringify({ kills: 0, deaths: 0, assistant: 0 }); // 扩展参数,格式为JSON字符串
eventParams.areaId = "1001"; // 游戏大区ID,若游戏无大区概念,可不填,默认值为 1,表示初始大区编号
eventParams.roleId = "123456"; // 角色ID,若游戏无角色概念,可不填,默认值同accountId账号ID
// 执行上报
sdk.trackEvent(eventId, eventParams);
注意事项
- eventId:事件ID,固定为
custom
,无需修改; - eventParams:必须包含
eventName
字段。
# 4、FAQ
问题1:国内海外数据统计接口是否唯一?
回答:数据统计接口为统一接口,国内和海外相同。根据SDK开放平台配置的不同,将会上报数据到不同平台。
问题2:国内数据统计需上报到哪些平台?
回答:目前,数据统计在国内默认只会上报到OSS数据分析平台。
问题3:海外数据统计需上报到那些平台?
回答:目前,数据统计在海外默认只会上报到OSS数据分析平台;如果需要上报至Adjust,需要运营人员在开放平台配置二合一表格,研发人员无需进行额外的接入。
# 5、特别说明
关于上文3.1、流程统计上报,本文做如下特别说明:
SDK及游戏侧需按照《官方H5小游戏日志上报埋点模板》 (opens new window) 或 《第三方渠道日志上报埋点模板》 (opens new window) 完成相应基础日志埋点,其他扩展日志请根据游戏业务需要或运营需求自行定义,本文档不做要求,谢谢!
注意事项
- 事件ID格式为:6 位纯数字 + 英文双冒号 + SDK或GAME + SERVER或CLIENT + 动作或事件标识;如100100::SDK_CLIENT_LAUNCH,表示SDK客户端上报的启动事件;
- 事件ID应确保同一游戏内全局唯一;
- 包含
::SDK_CLIENT
字符的事件由SDK客户端负责上报,如有疑问请联系对接人员:王占伟、丁伟; - 包含
::SDK_SERVER
字符的事件由SDK服务端负责上报,如有疑问请联对接人员:邓泳辉、陈肖军; - 包含
::GAME_CLIENT
字符的事件由游戏客户端负责上报,如有疑问请联系游戏客户端研发相关人员; - 包含
::GAME_SERVER
字符的事件由游戏服务端负责上报,如有疑问请联系游戏服务端研发相关人员。