1 JavaScript SDK 预置属性

最后更新于:2019-11-20 17:55:28

1.1 获取前端 JS SDK 采集的预置属性(1.9.13 支持)

此方法可获取,页面地址,页面标题,前向地址,SDK 类型及版本,屏幕宽高,最近一次的相关属性,如果服务端需要使用这些属性需要客户自己传输,且这些属性不包括需要后端解析的 ip 及 UA 等属性。

sensors.getPresetProperties();

1.2 所有事件都会有的预置属性:

字段名称 类型 说明 SDK 版本
$lib 字符串 SDK类型
$lib_version 字符串 SDK版本
$screen_height 数值 屏幕高度
$screen_width 数值 屏幕宽度
$is_first_day 布尔值 是否首日访问(从新用户第一次访问到当天的凌晨十二点之间的值都为真,之后都为假,标识在浏览器缓存中) 1.5 支持
$latest_referrer 字符串 最近一次站外地址(只要前向域名不是当前页面的域名,就会重置) 1.6 支持
$latest_referrer_host 字符串 最近一次站外域名 (1.14.8及以上版本,默认不采集,需要手动设置 preset_properties 详细配置参考 1.6 支持
$latest_utm_source 字符串 最近一次付费广告系列来源(只要有来源参数,就会重置) 1.6 支持
$latest_utm_medium 字符串 最近一次付费广告系列媒介 1.6 支持
$latest_utm_term 字符串 最近一次付费广告系列字词 1.6 支持
$latest_utm_content 字符串 最近一次付费广告系列内容 1.6 支持
$latest_utm_campaign 字符串 最近一次付费广告系列名称 1.6 支持
$latest_search_keyword 字符串 最近一次搜索引擎关键词 1.8 支持
$latest_traffic_source_type 字符串 最近一次流量来源类型 1.8 支持

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

1.3 UserAgent 相关的预置属性

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

字段名称 类型 说明 SDK 版本
$manufacturer 字符串 设备制造商 1.6 新解析方式支持
$model 字符串 设备型号
$os 字符串 操作系统
$os_version 字符串 操作系统版本
$browser 字符串 浏览器名
$browser_version 字符串 浏览器版本
$bot_name 字符串 爬虫名称(如果是爬虫)

目前是神策是通过 UA 判断并有一个默认的属性 $bot_name (爬虫名称),但是有两种情况无法判断:
第一种:如果 UA 里没有标明、且会触发 JS 脚本的非法爬虫。
第二种:如果爬虫没有触发 JS 脚本,那么也不会触发我们的 SDK ,所以本身就不会被统计到。
对于爬虫种类,不能提前把所有的种类都加进去,主流的神策都加了,其它的属于不太常见的,量较少。

1.4 $pageview(Web 浏览页面)事件的预置属性

字段名称 类型 说明 SDK 版本
$referrer 字符串 前向地址
$referrer_host 字符串 前向域名
$url 字符串 页面地址
$url_path 字符串 页面路径
$title 字符串 页面标题
$is_first_time 布尔值 是否首次访问(新用户首次触发这个事件标识为真) 1.7修改
$utm_source 字符串 广告系列来源(只有浏览的当前页面地址 url 中有 utm_source 参数,即一般是用 web 渠道追踪时,才会采集这些值)
$utm_medium 字符串 广告系列媒介(只有浏览的当前页面地址 url 中有 utm_medium 参数,即一般是用 web 渠道追踪时,才会采集这些值)
$utm_term 字符串 广告系列字词(只有浏览的当前页面地址 url 中有 utm_term 参数,即一般是用 web 渠道追踪时,才会采集这些值)
$utm_content 字符串 广告系列内容(只有浏览的当前页面地址 url 中有 utm_content 参数,即一般是用 web 渠道追踪时,才会采集这些值)
$utm_campaign 字符串 广告系列名称(只有浏览的当前页面地址 url 中有 utm_campaign 参数,即一般是用 web 渠道追踪时,才会采集这些值)

是否首次访问参考文档:新增用户及首日首次标记

1.5 $WebClick(Web 元素点击)事件的预置属性

字段名称 类型 说明 SDK 版本
$element_id 字符串 元素 ID
$element_content 字符串 元素内容
$element_name 字符串 元素名字
$element_class_name 字符串 元素样式名
$element_type 字符串 元素类型
$element_selector 字符串 元素选择器
$element_target_url 字符串 元素链接地址
$url 字符串 页面地址
$title 字符串 页面标题
$url_path 字符串 页面路径
$viewport_width 数值 视区宽度 (1.12.2支持)

表格中列出的属性表示,如果您的页面标签有这个属性神策 SDK 会自动采集,如果没有某几个属性,那么这几个属性的值为未知,但不影响此次点击事件的采集。

属性介绍参考文档: $WebClick 事件,预置属性说明

1.6 $WebStay (Web 视区停留) 事件的预置属性

字段名称 类型 说明 SDK 版本
$viewport_width 数值 视区宽度(当前浏览器的可视区域的宽度,单位是 px。) (1.9支持)
$viewport_position 数值 视区距顶部的位置(当前滚动条所在位置,距离页面顶部的高度,单位是 px。) (1.9支持)
$viewport_height 数值 视区高度(当前浏览器的可视区域的高度,单位是 px。) (1.9支持)
$event_duration 数值 视区停留时间(1.10.5 版本开始就采集的时长单位为秒,之前为毫秒。对于神策分析版本大于等于 1.13 的环境,如果上传了 event_duration 属性,会自动 rename 为 $event_duration)。1.14.12 版本及以后可通过配置项设置该属性的最大值。点击图详细配置参数 (1.9支持)
$url 字符串 页面地址
$title 字符串 页面标题
$url_path 字符串 页面路径

此事件为触达率分析图所使用的事件,触达率分析图可对用户在网页中的触达深度进行分析。

视区宽度及视区高度的示例如下图右上角所示。

1.7 预置的用户属性

字段名称 类型 说明
$first_visit_time Datetime 首次访问时间(新用户第一次来到有神策 SDK 页面的客户端时间)
$first_referrer 字符串 首次前向地址 (新用户第一次来到有神策 SDK 页面时的前向页面地址)
$first_referrer_host 字符串 首次前向域名 (新用户第一次来到有神策 SDK 页面时的前向页面域名)
$first_browser_language 字符串 首次使用的浏览器语言(新用户第一次来到有神策 SDK 页面时的浏览器语言)
$first_browser_charset 字符串 首次浏览器字符类型(1.8支持,新用户第一次来到有神策 SDK 页面时的浏览器符类型)
$first_search_keyword 字符串 首次搜索引擎关键词(1.8支持)
$first_traffic_source_type 字符串 首次流量来源类型(1.8支持) 参考本页底部 7.2 的介绍
$utm_source 字符串 首次广告系列来源(新用户第一次来到有神策 SDK 页面时,页面地址 url 中有 utm 参数,即一般是用 web 渠道追踪时,才会采集这些值,且只会设置一次)
$utm_medium 字符串 首次广告系列媒介 (同上)
$utm_term 字符串 首次广告系列字词 (同上)
$utm_content 字符串 首次广告系列内容 (同上)
$utm_campaign 字符串 首次广告系列名称 (同上)

注意:
(1)其中 $first_traffic_source_type 这个的属性值包括:付费广告流量、自然搜索流量、社交网站流量、引荐流量、直接流量。
(2)其中 $first_search_keyword 采集逻辑是,新用户第一次来到有神策 SDK 页面时前向地址如果是搜索引擎结果页面,那么 SDK 会尝试获取前向地址中的搜索引擎关键词。