用户行为分析 JSSDK
用户行为分析 JS-SDK 主要用于前端页面的数据采集,支持移动端和 PC 两种适配方式。
获取和引入 JavaScript SDK
获取和安装
从私有 npm 仓库获取 sdk :
npm install mskj-js-sdk --registy=yourPrivateRegistry
如何使用
通过 npm 获取 sdk 之后,我们就可以开始在代码中引入和使用了:
import MSKJ from 'mskj-js-sdk';
const mskj = new MSKJ({
// 服务器地址
url: '...',
// 项目唯一标识
productid: 'xxxx',
// 用户唯一标识
xwho: "9692043c-7d85-417a-b84e-fd37e1b7a67e",
.......
});
mskj.track({
{
xwhat: "lezhu_search_keyword",
type: "user_behavior",
xcontext: {
lezhu_search_type: "制度库搜索",
lezhu_search_keyword: "年假制度"
}
}
});
参数配置
必填参数
url:用于指定用户分析服务器地址
productid:用于唯一标识 app 项目
可选参数
xwho:用于唯一标识用户,若未传递,则会自动生成唯一标识
limit:用于自定义批量发送的阈值,SDK 在达到该阈值时将自动发送采集数据,默认值为 1
自定义事件追踪
SDK 初始化成功之后,即可以通过mskj.track(event)
,方法来记录事件:
- event:
object
,表示事件的属性
// 追踪关键字查询事件
mskj.track({
{
xwhat: "lezhu_search_keyword",
type: "user_behavior",
xcontext: {
lezhu_search_type: "制度库搜索",
lezhu_search_keyword: "年假制度"
}
}
});
预置属性
获取 SDK 预置属性
mskj.getContext()
该方法可以获取 SDK 中的公共属性,主要包括:productid
、url
、xwho
以及xcontext
,我们的预置属性主要包含于xcontext
字段下。
预置属性列表
字段名称 | 类型 | 说明 | 版本 |
---|---|---|---|
_lib_version | string | sdk 版本 | 无 |
_os | string | 操作系统 | 无 |
_debug | number | 预留字段 | 无 |