2025年前端埋点sdk（前端埋点sdk开发）

大家好，我是讯享网，很高兴认识大家。

在进行埋点前，需要确定在哪里埋点、埋哪些点等，即需要梳理清楚明确的埋点需求。在QuickTracking平台中将明确的埋点需求称为埋点方案，并为埋点方案设计了规范模板。如下：
讯享网

在埋点方案中，明确的所需埋点内容有：

1、事件主体：指“谁”触发了这个事件，分为设备ID和账号ID，上报的事件务必具备其中之一。

设备ID：在小程序中一般为openid，小程序中嵌入的h5页面设备ID也需要设置为小程序的openid。
账号ID：客户端用户登录后账号标识，当一个用户在不同的设备进行登录时，设备ID会发生变化，但是账号ID不会发生变化。例如一个用户使用手机和pad分别登录。

2、用户属性：针对账号ID的属性，例如账号ID为“testdemo@111”的用户，“生日”为“1999-02-13”，“会员等级”为“铂金”等。“生日”和“会员”等级就为用户属性。

3、渠道属性：广告投放的属性，例如投放渠道、投放方式、投放内容等。

4、全局属性：在全局设置一次后，每一个事件都会携带的属性

5、页面浏览事件：页面加载时上报的事件（埋点方案中页面编码和事件编码相等的事件，也是标记为蓝色的事件）

6、点击、曝光、自定义事件：客户端用户与客户端发生任意交互时上报的事件。

由于各小程序平台均有自己的设备ID生成逻辑，所以QuickTracking SDK不会自动生成任何设备ID，但是QuickTracking SDK的日志依赖设备ID，所以在进行埋点之前，需要设置设备ID。如果是微信小程序，SDK支持授权QuickTracking自动获取openid。或者开发者获取openid/unionid等官方小程序ID后手动上传作为设备ID，否则，QuickTracking SDK将无法进行任何日志上报。

手动上传方式如下：

请注意：示例为微信小程序的代码调用示例，其他小程序平台逻辑相似

PS：目前QuickTracking支持自动采集微信小程序openid，需要在产品中进行授权。授权方式如下，点击后按照要求填写内容即可。

授权后，设置设备ID代码方式为：

如果之前已经使用了手动设置openid，现希望改为上述的QuickTracking自动采集微信小程序openid，还需要注意以下内容：

移除metainfo中设置_hold=BLOCK的SDK阻塞上报逻辑
注释掉之前手动设置「_anony_id=openid」的相关逻辑代码，也就是移除从wx.login中获取openid的相关代码。
注意，务必确保关于设置appKey和收数域名的内容不受影响。

在用户登录时，以及登录态进入小程序时，都需要设置账号ID。因为设置后的每一条日志都将携带账号ID，但退出小程序再进入后触发的事件不会携带账号ID。所以需要在用户登录时，以及登录态进入小程序时设置账号ID：

若需要在小程序端上获取QuickTracking的设备ID时，可以在metainfo中获取_anony_id，以微信小程序为例：

若需要在小程序端上获取QuickTracking的账号ID时，可以在metainfo中获取_user_id，以微信小程序为例：

