SDK API 接口说明

setPara(options: object)

提示

• setPara 配置接口，用来调整 SDK 的基础机制。应该在 App()调用之前调用。
• 首次调用初始化 SDK，再次调用覆盖之前传入的配置，可多次调用。

名称	类型	必填	描述
appid	string	Y	微信小程序 appId
app_name	string	Y	微信小程序名称
server_url	string	Y	您的数据接收地址
app_version	string	N	微信小程序版本号
autoTrack	object	N	全埋点控制开关（相关预置事件，如 APP-onLuanch 或 page-onShow），默认是：全部开启
show_log	bool	N	是否打印日志，默认是：true
batch_send	bool或object	N	是否把收集好的数据发送请求到服务端，默认是：true
actionEventData	array	N	点击事件配置表，详情请前往 点击事件配置表 指引
interval_timeout	number	N	发送数据时间间隔，默认是：300000 5 分钟 单位毫秒

---

initTrack(options: object)

提示

• initTrack 方法接口入参： 原生小程序开发可以不传任何参数，直接调用即可。
• 使用 Taro 和 mpvue 框架需要传入当前框架的实例进来。

名称	类型	必填	描述
taro	object	N	使用 Taro 框架传入 Taro 实例
vue	object	N	使用 mpvue 框架传入 Vue 实例

setUserInfo(options: object)

提示

• 当用户注册成功或者登录成功后，需要调用 setUserInfo() 方法传入登录的信息
• 再次调用覆盖之前传入的配置，可多次调用。

名称	类型	必填	描述
user_id	string	Y	用户 ID
avatar	string	N	用户头像
name	string	N	用户昵称
gender	number	N	用户性别
country	string	N	国家
province	string	N	省
city	string	N	市
tid	string	Y	机构 ID (要获取联系凡泰技术人员)
app_type	string	Y	用户类型 RETAIL 代表零售 STAFF 代表员工

setDeviceId(arguments)

提示

• 在微信小程序平台可以理解为是 openId, 通过 wx.login 获取 openid 后，调用 setDeviceId() 方法传入 openId
• 再次调用覆盖之前传入的配置，可多次调用。

名称	类型	必填	描述
arguments	string	Y	设备 ID

quick(arguments)

• quick 接口定义 快速重新自定义某些事件以及属性。
• 在业务开发中，SDK 自动收集的预置事件以及属性，并不能完全满足需求，开发者就可以调用此 API 来做到精细化数据。
• arguments 总共可以传入 4 条参数，下面各自参数详细说明。

提示

• 可以简单理解第一个参数就是 事件类型

第一个参数的合法值

名称	类型	必填	描述
appLaunch	string	Y	重新定义小程序应用启动事件
appHide	string	Y	重新定义小程序应用关闭事件
pageLoad	string	Y	重新定义小程序页面启动事件
pageHide	string	Y	重新定义小程序页面关闭事件
pageUnload	string	Y	重新定义小程序页面关闭事件
pageAction	string	Y	重新定义小程序点击事件
custom	string	Y	完全由开发者自定义事件

第二／三／四的参数说明

• 如果第一个参数是 'appLaunch || pageLoad ', 第二个参数必须传入为该生命周期回调函数的参数, 第三个参数传入 props, 具体的行为数据。

• 代码示例

  onLaunch: function(options) {
    fcTrack.quick('appLaunch', options, {
      test: 'test',
      name: 'fc',
    });
  },
  onLoad: function(options) {
    fcTrack.quick('pageLoad', options, {
      test: 'test',
      name: 'fc',
    });
  }

• 如果第一个参数是 'appHide || pageHide || pageUnload', 第二个参数传入 props, 具体的行为数据，第三／四参数无需传入。
• 代码示例

 onHide: function() {
    // appHide  pageHide  pageUnload 都可以传入到第一个参数
    fcTrack.quick('appHide', {
      test: 'test',
      name: 'fc',
      id: '666'
    });
  },

• 如果第一个参数是 'custom', 第二个参数传入自定义的事件名称，第三个参数传入 props, 具体的行为数据。
• 代码示例

fcTrack.quick('custom', 'testCustom', {
  msg: '自定义看看',
  succ: true,
});

• 如果第一个参数是 'pageAction', 第二个参数传入事件的 event, 第三个参数传入点击的事件名称，第四个参数传入 props, 具体的行为数据。
• 代码示例

  handleProduct: function(event) {
    fcTrack.quick('pageAction', event, 'clickTest', {
      test: 'test',
      name: 'hhh',
      age: 100,
      id: '666'
    });
  },

beforeEach(fn: Function<data ⇒ data>)

fn 在数据采集各个预置事件之前时会触发。这个函数允许在各个预置事件之前时对数据做一些改造。

提示

• 可以简单理解就和 Vue 的全局路由拦截器，在路由加载之前触发

• 代码示例

fcTrack.beforeEach((data) => {
  return {
    mid: 'M00000',
    test: 'beforeEach',
  };
});

beforeEnterApp(fn: Function<data ⇒ data>)

fn 在数据采集预置事件 enter_app 之前时会触发。这个函数允许在预置事件 enter_app 之前时对数据做一些改造。

• 代码示例

fcTrack.beforeEnterApp((data) => {
  return {
    test: 'beforeEnterApp',
  };
});

beforeLeaveApp(fn: Function<data ⇒ data>)

fn 在数据采集预置事件 leave_app 之前时会触发。这个函数允许在预置事件 leave_app 之前时对数据做一些改造。

• 代码示例

fcTrack.beforeLeaveApp((data) => {
  return {
    test: 'beforeLeaveApp',
  };
});

beforeEnterPage(fn: Function<data ⇒ data>)

fn 在数据采集预置事件 enter_page 之前时会触发。这个函数允许在预置事件 enter_page 之前时对数据做一些改造。

• 代码示例

fcTrack.beforeEnterPage((data) => {
  return {
    test: 'beforeEnterPage',
  };
});

beforeLeavePage(fn: Function<data ⇒ data>)

fn 在数据采集预置事件 leave_page 之前时会触发。这个函数允许在预置事件 leave_page 之前时对数据做一些改造。

• 代码示例

fcTrack.beforeLeavePage((data) => {
  return {
    test: 'beforeLeavePage',
  };
});

beforeSharePage(fn: Function<data ⇒ data>)

fn 在数据采集预置事件 shareToFriend 之前时会触发。这个函数允许在预置事件 shareToFriend 之前时对数据做一些改造。

• 代码示例

fcTrack.beforeSharePage((data) => {
  return {
    test: 'beforeSharePage',
  };
});

immedRequest()

调用此 API 可以立即发送收集好的数据请求