@fle-sdk/event-tracking-weapp v1.0.2

@fle.sdk/event-tracking-weapp

构建用户数据体系，让用户行为数据发挥深远的价值。

前言

WEB 数据埋点 sdk，开始之前请确保了解埋点的架构和基础知识

埋点中比较重要的组成部分就是每个事件的 key，注意的是 key 至少由两部分组成。 完整的 key 由这几部分组成：appkey.pagekey.partkey 通过“.”来分割

• appkey：APP 应用唯一标识
• pagekey：页面唯一标识，默认取当前路由
• partkey：控件/自定义事件唯一标识，可通过接口获取或自定义

一、下载

// npm
npm install @fle-sdk/event-tracking-weapp --save-dev

// yarn
yarn add @fle-sdk/event-tracking-weapp

二、全埋点

全埋点包括三种事件：Web 页面浏览、Web 元素点击、Web 页面留存时长，对应的配置如下：

// 初始化
WebTracking.init({
	appKey: "218844",
	showLog: true,
	autoTrack: true, // 设置该属性之后，SDK 就会自动收集页面浏览事件
	isTrackSinglePage: true,
	contentType: "application/json",
	serverUrl: "https://xxx/push"
});

2.1 元素点击

元素的点击事件上报 attr 属性中必须含有 data-part-key ，否则会被过滤。

// 对充值按钮的点击次数进行统计
<button data-part-key="recharge_btn" data-desc="显示充值弹窗">
	充值
</button>

2.2 全埋点参数示例

全埋点三种类型的上报参数示例，建议都了解一下

{
  "desc": "Web 浏览页面",
  "event": "PageView",
  "appKey": "218844",
  "siteId": "",
  "itemKey": "218844.app_other",
  "requestTime": 1638456820316,
  "deviceId": "f9e3f35a6371f369a2c9f21c48dcabe8",
  "privateParamMap": {
    "currentUrl": "http://localhost:9999/app/other",
    "targetUrl": null,
    "sdkVersion": "1.1.0",
    "pageWidth": 742,
    "pageHeight": 867,
    "screenWidth": 1680,
    "screenHeight": 1050,
    "systemsInfo": {
      "language": "zh-CN",
      "platform": "pc",
      "client": "Mac, MacOS 10.15.7",
      "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
      "navigationStart": 1638456820099,
      "navigation": "1ms",
      "dns": "0ms",
      "tcp": "0ms",
      "request": "2ms",
      "response": "1ms"
    },
    "urlParams": {},
    "userInfo": {
      "userId": 20211232232123
    }
  }
}

{
  "desc": "Web 元素点击",
  "event": "WebClick",
  "appKey": "218844",
  "siteId": "",
  "itemKey": "218844.main.8ydgk",
  "requestTime": 1638460476808,
  "deviceId": "f9e3f35a6371f369a2c9f21c48dcabe8",
  "privateParamMap": {
    "position": [
      126,
      87
    ],
    "targetEle": {
      "id": "",
      "nodeName": "H1",
      "className": ""
    },
    "pointerType": "mouse",
    "currentUrl": "http://localhost:9999/main?a=1",
    "elementSelector": "#root > div:nth-of-type(1) > div:nth-of-type(1) > h1:nth-of-type(1)",
    "sdkVersion": "1.1.0",
    "pageWidth": 742,
    "pageHeight": 867,
    "screenWidth": 1680,
    "screenHeight": 1050,
    "systemsInfo": {
      "language": "zh-CN",
      "platform": "pc",
      "client": "Mac, MacOS 10.15.7",
      "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
      "navigationStart": 1638456820099,
      "navigation": "1ms",
      "dns": "0ms",
      "tcp": "0ms",
      "request": "2ms",
      "response": "1ms",
      "domComplete (domLoaded)": "201ms (186ms)",
      "loadEvent": "1ms",
      "total (DOM)": "218ms (217ms)"
    },
    "urlParams": {
      "a": "1"
    },
    "userInfo": {
      "userId": 20211232232123
    }
  }
}

