2020-09-06 18:37:02 +08:00
2020-09-06 18:31:00 +08:00
2020-09-06 18:35:15 +08:00
2020-09-06 18:31:00 +08:00
2020-09-06 18:31:00 +08:00
2019-12-20 00:13:14 +08:00
2020-09-06 18:31:00 +08:00
2020-09-06 18:31:00 +08:00
2020-09-06 18:31:00 +08:00
2020-09-06 18:31:00 +08:00

vue-baidu-analytics 使用说明

基于Vue开发的百度统计插件可以在 Vue-CLI脚手架项目 或者 引入了Vue相关CDN的普通页面 上使用,使用本插件的项目需要引入 Vue Router

注意:本插件在 1.0.0 版本的部分参数和api现在有所弃用请按照当前最新文档说明使用新版本或者安装以前的 1.0.0 旧版本使用。

功能

  • 异步载入百度统计脚本无需修改入口html

  • 支持部署多个站点id并对应进行数据上报

  • 支持自动上报路由切换产生的pv数据支持 hash模式history模式 的地址)

  • 支持手动提交pv上报

  • 支持手动提交事件分析上报

预览

demo已开启debug模式可开启控制台查看上报情况。

点击预览:vue-baidu-analytics demo

参数

参数 是否必填 参数类型 参数说明
router object Vue Router本插件基于路由使用
siteIdList object Array 百度统计的站点id列表item为站点id
只有一个站点需要上报就保留一个item即可
isDebug boolean 是否开启debug模式默认 false
开启后会在控制台打印上报信息,上线前记得关闭

安装

通过npm安装

npm install vue-baidu-analytics --save-dev

通过cdn安装

<script src="https://cdn.jsdelivr.net/npm/vue-baidu-analytics/dist/vue-baidu-analytics.min.js"></script>

使用

通过npm安装的项目需要先在 main.js 里引入插件通过cdn则无需该步骤

import baiduAnalytics from 'vue-baidu-analytics'

安装插件后,在 main.js 引入以下代码,即可开启自动上报功能,首次访问页面会部署统计代码并提交第一次访问数据上报。

后续在路由切换过程中也会根据路由的切换提交相应的url信息到友盟统计。

Vue.use(baiduAnalytics, {
  router: router,
  siteIdList: [
    'aaaaaaaaaaaaaaaaaaa',
    'bbbbbbbbbbbbbbbbbbb',
    'ccccccccccccccccccc'
  ],
  isDebug: false
});

可在开发环境打开debug模式了解相关的上报情况上线前记得关闭debug

方法

插件目前封装了两个常用的api统一挂载到Vue实例上的 $pushBAIDU 去调用。

如果配置了多个站点id会同时上报给所有站点。

手动上报页面PV

api名称 功能说明
pv 手动执行PV数据上报

api参数

参数 是否必填 参数类型 参数说明
pageUrl String 提交上报的url必须是以 / 开头的相对路径
如果不填,则会默认提交为域名根目录

使用示范

在template里使用

<button @click="$pushBAIDU.pv('/test')">手动上报PV</button>

在method里使用

// this是Vue实例
this.$pushBAIDU.pv('/home');

手动上报事件分析

api名称 功能说明
event 手动执行事件分析数据上报

api参数

参数 是否必填 参数类型 参数说明
category string 产生该事件的位置名称,比如 首页banner
action string 产生该事件的行为描述,比如 点击
label string 产生该事件的标签名称可以用来记录事件子id比如 bannerId_123,默认为空
value number 该事件的分值默认0

使用示范

在template里使用比如点击了一个id为123的首页banner

<button @click="$pushBAIDU.event('首页banner', '点击', 'bannerId_123')">手动上报点击事件</button>

在method里使用比如点击了一个id为123的首页banner并设置该事件的价值为1

// this是Vue实例
this.$pushBAIDU.event('首页banner', '点击', 'bannerId_123', 1);
Description
A data collection tool that supports reporting of single-page application data built by Vue 3.0 & 2.0 & VuePress, based on baidu statistics.
Readme MIT 20 MiB
Languages
TypeScript 88.9%
JavaScript 11.1%