report-sdk
v1.0.16
Published
report SDK for H5
Downloads
23
Readme
report-sdk
Report SDK for the H5
Browser Support
| 
| 
| 
| 
| 
|
--- | --- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |
Installing
Using npm:
$ npm install report-sdkSDK使用说明
SDK引入
1、单页面（SPA）应用引入，以vue应用为例：
// 入口 main.js 中引入
import './report-sdk.js'
// 挂载到 vue 实例上
Vue.prototype.$SDK = $SDK
// 具体页面中使用
以 `this.$SDK.xxx` 的形式调用上报方法
2、传统的html多页面应用引入
注意：SDK必须先引入，再使用，顺序不能颠倒。最好在onload或者ready之后调用SDK的具体方法。
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>主页</title>
</head>
<body>
<h1>主页</h1>
<script src="./report-sdk.js"></script>
<script>
$SDK.sendPageEvent({
event_id: 'xxxxxx',
})
</script>
</body>
</html>
实例方法
1、页面浏览事件
$SDK.sendPageEvent({
event_id: 'xxxxxx',
data: { // 业务参数
//
},
})
// or 在vue中
this.$SDK.sendPageEvent({
event_id: 'xxxxxx',
data: { // 业务参数
//
}
})
// 没有业务参数，data 参数可省略 2、用户操作事件（点击）
/*
* 预留方法，暂勿使用
* */
$SDK.sendCommonEvent({
event_id: 'xxxxxx',
data: { // 业务参数
//
},
})
// 没有业务参数，data 参数可省略 2、用户信息参数，在登录或者授权，拿到相关信息之后调用
$SDK.setUserInfo({
userId: 'xxx',
openId: 'xxx',
unionId: 'xxx',
})
// 如果其中有参数未获取到，则传空字符串3、beforeInit 方法，在页面不刷新的情况下，SDK上报方法之前调用
$SDK.beforeInit({
envType: 'dev' // 测试开发环境 dev 正式环境 prod
})License
MIT