{
  "desc": "Web 页面浏览时长",
  "event": "PageRetained",
  "appKey": "218844",
  "siteId": "",
  "itemKey": "218844.app_other",
  "requestTime": 1638460554657,
  "deviceId": "f9e3f35a6371f369a2c9f21c48dcabe8",
  "privateParamMap": {
    "sdkVersion": "1.1.0",
    "pageWidth": 742,
    "pageHeight": 867,
    "screenWidth": 1680,
    "screenHeight": 1050,
    "currentUrl": "http://localhost:9999/app/other",
    "systemsInfo": {
      "language": "zh-CN",
      "platform": "pc",
      "client": "Mac, MacOS 10.15.7",
      "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
      "navigationStart": 1638456820099,
      "navigation": "1ms",
      "dns": "0ms",
      "tcp": "0ms",
      "request": "2ms",
      "response": "1ms",
      "domComplete (domLoaded)": "201ms (186ms)",
      "loadEvent": "1ms",
      "total (DOM)": "218ms (217ms)"
    },
    "urlParams": {},
    "userInfo": {
      "userId": 20211232232123
    }
  },
  "retainedStartTime": 1638460451953
}

三、API

WebTracking

• init() ---初始化
• preset() ---配置全局参数（注意：如果配置的全局属性初始化已配置，将覆盖。）
• login() ---用户登录
• track() ---自定义代码埋点上报
• getDeviceId() ---获取设备唯一标识

Init

参数

例子

初始化 sdk 例子，建议在 src/App.js 中初始化，且需在useLayoutEffect中初始化。

import React, { useLayoutEffect } from "react";
import WebTracking from "@fle-sdk/event-tracking-weapp";

const App = () => {
	useLayoutEffect(() => {
		// init tracking
		WebTracking.init({
			appKey: "xxxxxx", // 由接口生成，应用唯一标识
			serverUrl: "https://www.serverHost.com/serverApi/push",
			autoTrack: true,
			showLog: true,
			isTrackSinglePage: true
		});
	}, []);

	return <div className="App"></div>;
};

export default App;

Preset

除了不可配置 appKey、serverUrl，本质上和 init 差不多，这么做是为了更好的区分使用场景，不产生歧义。

参数

例子

import React, { useLayoutEffect } from "react";
import WebTracking from "@fle-sdk/event-tracking-weapp";

const App = () => {
	useLayoutEffect(() => {
		// init tracking
		WebTracking.init({
			appKey: "xxxxxx", // 由接口生成，应用唯一标识
			serverUrl: "https://www.serverHost.com/serverApi/push"
		});

		// 配置全局参数，初始化后预置属性用该方法。
		// 注意：如果配置的全局属性初始化已配置，将覆盖
		WebTracking.preset({
			autoTrack: true,
			showLog: true,
			isTrackSinglePage: true,
			sendTimeout: 10000
		});
	}, []);

	const pageHandle = () => {
		WebTracking.preset({
			autoTrack: false // 关闭全埋点
		});
	};

	return <div className="App" onClick={pageHandle}></div>;
};

export default App;

Login

参数

例子

import React, { useEffect } from "react";
import WebTracking from "@fle-sdk/event-tracking-weapp";
import { LoginStore } from "store";

const Test = () => {
  const getUserInfo = () => {
  	const { userId } = await LoginStore.getUserInfo();
    WebTracking.Login("用户ID");
  }
  useEffect(() => {
    getUserInfo()
  }, []);

  return <div className="Test"></div>;
};

export default Test;

GetDeviceId

例子

获取设备唯一标识，单用户没有登录时即用户唯一标识

import React, { useEffect } from "react";
import WebTracking from "@fle-sdk/event-tracking-weapp";
import { LoginStore } from "store";

const Test = () => {
	useEffect(() => {
		WebTracking.getDeviceId();
	}, []);

	return <div className="Test"></div>;
};

export default Test;

Track

手动代码埋点上报

上报参数

例子

import React, { useEffect } from "react";
import WebTracking from "@fle-sdk/event-tracking-weapp";

const Index = () => {
	const history = useHistory();

	const tracking = () => {
		WebTracking.track({ desc: "我是描述", partkey: "xxx" })
			.then((res) => console.log(res || "上报成功！"))
			.catch((err) => console.log(err || "上报失败！"));
	};

	// 手动上报商品详情浏览量示例
	useEffect(() => {
		WebTracking.track({
			desc: "商品详情PV埋点",
			partkey: "goods_detail_pv",
			business: {
				goodsId: "123",
				goodsName: "测试商品"
			}
		});
	}, []);

	return (
		<div className="index-wrap">
			<button onClick={tracking}>点我，自动上报</button>
		</div>
	);
};

export default Index;

四、完整参数明细

4.1 request 参数明细

application/json application/x-www-form-urlencoded | application/x-www-form-urlencoded | | privateParamMap | object | 私有参数 | 查看详情 |

4.2.1 privateParamMap 参数明细

4.2.2 TargetEleProps 参数明细

4.2.3 SystemsInfoTypes 参数明细