通过预置事件编码 $\(_user_profile 上报用户属性，事件类型为其他事件。在上报用户属性之前，需要先设置_user_id上报用户账号，否则QuickTracking流量分析对用户属性不会进行关联计算。确认上报用户的账号ID后，上报用户属性示例如下：上述内容中，3行不能发生任何变化，仅可自定义4、5、6行。渠道属性无需进行任何埋点，但是需要唤起小程序的URL中携带这些渠道属性，且属性key务必以“utm_”开头，因为SDK识别的关键字为“utm_”。例如：qaplus/product?utm_channel=gzhPS：如果渠道属性已经与市面上渠道投放公司进行了合作，无法使用utm_开头，可以使用全局属性API将渠道属性进行埋点上报（属性key依然需要以“utm_”开头）。全局属性的生命周期为应用启动到应用隐藏使用aplus.appendMetaInfo进行全局属性上报时，如果和已经存在的全局属性key重复，则更新已有值；如果和已经存在的全局属性key不一致，则插入新的全局属性。接口：示例：使用aplus.setMetaInfo进行全局属性上报时，仅会以最后一次上报为准。即先清空已有全部全局属性，再将本次setMetaInfo设置的全局属性放入。接口：示例：1、页面浏览事件分为SDK自动埋点（全埋点）和代码埋点两种方式，默认页面浏览事件的全埋点是开启的。2、页面浏览事件需要埋点的内容为：<ul id="182c4032e1ruy"><li id="182c4030e1fgj">事件编码：也就是页面编码，在页面浏览事件中事件编码即为页面编码。<img id="13c6ed7021qkl" src="https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN//p.png" alt="image.png" placement="break" class="image break"></li><li id="2404a140e12sx">页面浏览事件的事件属性：具体属性见埋点方案</li><li id="8e1496e021ar0"><img id="8eaah" src="https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN//p.png" alt="image.png" placement="break" class="image break"></li></ul>pageConfig为全局设置页面的页面编码的方式，具体示例如下：其中<ul id="54d5bb11e11du"><li id="54d59400e10qz">pageName表示页面编码</li><li id="55a9fb01e1oxu">pageTitle表示页面标题</li><li id="59da5e41e1nnk">skipMe为是否关闭该页面的自动浏览事件采集（true表示关闭，false表示开启）</li></ul>注意：skipMe设置的优先级低于关闭页面浏览事件自动采集的总开关aplus-disable-apvSDK识别到页面的onHide时，上报页面浏览事件，上报的内容为：<ul id="03df9b32e1fot"><li id="03df9b30e1gbq">当前客户端时间</li><li id="074d98d1e1eam">页面path</li><li id="0a02a6b1e1ueg">页面编码（默认为页面path，如果设置了pageConfig，则取值为映射pageConfig的page_name）</li><li id="1fa0dc81e1tji">页面标题（默认为页面title，如果设置了pageconfig，则取值为映射的page_title）</li><li id="223fca50e110z">页面停留时长：从onShow到onHide的时间</li></ul><h4 id="29d26b60e1jky">6.2.1 关闭页面自动埋点</h4>页面自动上报默认是开启的，如果需要关闭自动页面上报，API如下：如果仅须关闭某一页面的自动页面上报，可以在pageconfig中设置skipMe为true关闭。<h4 id="4a6e80c0e1cg4">6.2.2 设置自动页面浏览事件的事件属性</h4>在页面onhide钩子触发之前，可以调用updatePageProperties动态设置页面编码和页面浏览事件的事件属性。API说明：其中<ul id="6f92dd62e1pz2"><li id="6f92dd60e11cw">\)params: 页面事件属性集合，object类型，不支持多层嵌套，其中预制字段page_name，用于动态设置自动页面事件的页面编码

$page_path：可选字段，string类型，如果不传，默认为当前页面路径</li></ul>示例APIsendPV 方法将发送一条页面 PV 日志，其 API 定义如下：其中<ul id="baeb0ad1e1668"><li id="baeae3c0e1jfl">$pageEventConfig 为页面事件的配置，只需要写死{ is_auto: false } 即可

