bpnpm v2.0.0

使用指南：

适用平台：uniapp 版的微信小程序 使用前提：属性神策数据微信小程序 SDK 的基本使用，参考：https://manual.sensorsdata.cn/sa/latest/sdk-67567625.html 开发目的：做一款符合自己公司业务的埋点 SDK，可以引入到各个项目，减少重复开发量

• 本插件基于神策小程序 SDK 开发做了 1 个修改， 1 个自定义功能，并做了 2 个组件，其他按照神策配置使用即可。

  • 修改：将 sensor 换成 bp 即可 如：

  import bp from 'bpnpm'
  // 配置初始化参数
  bp.setPara()

  • 配置功能：bp.setRequestList(config:object) :-----请求配置,拦截配置中的请求，并上报相关数据 | 参数 | 类型 | 说明 | | -------------- | -------- | ----------------------------------------------------------------------------------------------- | | eventType | String | 事件 CODE | | uri | String | 请求 api 地址 | | turnData | Function | 发送的数据。第一个参数为 res-请求返回结构,第二个参数为 params-请求参数。需要返回想要发送的 data | | pass | Function | 是否上报。第一个参数为 params-请求参数。需要返回 Boolean |

    例如：
    //只上报 params 中有 type 的情况
    {
    event_type: 1200,
    url: '/st/faq/api/v1',
    pass: (params) => {
      return params.type ? true : false
    },
    turnData: (res, params) => ({
      value: params.type,
    }),
    },

  返回为 even_type: 1200,data:{value:params.type}

  • 组件：参考下方-组件的使用

基本配置

• 参考：https://manual.sensorsdata.cn/sa/latest/sdk-api-81297493.html

组件的使用

• import BpVideo from 'bpnpm/components/bp-video.vue' ----- 导入组件

• bp-video 组件

  • props:

  参数	类型	说明
  src	String	视频地址
  shareId	String	分享人 ID
  fileId	String	文件 ID
  fileName	String	文件名称
  showProgress	Boolean	是否显示进度条

  • event:

  事件名	返回类型	说明
  buryPoint	object	第一个参数为上报的 data 数据

• bp-image 组件

  • props:

  参数	类型	说明
  src	String	图片地址
  shareId	String	分享人 ID
  fileId	String	文件 ID
  imageId	String	图片 ID
  page	Number	页数
  totalPage	Number	总页数

  • event:

  事件名	返回类型	说明
  buryPoint	object	第一个参数为上报的 data 数据

数据格式

预置事件

参考：https://manual.sensorsdata.cn/sa/latest/sdk-34537695.html

预置属性

• 参考：https://manual.sensorsdata.cn/sa/latest/sdk-34537695.html

• 变更的预置属性说明

因为点击事件广泛且数据结构多种多样，应该设为自定义事件，但是已经有预置属性来表示了，所以将这些预置属性映射对上自定义的属性，由后台统一转换，如：$element_type 转换成了 event_type

自定义事件

自定义属性

• 除 event_type,data 属性外其余均需要调用 bp.registerApp()设置所有事件都有的自定义属性
• data 下的属性查看 apifox 的 data 自定义属性下对应 code 的属性

注意事项

• onShareAppMessage() 不要写成异步，不然没有被分享人打开时没有分享的相关数据
• onClick 绑定点击埋点事件需要触发方法且要在原生组件上