海心全平台埋点SDK-小程序

介绍

基于 Taro开发，为公司内部小程序项目提供独立的打点SDK。

安装

npm install @aistarfish/event-mini / yarn add @aistarfish/event-mini

使用

1.事件ID获取

具体获取参照 https://shimo.im/sheets/uhbR1dP8Pb0Tzno4/H4iy7，获取过程有任何问题，可直接联系索隆。

2.SDK提供了onEvent、onPageStart、onPageEnd三个打点方法，分别用于事件打点、页面统计。

  /**
   * 事件打点
   * @param  eventId 事件id
   * @param  params 携带参数
   */
  onEvent(eventId = "", params = {}) 

  /**
   * 页面可见的时候调用onPageStart
   */
  onPageStart(eventId) 
  /**
   * 页面不可见的时候调用onPageEnd
   */
  onPageEnd(eventId, params)

页面统计是在页面可见与不可见时调用，在页面的生命周期方法中直接调用。

3.在0.0.7+版本中新增HOC方式进行页面打点。

  @PageEvent(PageEvent.Ruguoai.pageShow)
  export default class extends Component {
    ...
    //若需要设置页面额外参数，则重写此方法，返回参数对象。
    //若不需要则忽略
    setEventParams(){
      return { id: "hxjk" };
    }
    ...
  }

扩展

1.事件统计的参数会默认携带eventDate、userAgent、userId。

userId用做统计当前事件的UV。若不需要统计UV则跳过。 需要手动进行设置setUserId，只需设置一次。若不进行设置，则需要开发人员放入额外参数中。

  /**
   * 存入userId
   * @param {} userId
   */
  setUserId(userId)

2.为了避免线下测试产生脏数据，SDK中提供线下线上两个域名进行打点。

生产：https://gw.aistarfish.com/api/log/upload
测试：https://gateway-d9200.aistarfish.net/api/log/upload

SDK中默认设置isDebug=true为测试环境，发布生产环境，需手动修改isDebug=false，线上需要真机调试。

/**
 * 设置打点开发环境
 * @param {*} b 
 */
 setIsDebug(isDebug)