跟踪代码：基本配置

本参考文档描述的是可用于自定义 Google Analytics（分析）报告方方面面的方法。

ga.js 基本方法

方法详情

_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();
});

return

String：跟踪器的名称。

_getAccount()

_getAccount()

返回此跟踪器对象的 Google Analytics（分析）ID。如果您使用多个帐号跟踪您网站上的网页，则可以使用此方法确定与特定跟踪器对象相关联的帐号。

异步代码段（推荐） 

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var accountId = pageTracker._getAccount();
});

return

String 此跟踪器对象被实例化时所用的帐号 ID。

_getVersion()

_getVersion()

返回 Google Analytics（分析）跟踪代码 (GATC) 版本号。

异步代码段（推荐） 

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var version = pageTracker._getVersion();
});

return

String Google Analytics（分析）跟踪代码 (GATC) 版本号。

_getVisitorCustomVar()

_getVisitorCustomVar(index)

返回分配给指定索引的访问者级自定义变量值。

异步代码段（推荐） 

_gaq.push(function() {
  var pageTracker = _gat._getTrackerByName(); // Gets the default tracker.
  var visitorCustomVar1Value = pageTracker._getVisitorCustomVar(1);
});

参数

Int   index：访问者级自定义变量的索引。

return

String：访问者级自定义变量的值。如果无法检索指定索引的变量，则返回 undefined。

_initData()

_initData()已弃用。initData() 现在会在 ga.js 跟踪代码中自动执行。

初始化或重新初始化 Google Analytics（分析）跟踪代码 (GATC) 对象。

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]);

return

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 秒）。会话超时用于计算访问次数（请参阅 Google Analytics（分析）如何定义会话）。 如果希望根据自己的特定需求更改“会话”的定义，您可以传递定义新值所需的秒数。这将影响计算访问次数以及使用访问次数计算其他值的各个部分的“访问次数”报告。例如，如果您缩短会话超时，访问次数通常会增加；如果您延长会话超时，访问次数通常会减少。

参数

String newTimeout 要设置的新会话超时（以秒为单位）。

_setSessionCookieTimeout()

_setSessionCookieTimeout(cookieTimeoutMillis)

设置新的以毫秒计的会话 Cookie 超时。默认情况下，会话超时设为 30 分钟。会话超时被用于计算访问次数：如果某用户的浏览器处于非活动状态的时间超过 30 分钟，或者退出了浏览器，那么访问将结束。如果希望根据自己的特殊需要改变对“会话”的定义，您可以传递定义新值所需的毫秒数。这将影响计算访问次数的每个版块报告的访问次数以及使用访问次数对其他值的计算结果。例如，如果您缩短会话超时，访问次数会增加；如果增加会话超时，访问次数会减少。您可以将到期超时更改为 0，以表明应在浏览器关闭时删除此 Cookie。

异步代码段（推荐） 

_gaq.push(['_setSessionCookieTimeout', 1800000]);


参数

Number cookieTimeoutMillis：以毫秒为单位的新会话超时设置，也可设置为 0，以在浏览器关闭时删除相应 Cookie。

_setSiteSpeedSampleRate()

_setSiteSpeedSampleRate(sampleRate)

定义用于“网站速度”数据收集的新样本集大小。默认情况下，系统固定对 1% 的网站访问者进行采样，构成数据池，从而生成“网站速度”指标。如果每天访问您网站的用户数量相对较少（例如 10 万或更少），您可能需要将抽样率调整为更高的采样率。这将提高网页加载时间和其他网站速度指标的精细度。（如需详细了解“网站速度”报告，请参阅帮助中心内的网站速度。）

必须在调用 _trackPageview() 之前调用 _setSiteSpeedSampleRate() 方法才能生效。

Google 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 中更新此变量。在您的网站上实现此方法并通过此方法收集数据后，新定义的细分会显示在 Google Analytics（分析）报告“访问者”部分的“用户指定”报告中。此外，您可以访问“内容详情”报告中的“用户定义的值”细分，查看某网页的访问者中有多大比例属于您定义的特定细分。

参数

String newVal 要设置的新用户指定的值。

_trackPageLoadTime()

_trackPageLoadTime()

此方法已被弃用，因为系统会为所有用户自动启用“网站速度”报告功能。请使用 _setSiteSpeedSampleRate() 调整“网站速度”报告的采样率。

为此网页启用“网站速度”报告。针对您网站上要报告“网站速度”报告的每个网页，插入此方法。有关 Google Analytics（分析）中的“网站速度”报告的更多信息，请参阅我们帮助中心内的网站速度一文。

验证您的更改

如果报告中有数据，则表示您的设置正确无误。如果您在 24 小时后没有看到任何数据，请检查您的自定义设置，确保没有出现错误。要查看常见的跟踪代码错误列表，请参阅跟踪代码问题排查。本问题排查指南还包含基本调试步骤以及有关调试的更多信息。

请注意，为您的网站启用“网站速度”跟踪会向 Google Analytics（分析）服务器发送额外请求，这一请求不同于为获取浏览量而发送的网页跟踪 GIF 请求。为了尽可能减少整体网站延迟时间，系统将从您的网站浏览量中取样发送这一请求。因此，在使用 Firebug 或其他工具调试这一功能时，您有时可能看不到网站速度 GIF 请求。这是正常现象。

异步代码段（推荐） 

_gaq.push(['_setAccount', 'UA-12345-1']);
_gaq.push(['_trackPageview']);
_gaq.push(['_trackPageLoadTime']);

_trackPageview()

_trackPageview(opt_pagePath)

Google Analytics（分析）跟踪代码 (GATC) 的主逻辑。如果启用了链接器功能，它会尝试从网址中提取 Cookie 值。否则，它会尝试从 document.cookie 提取 Cookie 值。它还会根据需要更新或创建 Cookie，然后将它们写回文档对象。收集所有要发送到 UCFE（UDP 收集器前端）的相应指标。

异步代码段（推荐） 

_gaq.push(['_setAccount', 'UA-12345-1']);
_gaq.push(['_trackPageview', '/home/landingPage']);

参数

String opt_pagePath 可选参数，用于指示要跟踪的指标所在的网页路径。使用此选项时，请使用起始斜杠 (/) 指示网页路径。