xqdata-browser
v0.1.0
Published
xq-data JavaScript 埋点 SDK,API 对齐 ThinkingData thinkingdata-browser
Readme
xqdata-browser
xq-data 的浏览器埋点 SDK,当前版本 0.1.0。API 对齐 ThinkingData JavaScript SDK(thinkingdata-browser),自研实现,数据上报:
POST {serverUrl}/v1/track?appId={APPID}
完整接入见 docs/javascript-sdk-integration.md。
安装
npm install ../xq-data/sdk/javascriptimport xqdata from "xqdata-browser";
xqdata.init({
appId: "<控制台 appKey>",
serverUrl: "https://xq-data.nexfungo.com",
autoTrack: { pageShow: true, pageHide: true },
});
xqdata.login("user_10001");
xqdata.track("finish_order", { amount: 9.9 });脚本接入使用 npm run build 后的 dist/xqdata.umd.min.js,异步片段见 snippet.js。
本地验证
cd sdk/javascript
npm install
npm test
npm run buildAPI 对照(TE → xqdata)
| TE | xqdata-browser | 状态 |
|----|----------------|------|
| init / track / login / logout | 同名 | 已实现 |
| 首次 / 可更新 / 可重写 | trackFirst / trackUpdate / trackOverwrite | 已实现 |
| 公共属性 / 页面属性 / 动态公共属性 / timeEvent | 同名 | 已实现 |
| userSet / userSetOnce / userAdd / userAppend / userUniqAppend / userUnset / userDelete | 同名 | 已实现 |
| autoTrack.pageShow / pageHide / quick('autoTrack') / trackLink | 同名 | 已实现 |
| mode: debug / debugOnly + 白名单 | 同名,走 GET /v1/config | 已实现 |
| 多实例 initInstance / 多域名 quick('siteLinker') | 同名 | 已实现 |
| optOutTracking / optInTracking / setTrackStatus | 同名 | 已实现 |
| send_method: ajax / beacon | JSON fetch;beacon 为 keepalive | 已实现 |
| send_method: image | 降级为 ajax | 未按像素上报 |
| secretKey 传输加密 | 忽略并警告 | 未实现 |
| App 与 H5 打通 | — | 未实现 |
