本參考資料說明用來自訂 Google Analytics (分析) 報表各部分的方法。
ga.js 基本方法
-
_deleteCustomVar(index)
-
_getName()
-
_getAccount()
-
_getVersion()
-
_getVisitorCustomVar(index)
-
_initData()
已淘汰 -
_setAccount(accountID)
-
_setCookiePersistence(milliseconds)
已淘汰 -
_setCustomVar(index, name, value, opt_scope)
-
_setSampleRate(newRate)
-
_setSessionTimeout(newTimeout)
已淘汰 -
_setSessionCookieTimeout(cookieTimeoutMillis)
-
_setSiteSpeedSampleRate(sampleRate)
-
_setVar(newVal)
已淘汰 -
_setVisitorCookieTimeout(cookieTimeoutMillis)
-
_trackPageLoadTime()
已淘汰 -
_trackPageview(opt_pageURL)
方法詳細資料
_deleteCustomVar()
_deleteCustomVar(index)
這個方法會刪除指派給所提供索引的變數 (如果有的話)。舉例來說,您可能會設定訪客層級的自訂變數,但之後又決定不再使用這個訪客層級變數。
非同步程式碼片段 (建議)
_gaq.push(['_deleteCustomVar', 1]);
參數
Int index
要刪除的自訂變數索引。
_getName()
_getName()
傳回追蹤器在建立時所指定的名稱。
非同步程式碼片段 (建議)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var trackerName = pageTracker._getName(); });
傳回
String
追蹤器的名稱。
_getAccount()
_getAccount()
傳回此追蹤程式物件的 Google Analytics (分析) ID。如果您在多個帳戶中追蹤網站上的網頁,可以使用這個方法判斷與特定追蹤程式物件相關聯的帳戶。
非同步程式碼片段 (建議)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var accountId = pageTracker._getAccount(); });
傳回
String
帳戶 ID,用於將此追蹤程式物件例項化。
_getVersion()
_getVersion()
傳回 GATC 版本號碼。
非同步程式碼片段 (建議)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var version = pageTracker._getVersion(); });
傳回
String
GATC 版本號碼。
_getVisitorCustomVar()
_getVisitorCustomVar(index)
傳回指派給指定索引的訪客層級自訂變數值。
非同步程式碼片段 (建議)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var visitorCustomVar1Value = pageTracker._getVisitorCustomVar(1); });
參數
Int index
訪客層級自訂變數的索引。
傳回
String
訪客層級自訂變數的值。如果無法擷取指定索引的變數,系統會傳回「未定義」。
_initData()
_initData()
已淘汰。initData() 現在會自動在 ga.js 追蹤程式碼中執行。
初始化或重新初始化 GATC (Google Analytics (分析) 追蹤程式程式碼) 物件。
var pageTracker = _gat._getTracker("UA-12345-1");
pageTracker._trackPageview();
_setAccount()
_setAccount(accountId)
只用於非同步追蹤。設定追蹤物件的網站資源 ID。
_gaq.push(['_setAccount', 'UA-XXXXX-X']);
參數
String accountID
追蹤程式物件的完整網站資源 ID (例如 UA-65432-1
)。
_setCookiePersistence()
_setCookiePersistence(milliseconds)
此方法已淘汰。請改用 _setVisitorCookieTimeout(cookieTimeoutMillis)
。
設定 Google Analytics (分析) 訪客 Cookie 到期時間 (以毫秒為單位)。訪客 Cookie 預設為 2 年後過期。如有需要,您可以使用這個方法變更訪客 Cookie 的到期日。舉例來說,如要將訪客 Cookie 的到期時間設為 7 天,請使用以下程式碼:
pageTracker._setCookiePersistence(604800000);
參數
Number milliseconds
新的訪客 Cookie 到期時間。
_setCustomVar()
_setCustomVar(index, name, value, opt_scope)
使用所提供的名稱、值和範圍來設定自訂變數。name
和 value
的總字元數上限為 128 位元組。
非同步程式碼片段 (建議)
_gaq.push(['_setCustomVar', 1, 'Section', 'Life & Style', 3]);
傳回
Boolean
如果自訂變數已設定成功,此方法會傳回 true
;如果沒有,則傳回 false
(例如:名稱/值字串長度超過 128 個位元組,或是使用錯誤的版位)。
參數
Int index
必要。自訂變數使用的版位。可能的值為 1-5
(含頭尾)。
String name
必要。自訂變數的名稱。
String value
必要。自訂變數的值。
Int opt_scope
選用。自訂變數使用的範圍。可能的值包括 1
代表訪客層級、2
代表工作階段層級,3
則代表網頁層級。
_setSampleRate()
_setSampleRate(newRate)
設定新的取樣率。如果網站規模特別大,而且流量暴增,設定取樣率可確保報表追蹤作業不受中斷。Google Analytics (分析) 中的取樣是以一致的方式對所有的不重複訪客進行計算,因此即使啟用取樣功能,趨勢和報表資料仍會維持健全,因為系統開始取樣時,仍會納入或排除特定訪客。
您只需要在呼叫 _setAccount() 時指定這個方法,通常在每個網頁或應用程式上指定一次 (您每次初始化追蹤程式碼時)。請記住,只要追蹤物件本身持續存在,您指定的取樣率值就會失效。
非同步程式碼片段 (建議)
_gaq.push(['_setSampleRate', '2.5']);
參數
String newRate
要設定的新取樣率。請提供 0 到 100 之間的數值字串 (精確到小數點後兩位)。
_setSessionTimeout()
_setSessionTimeout(newTimeout)
此方法已淘汰。請改用 _setSessionCookieTimeout(cookieTimeoutMillis)
。
設定新的工作階段逾時秒數。工作階段逾時預設為 30 分鐘 (1800 秒)。工作階段逾時可用來計算造訪次數 (請參閱 Analytics (分析) 對工作階段的定義)。 如要依特定需求變更「工作階段」的定義,您可以傳遞秒數來定義新值。這會影響計算造訪次數的每個區段的造訪報表,以及用於計算其他價值的造訪次數。舉例來說,縮短工作階段逾時後,造訪次數通常會增加,但隨著工作階段逾時增加,造訪次數通常會減少。
參數
String newTimeout
新增工作階段逾時,以秒為單位。
_setSessionCookieTimeout()
_setSessionCookieTimeout(cookieTimeoutMillis)
設定新的工作階段 Cookie 逾時 (以毫秒為單位)。工作階段逾時預設為 30 分鐘。工作階段逾時是用來計算造訪次數,因為當造訪在瀏覽器閒置 30 分鐘後或瀏覽器離開時結束,系統就會結束造訪。若要根據特定需求變更「工作階段」的定義,您可以傳遞毫秒數來定義新值。這會影響計算造訪次數的每個區段的造訪報表,以及使用造訪次數計算其他價值的位置。舉例來說,縮短工作階段逾時後,造訪次數就會增加,只要增加工作階段逾時,造訪次數就會減少。您可以將到期時間設定為 0,表示瀏覽器關閉後應刪除這個 Cookie。
非同步程式碼片段 (建議)
_gaq.push(['_setSessionCookieTimeout', 1800000]);
參數
Number cookieTimeoutMillis
新的工作階段逾時 (以毫秒或 0 為單位),在瀏覽器關閉時刪除 Cookie。
_setSiteSpeedSampleRate()
_setSiteSpeedSampleRate(sampleRate)
定義「網站速度」資料收集的新樣本集大小。根據預設,系統會固定抽出您網站訪客的 1% 做為計算網站速度指標的資料集。如果網站每日訪客人數相對較少 (例如不超過 100,000 人),建議您調高取樣率。以便取得更精細的網頁載入時間和其他「網站速度」指標資料。(如要進一步瞭解「網站速度」報表,請參閱說明中心的「網站速度」一文)。
必須在 _trackPageview()
之前呼叫 _setSiteSpeedSampleRate()
方法才會生效。
Analytics (分析) 會將單一資源的網站速度收集命中次數限制在最多 1% 的使用者或每日 1 萬次命中中,以確保這項功能的系統資源平均分配。
注意:強烈建議網站每日命中量超過 100 萬次的網站,將樣本選取率設為預設的 1%。將樣本數調高至較大的數字並不會導致樣本數增加。
非同步程式碼片段 (建議)
_gaq.push(['_setSiteSpeedSampleRate', 5]); _gaq.push(['_trackPageview']);
參數
Number sampleRate
介於 0 到 100 之間的值,用來定義有多少百分比的網站訪客會受到「網站速度」的影響。舉例來說,如果值為 5
,系統就會將網站速度收集樣本設為 5%。
_setVisitorCookieTimeout()
_setVisitorCookieTimeout(cookieTimeoutMillis)
設定 Google Analytics (分析) 訪客 Cookie 到期時間 (以毫秒為單位)。根據預設,訪客 Cookie 會設為 2 年後過期。如有需要,您可以使用這個方法變更訪客 Cookie 的到期日。您可以將到期時間逾時變更為 0,表示在瀏覽器關閉後應刪除這個 Cookie。
非同步程式碼片段 (建議)
_gaq.push(['_setVisitorCookieTimeout', 63072000000]);
參數
Number cookieTimeoutMillis
新的訪客 Cookie 到期時間 (以毫秒或 0) 表示,可在瀏覽器關閉時刪除 Cookie。
_setVar()
_setVar(newVal)
此方法已淘汰。請改用「_setCustomVar()
」。
使用提供的字串設定或定義自訂訪客區隔。您可以使用這個值,為網站使用者提供額外區隔。舉例來說,您可以使用登入頁面或表單,根據訪客輸入內容 (例如訪客選擇的偏好設定或隱私權選項) 觸發值。接著,系統會針對該訪客在 Cookie 中更新這個變數。在網站上導入且透過這個方法收集資料時,新定義的區隔會顯示在 Analytics (分析)「訪客」區段的「使用者定義」報表中。此外,您也可以存取「內容詳情」報表中的「使用者定義值」區隔,查看某個網頁的訪客中,有多少百分比屬於您定義的特定區隔。
參數
String newVal
要設定的新使用者定義值。
_trackPageLoadTime()
_trackPageLoadTime()
這個方法已淘汰,因為系統會自動為所有使用者啟用網站速度報表。請使用 _setSiteSpeedSampleRate()
調整網站速度報表的取樣率。
為這個網頁啟用網站速度報表。請為網站上要取得網站速度報表的每個頁面插入這個方法。如要進一步瞭解 Analytics (分析) 中的網站速度報表,請參閱說明中心的網站速度一文。
驗證您的變更
如果報表中有資料,表示您的設定正確無誤。如果 24 小時後仍未看到任何資料,請檢查自訂內容,確認沒有任何錯誤。如需追蹤程式碼常見錯誤的清單,請參閱「追蹤程式碼疑難排解」一文。本疑難排解指南也包含基本偵錯步驟和更多偵錯相關資訊。
請注意,要是您啟用了網站速度追蹤功能,那麼除了追蹤網頁瀏覽量的 GIF 請求外,Google Analytics (分析) 伺服器還會多收到一個請求。為了盡量避免增加網站整體的等待時間,系統只會針對所採樣的網站瀏覽量提出這個請求。因此,使用 Firebug 等工具對「網站速度」進行除錯時,您可能不會每次都看到這項功能的 GIF 請求,這是正常現象。
非同步程式碼片段 (建議)
_gaq.push(['_setAccount', 'UA-12345-1']); _gaq.push(['_trackPageview']); _gaq.push(['_trackPageLoadTime']);
_trackPageview()
_trackPageview(opt_pagePath)
GATC 的主要邏輯 (Google Analytics (分析) 追蹤程式程式碼)。如果連結器功能已啟用,會嘗試從網址擷取 Cookie 值。否則,就會嘗試從 document.cookie
擷取 Cookie 值。也會視需要更新或建立 Cookie,然後將 Cookie 寫回文件物件。收集所有要傳送至 UCFE (Urchin Collector 前端) 的適當指標。
非同步程式碼片段 (建議)
_gaq.push(['_setAccount', 'UA-12345-1']); _gaq.push(['_trackPageview', '/home/landingPage']);
參數
String opt_pagePath
選用參數,用於指出追蹤指標所在網頁的路徑。使用這個選項時,請使用開頭斜線 (/) 表示網頁路徑。