预置事件和属性
为了帮助开发者更快速的集成SDK,了解采集哪些用户行为和属性 ,我们预置了一些事件、事件属性和用户属性。
说明
部分默认自动采集,Android、iOS、JS 和 小程序端略有差异;
非默认采集的字段,如有需要,可以直接使用预置字段作为事件 ID、属性 ID 进行上报,以便数据集成时, 能够自动生成预置看板。
以下表格中涉及标识为 Y/N/- 的含义
事件
- Y 表示相应平台默认自动采集
- N 表示相应平台不默认采集
- S 表示由服务端处理
- - 表示相应平台不支持采集该事件
属性
- Y 表示采集事件后相应属性可以自动获取,无需额外配置
- N 表示需要额外配置才能有值
- S 表示由服务端根据相应规则自动处理
- - 表示相应平台不支持该属性
除了预置的事件和属性ID会以$开头,其他自定义的事件ID和属性ID,须注意命名方式:仅支持字母、数字和下划线,不能以数 字或下划线开头,上限125个半角字符。
基础预置事件会默认加入到方舟埋点方案
启动、关闭、浏览页面事件会在集成了基础 SDK 后会自动采集;
$app_click、$web_click 用于记录点击网页/APP页面,用于分析点击位置热图、点击元素热图,集成 SDK 时设置参数autoHeatmap 设置为 true ;
$webstay 用于记录用户停留在可视区域,分析浏览深度线,集成 SDK 时设置参数 autoWebstay 为 true;
$user_click 用于采集用户点击元素的事件,集成 SDK 时开启全埋点功能,即设置参数 autoTrack 为 true
对于用不到的事件可以选择不用,比如集成的平台中没有小程序时,可以不用 $share;没有 APP 时,可以不用 $app_crash
事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 |
$startup | 启动 | APP启动 / 打开网站 | Y | Y | Y | Y |
$end | 关闭 | APP关闭 | Y | Y | - | - |
$pageview | 浏览页面 | 浏览APP/网站页面 | Y | Y | Y | Y |
$user_click | 点击元素 | 全埋点自动采集元素点击行为 | N | N | N | N |
$app_click | App点击 | App热图点击事件(用于热图分析) | N | N | - | - |
$web_click | Web点击 | Web热图点击事件(用于热图分析) | - | - | N | - |
$webstay | 视区停留 | 停留在可视区域(用于分析网页浏览深度) | - | - | N | - |
$share | 小程序分享 | 点击小程序分享按钮 | - | - | - | N |
$app_crash | APP崩溃 | APP崩溃信息 | N | N | - | - |
在首次创建 APP 推广监测成功后,系统会自动将 APP 推广监测相关事件添加在埋点方案中
无需在 SDK 中进行特殊设置,用户点击来推广链接激活后会自动上报数据
事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 |
$campaign_track | APP推广监测 | APP扫描监测扫描二维码时上报 | S | S | - | - |
$first_installation | 首次安装激活 | APP扫描监测扫描二维码后首次打开APP会时上报激活事件 | S | S | - | - |
在服务集成配置中配置消息通知推送通道后,系统会自动将这 3 个事件添加到埋点方案中
事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 |
$push_receiver_success | 消息推送成功 | 设备收到推送消息时触发 | N | N | - | - |
$push_click | 点击推送消息 | 设备点击了推送消 息时触发 | N | N | - | - |
$push_process_success | 成功处理push消息 | 成功处理push消息 | N | N | - | - |
事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 |
$alias | 绑定用户实名信息 | 用户实名认证 | S | S | S | S |
$alias 事件之外的Profile 系列的事件用于上报用户属性,所以同样不会作为单独的事件去分析,即不会出现在分析模型中事件的选项中,也不会计入任意事件的计算。
事件ID | 事件说明 | Android | iOS | JS | 小程序 |
$alias | 用户实名认证 | N | N | N | N |
$profile_set | 设置用户信息,覆盖写 | N | N | N | N |
$profile_set_once | 设置用户信息,有则不进行任何操作 | Y | Y | Y | Y |
$profile_increment | 增加或减少用户信息中的数字类型的属性 | N | N | N | N |
$profile_delete | 删除用户信息 | N | N | N | N |
$profile_append | 数组属性添加值 | N | N | N | N |
$profile_unset | 设置用户信息中的某个属性为空 | N | N | N | N |
除了上述预置事件之外,更多业务相关的事件,需要自定义埋点上报。
事件属性描述事件发生的方式和内容,是分析过程中的维度,也可以用于条件过滤。
- 事件通用属性:所有事件共同拥有的属性,e.g. 平台、应用版本、操作系统等;
- 事件自有属性:某个事件独有的事件属性,e.g. 浏览页面事件 $pageview 会有 $url、$title 等属性。
属性ID | 属性显示名称 |