微信小游戏 SDK
#2. 使用方法
#2.1 配置 SDK 对象
var entrolysis = require("./entrolysis.mg.wx.js");
var config = {
appId: "YOUR-APPID", // 项目 APP ID,可在熵析数据平台-项目管理-项目配置中查看
serverUrl: "https://api-report-saas-47.entrolysis.com", // 上报地址
enableLog: false // 日志开关
};
// 初始化
entrolysis.init(config);
#2.2 上报数据封装
请注意:无论是事件数据还是账号数据,所上报的属性都应先在 元事件-事件属性、用户属性中添加对应属性。 上报数据会根据所添加的属性进行过滤与数据格式校验
#2.2.1 设置账号id
/* 以下两个方法只设置和清除用户id,不会触发上报事件 */
// 设置用户的登录唯一标识,对应请求里的id
entrolysis.login("ES_001");
// 清除用户的登录唯一标识
entrolysis.logout();
#2.2.2 设置公共参数
// 公共参数为事件属性,此设置适合用来存储不经常变更的参数,例如游戏id
var superValues = {
'game_id':'100'
};
// 设置事件属性
entrolysis.setSuperValues(superValues);
// 使用track上传事件,此时事件中会带有事件属性
entrolysis.track({
eventName: 'account_login',
properties: {
vipLevel: 999,
role_lv: 888,
}, // 需要上传的事件属性
});
/* 等价于在事件中加入这些属性
entrolysis.track(
eventName:'account_login', // 追踪事件的名称
properties:{
vipLevel: 999,
role_lv: 888
game_id:'10001' // 相当于在事件中加入这个属性
}
);
*/
// 清除所有公共参数
entrolysis.clearSuperValues()
// 清除特定公共参数
entrolysis.unsetSuperValues('game_id')
#2.2.3 事件数据上报
请注意:无论是事件数据还是账号数据,所上报的属性都应先在 元事件-事件属性、用户属性中添加对应属性。 上报数据会根据所添加的属性进行过滤与数据格式校验
entrolysis.track({
eventName: "event_name", // 事件名称
properties: {
city: 'Shanghai',
country: 'China'
},
});
参数名 | 参数描述 |
---|---|
eventName | 事件名称 |
properties | 事件的属性值 |
#2.2.4 用户数据上报
// 设置用户属性,会根据login接口设置的用户id来自动判断要新增或者修改用户属性
entrolysis.userAddOrUpdate({
properties: {
"age": 20,
"phone": "17777777777"
}
});
参数名 | 参数描述 |
---|---|
properties | 用户的属性值 |