预置事件
| 事件英文变量名 | 事件显示名 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 属性值示例或说明 | 触发时机 | 备注 |
|---|---|---|---|---|---|---|---|
| $pageview | Web 浏览页面 | $预置属性 | 打开一个页面时自动采集，根据 autoTrack 的触发进行上报记录，触发时机可以自定义配置，一般建议放在初始化神策 SDK 后立刻执行。 | JS SDK通用性采集，打开autoTrack接口后会自动采集，参考文档：JS SDK https://www.sensorsdata.cn/manual/js_sdk.html UTM广告系列参数，可用来进行渠道追踪，参考文档： https://manual.sensorsdata.cn/sa/latest/channel_tracking-22258121.html |
|||
| $is_first_time | 是否首次 | 布尔值 | 新用户首次访问页面时，触发的第一个 $pageview ，该属性值为 true，后续再触发 $pageview 事件时，该属性都为 false。 | ||||
| $url_path | 页面路径 | 字符串 | |||||
| $referrer_host | 前向域名 | 字符串 | 如果直接打开页面，值为空字符串 | ||||
| $referrer | 前向地址 | 字符串 | 如果直接打开页面，值为空字符串 | ||||
| $utm_campaign | 广告系列名称 | 字符串 | 打开页面的 url 有该参数就采集 | ||||
| $utm_source | 广告系列来源 | 字符串 | 打开页面的 url 有该参数就采集 | ||||
| $utm_medium | 广告系列媒介 | 字符串 | 打开页面的 url 有该参数就采集 | ||||
| $utm_term | 广告系列字词 | 字符串 | 打开页面的 url 有该参数就采集 | ||||
| $utm_content | 广告系列内容 | 字符串 | 打开页面的 url 有该参数就采集 | ||||
| $WebClick | Web 元素点击 | $预置属性 | 点击一个元素/控件/按钮（可扩展） 时自动采集 | JS SDK通用性采集，打开autoTrack接口后会自动采集，参考文档：全埋点和点击图(Web) | |||
| $element_id | 元素ID | 字符串 | 元素有 id 属性才采集 | ||||
| $element_content | 元素内容 | 字符串 | 元素标签对直接的文本，例如：<a><span>提交</span></a>，采集的是 “提交” | ||||
| $element_name | 元素名字 | 字符串 | 元素有 name 属性的时候才采集 | ||||
| $element_class_name | 元素样式名 | 字符串 | 元素有 class 属性的时候才采集 | ||||
| $element_type | 元素类型 | 字符串 | 默认采集 | ||||
| $element_selector | 元素选择器 | 字符串 | 默认采集 | ||||
| $element_target_url | 元素链接地址 | 字符串 | a 标签默认采集 | ||||
| $url_path | 页面路径 | 字符串 | |||||
| $element_path | DOM 树结构的body 后对应结点 | 字符串 | 默认采集。优先从最近根路径中有 id 的元素取，所有根路径都没有 id 时取所有路径的拼接，中间加上 ’>‘ 。元素有 id 名称，在元素类型后加 '#'。 | ||||
| $element_position | 元素叶子结点序号 | 字符串 | 页面 li 标签 以及 li 标签内的子标签（即叶子结点为 li 标签 或叶子结点的父节点或父父节点为 li 标签）时采集。 | ||||
| $page_x |
点击位置距网页左侧距离 |
数值 | 1.21.5 版本开始采集 $page_x 和 $page_y。 | ||||
| $page_y | 点击位置距网页顶部距离 | 数值 | |||||
| $WebStay | Web 视区停留 | $预置属性 | 有效停留：关注网页区域不滚动，期间鼠标可以移动、点击等操作。 有效停留时间：停留时间超过规定的时间，javascript sdk 中默认为 4 秒(参数可设置)。 如果发生页面滚动时候，之前的页面停留是有效停留，也就是超过默认的4秒或者自定义的时间，javascript sdk就会发送一次页面停留事件。 |
若要使用神策分析中热力图-触达率图的功能，则需采集此事件。事件触发条件：在一个页面停留4秒以上并进行有效滑动则触发。不支持增加自定义属性 | |||
| $viewport_width | 视区宽度 | 数值 | 视区宽度（当前浏览器的可视区域的宽度，单位是 px。） | ||||
| $viewport_position | 视区距顶部的位置 | 数值 | 视区距顶部的位置（当前滚动条所在位置，距离页面顶部的高度，单位是 px。） | ||||
| $viewport_height | 视区高度 | 数值 | 视区高度（当前浏览器的可视区域的高度，单位是 px。） | ||||
| $event_duration | 停留时长 | 数值 | 距上次触发 scroll 事件的时间差。 页面没有操作，超过 4 秒后滚动页面触发一次事件。 如果页面有滚动，时长清零。 |
||||
| $url_path | 页面路径 | 字符串 | |||||
| $WebPageLeave | Web 页面浏览时长 | $预置属性 | 页面的「可视状态切换」(优先用 visibilitychange ,低版本浏览器不支持 visibilitychange 的也会用页面失去焦点/获得焦点)、「离开」(关闭窗口、页面跳转、刷新、浏览器前进后退)这两个生命周期触发 $WebPageLeave 事件，其中 event_duration 是指页面浏览的时长。 | 详细配置参考 | |||
| $url_path | 页面路径 | 字符串 | |||||
| $referrer_host | 前向域名 | 字符串 | 如果直接打开页面，值为空字符串 | ||||
| $referrer | 前向地址 | 字符串 | 如果直接打开页面，值为空字符串 | ||||
| $event_duration | 浏览时长 | 数值 | 页面浏览时长，单位 秒 | ||||
| $viewport_position | 视区距顶部的位置 | 数值 | 1.21.5 版本开始采集。视区距顶部的位置（当前滚动条所在位置，距离页面顶部的高度，单位是 px。） | 1.21.5 版本支持 | |||
| $WebPageLoad | Web 页面加载时长 | $预置属性 | 使用 performance API 计算页面加载时长，监听页面加载完成，触发 $WebPageLoad 事件。 | 详细配置参考 | |||
| $url_path | 页面路径 | 字符串 | |||||
| $referrer_host | 前向域名 | 字符串 | 如果直接打开页面，值为空字符串 | ||||
| $referrer | 前向地址 | 字符串 | 如果直接打开页面，值为空字符串 | ||||
| $event_duration | 加载时长 | 数值 | 页面加载时长，单位 秒 | ||||
|
$page_resource_size |
页面资源大小 | 数值 | 1.21.7 版本开始采集，页面资源大小，单位是 kb，大小限制大于 0，小于 10G 采集，不满足则不采集。 |
所有事件都有的预置属性
| 属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
|---|---|---|---|---|
| $lib | 字符串 | SDK 类型 | SDK 类型 | |
| $lib_version | 字符串 | SDK 版本 | SDK 版本 | |
| $lib_method | 字符串 | 埋点方式 | 埋点方式，目前值统一为 code | |
| $screen_height | 数值 | 屏幕高度 | 屏幕高度，采集的是像素 | |
| $screen_width | 数值 | 屏幕宽度 | 屏幕宽度，采集的是像素 | |
| $url_host | 字符串 | 页面地址域名 | 由服务端进行解析，如果事件中上报了 $url，则会解析出来该属性 | |
| $is_first_day | 布尔值 | 是否首日访问 | 表示是否是首日触发事件，可参考文档 新增用户及首日首次标记 | 1.5 版本支持 |
| $is_login_id | 布尔值 |
是否登录 ID |
数据入库时判断添加 | |
| $ip | 字符串 | IP | 后端通过解析 HTTP 请求而得到 | |
| $timezone_offset | 数值 | 时区偏移量 | 从浏览器的时间对象上直接获取 | 1.15.9 版本支持 |
| $country | 字符串 | 国家 |
由 IP 解析得到 |
|
| $province | 字符串 | 省份 | ||
| $city | 字符串 | 城市 | ||
| $latest_referrer | 字符串 | 最近一次站外地址 |
只要前向域名不是当前页面的域名，就会重置 |
1.6 版本支持 |
| $latest_referrer_host | 字符串 | 最近一次站外域名 | 1.14.8 及以上版本，默认不采集，需要手动设置 preset_properties 详细配置参考 |
1.6 版本支持 |
| $latest_landing_page | 字符串 | 最近一次落地页 | ||
| $latest_utm_source | 字符串 | 最近一次广告系列来源 |
使用 Web 渠道追踪 后，只要 URL 中包含 对应渠道信息（ utm_ 参数）就会重置 |
1.6 版本支持 |
| $latest_utm_term | 字符串 | 最近一次广告系列字词 | ||
| $latest_utm_content | 字符串 | 最近一次广告系列内容 | ||
| $latest_utm_campaign | 字符串 | 最近一次广告系列名称 | ||
| $latest_utm_medium | 字符串 | 最近一次广告系列媒介 | ||
| $latest_search_keyword | 字符串 | 搜索引擎关键词 | 由于各搜索引擎策略不同，可能有获取不到的情况 | 1.8 版本支持 |
| $latest_traffic_source_type | 字符串 | 最近一次流量来源类型 |
|
1.8 版本支持 |
| $url | 字符串 | 页面地址 | 1.16.5 版本将 $title 和 $url 设置为所有事件都有的属性 | |
| $title | 字符串 | 页面标题 | ||
| $viewport_width | 数值 | 视区宽度 | 视区宽度（当前浏览器的可视区域的宽度，单位是 px。） | 1.21.5 版本将 $viewport_width 和 $viewport_height 设置为所有事件都有的属性 |
| $viewport_height | 数值 | 视区高度 | 视区高度（当前浏览器的可视区域的高度，单位是 px。） | |
| $page_height | 数值 | 页面高度 | 1.21.5 版本集成页面高度插件会采集该属性 |
注意：
（1）其中 $latest_search_keyword 搜索引擎关键词由于各搜索引擎策略不同，可能有获取不到的情况。
（2）其中 $latest_traffic_source_type 这个的属性值包括：付费广告流量、自然搜索流量、社交网站流量、引荐流量、直接流量。
（3）最近一次付费广告相关参数是一个事件属性，且不需要做任何配置，会在所有事件中都存在。这个属性会保存最近一次有效的 utm_source 。
UserAgent 相关的预置属性
这一系列的属性从浏览器的 UserAgent 中进行解析。
| 字段名称 | 类型 | 说明 | SDK 版本 |
|---|---|---|---|
| $manufacturer | 字符串 | 设备制造商 | v1.6 及以上新解析方式支持 |
| $model | 字符串 | 设备型号 | |
| $os | 字符串 | 操作系统 | |
| $os_version | 字符串 | 操作系统版本 | |
| $browser | 字符串 | 浏览器名 | |
| $browser_version | 字符串 | 浏览器版本 | |
| $bot_name | 字符串 | 爬虫名称 |
目前是通过 UA 判断并有一个默认的属性 $bot_name （爬虫名称），但是有两种情况无法判断：
第一种：如果 UA 里没有标明、且会触发 JS 脚本的非法爬虫。
第二种：如果爬虫没有触发 JS 脚本，那么也不会触发我们的 SDK ，所以本身就不会被统计到。
对于爬虫种类，目前已经支持了主流爬虫名称的解析，对于新增或其他小众类型的爬虫，会出现无法解析的情况。
预置用户属性
| 属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
|---|---|---|---|---|
| $first_visit_time | 时间 | 首次访问时间 | 新用户首次访问网页时， 会给此属性赋值 | 因为这些属性的设置时机是新用户首次访问网页时，才会设置这些属性，新用户一般是以匿名 ID 标记用户行为，如果登录 ID 和匿名 ID 关联失败，则登录 ID 不会有这些属性值。 |
| $utm_source | 字符串 | 首次广告系列来源 |
使用Web渠道追踪，且新用户首次访问时，通过带有 utm 参数的渠道访问时，才会采集这些用户属性。如果是老用户，即使通过渠道访问网页，也不会设置这些用户属性。新老用户的标记可以参考此文档：新增用户及首日首次标记 |
|
| $utm_medium | 字符串 | 首次广告系列媒介 | ||
| $utm_term | 字符串 | 首次广告系列字词 | ||
| $utm_content | 字符串 | 首次广告系列内容 | ||
| $utm_campaign | 字符串 | 首次广告系列名称 | ||
| $first_referrer | 字符串 | 首次前向地址 | 新用户第一次来到有神策 SDK 页面时的前向页面地址 | |
| $first_referrer_host | 字符串 | 首次前向域名 | 新用户第一次来到有神策 SDK 页面时的前向页面域名 | |
| $first_browser_language | 字符串 | 首次使用的浏览器语言 | 新用户第一次来到有神策 SDK 页面时的浏览器语言 | |
| $first_browser_charset | 字符串 | 首次浏览器字符类型 | SDK 1.8 及以上版本支持，新用户第一次来到有神策 SDK 页面时的浏览器字符类型 | |
| $first_search_keyword | 字符串 | 首次搜索引擎关键词 | SDK 1.8 及以上版本支持 | |
| $first_traffic_source_type | 字符串 | 首次流量来源类型 | SDK 1.8 及以上版本支持，这个的属性值包括：付费广告流量、自然搜索流量、社交网站流量、引荐流量、直接流量。 |
渠道追踪相关的预置事件和预置属性
| 事件英文名 | 事件显示名 | 属性英文名 | 属性显示名 | 属性值类型 | 说明 | 触发时机 |
|---|---|---|---|---|---|---|
| $ChannelLinkReaching | 渠道链接触达 | $预置属性 | 用户点击渠道链接到达落地页时，会采集该事件以及事件属性 | |||
| $first_channel_keyword_id | 首次渠道关键词 ID | 字符串 | 首次渠道关键词 ID | |||
| $channel_keyword_id | 渠道关键词 ID | 字符串 | 渠道关键词 ID |
A / B 测试的预置事件和预置属性
| 事件英文名 | 事件显示名 | 属性英文名 | 属性显示名 | 属性值类型 | 说明 | 触发时机 |
|---|---|---|---|---|---|---|
|
$ABTestTrigger |
A / B 测试 | $预置属性 | 命中实验，会采集该事件以及事件属性 | |||
|
$abtest_experiment_id |
实验 ID | 字符串 | 实验 ID | |||
|
$abtest_experiment_group_id |
实验分组 ID | 字符串 | 实验分组 ID |
弹窗的预置事件和预置属性
| 事件英文名 | 事件显示名 | 属性英文名 | 属性显示名 | 属性值类型 | 说明 | 触发时机 |
|---|---|---|---|---|---|---|
| $PlanPopupDisplay | 弹窗展示 | $预置属性 | 弹窗展示，会采集该事件以及事件属性 | |||
| $sf_plan_id | 运营计划名称 | 字符串 | 实际上报的是 ID，会有一个维度字典映射到计划名称 | |||
| $sf_plan_type | 计划类型 | 字符串 | 运营计划，流程画布，微信运营 | |||
| $sf_channel_service_name | 消息发送服务商 | 字符串 |
SENSORS_FOCUS |
|||
| $sf_channel_category | 消息通道类型 | 字符串 |
POPUP |
|||
| $sf_audience_id | 运营受众 ID | 字符串 | 受众 ID，仅当有受众规则时存在 | |||
| $sf_plan_strategy_id | 实验组 ID | 字符串 | 属性值0或-1， 0代表策略组，-1代表对照组 | |||
| $sf_succeed | 消息发送成功 | 字符串 | 属性值 true 或 false ， true 代表成功， false 代表失败 | |||
| $sf_fail_reason | 消息发送失败原因 | 字符串 | 如弹窗成功，显示未知 | |||
| $sf_msg_title | 推送标题 | 字符串 | ||||
| $sf_msg_content | 推送内容 | 字符串 | ||||
| $sf_platform_tag | 端类型标签 | 字符串 | ANDRIOD，IOS，H5，WEB | |||
| $sf_msg_id | 推送消息 ID | 字符串 | ||||
| $sf_lib_version | 弹窗 SDK 版本 | 字符串 | 弹窗的 SDK 的对应版本号 | |||
| $sf_msg_image_url | 图片链接 | 字符串 | 图片链接（图片 CDN 存储地址） | |||
| $PlanPopupClick | 点击行为 | $预置属性 | 弹窗点击，会采集该事件以及事件属性
|
|||
| $sf_plan_id | 运营计划名称 | 字符串 | 实际上报的是 ID，会有一个维度字典映射到计划名称 | |||
| $sf_plan_type | 计划类型 | 字符串 | 运营计划，流程画布，微信运营 | |||
|
$sf_channel_service_name |
消息发送服务商 |
字符串 |
SENSORS_FOCUS |
|||
|
$sf_channel_category |
消息通道类型 |
字符串 |
POPUP |
|||
|
$sf_audience_id |
运营受众 ID |
字符串 |
受众 ID，仅当有受众规则时存在 |
|||
|
$sf_plan_strategy_id |
实验组 ID |
字符串 |
属性值0或-1， 0代表策略组，-1代表对照组 |
|||
|
$sf_msg_title |
推送标题 |
字符串 |
||||
|
$sf_msg_content |
推送内容 |
字符串 |
||||
|
$sf_msg_element_type |
弹窗按钮类型 |
字符串 |
弹窗元素类型：普通按钮、文字链接、图片链接、关闭 icon、蒙层 |
|||
|
$sf_msg_element_content |
弹窗按钮文案 |
字符串 |
弹窗按钮文案，按钮独有 |
|||
|
$sf_msg_element_action |
弹窗按钮行为 |
字符串 |
弹窗点击行为： URL 链接 、自定义链接、关闭弹窗 |
|||
|
$sf_msg_image_url |
图片链接 |
字符串 |
图片链接（图片 CDN 存储地址） |
|||
| $sf_msg_action_id | 点击行为 ID | 字符串 | ||||
| $sf_platform_tag | 端类型标签 | 字符串 | ANDRIOD，IOS，H5，WEB | |||
| $sf_msg_id | 推送消息 ID | 字符串 | ||||
| $sf_close_type | 关闭按钮类型 | 字符串 | 关闭按钮类型，只有关闭行为有：关闭蒙层、弹窗右上关闭 icon 、弹窗下部关闭 icon 、底部按钮（设置为关闭弹窗的按钮） | |||
| $sf_lib_version | 弹窗 SDK 版本 | 字符串 |