# 自定义事件上报
# 接口说明
用于上报相关自定义事件;自定义事件名称格式、参数无固定格式,请根据下文参数说明,结合游戏业务需要或运营需求自行上报。
sdkInstance.analytics.event(params, callback?);
# 参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
params | object | 是 | -- | -- |
params.accountId | number | 是 | -- | 账号ID(账号唯一标识) |
params.areaId | string / number | 否 | 1 | 游戏大区ID,若游戏无大区概念,可不填,默认值为 1 ,表示初始大区编号 |
params.roleId | string / number | 否 | 同 accountId | 角色ID,若游戏无角色概念,可不填,默认值同 accountId 账号ID |
params.eventName | string | 是 | -- | 自定义事件名称,请使用英文单词命名,如 levelUp 、joinCorp |
params.eventObj | string | 否 | -- | 事件操作对象,例如按钮点击事件,可填对应按钮ID标识 |
params.eventResult | string | 否 | -- | 事件操作结果,例如按钮点击事件,可填按钮点击结果(例如点击按钮跳转至另一个页面,可填目标页面ID标识) |
params.eventCode | string | 否 | -- | 事件操作原因 code 码 |
params.statMode | string | 否 | 1 | 数据统计方式
|
params.extendParamJson | string | 否 | -- | 数据扩展参数,格式为 JSON 字符串,如:JSON.stringify({ kills: 0, deaths: 0, assistant: 0 }) ;参数最多 20 个 |
callback | function | 否 | -- | 数据上报完成时的回调函数 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdkInstance.analytics.event({
accountId: sdkInstance.userInfo.accountId,
areaId: 1001, // 游戏大区ID,若游戏无大区概念,可不填,默认值为 1,表示初始大区编号
roleId: "123456", // 角色ID,若游戏无角色概念,可不填,默认值同 accountId 账号ID
eventName: "levelUp",
eventObj: "",
eventResult: "",
eventCode: "",
statMode: "1",
extendParamJson: JSON.stringify({ kills: 0, deaths: 0, assistant: 0 })
}, function(params) {
console.log(params);
});