# 埋点方案与数据验收

TA 通过“事件”记录用户在产品内的关键行为,如注册、登录、付费,“事件属性”描述事件发生时的相关信息,如注册用户的“来源渠道”、“操作系统”等。通过“用户属性”描述每名用户及其最新状态,如用户的性别、等级、累积充值金额。

在使用 TA 系统进行分析前,数据需求方结合分析需求,确认需采集的事件、事件属性和用户属性,形成埋点方案。数据开发人员根据确定好的埋点方案,进行埋点实施,及时、准确、完整的上报数据,是实现数据分析的基石。

在实践过程中,常见数据开发人员缺少工具支持,无法及时定位数据问题,出现埋点数据缺失、属性上报类型与计划类型不一致等问题,导致上报的数据无法实现分析;数据需求方在对数据进行分析前,也需要获知埋点数据质量,保证分析结果的可用性。

埋点方案和数据验收功能旨在解决以上埋点过程中的常见问题,通过上传埋点方案、设置数据处理规则、进行数据验收等功能,保障埋点数据质量。各模块功能说明如下:

  • 管理埋点方案:将埋点方案上传至 TA 平台统一管理,记录埋点变更情况,作为实施埋点的依据
  • 设置数据处理规则:将埋点方案作为数据采集标准,设置 ETL 数据处理规则,保证入库数据的准确性
  • 进行数据验收:获取实际上传的数据与埋点方案的差异,不断优化埋点代码,稳步提升数据质量

# 一、管理埋点方案

该部分包括添加埋点方案、查看埋点方案和修改埋点方案的操作说明。

# 1.1 添加埋点方案

默认项目管理员及超管用户可添加埋点方案,埋点方案包括 3 部分内容:

(1)埋点事件:记录需采集的事件及事件属性

(2)公共事件属性:作用于每一个事件的属性,可选择作为公共事件属性上传。公共事件属性需在埋点时手动设置,设置方式见各接入端使用手册。

(3)用户属性:记录需采集的用户属性

提示

数据处理规则及数据验收功能不对预置属性生效。如无多端接入需进行属性对齐的情况,在埋点方案中可选择不填报预置属性信息

  • 您可选择[批量上传]或[逐个添加]埋点方案。批量上传时,按照TA 埋点方案模板格式整理您的埋点方案,即可选择导入至埋点方案页面。
  • 当产品迭代,需要新增少量埋点时,可选择[逐个添加]埋点,在当前的方案基础上新增埋点事件、事件属性或用户属性信息。

若您的项目中已有数据上报,希望在现有埋点基础上进行埋点方案的维护,可选择“一键同步已上报埋点”。注意:

  • 该操作的同步内容不包括预置属性
  • 因 TA 无法识别“公共事件属性”,因此所有的事件属性将会同步至“埋点事件”中,与您的埋点计划可能存在差异,可根据需要进行调整

# 1.2 查看埋点方案

提示

您可通过事件或属性前方的状态标识判断事件或属性是否已有数据上传。“绿色” 代表已有数据上报;“灰色”代表未上报。

(1)点击埋点事件名称,可查看该事件的详情信息

(2)可通过搜索“事件名”、“显示名”、“事件说明”、“创建人”等信息对列表进行筛选查看

(3)点击“按属性查看”,可选择某一非公共事件属性,查看该属性所关联的事件列表

在添加埋点事件时,可根据需要为事件增加标签,按事件标签进行分类查看。可根据埋点平台、事件所属产品模块等分类标准创建分类标签。

# 1.3 编辑埋点方案

# 1.3.1 修改埋点方案

新增埋点方案后,可根据需求对埋点方案进行编辑。点击事件、公共事件属性、用户属性后的编辑按钮,或点击详情卡片上方的编辑,即可进入编辑状态:

(1)事件的编辑规则

事件
编辑状态
事件名
事件未上报时,可编辑;事件已上报,不可编辑
显示名
可编辑
事件标签
可编辑
事件说明
可编辑

(2)事件属性的编辑规则

事件属性
编辑状态
属性名
不可编辑
显示名
可编辑
属性类型
可编辑
属性说明
可编辑

注意

同一事件属性可能关联至多个事件。若在某事件明细页编辑事件属性显示名、属性类型或属性说明,将同时修改其他事件下的该属性信息。

(3)用户属性的编辑规则

用户属性
编辑状态
属性名
不可编辑
显示名
可编辑
属性类型
可编辑
更新方式
可编辑
属性标签
可编辑
属性说明
可编辑

# 1.3.2 删除埋点方案

(1)可以选择删除埋点方案下的事件、事件属性或用户属性。删除埋点方案中的事件或属性,仅代表从埋点方案中删除,并不实际删除已上报的数据。

(2)点击操作栏的“更多”,可选择"清空埋点方案"。该操作将同时清空埋点事件、公共事件属性和用户属性中的内容,清空后可选择重新上传。

