预置事件

事件英文变量名事件显示名属性英文变量名事件属性显示名属性值类型属性值示例或说明触发时机备注
$pageviewWeb 浏览页面
$预置属性

打开一个页面时自动采集,根据  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页面路径字符串
$url_host页面地址域名字符串

由服务端进行解析,如果事件中上报了 $url,则会解析出来该属性

SA 版本需针对当前大版本,大于以下小版本号 1.15.2609、
1.16.2601、1.17.2641 

$referrer_host前向域名字符串如果直接打开页面,值为空字符串
$referrer前向地址字符串如果直接打开页面,值为空字符串
$utm_campaign广告系列名称字符串打开页面的 url 有该参数就采集
$utm_source广告系列来源字符串打开页面的 url 有该参数就采集
$utm_medium广告系列媒介字符串打开页面的 url 有该参数就采集
$utm_term广告系列字词字符串打开页面的 url 有该参数就采集
$utm_content广告系列内容字符串打开页面的 url 有该参数就采集
$WebClickWeb 元素点击
$预置属性

点击一个元素/控件/按钮(可扩展) 时自动采集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_host页面地址域名字符串由服务端进行解析,如果事件中上报了 $url,则会解析出来该属性
$url_path页面路径字符串
$element_pathDOM 树结构的body 后对应结点字符串默认采集。优先从最近根路径中有 id 的元素取,所有根路径都没有 id 时取所有路径的拼接,中间加上 ’>‘ 。元素有 id 名称,在元素类型后加 '#'。
$element_position元素叶子结点序号字符串页面 li 标签 以及 li 标签内的子标签(即叶子结点为 li 标签 或叶子结点的父节点或父父节点为 li 标签)时采集。
$WebStayWeb 视区停留
$预置属性

有效停留:关注网页区域不滚动,期间鼠标可以移动、点击等操作。

有效停留时间:停留时间超过规定的时间,javascript sdk 中默认为 4 秒(参数可设置)。

如果发生页面滚动时候,之前的页面停留是有效停留,也就是超过默认的4秒或者自定义的时间,javascript sdk就会发送一次页面停留事件。
若要使用神策分析中热力图-触达率图的功能,则需采集此事件。事件触发条件:在一个页面停留4秒以上并进行有效滑动则触发。不支持增加自定义属性
$viewport_width视区宽度数值视区宽度(当前浏览器的可视区域的宽度,单位是 px。)
$viewport_position视区距顶部的位置数值视区距顶部的位置(当前滚动条所在位置,距离页面顶部的高度,单位是 px。)
$viewport_height视区高度数值视区高度(当前浏览器的可视区域的高度,单位是 px。)
$event_duration停留时长数值距上次触发 scroll 事件的时间差。

页面没有操作,超过 4 秒后滚动页面触发一次事件。

如果页面有滚动,时长清零。
$url_host页面地址域名字符串由服务端进行解析,如果事件中上报了 $url,则会解析出来该属性
$url_path页面路径字符串
$WebPageLeaveWeb 页面浏览时长
$预置属性

页面的「活跃状态切换」(页面失去焦点/获得焦点、切换窗口最小化、切换浏览器 tab、电脑睡眠和唤醒)、「离开」(关闭窗口、页面跳转、刷新、浏览器前进后退)这两个生命周期触发 $WebPageLeave 事件,其中 event_duration 是指页面浏览的时长。详细配置参考
$url_path页面路径字符串
$referrer_host前向域名字符串如果直接打开页面,值为空字符串
$referrer前向地址字符串如果直接打开页面,值为空字符串
$event_duration浏览时长数值页面浏览时长,单位 秒

所有事件都有的预置属性

属性名属性类型默认显示名说明备注
$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_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字符串页面标题

注意:
(1)其中 $latest_search_keyword 搜索引擎关键词由于各搜索引擎策略不同,可能有获取不到的情况。
(2)其中 $latest_traffic_source_type 这个的属性值包括:付费广告流量、自然搜索流量、社交网站流量、引荐流量、直接流量。
(3)最近一次付费广告相关参数是一个事件属性,且不需要做任何配置,会在所有事件中都存在。这个属性会保存最近一次有效的 utm_source 。

UserAgent 相关的预置属性

这一系列的属性从浏览器的 UserAgent 中进行解析。

字段名称类型说明SDK 版本
$manufacturer字符串设备制造商1.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