\(properties 为本次页面事件的扩展参数，其取值为一个object类型，不能多层嵌套，若无可传空对象'{}'<ul id="aa1b0bce172sr"><li id="b41d8e12edyiv">duration：其中duration作为预制字段，用于手动PV功能下记录本次页面浏览的页面停留时长，计算duration的逻辑需要开发者根据业务场景自行设计实现。自动PV功能下，duration计算逻辑由sdk内部实现</li></ul></li></ul>示例注意：页面标题（page_title）默认为pageConfig中的值，如果这里设置了，则为这里设置的值。页面编码（page_name）默认为pageConfig中的值，如果这里设置了，则为这里设置的值。除了页面浏览事件外的事件都使用'action':'aplus.record'进行埋点，事件需要埋点的内容有：<ul id="0c88bfe2e1kav"><li id="0c88bfe0e1h3b">事件编码：<img id="daab5ed021sid" src="https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN//p.png" alt="image.png" placement="break" class="image break"></li><li id="1863e010e1ams">事件属性：<img id="075apj4" src="https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN//p.png" alt="image.png" placement="break" class="image break"></li><li id="27121d70e12wz">页面编码（可选）：SDK默认采集页面path，如果页面path在pageConfig中进行了映射，并设置了page_name，则取值为pageConfig中的page_name。如果在事件埋点时，在事件属性中设置了page_name，则取值为事件属性中的page_name。也就是取值优先级为：事件属性中的page_name > pageConfig中的page_name > 页面path<img id="5bae68b021q4w" src="https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN//p.png" alt="image.png" placement="break" class="image break"></li><li id="801e49c0e1y0a">页面标题（可选）：SDK默认采集页面title，如果页面path在pageConfig中进行了映射，并设置了page_title，则取值为pageConfig中的page_title。如果在事件埋点时，在事件属性中设置了page_title，则取值为事件属性中的page_title。也就是取值优先级为</li></ul>事件属性中的page_title > pageConfig中的page_title > 页面title事件埋点分为SDK自动埋点（全埋点）和代码埋点两种方式，默认点击和曝光的全埋点是关闭的。EXP特指曝光事件CLK特指点击事件OTHER特指除点击和曝光事件外的其他自定义事件由SDK内部帮助开发者处理曝光时机，并自动采集元素曝光行为。触发时机为控件展示在可视区域内面积超过50%，时间超过300ms。以微信为例， UI部分：sdk 配置部分：自动曝光前置回调函数，默认值为undefined，如需开启，需设置：请注意：针对跨自定义组件的后代选择器，需要使用 >>> 语法，帮助SDK获取元素DOM数据，参考示例：从版本1.1.0开始，为减少开发者埋点工作量，sdk也支持通过配置部分信息，让SDK自动采集页面内的点击事件。（支付宝、百度小程序需要基础库2.x版本以上才支持）以微信为例， UI部分：sdk 配置部分：自动点击前置回调函数，默认值为undefined，如需开启，需设置：从版本 2.4.2 开始，开发者某些场景下需要采集页面内绑定事件函数的元素点击行为，为了减少7.5节开发者配置化的工作量，sdk已支持此种场景的自动采集。默认不采集绑定事件函数元素的点击行为，如需开启需要使用场景：以微信小程序场景举例当用户触发onClick事件时，sdk 会上报一条事件编码为\)$_mp_item_click的事件，采集字段包括：

事件属性
- （默认采集）methodName:“onClick”
- （用户自定义属性）custom_property:“1111”
全埋点属性
- element_id: “my_bottom_tab”
- element_type: “元素类型，开发者按需补充”
- element_name: “元素名称，开发者按需补充”
- element_class_name: “元素class，开发者按需补充”
- element_content: “元素内容，开发者按需补充”
- element_selector: “css筛选器，开发者按需补充”
- element_path: “元素路径，开发者按需补充”

备注：全埋点属性仅开发者在元素上配置了数据属性data-element_xxx后生效。

分享裂变是增长黑客策略的一个关键概念，它依靠用户之间的社交联系来实现信息的相互传递，从而促进新用户的获取。

完成分享裂变的SDK功能集成，您将可以使用QuickTracking平台分享趋势模型，通过分享回流相关指标衡量营销活动的拉新效益。

支持查看TOP分享用户和不同分享回流层级的分享回流效果指标。
支持回流指标灵活组合配置，查看最具裂变拉新能力和分享回流转化能力的TOP用户，追踪用户分享裂变链路与分享回流关系，快速定位关键意见消费者。

版本要求

小程序 sdk v2.2.0版本及以上

功能

当被分享人打开小程序时，用于获取来源分享id 和来源分享 url 的 API

请求参数

无

返回参数

Object 类型

调用示例

注：考虑到小程序平台在onShareAppMessage和onShareTimeline API上的能力差异，SDK提供了两种API使用方式来请求分享参数，分别是支持Promise返回和支持函数回调方式返回。开发者请根据产品所需适配的平台自行选择。

基于支持 promise 的方式使用

基于 callback 的方式使用

版本

小程序 sdk v2.2.0版本及以上

功能

请求用于构建分享链需要的分享id

请求参数

返回参数

如果请求参数不包含 callback，返回

调用示例

基于支持 promise 的方式使用

方式1：在自定义方法中获取分享id，然后在 onShareAppMessage onShareTimeline 中通过返回结果上报分享信息

方式2：在onShareAppMessage中调用分享参数获取API，然后在 onShareAppMessage 中通过promise返回结果上报分享信息

注：因 onShareTimeline 方法不支持 promise 返回，因此 onShareTimeline 仍需考虑通过 setState 方式获取分享 id

基于 callback 的方式使用

2025年前端埋点sdk（前端埋点sdk开发）

手动上传方式如下：

相关推荐