1.2.6 • Published 9 months ago

txs-sdk v1.2.6

Weekly downloads
-
License
ISC
Repository
-
Last release
9 months ago

土行孙埋点SDK

版本说明

npm最新的包是1.1.0版本,

因为包还在完善的过程中 建议每次新下载包都使用最新版本

安装

* npm install txs-sdk -S
* yarn add txs-sdk

使用

在main.js/main.ts中引用, APP应用为import { AppTracker} from 'txs-sdk,其余为import { Tracker} from 'txs-sdk,然后执行init

初始化

先new一个引入的类, App为Tracker,其余为AppTracker,options详见下方,然后全局挂载在vue实例上 Vue2中:

const $tracker = new Tracker(options);
Vue.prototype.$tracker = $tracker;

Vue3中:

const $tracker = new Tracker(options);
app.config.globalProperties.$tracker = $tracker;

App中开启埋点

仅限App中,在App.vue的onLunch生命周期里,执行SDK中全局监听方法 Vue2中:

this.$tracker.watchApp(func);

Vue3中:

import { getCurrentInstance } from "vue";
const { proxy }: any = getCurrentInstance();
proxy.$tracker.watchApp(func);

其中func为获取页面栈方法,比如uniapp中为getCurrentPages

设置userId

多用于登录后,对登录之前的数据进行用户绑定。 在登录完成之后,调用SDK中的设置userId方法,传入可作为用户唯一标识的参数 Vue2中:

this.$tracker.setUserId(userId);

Vue3中:

import { getCurrentInstance } from "vue";
const { proxy }: any = getCurrentInstance();
proxy.$tracker.setUserId(userId);

API

Props

参数说明类型默认值平台差异
appid应用IdString无默认值,必填
platform应用平台类型StringwebApp不需要传,其余可传值参考platform
requestUrlSDK中全局请求接口前缀Stringhttps://track.lyzhyun.com:18300
enableHistoryTracker是否启用全局history跳转埋点BooleanfalseApp不支持
enableHashTracker是否启用全局hash跳转埋点BooleanfalseApp不支持
openReqTrack是否启用网络请求拦截上报Booleanfalseweb
openBugTrack是否启用异常拦截上报Booleanfalseweb
apiSDK里用到的接口Object接口详细看下方,一般不需要传
wx微信小程序内嵌对象,wx对象或者uni对象都行Object无默认值微信小程序必填
uniuniApp内嵌全局对象Object无默认值uniApp必填
vueAppvue实例Object无默认值使用Js异常上报必填

platform

名称说明
wechat小程序
webweb/H5

接口

  • sendApi (埋点上报接口): '/api/track'
  • bindApi (埋点绑定用户接口): '/api/track/bind'
  • sendBugApi (Js异常上报接口): '/api/bug/report'
  • performanceApi (网络请求拦截上报接口): '/api/track/requestlog'
  • wxOpenIdApi (微信小程序获取openId接口): 应用里的接口传入,微信小程序必传

方法

通过全局挂载的$tracker进行调用

方法名说明参数返回值
setUserId绑定用户IduserId:作为用户的唯一标识-
sendTracker手动上传埋点function(eventId: string, data: Object, eventInfo: Object)eventId: 事件名称data: 作为这次埋点的数据一并上传eventInfo:将被转为JSON字符串作为eventInfo的值上传-

开源协议

ISC

1.2.0

9 months ago

1.1.1

10 months ago

1.1.0

10 months ago

1.2.6

9 months ago

1.2.5

9 months ago

1.2.4

9 months ago

1.2.3

9 months ago

1.2.2

9 months ago

1.2.1

9 months ago

1.0.5-alpha.1

1 year ago

1.0.9

12 months ago

1.0.8

1 year ago

1.0.6-alpha.1

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.6-alpha.3

1 year ago

1.0.6-alpha.2

1 year ago

1.0.9-beta.1

1 year ago

1.0.8-beta.1

1 year ago

1.0.9-beta.2

1 year ago

1.0.8-beta.4

1 year ago

1.0.8-beta.3

1 year ago

1.0.8-beta.2

1 year ago

1.0.4

1 year ago

1.0.3-rc.1

1 year ago

1.0.3-alpha.3

1 year ago

1.0.3-alpha.2

1 year ago

1.0.3-alpha.1

1 year ago

1.0.3-beta

1 year ago

1.0.2

1 year ago

1.0.2-beta

2 years ago

1.0.1-beta

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago