预置事件和属性

为了帮助开发者更快速的集成SDK,了解采集哪些用户行为和属性,我们预置了一些事件、事件属性和用户属性。

说明

部分默认自动采集,Android、iOS、JS 和 小程序端略有差异;

非默认采集的字段,如有需要,可以直接使用预置字段作为事件 ID、属性 ID 进行上报,以便数据集成时,能够自动生成预置看板。

以下表格中涉及标识为 Y/N/- 的含义

事件

  • Y 表示相应平台默认自动采集

  • N 表示相应平台不默认采集

  • S 表示由服务端处理

  • - 表示相应平台不支持采集该事件

属性

  • Y 表示采集事件后相应属性可以自动获取,无需额外配置

  • N 表示需要额外配置才能有值

  • S 表示由服务端根据相应规则自动处理

  • - 表示相应平台不支持该属性

除了预置的事件和属性ID会以$开头,其他自定义的事件ID和属性ID,须注意命名方式:仅支持字母、数字和下划线,不能以数字或下划线开头,上限125个半角字符。

预置事件

1. Event:基础预置事件

基础预置事件会默认加入到方舟埋点方案

启动、关闭、浏览页面事件会在集成了基础 SDK 后会自动采集;

$app_click$web_click 用于记录点击网页/APP页面,用于分析点击位置热图、点击元素热图,集成 SDK 时设置参数autoHeatmap 设置为 true ;

$webstay 用于记录用户停留在可视区域,分析浏览深度线,集成 SDK 时设置参数 autoWebstaytrue;

$user_click 用于采集用户点击元素的事件,集成 SDK 时开启全埋点功能,即设置参数 autoTrack 为 true

对于用不到的事件可以选择不用,比如集成的平台中没有小程序时,可以不用 $share;没有 APP 时,可以不用 $app_crash

2. Event:APP 推广监测预置事件

在首次创建 APP 推广监测成功后,系统会自动将 APP 推广监测相关事件添加在埋点方案中

无需在 SDK 中进行特殊设置,用户点击来推广链接激活后会自动上报数据

3. Event:消息通知预置事件

在服务集成配置中配置消息通知推送通道后,系统会自动将这 3 个事件添加到埋点方案中

集成 SDK 时需要注意消息通知模块的设置,详见 SDK 集成文档

绑定用户实名信息

4. Profile 系列事件

$alias 事件之外的Profile 系列的事件用于上报用户属性,所以同样不会作为单独的事件去分析,即不会出现在分析模型中事件的选项中,也不会计入任意事件的计算。

除了上述预置事件之外,更多业务相关的事件,需要自定义埋点上报。

预置 Event 事件通用属性

事件属性描述事件发生的方式和内容,是分析过程中的维度,也可以用于条件过滤。

  • 事件通用属性:所有事件共同拥有的属性,e.g. 平台、应用版本、操作系统等;

  • 事件自有属性:某个事件独有的事件属性,e.g. 浏览页面事件 $pageview 会有 $url、$title 等属性。

非自动采集的属性,会根据相应字段自动解析

$ip :方舟的收数服务会自动记录上报的数据来源 IP,根据 IP 解析为国家、省份、城市三个字段

$county:通过 IP 解析

$province:通过 IP 解析

$city :通过 IP 解析

$device_type:通过 UA 解析

部分自动采集的属性不会作为独立的属性用于分析

$debug:用于标识是否入库

  • 0:表示关闭 Debug 模式

  • 1:表示打开 Debug 模式,但该模式下发送的数据仅用于调试,不计入平台数据统计

  • 2:表示打开 Debug 模式,该模式下发送的数据可计入平台数据统计

$session_id:标识一次会话

$user_agent:UA,用于解析设备类型、浏览器、浏览器版本、操作系统、操作系统版本 $device_id:系统唯一标识,默认不采集(4.4.5版本新增)

Andorid 采集规则:advertising id > android id > uuid,按照先后顺序获取

iOS 采集规则:idfa>idfv>uuid,按照先后顺序获取

预置 Event 事件自身属性

部分预置事件在通用属性之外,还有自身独有的属性

1 基础预置事件

$startup 启动

集成基础 SDK 后自动采集

$end 关闭

集成基础 SDK 后自动采集

$pageview 浏览页面

集成基础 SDK 后自动采集

  • $referrer 字段在 App 中手动调用 pageview 接口,默认不采集

  • $url_domain, $traffic_source_type, $search_engine 等非自动采集的属性,系统会根据$url 和 $referrer 自动解析

$user_click 点击元素(全埋点事件)

用于采集用户点击元素的事件,集成 SDK 时需开启全埋点功能,即设置参数 autoTrack 为 true

标识为 N 的属性表示设置参数 autoTrack 为 true 后,相应属性也需要额外配置

$webstay 视区停留

采集用户在可视区域的停留行为,分析浏览深度线,集成 SDK 时设置参数 autoWebstaytrue

$app_click APP点击

采集APP点击行为,用于分析点击位置热图、点击元素热图,集成 SDK 时设置参数autoHeatmap 设置为 true

$web_click Web点击

采集网页点击行为,用于分析点击位置热图、点击元素热图,集成 SDK 时设置参数autoHeatmap 设置为 true

$share 小程序分享

$app_crash APP崩溃

$alias 实名绑定

2 APP 推广监测预置事件

$campaign_track APP推广监测

$first_installation 首次安装激活

3 消息通知预置事件

$push_receiver_success 消息推送成功

$push_process_success 成功处理消息

$push_click 点击消息通知

预置用户属性

基础预置用户属性

默认加入到方舟埋点方案-用户方案中

推送相关用户属性

集成服务配置/EA配置后注册

渠道监测相关用户属性

首次创建APP推广监测成功时触发注册

以上内容没有解答我的问题?点击我进入方舟论坛去反馈 🚀

最后更新于