小程序SDK集成文档

• 下载地址： wx-mini-sdk.js (右键另存为)

App init参数配置：

基于原生微信小程序

const sdkKit = require('./util/wx-mini-sdk.js') //引入sdkKit
App({
  onLaunch: function () {
    // 初始化采集SDK
    sdkKit.App.init({
      "project_id": "com_H1bIzqK2SZ_project_HyAKaKC5Z", //项目ID
      "token": "2c170b6be6bb15521bd8560a41f8c849" // 项目TOKEN
      "gateway_host": '<collectGateway>', //数据上报的地址
      "api_host": '<api_host>', // 可视化配置时服务端地址
      "app_version": '2.3.0', //应用版本
      "track_share_app": false, // 自动上报转发事件
      "track_pull_down_fresh": false, // 自动上报下拉刷新事件
      "track_reach_bottom": false, // 自动上报上拉触底事件
      "track_auto_duration": true, // 自动上报停留事件
      "debug": false // 是否启用debug
    });
    console.log('App Launch');
  })

基于taro框架微信小程序

//在App.js中初始化
import sdkKit from '../../utils/wx-mini-sdk'
 // 初始化采集SDK
sdkKit.App.init({
  "project_id": "tindex_tvAVNFqC3_project_N2uKB3HAq", //项目ID 
  "token": "c7ee1fee467fb263c0059d6509260465", // 项目TOKEN 
  "gateway_host": 'http://192.168.0.220', //数据上报的地址 
  "api_host": 'http://192.168.0.220:8000', // 可视化配置时服务端地址 
  "app_version": '2.3.0', //应用版本
  "track_share_app": false, // 自动上报转发事件 
  "track_pull_down_fresh": false, // 自动上报下拉刷新事件 
  "track_reach_bottom": false, // 自动上报上拉触底事件 
  "track_auto_duration": true, // 自动上报停留事件
  "debug": true // 是否启用debug });
}); 

class App extends Component { ... }

• ${appid}： 为应用TOKEN。

• ${project_id}： 为项目ID。

上报页面浏览事件：

基于原生微信小程序

// 上报页面浏览记录
 Page({
   onLoad: function () {
     sdkKit.Page.init();
     //支持传入自定义维度 sdkKit.Page.init({key:value});
     console.log('Page onLoad')
   }
 });

基于taro框架微信小程序

import sdkKit from '../../utils/wx-mini-sdk'
//Demo为应用中的某个页面
class Demo extends Component { 
  componentWillMount(){
    sdkKit.Page.init();
     //支持传入自定义维度 sdkKit.Page.init({key:value});
  }
}

用户自定义维度：

自定义事件上报(代码埋点上报)

SDK 初始化成功后，即可以通过 sdkKit.track(event_name, [properties], [callback]) 记录事件：

• event_name: string，必选。表示要追踪的事件名。
• properties: object，可选。表示这个事件的属性。
• callback: function，可选。表示已经发送完数据之后的回调。

1.普通字段上报

  // 追踪点击车辆信息事件
  sdkKit.track('点击车辆车型', {
    'carType': '轿车',
    'carColor': "red",
  });

其中: '点击车辆车型' 为事件名称，'carType' 为自定义维度汽车类型，‘carColor’为自定义维度汽车颜色

2.普通多值列数据上报

  // 点击购买
  sdkKit.track('点击购买', {
    'product_name': '衣服套装',
    'product_price': 20000,
    'product_sizes': ['M','L','XL','XXL']
  });

其中: '点击购买' 为事件名称，'product_name' 为自定义维度商品名称，‘product_price’为自定义维度商品价格，'product_sizes'为自定义维度商品所有尺寸

2.多值列对象数据上报

  // 点击购买
  sdkKit.track('点击购买', {
    'product_name': '衣服套装',
    'product_price': 20000,
    "sugo_multiProps": [
       {"product_title":'T恤',"product_price":'50.5'}, 
       {"product_title":'裤子',"product_price":'30.3'},
     ]
  });

其中: '点击购买' 为事件名称，'product_name' 为自定义维度商品名称，‘product_price’为自定义维度商品价格，'product_title'为自定义维度衣服名称，'product_price'为自定义维度衣服价格，'sugo_multiProps'为固定字段，该字段不用再维度管理中添加，专用于传入多值列对象

数据类型说明

• object: 上面 properties 是 object 类型，但是里面必须是 key: value 格式。

事件公共属性(全局数据上报)：

  // sdkKit.register 提供全局设置为每条上报记录都设置共有属性，在 WxStorage 中永久保存属性，永久有效，如果存在这个属性了则覆盖
  sdkKit.register({
    appid: 'appidValue',
    faceid: 'faceidValue',
    unionid: 'unionidValue',
    ...
  });

sdkKit.register_once(object)

在 WxStorage 中永久保存属性，如果存在这个属性了则不覆盖

删除事件公共属性

  // sdkKit.unregister 删除事件公共属性
  sdkKit.unregister(key);

• key: 事件公共属性key

页面绑定业务属性(在页面停留事件中生效)：

 sdkKit.bindPageInfo({'user_name':'我是张三'});