mirror of
https://github.com/1621740748/vue-ba.git
synced 2025-04-05 19:41:58 +08:00
120 lines
4.1 KiB
Markdown
120 lines
4.1 KiB
Markdown
# vue-ba
|
||
|
||
> vuejs 百度统计埋点插件
|
||
>
|
||
> 项目参考：https://github.com/raychenfj/vue-uweb
|
||
|
||
## 项目地址
|
||
|
||
https://github.com/minlingchao1/vue-ba
|
||
|
||
## 1. 安装
|
||
|
||
```
|
||
npm install vue-ba --save
|
||
|
||
```
|
||
直接在页面中引用
|
||
```
|
||
<script src="./node_modules/vue-uweb/dist/index.js"><script>
|
||
```
|
||
|
||
或者通过es6模块加载
|
||
|
||
```
|
||
import ba from 'vue-ba'
|
||
|
||
```
|
||
使用vue-ba插件
|
||
|
||
```
|
||
Vue.use(ba, 'YOUR_SITEID_HERE')
|
||
|
||
```
|
||
通过传递 options 参数进行更多设置
|
||
|
||
```
|
||
Vue.use(uweb,options)
|
||
|
||
```
|
||
#### options
|
||
|
||
<table><tr><td>参数</td><td>必须</td><td>默认</td><td>说明</td><td>备注</td></tr><tr><td>siteId</td><td>是</td><td></td><td>绑定要接受API请求的统计代码</td><td></td></tr><tr><td> debug </td><td>否</td><td>false</td><td>调试模式下将在控制台中输出调用window._hmt时传递的参数</td><td>请不要在生产环境中使用，避免造成安全隐患</td></tr><tr><td> src </td><td>否</td><td>https://hm.baidu.com/hm.js?SITEID</td><td>指定统计脚本标签的 src 属性</td><td></td></tr></table>
|
||
|
||
## 2. ba API
|
||
|
||
### 2.1 trackEvent
|
||
|
||
用于发送页面上按钮等交互元素被触发时的事件统计请求。
|
||
|
||
#### 用法
|
||
|
||
```
|
||
this.$ba.trackEvent(category,action,opt_label,opt_value)
|
||
```
|
||
|
||
#### 参数
|
||
|
||
<table><tr><td>参数</td><td>必须</td><td>类型</td><td>说明</td></tr><tr><td> category </td><td>是</td><td> string </td><td>表示事件发生在谁身上</td></tr>
|
||
<tr><td> action </td><td>是</td><td> string </td><td>表示访客跟元素交互的行为动作</td></tr><tr><td> opt_label </td><td>否</td><td> string </td><td>用于更详细的描述事件</td></tr><tr><td> opt_value </td><td>否</td><td> int </td><td>用于填写打分型事件的分值，加载时间型事件的时长，如果填写为其他形式，系统将按0处理。若填写为浮点小数，系统会自动取整，去掉小数点。</td></tr></table>
|
||
|
||
### 2.2 trackPageview
|
||
|
||
用于发送某个URL的PV统计请求，适用于统计AJAX、异步加载页面，友情链接，下载链接的流量
|
||
|
||
#### 用法
|
||
|
||
```
|
||
this.$ba.trackPageview(pageURL)
|
||
|
||
```
|
||
|
||
#### 参数
|
||
|
||
<table><tr><td>参数</td><td>必须</td><td>类型</td><td>说明</td></tr><tr><td>pageURL </td><td>是</td><td> string </td><td>自定义虚拟PV页面的URL地址，填写以斜杠‘/’开头的相对路径，系统会自动补全域名</td></tr></table>
|
||
|
||
## 3. ba 指令
|
||
|
||
vue-ba 提供 track-event，track-pageview 两个指令，开发者可以直接在 html 模版中使用来统计网站数据
|
||
|
||
### 3.1 track-event
|
||
|
||
使用指令 v-track-event 监听事件， 通过 modifiers 指定事件类型，将自动为绑定元素添加事件监听，当事件触发调用统计代码。 如不指定事件，默认监听 click 事件。
|
||
|
||
可通过逗号分隔的字符串或对象字面量传递参数，以字符串传递时请注意参数顺序，可参考trackEvent API。
|
||
|
||
统计自定义事件使用 v-track-event.someEvent:custom
|
||
|
||
#### 用法
|
||
|
||
```
|
||
<button v-track-event.click="'category, action''"></button> // 统计click事件
|
||
|
||
<button v-track-event="'category, action'"></button> // 统计click事件简写
|
||
|
||
<input v-track-event.keypress="'category, action'"> // 统计keypress事件
|
||
|
||
<input v-track-event.someEvent:custom="'category, action'"> // 统计someEvent事件,someEvent是自定义事件
|
||
|
||
<button v-track-event="'category, action, opt_label, opt_value'"><button> // 以字符串传递参数
|
||
|
||
<button v-track-event="{category:'event', action:'click'}"></button> // 以对象字面量传递参数
|
||
```
|
||
|
||
### 3.2 track-pageview
|
||
|
||
使用指令 track-pageview 统计虚拟 PV ，一般可以配合 v-show 或 v-if 来统计局部动态视图的 PV。
|
||
|
||
可通过逗号分隔的字符串或对象字面量传递参数，以字符串传递时请注意参数顺序，可参考trackPageview API
|
||
用法
|
||
|
||
```
|
||
<div v-show="show" v-track-pageview="'/bar'">bar</div> // 跟踪 v-show 绑定元素的虚拟pv
|
||
|
||
<div v-if="show" v-track-pageview="'/foo'">foo</div> // 跟踪 v-if 绑定元素的虚拟pv
|
||
|
||
<div v-track-pageview="'/tar'"></div> // 以字符串指定受访页面和来源
|
||
|
||
<div v-track-pageview="{pageURL:'/zoo''}"></div> // 以对象字面量指定受访页面和来源
|
||
```
|