QuickTracking 快应用SDK集成文档

引入 SDK

1.登录QuickTracking平台，进入管理控制台--采集信息--小程序SDK信息

将qt_quickapp.js文件放入项目对应目录下（示例：以src/assets/js 为例）

在应用入口文件app.ux文件中添加

// 添加在 app.ux 头部
import qt from './assets/js/qt_quickapp.js';

2.配置SDK参数

引入SDK后，调用setParams进行SDK的初始化配置

// 添加在 app.ux 头部
import qt from './assets/js/qt_quickapp.js';
qt.setParams({
  /************   必选字段   *************/
  appKey: '当前应用的appKey', 
  trackDomain: '当前应用的收数域名',
  /************   可选字段   *************/
  showLog: true, //是否展示SDK日志 true展示 false关闭
  userId: 'test_user', //用户账号，也可通过调用login接口配置
  globalproperty: {  //事件的全局属性
    a:1,
    b:2
  }
});

初始化SDK

在完成SDK的参数配置之后，通过调用init方法来初始化SDK。

//app.ux 文件的onCreate方法
export default {
  onCreate(options) {
    // SDK初始化调用
    qt.init(); //将qt注册在全局
  }
}

添加埋点

1.应用启动埋点

//app.ux 文件中的onCreate方法中调用qt.appLaunch()方法
export default {
  onCreate(options) {
    qt.init();
    qt.appLaunch(options);
  },
  ...
}

2.应用退出埋点

//app.ux 文件中的onHide方法中调用qt.appHide()方法
export default {
	onHide() {
    qt.appHide();
  }
}

3.页面浏览事件埋点

事件属性对象：该字段代表事件的自定义参数，其取值为一个JSON对象（平铺的简单对象，不能多层嵌套），参数取值支持JavaScript值类型中string、number 、boolean，如果取值为空，传值""即可，数据端同学统一处理

示例：

//测试页面 pages/TestPage/index.ux
export default {
  ...
  onShow() {
    qt.sendPageStart({
      page_name: 'test_page', //预制字段（可选）页面编码
      page_title: '页面title', //预制字段（可选）页面title
      param1: 'xxx',
      param2: 'xxx'
    });
  }
	...
}

4.事件埋点

事件编码：该字段为在Quicktracking管理平台注册的点击、曝光、其他等自定义事件的事件编码，仅支持英文字符串格式，最长支持128位字符串

事件属性对象：该字段代表事件的自定义参数，其取值为一个JSON对象（平铺的简单对象，不能多层嵌套），参数取值支持JavaScript值类型中string、number 、boolean，如果取值为空，传值""即可，数据端同学统一处理

示例：

//测试页面 pages/TestPage/index.ux
export default {
  ...
  onTestButtonClick() {
  	qt.sendEvent('test_clk', {
      page_name: 'test_page', //预制字段（可选）页面编码
      page_title: '页面title', //预制字段（可选）页面title
      param1: 'xxx',
      param2: 'xxx'
    });
  }
	...
}

设置全局属性

//方式1
qt.setGlobalProperty({
  param1: '1111',
  param2: 2222,
  param3: true
});

//方式2
qt.setParams({
	....
  globalproperty: {
    param1: '1111',
    param2: 2222,
    param3: true
  }
});

上述调用后 globalproperty 为：{ param1: '1111', param2: 2222, param3: true }

qt.appendGlobalProperty({
  param4: '4444',
  param5: 55555
});

上述调用后 globalproperty 为：

{ param1: '1111', param2: 2222, param3: true, param4: '4444', param5: 55555 }

设置用户账号

qt.login('用户账号ID') //上报用户账号，并缓存

qt.logoff() //清空用户账号缓存

用户属性上报

注：上报用户属性之前，需要先上报用户账号

qt.sendUserProfile({
  name: '张三',
  age: '25',
  level: 'vip3'
});

采集多种ID类型

注：请确保下述每一个ID的key书写正确

qt.setIds({
  openId: 'xxxx',
  unionid: 'xxxxx',
  androidId: 'xxxxx',
  advertisingId: 'xxxxx',
  phonenumber: 'xxxxx',
  mac: 'xxxxx',
  oaid: 'xxxxx',
  serial: 'xxxxx',
  deviceId: 'xxxxx'
});

上述各ID字段的含义请参考快应用官方文档

https://doc.quickapp.cn/features/service/account.html?h=openid

https://doc.quickapp.cn/features/system/device.html?h=deviceId

查看SDK日志

SDK参数配置showLog为true

qt.setParams({
  ...
  showLog: true
})

埋点验证

开发者在完成埋点功能之后，可通过QuickTracking平台的埋点验证功能对已有埋点进行验证，首先获得log_xxxx形式的debugId，并将其添加到SDK配置参数用以开启埋点验证模式下的日志上报

// 添加在 app.ux 头部
import qt from './assets/js/qt_quickapp.js';
qt.setParams({
  ...
  debugId: 'log_xxxxxxxx', //用于埋点验证使用
  ....
});

备注：事件编码、事件属性key、页面编码、页面title长度限制

​

​

​