1.0.7 • Published 1 month ago

@wise-group/tracking-jssdk v1.0.7

Weekly downloads
-
License
MIT
Repository
-
Last release
1 month ago

快速入门

$ npm i @wise-group/tracking-jssdk

引用SDK

// 在入口文件
// 小程序原生开发 app.js
const wTracker = require('@wise-group/tracking-jssdk')

// 第三方框架,如uniapp
// src/main.js
import wTracker from "@wise-group/tracking-jssdk";

初始化SDK

小程序原生

// app.js
const wTracker = require('@wise-group/tracking-jssdk')
wTracker.init({
  apiUrl: 'xxx'
})

// 针对小程序端,需要将apiUrl的域名加入小程序的Request合法域名中
App({
  ...
})

Uniapp

vue2

// src/main.js
...
wTracker.init({
  apiUrl: 'xxx',
  framework: {
    uni: Vue
  }
})
...

vue3

// src/main.js
export function createApp() {
  ...
  // const app = xxxx;
  wTracker.init({
    apiUrl: 'xxx',
    framework: {
      uni: app
    }
  });
  // return xxxx
  ...
}

方法

init(Object)

初始化SDK

参数 Object

字段必填类型默认值说明
apiUrlYstringnull服务端接口域名 针对小程序端,需要将apiUrl的域名加入小程序的Request合法域名中
appIdNstring-小程序AppId
agentIdNstring-企微应用 agentid
debugNbooleanfalsedebug模式
platformNstring-当前平台,默认系统会自动判断如有特殊情况可手动指定平台;可选值:mp-wx | web
manualNbooleanfalse是否全手动提交默认为false,sdk会自动上报程序和页面级的进入 离开 行为
frameworkNObject-框架信息
framework.uniN-uni实例(如果使用uni app框架则必填,否则无法自动抓取页面访问行为) 使用方法

track(action, param, eventCode)

事件上报

参数

字段必填类型说明
actionYstring上报行为: launch: 应用启动 enter: 进入页面 leave: 离开页面 click: 点击 ${actionName}: 自定义行为名称
paramNobject附加参数,格式 {key: value}
eventCodeNstringeventCode

insert(Object)

追加字段

部分字段在初始化时无法获取,例如用户的unionId,因此加入数据插入机制,在获取后进行补偿插入

参数

字段必填类型说明
unionIdNstring用户uid
openIdNstring用户oid
agentIdNstring企微应用 agentid
wechatWorkUserIdNstring企微用户id
wechatWorkEUserIdNstring企微外部联系人id
1.0.7

1 month ago

1.0.6

1 month ago

1.0.5

1 month ago

1.0.4

1 month ago

1.0.3

1 month ago

1.0.2

1 month ago

1.0.1

1 month ago

1.0.0

1 month ago