特赞(上海)信息科技有限公司
用户232
【前端】开放组件及 SDK
分享
@tezignlab/tezign-external-track 特赞微信小程序埋点sdk使用指南
输入“/”快速插入内容
@tezignlab/tezign-external-track
特赞
微信小程序
埋点
sdk
使用指南
✅
适用于原生微信小程序开发的
埋点
sdk
;
另:
tezign-external-sdk 特赞Web埋点sdk使用指南
sdk
版本查看:
https://static.tezign.com/tezign-external-track/version.json
埋点
传参说明:
tezign前端埋点SDK参数说明
npm:
https://www.npmjs.com/package/@tezignlab/tezign-external-track
集成
tezign
sdk
npm
代码块
Bash
# npm
npm install @tezignlab/tezign-external-track
# yarn
yarn add @tezignlab/tezign-external-track
# pnpm
pnpm install @tezignlab/tezign-external-track
使用
✏️
•
构建 npm: 按照
微信小程序中npm包的使用
,安装完npm包之后,在微信开发者工具中
工具->构建npm
,生成miniprogram_npm包.
代码块
TypeScript
import tezignSdk from '@tezignlab/tezign-external-track/miniprogram_dist'
初始化
SDK
实例
tezignSdk 需要执行初始化init方法后才能上报
埋点
, 期间你可以使用
track
函数来上报事件,但是实际报上的时机会在
init
函数执行完之后。
OpenAPI 获取 access token
在初始化
埋点
实例前,需获取open-api
•
token
•
tenant_id
•
client_id
•
api
init:初始化
埋点
需传入
埋点
公共数据,init执行后才能发起埋点上报
代码块
TypeScript
declare const init: (config: InitConfig) => Promise<void>;
// InitConfig见api👇
tezignSdk.init(initParams: InitConfig)
埋点
上报
使用
track
函数手动上报事件
上报事件会发起
埋点
请求,可在network中查看
代码块
TypeScript
interface IEvent {
/** 事件类型code */
event_type_code: string;
/** 事件属性 */
event_properties: Record<string, any>;
}
// event_type_code和event_properties需要事先约定
tezignSdk.track(trackEvent: IEvent)
批量上传 batchSend 模式 (默认关闭)
batchSend 模式,会把 event 加入到队列中,等待下一次清空队列统一上报
代码块
TypeScript
init({
//...
sender: {
enableBatchSend: true
}
})