Aplus 使用

Monitor aplus 是 基于 aplus_queue 的封装,主要目的:

• 简化步骤: 只需要init即可初始化
• 提高开发效率: 一行代码,即可完成对应的埋点上报
• 提升开发者体验: 静态函数直接调用,支持ts类型提示
• 优化代码质量: 代码干净整洁,内部处理错误, init 初始化完成之前, 内部队列记录埋点数据,保证数据不丢失

aplus_queue可以看湘涛的文档- Quick Tracking 埋点接入指南

基础用法

和同事沟通调查, 暴露 init, page,click三个静态方法,方便快捷调用

依赖

pnpm add @mid-vue/monitor

1. 导入

import { Aplus } from '@mid-vue/monitor'

2. 初始化实例

Aplus.init({
  appKey: import.meta.env.VITE_APLUS_APPKEY,
  host: import.meta.env.VITE_APLUS_HOST,
})

3. 手动埋点使用

// 页面事件
Aplus.page({
  page_title: '注册页面浏览',
  page_name: 'register',
  // 如果您设置了duration参数
  duration: 1111111,
  //自定义事件属性
  x: 111,
  y: 222,
})

// 点击事件
// 第一个参数是 事件编码
Aplus.click('register-submit', {
  name: 'text', //自定义属性
  phone: '1234555666', //自定义属性
  page_name: 'demoPageName', //事件这里 的页面编码非必填
})

其他实例函数

保留aplus_queue 内部支持的所有方法,而且拓展更便捷方便

追加全局属性(appendMetaInfo)

// 数组传参
Aplus.instance.appendMetaInfo(['globalproperty', { a: 1 }])
// 对象传参
Aplus.instance.appendMetaInfo({
  metaName: 'globalproperty',
  metaValue: { a: 1 },
})

覆盖全局属性(setMetaInfo)

// 数组传参
Aplus.instance.setMetaInfo(['globalproperty', { a: 1 }])
// 对象传参
Aplus.instance.setMetaInfo({
  metaName: 'globalproperty',
  metaValue: { a: 1 },
})

获取全局属性(getMetaInfo)

Aplus.instance.getMetaInfo('globalproperty')

页面日志(sendPV)

// 数组传参
Aplus.instance.sendPV([
  {
    is_auto: false,
  },
  { page_title: '首页', page_name: 'yourCurrentPageName' },
])

// 对象传参
Aplus.instance.sendPV({
  pageEventConfig: {
    is_auto: false,
  },
  userData: { page_title: '首页', page_name: 'yourCurrentPageName' },
})

事件日志(record)

// 数组传参
Aplus.instance.record(['事件编码', 'CLK', { a: 1, page_name: 'yourCurrentPageName' }])

// 对象传参
Aplus.instance.record({
  eventCode: '事件编码',
  eventType: 'CLK', // CLK,OTHER 之类的
  eventParams: {
    a: 1,
    page_name: 'yourCurrentPageName', //页面参数
  },
})