Web JS SDK 預設事件和預設屬性
預設事件
| 事件英文變數名 | 事件顯示名 | 屬性英文變數名 | 事件屬性顯示名 | 屬性值型別 | 屬性值範例或說明 | 觸發時機 | 備註 |
|---|---|---|---|---|---|---|---|
| $pageview | Web 瀏覽頁面 | $預設屬性 | 打開一個頁面時自動採集，根據 autoTrack 的觸發進行上報記錄，觸發時機可以自定義設定，一般建議放在初始化神策 SDK 後立刻執行。 | JS SDK 通用性採集，打開autoTrack介面後會自動採集，參考文件：JS SDK https://www.sensorsdata.cn/manual/js_sdk.html UTM 廣告系列參數，可用來進行管道追蹤，參考文件： https://www.sensorsdata.cn/manual/app_channel_tracking.html | |||
| $is_first_time | 是否首次 | 布林值 | 新用戶首次連接頁面時，觸發的第一個 $pageview ，該屬性值為 true，後續再觸發 $pageview 事件時，該屬性都為 false。 | ||||
| $title | 頁面標题 | 字串 | 頁面<title>標籤對的内容 | ||||
| $url | 頁面網址 | 字串 | JS SDK 預設採集的預設屬性 | ||||
| $url_path | 頁面路徑 | 字串 | |||||
| $url_host | 頁面網址網域名 | 字串 | 由伺服器端進行解析，如果事件中上報了 $url，則會解析出來該屬性 SA 版本需針對當前大版本，大於以下小版本號 1.15.2609、 | ||||
| $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 name 屬性的時候才採集 | ||||
| $element_type | 元素類型 | 字串 | 預設採集 | ||||
| $element_selector | 元素選擇器 | 字串 | 預設採集 | ||||
| $element_target_url | 元素連接網址 | 字串 | a 標籤預設採集 | ||||
| $url | 頁面網址 | 字串 | |||||
| $url_host | 頁面網址網域 | 字串 | 由伺服器端進行解析，如果事件中上報了 $url，則會解析出來該屬性 | ||||
| $title | 頁面標题 | 字串 | |||||
| $url_path | 頁面路徑 | 字串 | |||||
| $WebStay | Web 視區停留 | $預設屬性 | 有效停留：關注網頁區域不滾動，期間游標可以移動、點擊等操作。 有效停留時間：停留時間超過規定的時間，javascript sdk 中預設為 4 秒(參數可設定)。 如果發生頁面滾動時候，之前的頁面停留是有效停留，也就是超過預設的4秒或者自定義的時間，javascript sdk就會發送一次頁面停留事件。 | 若要使用神策分析中熱力圖-觸達率圖的功能，則需採集此事件。事件觸發條件：在一個頁面停留4秒以上並進行有效滑動則觸發。不支援增加自定義屬性 | |||
| $viewport_width | 視區寬度 | 數值 | 視區寬度（當前瀏覽器的可視區域的寬度，單位是 px。） | ||||
| $viewport_position | 視區距頂部的位置 | 數值 | 視區距頂部的位置（當前滾動條所在位置，距離頁面頂不的高度，單位是 px。） | ||||
| $viewport_height | 視區高度 | 數值 | 視區高度（當前瀏覽器的可視區域的高度，單位是 px。） | ||||
| $event_duration | 停留時長 | 數值 | 距上次觸發 $WebStay 事件的時間差。 頁面沒有操作，超過 4 秒後滾動頁面觸發一次事件。 如果頁面有滾動，時長清零。 | ||||
| $url | 頁面網址 | 字串 | |||||
| $url_host | 頁面網址網域 | 字串 | 由伺服器端進行解析，如果事件中上報了 $url，則會解析出來該屬性 | ||||
| $title | 頁面標题 | 字串 | |||||
| $url_path | 頁面路徑 | 字串 |
所有事件都有的預設屬性
| 屬性名 | 屬性型別 | 預設顯示名 | 說明 | 備註 |
|---|---|---|---|---|
| $lib | 字串 | SDK 類型 | SDK 類型 | |
| $lib_version | 字串 | SDK 版本 | SDK 版本 | |
| $lib_method | 字串 | 埋點方式 | 埋點方式，目前值統一為 code | |
| $screen_height | 數值 | 螢幕高度 | 螢幕高度，採集的是像素 | |
| $screen_width | 數值 | 螢幕寬度 | 螢幕寬度，採集的是像素 | |
| $url | 字串 | 頁面網址 | 預設不採集，需要手動設定 preset_properties 詳細設定參考 | 1.14.10 版本支援 |
| $url_host | 字串 | 頁面網址網域名 | 由伺服器端進行解析，如果事件中上報了 $url，則會解析出來該屬性 | |
| $is_first_day | 布林值 | 是否首日連接 | 表示是否是首日觸發事件，可參考文件 新增用戶及首日首次標記 | 1.5 版本支援 |
| $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 | 字串 | 最近一次廣告系列來源 | 使用 管道參數 後，只要 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 版本支援 |
注意：
（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 版本支援，這個的屬性值包括：付費廣告流量、自然搜尋流量、社群網站流量、推薦流量、直接流量。 |