# 二、设置数据处理规则

TA 默认根据属性首次入库时的数据类型作为属性类型。在实际上报数据过程中,常见问题如属性上报类型与期望类型不一致,导致上报的数据无法支持分析,后期修复成本较高等问题。该功能模块将上传的埋点方案作为数据采集标准,将入库数据与埋点信息进行对比,设置存在上报差异时的数据处理规则。可有效规避不一致的数据,在数据上报初期保证上报数据与计划数据的一致性。

上传埋点方案后,TA 超管或管理员可在项目管理中设置数据处理规则。选择是否在默认的 ETL 数据处理规则的基础上,开启基于埋点方案的数据校验。设置内容包括:

  • 不在埋点方案中的事件 → 是否可以入库
  • 不在埋点方案中的事件属性(指在埋点方案中的所有事件下均不存在的事件属性) → 是否可以入库
  • 不在埋点方案中的用户属性 → 是否可以入库
  • 与埋点方案中“属性类型不一致”的事件属性或用户属性 → 是否可以入库

注意

数据处理规则仅针对新上报、且尚未生成元数据的事件或属性生效。

例如,“充值”事件未在埋点方案中记录,但该事件已有数据上报。选择”不在埋点方案中的事件不入库“时,该规则并不对“充值”事件生效。

默认项目配置为”自由上报模式“,即埋点方案对 ETL 数据处理规则不产生影响,可切换为”强校验模式“或“自定义模式”。在强校验模式下,数据处理规则说明如下:

事件规则 :不在埋点方案中的事件 → 不入库:即您需要先在埋点方案中维护完整的埋点信息,再进行数据上报。该规则可防止不在计划中的脏数据的入库。

属性规则:包括不在埋点方案中的事件属性/用户属性 → 丢弃属性,与埋点方案中属性类型不一致 → 丢弃属性。该规则可防止无效属性的入库,并且通过将实际属性类型与埋点方案属性类型进行对比,保证属性以期望的属性类型入库。

注意:属性规则的生效范围仅包括自定义属性,不对 TA 预置属性生效。

设置后,成员可在埋点方案页面查看当前项目的数据处理规则设置:

# 三、数据验收

在上传埋点方案并进行数据上报后,您可以进行数据验收,获取上报数据质量,验收结果由以下两部分组成:

  • 上报数据与埋点方案的全部差异:包括埋点事件是否全部上报、是否有计划外事件(不在埋点方案中的事件);是否存在属性缺失、计划外属性(不在埋点方案中的属性)、上报属性类型与预期类型不一致的情况
  • 上报属性的空值率:支持设置空值率阈值,当属性空值率大于阈值时,将在验收结果中显示异常

注意

数据验收范围包括事件和自定义属性,并不对预置属性进行验收。

# 3.1 进行数据验收

点击页面右上角的“进行数据验收”,可配置验收规则,您可选择对事件数据或用户数据进行验收。

(1)验收事件数据

点击选择“验收事件数据”,可设置验收的数据范围。包括事件时间、事件范围和筛选条件:

  • 事件时间:验收事件的时间范围,默认为昨天,可自定义。注意该时间指上报数据中的#time 字段,不随项目时区偏移
  • 事件范围:即需要验收的事件,默认全事件,可自定义事件范围。如选择新版本增加的埋点事件进行数据验收
  • 筛选条件:可对事件数据进行筛选。如您通过个客户端 SDK 采集上报数据,可指定某来源下的数据进行验收

点击下一步,可设置属性空值率验收规则。包括空值率阈值和统计规则:

  • 空值率阈值:设置空值率阈值,当上报的属性空值率超出阈值时,将在验收结果中显示异常
  • 统计规则:可选择是否将空字符串计入属性空值率

(2)验收用户数据

点击选择“验收用户数据”,可设置验收的用户数据范围和属性空值率验收规则。同验收事件数据。

# 3.2 查看验收结果

点击验收记录后的操作,可查看验收结果报告。事件数据的验收结果包括以下几种场景:

验收结果
结果说明
成功
上报数据与埋点方案一致,且属性空值率均低于设置的阈值
未上报
所选验收范围内,事件无数据上报
异常
存在以下情况时,将记为事件异常:
1. 存在不在埋点方案中的事件
2. 存在不在埋点方案中,但实际有上报的属性
3. 存在属性缺失,即在埋点方案中,但实际无上报的属性
4. 存在上报属性类型与埋点方案中的属性类型不一致
5. 属性空值率超出所设置的阈值

用户数据的验收结果包括:

验收结果
结果说明
成功
上报的属性数据与埋点方案一致,且属性空值率低于设置的阈值
异常
存在以下情况时,将记为用户属性异常:
1. 不在埋点方案中的用户属性
2. 属性缺失:即在埋点方案中,但实际无上报的用户属性
3. 上报属性类型与埋点方案中的属性类型不一致
4. 属性空值率超出所设置的阈值