埋点SDK 使用说明

版本 v1.0.0

安装sdk

1. 安装

  yarn add ideamake-buried-point

使用sdk

1. 引入

  import { IdeamakeBuriedPoint } from 'ideamake-buried-point'

初始化

1. 初始化

  /**
  * @description 初始化埋点
  * @param {String} websocketUrl websocket地址【可选】
  * @param {String} userId 用户的id【必传】
  */
const ideamakeBuriedPoint = new IdeamakeBuriedPoint({websocketUrl: 'wss://...', userId: '12345678910'})

注册

1. uniapp打包生成的app

  /**
  * @description 注册uniapp生成的app
  * @param {Function} success 注册成功【可选】
  * @param {Function} fail 注册成功【可选】
  * @param {Object} data 基础参数【必传】
  * @param {String ｜ number} android_id 安卓id【可选】
  * @param {String} app_version 安卓版本号【可选】
  * @param {String} packgename app包名【可选】
  */
  ideamakeBuriedPoint.initUniApp({
    success() {}
    fail() {}
    data: { android_id, app_version, packgename }
  })

2. uniapp生成的小程序

  /**
  * @description 注册uniapp生成的小程序
  * @param {Function} success 注册成功【可选】
  * @param {Function} fail 注册成功【可选】
  * @param {Object} data 基础参数【必传】
  * @param {String} language 语言,zh-cn、zh、en-us、其他【可选】
  */
  ideamakeBuriedPoint.initUniMiniprogram({
    data: { language  }, success() {}, fail() {}
  })

3. uniapp生成的web

  /**
  * @description 注册uniapp生成的web
  * @param {Function} success 注册成功【可选】
  * @param {Function} fail 注册成功【可选】
  * @param {Object} data 基础参数【必传】
  * @param {String} language 语言,zh-cn、zh、en-us、其他【可选】
  */
  ideamakeBuriedPoint.initWeb({
    data: { language  }, success() {}, fail() {}
  })

4. 原生小程序

  /**
  * @description 注册原生小程序
  * @param {Function} success 注册成功【可选】
  * @param {Function} fail 注册成功【可选】
  * @param {Object} data 基础参数【必传】
  * @param {String} language 语言,zh-cn、zh、en-us、其他【可选】
  */
  ideamakeBuriedPoint.initNativeMiniprogram({
    data: { language  }, success() {}, fail() {}
  })

5. react/vue等开发的web

  /**
  * @description 注册uniapp生成的web
  * @param {Function} success 注册成功【可选】
  * @param {Function} fail 注册成功【可选】
  * @param {Object} data 基础参数【必传】
  * @param {String} language 语言,zh-cn、zh、en-us、其他【可选】
  */
  ideamakeBuriedPoint.initWeb({
    data: { language  }, success() {}, fail() {}
  })

使用

1. buriedPoint

  /**
  * @description 注册uniapp生成的web
  * @param {Object} data 基础参数【必传】
  * @param {Object} business 业务参数【必传】
  * @param {Object} id 事件id【必传】
  * @param {Object} event 事件参数【必传】
  * @param {String} type 事件类型： clickEvent：点击 pageEvent：曝光 routerEvent：跳转
  */
  ideamakeBuriedPoint.buriedPoint({
    data: {event = {}, business = {}, id = ''}, type
  })