cloudtrek-radar-wxapp-sdk

4.0.11 • Public • Published

云启雷达上报SDK开发文档(v4.0)

更新时间: 2021-07-26

使用步骤

一、安装SDK

1、npm安装

  1. 在小程序package.json目录下执行命令安装sdk。
npm i cloudtrek-radar-wxapp-sdk --save
  1. 点击开发者工具中的菜单栏:工具 --> 构建 npm。

  2. 勾选“使用 npm 模块”选项。

2、本地文件引入

云启SDK下载地址:https://arch-1255455723.cos.ap-guangzhou.myqcloud.com/SDK/cloudtrek_radar_sdk4.0.min.js

二、引用SDK

1、npm引用

在app.js 中引入sdk。

import { cloudtrek } from 'cloudtrek-radar-wxapp-sdk';

2、本地文件引入

在app.js 中引入下载的压缩文件。

const cloudtrek = require('./libs/cloudtrek_radar_sdk4.0.min')

npm引用和本地文件引入二选一引入即可

3、初始化

// 初始化
cloudtrek.init({
  url: 'https://arch-st.c2star.com', // 请求host域名
  origin: 'yunqi',  // 当前小程序name简称
});
App({
  ...,
  cloudtrek  // 全局注册cloudtrek, 后续通过此实例方法上报事件
})

三、SDK方法

1、init(config)

  • 定义:SDK初始化配置方法;
  • config 的完整配置如下:
参数名 类型 是否必填 默认值 说明
url string 'https://arch-st.c2star.com' 请求host地址
baseUrl string api/v3/radar/collect 请求base链接
origin string appid 数据来源标识([0-9a-z.]{4,16}), 小程序名称英文简写
appid string '' 小程序appid
customer string - - 顾客唯一标识(unionid),有则必传
openid string - - 顾客微信openid,有则必传
guider string - 导购/店员唯一标识(导购qy_user_id)
debug boolean true 是否开启调试
system boolean true 是否收集设备信息
scene number '' 小程序进入场景值
sdkBusinessFields array [] 业务追踪参数字段集合
autoPageRadar Object - 页面采集配置
useOutAutoReport Boolean false 是否禁止sdk自动pv采集
  • 示例
// app.js文件

 cloudtrek.init({
   debug: false,
   url: 'https://arch-st.c2star.com', // 请求host域名
   origin: 'yunqi',  // 当前小程序name简称
 });

2、trace(config)

  • 定义:公共参数追加事件方法

  • 调用场景:参数值是异步获取或是变量获取的参数值,可以通过此方法追加到所有事件的公共参数中。

  • config 配置参数说明:

参数名 类型 是否必填 默认值 说明
customer string - 顾客唯一标识(unionid),有则必传
openid string - 顾客微信openid,有则必传
guider string - 导购/店员唯一标识(导购qy_user_id)
... ... ... ... ...
  • 示例场景:1、小程序登录成功后才可拿到用户的unionid,openid。2、导购id是通过外部传入获取的。则可通过以下方式处理:
  getApp().cloudtrek.trace({
    customer: 'asdsadrqwew12321321wqe',
    openid: 'arrewfd214324322334',
    guider: 'wginit'
  });

3、collect(params)

  • 定义:系统事件上报方法;

  • 需要上报的系统事件:参考云启系统事件上报事件定义表

  • 事件表中的页面部分的事件:view_page、exit_page、share_page事件SDK会自动收集上报,开发者无需再上报

  • 其中商品模块中的share_goods 和share_goodsposter 为用户端(个人微信端)场景上报, send_goods 和send_goodsposter 为导购端(企业微信端)场景上报,开发者可通过wx.getSystemInfoSync() 来判断当前的运行环境。

  • params参数说明

参数名 类型 是否必填 默认值 说明
event string - 事件名称
resource array [] 事件相关资源唯一标识数组。 例如: 商品ID
extra object {} 扩展字段
isStandardEvent boolean false 是否标记为云启系统事件
  • 上报示例:
// 进入商品详情页上报view_goods事件
getApp().cloudtrek.collect({
  event: 'view_goods', // 事件名称
  resource: ['1232'], // 商品ID(模号)
  extra: {
    room_id: '32432',
    share_openid: '32432'
  }
})

// 在支付成功回调里上报pay_oder事件
getApp().cloudtrek.collect({
  event: 'pay_order', // 事件名称
  resource: ['412325454543432432432'], // 订单号
  extra: {
    goods: ['213421', '21321', '214213'],
    skus: [{
      id: '324',
      amount: 2,
      price: 32132
    }],
    order_type: 0,
    total_fee: 23432
  }
})

4、getRadarParam

  • 定义:查看当前完整上报参数
  • 例子:
const reportParams = getApp().cloudtrek.getRadarParam()
console.log(reportParams)

查看当前SDK版本:cloudtrek.version

四、版本升级

  • 如何从v3.0 升级到 v4.0?

1、安装

  • 下载v4.0 的sdk,替换掉之前v3.0 的sdk;

2、引用sdk

  • 1、之前的引用方式不变。
  • 2、在小程序项目的app.js中需要删除以下代码:
//app.js 旧的pv埋点方式
(function () {
  let _page = Page
  Page = function (ob) {
    let onshow = ob['onShow'] || (() => {})
    ob.onShow = function () {
      if (getApp().cloudtrek) {
        getApp().cloudtrek.viewPage()
      }
      var arg1 = [].slice.call(arguments)
      onshow.call(this, arg1[0])
    }

    ...

    let onunload = ob['onUnload'] || (() => {})
    ob.onUnload = function () {
      if (getApp().cloudtrek) {
        getApp().cloudtrek.exitPage()
      }
      var arg3 = [].slice.call(arguments)
      onunload.call(this, arg3[0])
    }
    _page(ob)
  }
})()

3、替换完成

Package Sidebar

Install

npm i cloudtrek-radar-wxapp-sdk

Weekly Downloads

1

Version

4.0.11

License

ISC

Unpacked Size

19.6 kB

Total Files

4

Last publish

Collaborators

  • wginit