# 预置事件和属性
> 最后更新时间:2023-3-21
为了帮助开发者更快速的集成SDK,了解采集哪些用户行为和属性,我们预置了一些事件、事件属性和用户属性。
>[info] **说明**
> 部分默认自动采集,Android、iOS、JS 和 小程序端略有差异;
> 非默认采集的字段,如有需要,可以直接使用预置字段作为事件 ID、属性 ID 进行上报,以便数据集成时,能够自动生成预置看板。
>[info] 以下表格中涉及标识为 Y/N/- 的含义
> **事件**
> * **Y 表示相应平台默认自动采集**
> * **N 表示相应平台不默认采集,需额外配置进行采集**
> * **S 表示由服务端处理**
> * **\- 表示相应平台不支持采集该事件**
> **属性**
> * **Y 表示采集事件后相应属性可以自动获取,无需额外配置**
> * **N 表示需要额外配置才能有值**
> * **S 表示由服务端根据相应规则自动处理**
> * **\- 表示相应平台不支持该属性**
>[danger] 除了预置的事件和属性ID会以$开头,其他自定义的事件ID和属性ID,须注意命名方式:仅支持字母、数字和下划线,不能以数字或下划线开头,上限125个半角字符。
## 预置事件
### 1\. \*\*Event:\*\*基础预置事件
>[info] 基础预置事件会默认加入到方舟埋点方案
> 启动、关闭、浏览页面事件会在集成了基础 SDK 后会自动采集;
> **$app\_click**、\*\*$web\_click \*\*用于记录点击网页/APP页面,用于分析点击位置热图、点击元素热图,集成 SDK 时设置参数\_autoHeatmap \_设置为 *true ;*
> **$websta**y 用于记录用户停留在可视区域,分析浏览深度线,集成 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 | \- | \- | |
### 2\. Event:APP 推广监测预置事件
>[info] 在首次创建 APP 推广监测成功后,系统会自动将 APP 推广监测相关事件添加在埋点方案中
> 无需在 SDK 中进行特殊设置,用户点击来推广链接激活后会自动上报数据
| 事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- |
| $campaign\_track | APP推广监测 | APP扫描监测扫描二维码时上报 | S | S | \- | \- | |
| $first\_installation | 首次安装激活 | APP扫描监测扫描二维码后首次打开APP会时上报激活事件 | N | N | \- | \- | |
### 3\. Event:消息通知预置事件
>[info] 在服务集成配置中配置消息通知推送通道后,系统会自动将这 3 个事件添加到埋点方案中
> 集成 SDK 时需要注意消息通知模块的设置,详见 [SDK 集成文档](https://docs.analysys.cn/integration/sdk/android/xiao-xi-tui-song-mo-kuai)
| 事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $push\_receiver\_success | 消息推送成功 | 设备收到推送消息时触发 | N | N | \- | \- | 集成消息通知模块后,当用户设备收到消息通知时,上报该事件 |
| $push\_click | 点击推送消息 | 设备点击了推送消息时触发 | N | N | \- | \- | 用户设备上点击了消息通知,上报该事件 |
| $push\_process\_success | 成功处理push消息 | 成功处理push消息 | N | N | \- | \- | 用户点击了消息通知后,上报了$push\_click 事件后,自动触发上报该事件 |
#### 绑定用户实名信息
| 事件ID | 事件显示名称 | 事件说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- |
| $alias | 绑定用户实名信息 | 用户实名认证 | S | S | S | S | |
### 4\. Profile 系列事件
>[info] $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 | |
>[warning] 除了上述预置事件之外,更多业务相关的事件,需要自定义埋点上报。
> 详见:[埋点方案说明](features/project-manegement/data-integration/schema.md)
## 预置 Event 事件通用属性
事件属性描述事件发生的方式和内容,是分析过程中的维度,也可以用于条件过滤。
* 事件通用属性:所有事件共同拥有的属性,e.g. 平台、应用版本、操作系统等;
* 事件自有属性:某个事件独有的事件属性,e.g. 浏览页面事件 $pageview 会有 $url、$title 等属性。
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| appid | Appkey | 字符串 | 项目对应的Appkey | Y | Y | Y | Y | 系统会自动采集,但“元数据管理”页面上不可见 |
| $appid | 应用ID | 字符串 | 应用ID,如小程序ID(目前仅小程序可采集) | \- | \- | \- | Y | |
| $appname | 应用名称 | 字符串 | 应用名称,如小程序名称(目前仅小程序可采集) | \- | \- | \- | Y | |
| $app\_version | 应用版本 | 字符串 | 应用版本,e.g. V1.0 | Y | Y | \- | \- | |
| xwho | 用户ID | 字符串 | 用户ID | Y | Y | Y | Y | |
| distinct\_id | 唯一ID | 字符串 | 系统在 xwho 的基础上根据一些规则生成的唯一 ID | S | S | S | S | 用户在方舟系统中的的唯一ID,是进行“用户数”、分群计算的唯一标识 |
| xwhen | 触发时间 | 日期 | 事件发生的时间 | Y | Y | Y | Y | |
| ds | \- | 日期 | xwhen对应的日期,服务端处理 | S | S | S | S | 系统xwhen自动处理生成,但”元数据管理“页面上不可见 |
| xwhat | 事件ID | \- | \- | Y | Y | Y | Y | “事件”的唯一标识,但“元数据管理”页面上不可见 |
| xwhat\_id | \- | \- | \- | S | S | S | S | 系统根据xwhat自动处理生成,但“元数据”管理页面上不可见 |
| $session\_id | SessionID | 字符串 | 会话ID,e.g. 515950b8f1a6221c | Y | Y | Y | Y | |
| $is\_first\_day | 是否安装后首日访问 | 布尔 | 是否安装后首日访问 | Y | Y | Y | Y | |
| $is\_login | 是否是注册用户 | 布尔 | 是否是注册用户 | Y | Y | Y | Y | |
| $web\_crawler | 是否是爬虫 | 布尔 | 爬虫识别 | \- | \- | Y | \- | |
| $is\_time\_calibrated | 是否与服务端时间校准 | 布尔 | 是否与服务端时间校准 | N | N | \- | N | |
| $lib | SDK类型 | 字符串 | SDK类型,e.g. python、iOS等 | Y | Y | Y | Y | |
| $lib\_version | SDK版本 | 字符串 | SDK版本, e.g. :11.2.5 | Y | Y | Y | Y | |
| $platform | 平台 | 字符串 | 应用平台,枚举取值:JS/iOS/Android/Wechat | Y | Y | Y | Y | |
| $device\_id | 设备ID | 字符串 | 设备ID,idfa/oaid > idfv/androidid > uuid | N | N | \- | \- | |
| $device\_type | 设备类型 | 字符串 | 设备类型,e.g. PC、移动设备 | S | S | S | S | |
| $user\_agent | UA | 字符串 | UA | \- | \- | Y | \- | |
| $os | 操作系统 | 字符串 | 操作系统,e.g.Window、MacOS | Y | Y | S | Y | |
| $os\_version | 操作系统版本 | 字符串 | 操作系统版本,e.g.Windows 10 | Y | Y | S | Y | |
| $brand | 设备品牌 | 字符串 | 设备品牌,e.g. 华为荣耀 | Y | Y | S | Y | |
| $model | 设备型号 | 字符串 | 设备型号,e.g. iPhone8、小米4 | Y | Y | S | Y | |
| $manufacturer | 设备制造商 | 字符串 | 制造厂商, e.g. 小米 | Y | Y | \- | \- | |
| $screen\_width | 屏幕宽度 | 数值 | 屏幕宽度/屏幕分辨率,e.g. 1920 | Y | Y | Y | Y | |
| $screen\_height | 屏幕高度 | 数值 | 屏幕高度/屏幕分辨率,e.g. 768 | Y | Y | Y | Y | |
| $language | 语言 | 字符串 | 系统语言,e.g. zh-cn | Y | Y | Y | Y | |
| $time\_zone | 用户时区 | 字符串 | 用户时区,e.g.GMT+08:00 | Y | Y | Y | Y | |
| $ip | IP | 字符串 | IP地址 | S | S | S | S | |
| $country | 国家 | 字符串 | <p>事件发生时所在国家,</p><p>e.g. 中国、美国</p> | S | S | S | S | |
| $province | 省份 | 字符串 | <p>事件发生时所在省份,</p><p>e.g. 北京、上海、福建</p> | S | S | S | S | |
| $city | 城市 | 字符串 | <p>事件发生时所在城市,</p><p>e.g. 北京、厦门</p> | S | S | S | S | |
| $carrier\_name | 运营商 | 字符串 | 接入运营商名称,e.g. 中国联通 | Y | Y | \- | \- | |
| $network | 网络类型 | 字符串 | 网络类型,e.g. WIFI、2G、3G、4G | Y | Y | \- | Y | |
| $browser | 浏览器 | 字符串 | 浏览器名称,e.g. Chrome | \- | \- | S | Y | |
| $browser\_version | 浏览器版本 | 字符串 | 浏览器版本,e.g. Chrome 62.23.23 | \- | \- | S | Y | |
| $channel | 下载渠道 | 字符串 | 下载渠道,SDK 初始化时传入。仅 Android 通过渠道包分发时才有意义,iOS 会统一为“App Store” | Y | Y | \- | \- | |
| $utm\_campaign\_id | 活动ID | 字符串 | <p>根据添加的内容自动生成,</p><p>标识一次活动</p> | Y | Y | Y | Y | |
| $utm\_campaign | 活动/广告名称 | 字符串 | 特定的推广活动,e.g. 双11推广 | Y | Y | Y | Y | |
| $utm\_medium | 活动/广告媒介 | 字符串 | 推广类型,e.g. SEM,cpc | Y | Y | Y | Y | |
| $utm\_source | 活动/广告来源 | 字符串 | 推广来源,e.g. 今日头条 | Y | Y | Y | Y | |
| $utm\_content | 活动/广告内容 | 字符串 | 广告内容,e.g. 优惠信息 | Y | Y | Y | Y | |
| $utm\_term | 活动/广告关键字 | 字符串 | 广告关键字,e.g. 用户画像 | Y | Y | Y | Y | |
| $session\_id | SessionID | 字符串 | 会话ID,e.g. 515950b8f1a6221c | Y | Y | Y | Y | |
| $debug | Debug模式 | 数值 | 标识数据处理方式,0:非debug 1:debug,不入库 2:debug,入库 | Y | Y | Y | Y | |
| $importflag | 是否工具导入 | 数值 | 标识是否是工具导入,1为工具导入 | N | N | N | N | |
>[info] **非自动采集的属性,会根据相应字段自动解析**
> **$ip :** 方舟的收数服务会自动记录上报的数据来源 IP,根据 IP 解析为国家、省份、城市三个字段
> **$county:** 通过 IP 解析
> **$province:** 通过 IP 解析
> **$city :** 通过 IP 解析
> **$device\_type:** 通过 UA 解析
>[info] **部分自动采集的属性不可在属性列表中进行选择用于分析**
> **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 启动**
>[info] 集成基础 SDK 后自动采集
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | --- | :-: | --- |
| $is\_first\_time | 是否安装后首次访问 | 布尔 | 是否安装后首次访问 | Y | Y | Y | Y | |
| $is\_from\_background | 是否从后台唤醒 | 布尔 | 是否从后台唤醒恢复 | Y | Y | \- | \- | |
| $start\_source | 启动来源 | 字符串 | 标识APP的启动来源,e.g. 通过点击图标启动、点击通知、URL唤醒、3D touch等 | N | N | \- | \- | |
| $scene | 场景值 | 字符串 | 标识小程序的场景值,e.g 顶部搜索框的搜索结果页 | \- | \- | \- | N | |
| $scene\_type | 场景值类型 | 字符串 | 标识小程序场景值类型 | \- | \- | \- | S | |
### **$end 关闭**
>[info] **集成基础 SDK 后自动采集**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $duration | 使用时长 | 数值 | <p>从启动到关闭的使用时长<br>单位:毫秒</p> | Y | Y | \- | \- | |
### **$pageview 浏览页面**
>[info] **集成基础 SDK 后自动采集**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $url | 页面URL(含参) | 字符串 | 页面完整路径 | Y | Y | Y | Y | |
| $url\_domain | 页面URL(去参) | 字符串 | 去参的页面URL | \- | \- | S | \- | |
| $title | 页面标题 | 字符串 | 页面标题 | Y | Y | Y | \- | |
| $referrer | 页面来源 | 字符串 | 页面来源 | Y | Y | Y | Y | |
| $referrer\_domain | 页面来源域名 | 字符串 | 页面来源域名 | \- | \- | Y | \- | |
| $traffic\_source\_type | 流量来源类型 | 字符串 | 流量来源类型,数据处理 | \- | \- | S | \- | |
| $search\_engine | 搜索引擎 | 字符串 | 标识搜索引擎来源,e.g. 百度 | \- | \- | S | \- | |
| $search\_keyword | 搜索关键词 | 字符串 | 标识搜索词来源,e.g. 易观方舟 | \- | \- | S | \- | |
| $social\_media | 社交媒体 | 字符串 | 标识社交媒体来源,e.g. 微博 | \- | \- | S | \- | |
| $social\_share\_from | 社交媒体分享来源 | 字符串 | 标识微信来源,e.g. 微信朋友圈、微信群 | \- | \- | S | \- | |
| $scene | 场景值 | 字符串 | 标识小程序的场景值,e.g 顶部搜索框的搜索结果页 | \- | \- | \- | Y | |
| $scene\_type | 场景值类型 | 字符串 | 标识小程序场景值类型 | \- | \- | \- | S | |
| $startup\_time | 启动时间 | 日期 | yyyy-MM-dd hh:mm:ss.SSS | \- | \- | Y | Y | |
| $share\_id | 分享者ID | 字符串 | 当点击分享的小程序后上报来源 | \- | \- | \- | N | |
| $share\_level | 转发层级 | 数值 | 当点击分享的小程序后上报来源 | \- | \- | \- | N | |
| $share\_path | 转发地址 | 字符串 | 当点击分享的小程序后上报来源 | \-- | \- | \- | N | |
>[info] * **$referrer 字段在 App 中手动调用 pageview 接口,默认不采集**
> * **$url\_domain, $traffic\_source\_type, $search\_engine 等非自动采集的属性,系统会根据$url 和 $referrer 自动解析**
### **$user\_click 点击元素(全埋点事件)**
>[info] 全埋点事件
> 用于采集用户点击元素的事件
> 集成 SDK 时需开启全埋点功能,即设置参数 \_autoTrack 为 true \_
> 标识为 N 的属性表示设置参数 \_autoTrack 为 true \_后,相应属性也需要额外配置
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $title | 页面标题 | 字符串 | 页面标题 | Y | Y | Y | \- | |
| $parent\_url | 父页面URL | 字符串 | 页面URL,为空则为顶级页 | Y | \- | \- | \- | |
| $url | 页面URL | 字符串 | 页面URL | Y | Y | Y | Y | |
| $url\_path | 页面地址(不含参) | 字符串 | 页面地址(不含参) | \- | \- | Y | Y | |
| $element\_path | 元素路径 | 字符串 | APP 为元素唯一标识;JS 为元素路径 | Y | Y | Y | \- | |
| $element\_class\_name | 元素样式的类 | 字符串 | 仅 JS 有效 | \- | \- | Y | \- | |
| $element\_target\_url | 元素链接地址 | 字符串 | 仅 JS 有效 | \- | \- | Y | \- | |
| $element\_id | 元素ID | 字符串 | 元素ID | Y | Y | Y | N | |
| $element\_name | 元素名称 | 字符串 | 仅 JS 有效 | \- | \- | Y | N | |
| $element\_type | 元素类型 | 字符串 | 元素类型 | Y | Y | Y | N | |
| $element\_position | 列表控件位置 (可选) | 字符串 | 列表控件位置 (可选) | Y | Y | \- | \- | |
| $element\_content | 元素内容 | 字符串 | 元素的内容(优先级:内容>描述>空) | Y | Y | Y | \- | |
| $element\_function | 触发事件名(函数名) | 字符串 | 函数名,用于标识点击元素触发事件名 | \- | \- | \- | Y | |
### **$webstay 视区停留**
>[info] Web 热图事件
> 采集用户在可视区域的停留行为,分析浏览深度线,
> 需在集成 SDK 时设置参数 *autoWebstay* 为 \*true ,\*方可自动采集下述属性
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $url | 页面URL | 字符串 | 页面URL/页面完整路径 | \- | \- | Y | \- | |
| $title | 页面标题 | 字符串 | 页面标题 | \- | \- | Y | \- | |
| $referrer | 页面来源 | 字符串 | 页面来源 | \- | \- | Y | \- | |
| $referrer\_domain | 页面来源域名 | 字符串 | 页面来源域名 | \- | \- | Y | \- | |
| $viewport\_width | 视区宽度 | 数值 | 视区宽度 | \- | \- | Y | \- | |
| $viewport\_position | 视区距顶部的位置 | 数值 | 视区距顶部的位置 | \- | \- | Y | \- | |
| $viewport\_height | 视区高度 | 数值 | 视区高度 | \- | \- | Y | \- | |
| $event\_duration | 视区停留时间 | 数值 | 视区停留时间 | \- | \- | Y | \- | |
### **$web\_click Web点击**
>[info] Web 热图事件
> 采集网页点击行为,用于分析点击位置热图、点击元素热图
> 集成 SDK 时设置参数\_autoHeatmap \_设置为 \_true \_
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $page\_width | 页面宽度 | 数值 | 热图页面宽度 | Y | Y | Y | \- | |
| $page\_height | 页面高度 | 数值 | 热图页面高度 | Y | Y | Y | \- | |
| $screen\_dpi | 屏幕DPI | 数值 | 屏幕DPI | Y | \- | \- | \- | |
| $screen\_scale | 屏幕缩放比 | 数值 | 屏幕缩放比 | Y | \- | \- | \- | |
| $click\_x | 点击X坐标 | 数值 | 热图点击X坐标 | Y | Y | Y | \- | |
| $click\_y | 点击Y坐标 | 数值 | 热图点击Y坐标 | Y | Y | Y | \- | |
| $url | 页面URL | 字符串 | 点击热图时页面URL | Y | Y | Y | \- | |
| $element\_x | 元素X坐标 | 数值 | 点击元素X坐标 | Y | Y | Y | \- | |
| $element\_y | 元素Y坐标 | 数值 | 点击元素Y坐标 | Y | Y | Y | \- | |
| $element\_path | 元素路径 | 字符串 | 热图元素路径 | Y | Y | Y | \- | |
| $element\_name | 元素名称 | 字符串 | 热图元素名称 | \- | Y | \- | \- | |
| $element\_type | 元素类型 | 字符串 | 热图元素类型 | Y | Y | Y | \- | |
| $element\_content | 元素内容 | 字符串 | 热图元素的内容 | Y | Y | Y | \- | |
| $element\_clickable | 是否可以点击元素 | 数值 | 是否可以点击元素 | Y | Y | Y | \- | |
| $element\_target\_url | 元素链接地址 | 字符串 | 仅 JS 有效 | \- | \- | Y | \- | |
| $url\_path | 页面地址(不含参) | 字符串 | 页面地址(不含参) | \- | \- | Y | \- | |
| $title | 页面标题 | 字符串 | 页面标题 | \- | \- | Y | \- | |
| $element\_id | 元素id | 字符串<br> | 元素id | \- | \- | Y | \- | |
| $element\_class\_name | 元素样式的类名 | 字符串 | 仅JS有效 | \- | \- | Y | \- | |
### **$app\_click APP点击**
>[info] APP 热图事件
> 采集APP点击行为,用于分析点击位置热图、点击元素热图,集成 SDK 时设置参数\_autoHeatmap \_设置为 \_true \_
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $page\_width | 页面宽度 | 数值 | 热图页面宽度 | Y | Y | \- | \- | |
| $page\_height | 页面高度 | 数值 | 热图页面高度 | Y | Y | \- | \- | |
| $screen\_dpi | 屏幕DPI | 数值 | 屏幕DPI | Y | \- | \- | \- | |
| $screen\_scale | 屏幕缩放比 | 数值 | 屏幕缩放比 | Y | \- | \- | \- | |
| $click\_x | 点击X坐标 | 数值 | 热图点击X坐标 | Y | Y | \- | \- | |
| $click\_y | 点击Y坐标 | 数值 | 热图点击Y坐标 | Y | Y | \- | \- | |
| $url | 页面URL | 字符串 | 点击热图时页面URL | Y | Y | \- | \- | |
| $element\_x | 元素X坐标 | 数值 | 点击元素X坐标 | Y | Y | \- | \- | |
| $element\_y | 元素Y坐标 | 数值 | 点击元素Y坐标 | Y | Y | \- | \- | |
| $element\_path | 元素路径 | 字符串 | 热图元素路径 | Y | Y | \- | \- | |
| $element\_name | 元素名称 | 字符串 | 热图元素名称 | \- | Y | \- | \- | |
| $element\_type | 元素类型 | 字符串 | 热图元素类型 | Y | Y | \- | \- | |
| $element\_content | 元素内容 | 字符串 | 热图元素的内容 | Y | Y | \- | \- | |
| $element\_clickable | 是否可以点击元素 | 数值 | 是否可以点击元素 | Y | Y | \- | \- | |
| $element\_id|元素id | 字符串 | 元素id | Y | Y | \- | \- | | |
| $screen\_height | 屏幕高度 | 数值 | 屏幕高度素 | Y | \- | \- | \- | |
| $screen\_width | 屏幕宽度 | 数值 | 屏幕宽度 | Y | \- | \- | \- | |
### **$share 小程序分享**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $share\_id | 分享者ID | 字符串 | 当点击分享的小程序后上报来源 | \- | \- | \- | N | |
| $share\_level | 转发层级 | 数值 | 当点击分享的小程序后上报来源 | \- | \- | \- | N | |
| $share\_path | 转发地址 | 字符串 | 当点击分享的小程序后上报来源 | \- | \- | \- | N | |
### $app\_crash APP崩溃
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $crash\_data | 崩溃原因 | 字符串 | 崩溃的堆栈信息 | Y | Y | \- | \- | |
### **$alias 实名绑定**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $original\_id | 匿名ID | 字符串 | 实名绑定前的匿名ID | Y | Y | Y | Y | |
### 2 APP 推广监测预置事件
### $campaign\_track APP推广监测
| 属性ID | 属性名称 | 属性值数据类型 | 属性说明 | <p>Android<br>自动采集</p> | <p>iOS<br>自动采集</p> | <p>JS<br>自动采集</p> | <p>小程序<br>自动采集</p> | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| $campaign\_channelid | 推广渠道ID | 数值 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
| $campaign\_shortlink | 推广跳转短链CODE | 字符串 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
| $prop\_0 | 推广渠道信息1 | 字符串 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
| $prop\_1 | 推广渠道信息2 | 字符串 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
| $prop\_2 | 推广渠道信息3 | 字符串 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
| $prop\_3 | 推广渠道信息4 | 字符串 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
| $prop\_4 | 推广渠道信息5 | 字符串 | APP推广监测扫描二维码时上报 | S | S | \- | \- | |
### $first\_installation 首次安装激活
| 属性ID | 属性名称 | 属性值数据类型 | 属性说明 | <p>Android<br>自动采集</p> | <p>iOS<br>自动采集</p> | <p>JS<br>自动采集</p> | <p>小程序<br>自动采集</p> | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| $fingerprint | 设备指纹 | 数值 | 设备指纹 | S | S | \- | \- | |
| $track\_xwhen | 激活时间 | 数值 | 指纹匹配上的时间 | S | S | \- | \- | |
####
### 3 消息通知预置事件
### **$push\_receiver\_success 消息推送成功**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $action\_type | 操作类型 | 数值 | 点击消息通知后的操作类型 | N | N | \- | \- | |
| $action | 操作 | 字符串 | 点击消息通知后的操作 | N | N | \- | \- | |
### **$push\_process\_success 成功处理消息**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $action\_type | 操作类型 | 数值 | 点击消息通知后的操作类型 | N | N | \- | \- | |
| $action | 操作 | 字符串 | 点击消息通知后的操作 | N | N | \- | \- | |
### **$push\_click 点击消息通知**
| 属性ID | 属性显示名称 | 数据类型 | 属性说明 | Android | iOS | JS | 小程序 | 特别说明 |
| --- | --- | --- | --- | :-: | :-: | :-: | :-: | --- |
| $action\_type | 操作类型 | 数值 | 点击消息通知后的操作类型 | N | N | \- | \- | |
| $action | 操作 | 字符串 | 点击消息通知后的操作 | N | N | \- | \- | |
## 预置用户属性
### **基础预置用户属性**
>[info] 默认加入到方舟埋点方案-用户方案中
| 属性ID | 属性名称 | 属性值数据类型 | 属性说明 | <p>Android<br>自动采集</p> | <p>iOS<br>自动采集</p> | <p>JS<br>自动采集</p> | <p>小程序<br>自动采集</p> | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| distinct\_id | 唯一ID | 数值 | 方舟系统生成的用户唯一ID | S | S | S | S | |
| xwho | 用户ID | 字符串 | 行为主体 | Y | Y | Y | Y | |
| xwhen | 用户属性更新时间 | 日期时间 | 用户属性更新时间 | Y | Y | Y | Y | “元数据管理”页面不可见 |
| $original\_id | 匿名ID | 字符串 | 实名绑定前的匿名ID | S | S | S | S | |
| $original\_id\_list | 匿名ID列表 | 字符串 | 实名绑定过的匿名ID列表 | S | S | S | S | |
| $idfv | IDFV | 字符串 | IDFV | \- | N | \- | \- | |
| $idfa | IDFA | 字符串 | IDFA | \- | N | \- | \- | |
| $mac | MAC | 字符串 | MAC | N | \- | \- | \- | |
| $device\_id | DeviceID | 字符串 | DeviceID | N | N | | | |
| $imei | IMEI | 字符串 | IMEI | N | \- | \- | \- | |
| $wechatopenid | 微信OpenID | 字符串 | 微信OpenID | \- | \- | \- | N | |
| $phone | 手机号 | 字符串 | 手机号 | N | N | N | N | |
| $email | 邮箱 | 字符串 | 邮箱 | N | N | N | N | |
| $platform | 最后一次使用平台 | 字符串 | 最后一次使用平台 | Y | Y | Y | Y | |
| $lib | 最新版本的SDK类型(用户数据中的$lib 取值,仅记录最新版本的SDK类型) | 字符串 | SDK类型,e.g. python、iOS等 | Y | Y | Y | Y | “元数据管理”页面不可见 |
| $lib\_version | 最新版本的SDK版本(用户数据中$lib\_version的取值,仅记录最新版本的SDK版本号) | 字符串 | SDK版本,e.g. 11.2.5 | Y | Y | Y | Y | “元数据管理”页面不可见 |
| $country | 所在国家 | 字符串 | 用户所在国家 | N | N | N | N | |
| $province | 所在省份 | 字符串 | 用户所在省份 | N | N | N | N | |
| $city | 所在城市 | 字符串 | 用户所在城市 | N | N | N | N | |
| $is\_login | 是否是注册帐号 | 布尔值 | 是否是注册帐号 | Y | Y | Y | Y | |
| $signup\_time | 注册时间 | 日期时间 | 注册时间 | N | N | N | N | |
| $first\_visit\_time | 首次访问时间 | 日期时间 | 首次访问时间 | Y | Y | Y | Y | |
| $first\_visit\_language | 首次访问语言 | 字符串 | 设备语言 | Y | Y | Y | Y | |
| $time\_zone | 时区 | 字符串 | GMT+08:00 | Y | Y | Y | Y | |
| $debug | Debug模式 | 数值 | | Y | Y | Y | Y | |
| $importflag | 是否工具导入 | 数值 | | S | S | S | S | |
### **推送相关用户属性**
>[info] 集成服务配置/EA配置后注册
| 属性ID | 属性名称 | 属性值数据类型 | 属性说明 | <p>Android<br>自动采集</p> | <p>iOS<br>自动采集</p> | <p>JS<br>自动采集</p> | <p>小程序<br>自动采集</p> | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| $getui | 个推ID | 字符串 | 个推推送ID | N | N | \- | \- | |
| $jpush | 极光ID | 字符串 | 极光推送ID | N | N | \- | \- | |
| $baidu | 百度ID | 字符串 | 百度推送ID | N | N | \- | \- | |
| $xiaomi | 小米ID | 字符串 | 小米推送ID | N | N | \- | \- | |
| $huawei | 华为ID | 字符串 | 华为推送ID | N | \- | \- | \- | |
| $aliyun | 阿里云ID | 字符串 | 阿里云推送ID | N | N | N | N | |
| $xinge | 信鸽ID | 字符串 | 信鸽推送ID | N | N | N | N | |
| $apns | ANPS | 字符串 | ANPS | \- | N | \- | \- | |
| $meizu | 魅族ID | 字符串 | 魅族推送ID | N | \- | \- | \- | |
| $oppo | OPPOID | 字符串 | OPPO推送ID | N | \- | \- | \- | |
| $vivo | VIVOID | 字符串 | VIVO推送ID | N | \- | \- | \- | |
### 渠道监测相关用户属性
>[info] 首次创建APP推广监测成功时触发注册
| 属性ID | 属性名称 | 属性值数据类型 | 属性说明 | <p>Android<br>自动采集</p> | <p>iOS<br>自动采集</p> | <p>JS<br>自动采集</p> | <p>小程序<br>自动采集</p> | 特别说明 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| $prop\_0 | 推广渠道信息1 | 字符串 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
| $prop\_1 | 推广渠道信息2 | 字符串 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
| $prop\_2 | 推广渠道信息3 | 字符串 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
| $prop\_3 | 推广渠道信息4 | 字符串 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
| $prop\_4 | 推广渠道信息5 | 字符串 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
| $campaign\_shortlink | 推广跳转短链CODE | 字符串 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
| $campaign\_channelid | 推广渠道ID | 数值 | APP推广监测扫描二维码时上报 | Y | Y | \- | \- | |
- 产品简介
- 快速上手
- Step 1 安装部署
- Step 2 激活系统创建项目
- Step 3 开启您的分析旅程
- 1. 集成 SDK
- 2. 可视化埋点
- 3. 创建分析模型
- 附:埋点方案设计
- 附:数据分析思路
- 产品更新日志
- V5.5 新增LTV分析功能等
- V5.3 UI 升级、分布分析重构、维度表动态更新、细节优化等
- V5.2 新增归因分析、消息中心、重构埋点方案、优化看数据体验……
- V5.1.0317 体验优化& Bug修复
- V5.1 升级可视化埋点、增强权限控制……
- Part I 产品功能说明
- 名词解释
- 指标说明
- 看板
- 5.3.3 看板 UI 重构
- 分析
- 事件分析
- 渠道分析
- 渠道相关名词解释
- 来源识别规则
- 搜索引擎
- 社交媒体
- 小程序场景值
- Session 分析
- Session 规则
- 实时分析
- 留存分析
- 转化漏斗
- 智能路径
- 归因分析
- 热图分析
- Web/H5 热图
- APP 热图
- 分布分析
- 间隔分析
- 属性分析
- LTV 分析
- 多主体分析
- 自定义查询
- 用户
- 用户分群
- 用户探查
- 用户标签
- 标签体系应用概览
- 标签体系
- 标签生命周期管理
- 标签加工
- 如何自定义SQL创建标签
- 单用户档案
- 运营
- 广告跟踪
- 微信小程序渠道追踪
- 预置广告媒介和渠道
- App 推广监测(Beta版本)
- 电子邮件(即将下线)
- 短信(即将下线)
- 消息通知(即将下线)
- 项目管理
- 项目概览
- 项目角色管理
- 项目成员管理
- 数据接入管理
- 埋点方案
- 可视化埋点
- 集成SDK接入数据
- 数据验证
- 用户数据导入
- 微信小程序全埋点事件定义
- 元数据管理
- 元事件
- 虚拟事件
- 事件属性
- 用户属性
- Session 管理
- 页面组管理
- 维度表
- 服务集成配置
- 监控告警
- 智能监控
- 自定义监控
- 平台管理
- 企业概览
- 项目管理
- 成员管理
- 安全设置
- 企业设置
- 日志管理
- 帐号设置
- Part II 技术文档
- 技术接入准备工作
- 部署环境检测工具
- 数据模型
- 数据格式
- 预置事件和属性
- App预置事件/属性
- JS 预置事件/属性
- 如何准确识别用户
- 如何设计埋点方案
- 分平台上报数据 vs 跨平台打通
- SDK 指南
- Android SDK
- 快速集成
- 全埋点模块
- 消息推送模块
- Android Hybrid模式
- SDK Gradle集成方式
- 多渠道打包
- 易观小工具
- 合规相关
- iOS SDK
- 快速集成
- 全埋点介绍
- iOS Hybrid模式
- 消息推送模块
- JS SDK
- 快速集成
- JS SDK基础版
- JS SDK插件
- uni-app SDK
- 快速集成
- 打包原生APP
- 开启移动端全埋点
- uni-app SDK标准版
- 微信小程序 SDK
- 快速集成
- 微信小程序标准版
- 微信小程序插件版
- 微信小程序通用框架版
- 支付宝小程序 SDK
- 支付宝小程序标准版
- 支付宝小程序通用框架版
- 字节跳动小程序 SDK
- 字节跳动小程序标准版
- 字节跳动小程序通用框架版
- 百度小程序 SDK
- 百度小程序标准版
- 百度小程序通用框架版
- 钉钉小程序 SDK
- 钉钉小程序标准版
- 钉钉小程序通用框架版
- QQ小程序 SDK
- QQ小程序标准版
- QQ小程序通用框架版
- 快应用 SDK
- 华为WeCode小程序
- WeCode SDK 标准版
- WeCode SDK插件
- PhoneGap SDK
- mPaaS SDK
- ReactNative SDK
- Flutter SDK
- Java SDK
- Python SDK
- PHP SDK
- C++ SDK
- C# SDK
- Node JS SDK
- Lua SDK
- Golang SDK
- SDK FAQ
- identify与alias的区别
- 爬虫数据如何识别?
- 页面停留如何获取时间?
- 如果获取SDK及更新日志
- 代码埋点和无埋点有什么区别
- Web页面中发现丢失某一个事件
- 自研 SDK 注意事项
- 页面时长统计功能
- 飞书小程序 SDK
- 飞书小程序标准版
- 飞书小程序通用框架版
- Unreal Engine SDK
- 数据验证
- 客户端埋点验证
- Debug 数据验证
- 数据入库验证
- 数据导入
- 接口导入
- JAVA工具包
- 标准json文件导入
- csv格式导入
- 数据导入FAQ
- 数据导出
- JAVA工具包
- 事件数据导出
- 用户数据导出
- 直接从Kafka中消费数据
- 使用程序访问数据库
- 脚本工具
- API
- 分析API
- 事件分析
- 留存分析
- 自定义查询
- 转化漏斗
- 属性分析
- Session分析
- 渠道分析
- 分布分析
- 用户API
- 分群查询
- 用户档案
- 分群管理
- 管理API
- 权限管理
- 元数据管理
- 埋点方案管理
- 维度表管理
- 运营API
- 广告跟踪
- APP推广监测
- 平台管理API
- 项目管理
- 成员管理
- 第三方登录
- OAuth2.0登录
- LDAP登录
- GDPR 合规
- Part III 常见问题
- License 许可
- 产品试用及采购
- 参与贡献