ae-tracking 0.1.0

package/wiki/te-docs/raw//346/216/245/345/205/245/345/211/215/345/207/206/345/244/207/345/267/245/344/275/234//351/242/204/347/275/256/345/261/236/346/200/247/344/270/216/347/263/273/347/273/237/345/255/227/346/256/265.md

@@ -0,0 +1,634 @@
+---
+code: preset_properties
+name: "预置属性与系统字段"
+wikiToken: Ol8rw9SUXi45lqkBDXGc48tDnhf
+parentWikiToken: Bmhewqk5PiJirhk1GJzcJliqnOh
+updateTime: 1747886279000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=preset_properties
+---
+# 预置属性与系统字段
+
+::: tip 提示
+
+本节将会介绍TE中所有的的预置属性以及系统字段，具体平台的预置属性可以参考:
+
+Android平台 、iOS平台 、Web平台 、小程序&小游戏平台、服务端
+
+ :::
+
+预置属性指的是由 AE 生成或取得的属性，所有的预置属性以"#"开头，**且都为****事件属性**，且这些属性的中文名以及意义都已经确定。系统字段指的是数据中的结构字段（如`#account_id`、`#event_time`等），或者数据库中具有特殊用途的字段，在分析模型中往往不会被使用，或者被间接使用。
+
+**除以下罗列的预置属性外，任何以"#"开头的属性都被视为非法字段，将无法入库，因此不建议您将自定义属性设置成以"#"开头，所有系统字段不能作为事件或用户属性，在数据接入时传入。**
+
+**请注意，除了**`#ip`**之外的所有预置属性，不建议您直接使用，只有在同时使用客户端 SDK 与其他传输方式，需要让多端数据的属性一致时，****才****建议在 AE 工作人员的引导下进行设置****，请务必确保您上报的数据里预置属性的属性类型和表格内一致，类型不一致则****该属性的值将会被抛弃（即取值为 null）。**
+
+- 预置属性
+**属性名**
+
+**中文名**
+
+**属性类型**
+
+**说明**
+
+#ip
+
+客户端IP
+
+文本
+
+用户的 IP 地址，AE 将以此获取用户的地理位置信息
+
+#country
+
+国家地区
+
+文本
+
+用户所在国家或地区，根据 IP 地址生成
+
+#country_code
+
+国家地区代码
+
+文本
+
+用户所在国家或地区的国家地区代码(ISO 3166-1 alpha-2，即两位大写英文字母)，根据 IP 地址生成
+
+#province
+
+省份
+
+文本
+
+用户所在省份，根据 IP 地址生成
+
+#city
+
+城市
+
+文本
+
+用户所在城市，根据 IP 地址生成
+
+#os_version
+
+操作系统版本
+
+文本
+
+iOS 11.2.2、Android 8.0.0 等
+
+#manufacturer
+
+生产商
+
+文本
+
+用户设备的制造商，如 Apple，vivo 等
+
+#os
+
+操作系统
+
+文本
+
+如 Android、iOS 等
+
+#device_id
+
+设备号
+
+文本
+
+用户的设备 ID，iOS 取用户的 IDFV 或 UUID，Android 取 androidID
+
+#screen_height
+
+屏幕高度
+
+数值
+
+用户设备的屏幕高度，如 1920 等
+
+#screen_width
+
+屏幕宽度
+
+数值
+
+用户设备的屏幕宽度，如 1080 等
+
+#device_model
+
+设备型号
+
+文本
+
+用户设备的型号，如 iPhone 8 等
+
+#device_type
+
+设备类型
+
+文本
+
+用户设备的类型，如iPad,iPhone等
+
+#app_version
+
+app版本
+
+文本
+
+您的 APP 的版本
+
+#bundle_id
+
+应用包名
+
+文本
+
+APP包名或者进程名
+
+#lib
+
+SDK 类型
+
+文本
+
+您接入 SDK 的类型，如 Android，iOS 等
+
+#lib_version
+
+SDK 版本
+
+文本
+
+您接入 SDK 的版本
+
+#network_type
+
+网络类型
+
+文本
+
+事件发生时的网络状态，如 WIFI、3G、4G 等
+
+#carrier
+
+运营商
+
+文本
+
+用户设备的网络运营商，如中国移动，中国电信等
+
+#browser
+
+浏览器
+
+文本
+
+用户使用的浏览器类型，如 Chrome，Firefox 等
+
+#browser_version
+
+浏览器版本
+
+文本
+
+用户使用的浏览器的版本，如 Chrome 61.0，Firefox 57.0 等
+
+#duration
+
+事件时长
+
+数值
+
+使用计时功能记录的时长，单位是秒
+
+#url
+
+页面地址
+
+文本
+
+自动采集事件中使用，当前页面（非业务定义的页面）的地址。在web页面中取值为 location.href，Android / iOS 平台取值为自定义的页面路径
+
+#url_path
+
+页面路径
+
+文本
+
+自动采集事件中使用，当前页面（非业务定义的页面）的路径。取值为 location.pathname
+
+#referrer
+
+前向地址
+
+文本
+
+自动采集事件中使用，跳转前页面（非业务定义的页面）的地址。在 web 页面中取值为 document.referrer，Android / iOS 平台取值为自定义的前项页面路径
+
+#referrer_host
+
+前向域名
+
+文本
+
+自动采集事件中使用，跳转前页面（非业务定义的页面）的路径。取值为 referrer 的 host
+
+#title
+
+页面标题
+
+文本
+
+自动采集事件中使用,当前页面（非业务定义的页面）的标题。在web页面中取值为document.title。Android 平台取值为 Activity 的标题，取值为 Activity 的 title 属性的值。iOS平台取值为 View Controller 的标题，取值为 controller.navigationItem.title 属性的值
+
+#screen_name
+
+页面名称
+
+文本
+
+自动采集事件中使用，页面（非业务定义的页面）的名称。Android 平台取值为 Activity 的包名.类名；iOS平台取值 View Controller 的类名
+
+#element_id
+
+元素 ID
+
+文本
+
+自动采集事件中使用，控件的 ID
+
+#element_type
+
+元素类型
+
+文本
+
+自动采集事件中使用，控件的类型
+
+#resume_from_background
+
+是否从后台唤醒
+
+布尔
+
+自动采集事件中使用，应用是否从后台唤醒，布尔型
+
+#element_selector
+
+元素选择器
+
+文本
+
+自动采集事件中使用，控件的 viewPath
+
+#element_position
+
+元素位置
+
+文本
+
+自动采集事件中使用，控件的位置信息
+
+#element_content
+
+元素内容
+
+文本
+
+自动采集事件中使用，控件上的内容
+
+#scene
+
+场景值
+
+数值
+
+微信小程序启动时传入的场景值
+
+#mp_platform
+
+小程序平台
+
+文本
+
+标识应用所在的平台
+
+#app_crashed_reason
+
+异常信息
+
+文本
+
+自动采集事件中使用，记录 APP 崩溃的堆栈信息
+
+#zone_offset
+
+时区偏移
+
+数值
+
+数据时间相对 UTC 时间的偏移小时数
+
+#system_language
+
+系统默认语言
+
+文本
+
+用户设备的系统语言(ISO 639-1，即两位小写英文字母)，如 zh, en 等
+
+#install_time
+
+App安装时间
+
+时间
+
+用户安装应用的时间，值来源于系统
+
+#simulator
+
+是否为模拟器
+
+数值
+
+设备是否是模拟器 true/false
+
+#ram
+
+内存(GB)
+
+文本
+
+用户设备的当前剩余内存和总内存，单位GB，如 1.4/2.4
+
+#disk
+
+硬盘(GB)
+
+文本
+
+用户设备的当前剩余存储空间和总存储空间，单位GB，如 30/200
+
+#fps
+
+FPS
+
+数值
+
+用户设备的当前图像每秒传输帧率，如 60
+
+#background_duration
+
+后台停留时长
+
+数值
+
+记录两次start事件发生区间内，应用进入后台的时长，单位是秒
+
+#start_reason
+
+启动原因
+
+文本
+
+只有当应用被非launcher方式启动时存在该属性，如deeplink方式或者其他应用startActivity启动，数据样例："#start_reason":"{"url":"thinkingdata:\/\/","data":""}"
+
+#ua
+
+用户当前的代理信息
+
+文本
+
+用能够识别客户使用的操作系统及版本、CPU 类型、浏览器及版本、浏览器渲染引擎、浏览器语言、浏览器插件等。
+
+#utm
+
+广告系列来源属性
+
+文本
+
+用户来源的广告信息，其中包含广告来源，广告媒介等信息 
+
+- 事件表中的系统字段
+**字段名**
+
+**中文名**
+
+**属性类型**
+
+**说明**
+
+$part_event
+
+事件分区字段
+
+文本
+
+事件分区字段，取自 #event_name，即事件名
+
+$part_date
+
+日期分区字段
+
+时间
+
+日期分区字段，取自 #event_time ，也就是事件发生的日期
+
+#app_id
+
+项目ID
+
+文本
+
+事件所属项目ID
+
+#user_id
+
+用户唯一 ID
+
+数值
+
+用户在系统中的唯一用户标识
+
+#account_id
+
+账户 ID
+
+文本
+
+账户 ID，相当于数据中的 #account_id
+
+#distinct_id
+
+访客 ID
+
+文本
+
+访客 ID，相当于数据中的 #distinct_id
+
+#event_name
+
+事件名称
+
+文本
+
+事件名称，相当于数据中的 #event_name 字段
+
+#event_time
+
+事件时间
+
+时间
+
+事件时间，相当于数据中的 #time 字段
+
+#server_time
+
+服务端时间
+
+时间
+
+服务端收到数据的时间
+
+#dw_create_time
+
+首次入库时间
+
+时间
+
+该条事件数据入库时间，可更新事件该属性都是null
+
+#dw_update_time
+
+入库更新时间
+
+时间
+
+该条事件数据入库更新时间，非可更新事件该属性都是null
+
+#kafka_offset
+
+kafka偏移值
+
+数值
+
+事件存储在kafka上的偏移值
+
+#uuid
+
+UUID
+
+文本
+
+事件的识别ID
+
+- 用户表中的系统字段
+**字段名**
+
+**中文名**
+
+**属性类型**
+
+**说明**
+
+#user_id
+
+用户唯一 ID
+
+数值
+
+用户在系统中的唯一用户标识
+
+#account_id
+
+账户 ID
+
+文本
+
+账户 ID，相当于数据中的 #account_id
+
+#distinct_id
+
+访客 ID
+
+文本
+
+访客 ID，相当于数据中的 #distinct_id
+
+#active_time
+
+激活时间
+
+时间
+
+该用户的第一条数据（含事件和用户属性数据）入库时，该条数据 #time 字段的时间
+
+#reg_time
+
+注册时间
+
+时间
+
+该用户的第一条包含账户 ID 的数据（含事件和用户属性数据）入库时，该条数据 #time 字段的时间
+
+#update_time
+
+更新时间
+
+时间
+
+收到的最后一条用户属性数据的 #time 字段的时间
+
+#server_time
+
+服务端时间
+
+时间
+
+收到的最后一条用户属性数据的服务器时间
+
+#dw_update_time
+
+入库更新时间
+
+时间
+
+该条用户数据最新更新时间
+
+#event_date
+
+最新的事件日期
+
+数值
+
+该用户最新一条事件入库日期
+
+#user_operation
+
+用户操作类型
+
+文本
+
+用户属性数据的操作类型
+
+#kafka_offset
+
+kafka偏移值
+
+数值
+
+用户属性数据存储在kafka上的偏移值
+
+#uuid
+
+UUID
+
+文本
+
+用户属性数据的识别ID