Analytics.js 字段参考

本文档将列举 analytics.js 的所有可配置字段名称。

  1. Create 专有的字段
  2. 常规
  3. 用户
  4. 会话
  5. 流量来源
  6. 系统信息
  7. 匹配
  8. 内容信息
  9. 应用跟踪
  10. 事件跟踪
  11. 增强型电子商务
  12. 社交互动
  13. 计时
  14. 异常
  15. 自定义维度/指标
  16. 内容实验

Create 专有的字段

以下字段只可在 create 方法中设置。有关详情,请参阅高级配置指南中的创建跟踪器对象部分。

跟踪 ID/网络媒体资源 ID

对于所有匹配类型都是必填项。

跟踪 ID / 网络媒体资源 ID。格式为 UA-XXXX-Y。所有收集的数据都与此 ID 相关联。

字段名称 值类型 默认值
trackingId 文字
值示例:UA-XXXX-Y
用法示例:
ga('create', 'UA-XXXX-Y');

// Alerts the tracking ID for the default tracker.
ga(function(tracker) {
  alert(tracker.get('trackingId'));
});

跟踪器名称

选填。此字段只可在 create 方法中设置。

跟踪器对象的名称。

字段名称 值类型 默认值
name 文字 t0
值示例:myTracker
用法示例:
ga('create', 'UA-XXXX-Y', {'name': 'myTracker'});

Client ID

选填。此字段只可在 create 方法中设置。

以匿名方式标识浏览器实例。默认情况下,此值作为第一方分析跟踪 Cookie 的一部分进行存储,有效期为 2 年。

字段名称 值类型 默认值
clientId 文字 Randomly Generated
值示例:35009a79-1a05-49d7-b876-2b884d0f825b
用法示例:
ga('create', 'UA-XXXX-Y', {
  'clientId': '35009a79-1a05-49d7-b876-2b884d0f825b'
});

抽样率

选填。此字段只可在 create 方法中设置。

指定应对多大比例的用户进行跟踪。默认值为 100(跟踪所有用户),但是大型网站可能需要降低抽样率,以免超出 Google Analytics(分析)的处理上限。

字段名称 值类型 默认值
sampleRate number 100
值示例:5
用法示例:
ga('create', 'UA-XXXX-Y', {'sampleRate': 5});

网站速度抽样率

选填。此字段只可在 create 方法中设置。

此设置决定以何种频率发送网站速度跟踪信标。默认情况下,系统会自动跟踪 1% 的用户。

字段名称 值类型 默认值
siteSpeedSampleRate number 1
值示例:10
用法示例:
ga('create', 'UA-XXXX-Y', {'siteSpeedSampleRate': 10});

总是发送引荐来源网址

选填。此字段只可在 create 方法中设置。

默认情况下,系统仅在引荐网站的主机名与当前网页的主机名不一致时发送用于归因流量来源的 HTTP 引荐来源网址。仅当您想要将当前主机上的其他网页作为引荐处理时,才可启用此设置。

字段名称 值类型 默认值
alwaysSendReferrer 布尔值 false
值示例:true
用法示例:
ga('create', 'UA-XXXX-Y', {'alwaysSendReferrer': true});

允许定位点参数

选填。此字段只可在 create 方法中设置。

默认情况下,analytics.js 会在当前网页网址的查询字符串和定位点中搜索 utm_source、utm_medium 等自定义广告系列参数。如果将此字段设为“false”,系统将忽略出现在定位点中的任何自定义广告系列参数。

字段名称 值类型 默认值
allowAnchor 布尔值 true
值示例:false
用法示例:
ga('create', 'UA-XXXX-Y', {'allowAnchor': false});

Cookie 名称

选填。此字段只可在 create 方法中设置。

用于存储分析数据的 Cookie 的名称

字段名称 值类型 默认值
cookieName 文字 _ga
值示例:gaCookie
用法示例:
ga('create', 'UA-XXXX-Y', {'cookieName': 'gaCookie'});

Cookie 网域

选填。此字段只可在 create 方法中设置。

指定用于存储分析 Cookie 的网域。如果将此字段设为“none”,系统将不会在设置 Cookie 时指定网域。

字段名称 值类型 默认值
cookieDomain 文字 document.location.hostname (normalized)
值示例:example.com
用法示例:
ga('create', 'UA-XXXX-Y', {'cookieDomain': 'example.com'});

Cookie 有效期

选填。此字段只可在 create 方法中设置。

指定 Cookie 有效期,以秒为单位。

字段名称 值类型 默认值
cookieExpires 整数 63072000 (two years)
值示例:86400
用法示例:
ga('create', 'UA-XXXX-Y', {'cookieExpires': 86400});

存储 GAC

选填。此字段只可在 create 方法中设置。

默认情况下,analytics.js 会写入 Cookie 来存储广告系列信息。该字段可用于禁止写入该 Cookie。

字段名称 值类型 默认值
storeGac 布尔值 true
值示例:false
用法示例:
ga('create', 'UA-XXXX-Y', {'storeGac': false});

旧版 Cookie 网域

选填。此字段只可在 create 方法中设置。

此字段用于配置 analytics.js 如何搜索由 ga.js 和 urchin.js 等旧版 Google Analytics(分析)跟踪脚本生成的 Cookie。

字段名称 值类型 默认值
legacyCookieDomain 文字
值示例:store.example.com
用法示例:
ga('create', 'UA-XXXX-Y', {'legacyCookieDomain': 'store.example.com'});

旧版历史数据导入

选填。此字段只可在 create 方法中设置。

指明 analytics.js 是否应该尝试从 ga.js Cookie 中导入历史数据。

字段名称 值类型 默认值
legacyHistoryImport 布尔值 true
值示例:false
用法示例:
ga('create', 'UA-XXXX-Y', 'auto', {'legacyHistoryImport': false});

允许链接器参数

选填。此字段只可在 create 方法中设置。

将此字段设为 true 将会启用跨网域链接器参数(用于在网域间传递状态)分析。

字段名称 值类型 默认值
allowLinker 布尔值 false
值示例:true
用法示例:
ga('create', 'UA-XXXX-Y', {allowLinker: true});

常规

对 IP 地址进行匿名处理

选填。

启用后,发送者的 IP 地址将匿名显示。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
anonymizeIp aip 布尔值 不适用 全部
值示例:true
用法示例:
ga('set', 'anonymizeIp', true);

数据来源

选填。

表示匹配的数据来源。从 analytics.js 发送的匹配的数据来源设置为“web”,从其中一个移动 SDK 发送的匹配的数据来源设置为“app”。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
dataSource ds 文字 全部
值示例:crm
用法示例:
ga('set', 'dataSource', 'crm');

队列时间

选填。

用于收集离线/潜藏匹配。此值表示所报告匹配的发生时间和发送时间的间隔(以毫秒表示)。此值必须大于等于 0。大于 4 小时的值会导致此匹配不能得到处理。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
queueTime qt 整数 全部
值示例:560
用法示例:
ga('set', 'queueTime', 560);

强制采用 SSL

选填。

默认情况下,从 HTTPS 网页发送跟踪信标时使用 HTTPS,从 HTTP 网页发送信标时使用 HTTP。如果将 forceSSL 设为“true”,将强制 HTTP 网页也使用 HTTPS 发送所有信标。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
forceSSL 布尔值 false 不适用 全部
值示例:true
用法示例:
ga('set', 'forceSSL', true);

载体

选填。

此字段规定了发送匹配的传输机制。具体选项包括“beacon”、“xhr”和“image”。默认情况下,analytics.js 会尝试根据匹配规模和浏览器功能来确定最佳方法。如果您指定了“beacon”,而用户的浏览器不支持“navigator.sendBeacon”方法,则 analytics.js 会转而使用 “image”或“xhr”,具体取决于匹配规模。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
transport 文字 none (automatically determined) 全部
值示例:beacon
用法示例:
ga('send', 'event', 'click', 'download-me', {transport: 'beacon'});

使用信标

选填。

现在,此选项已被弃用,并用“transport”来代替。将此字段设为 true 将会指示客户端使用 navigator.sendBeacon 发送匹配。这对于以下情况很有帮助:您希望在用户即将离开您的网站之前跟踪某个事件,同时不延迟用户的导航操作。如果浏览器不支持 navigator.sendBeacon,将以常规方式发送匹配。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
useBeacon 布尔值 false 不适用 全部
值示例:true
用法示例:
ga('send', 'event', 'click', 'download-me', {useBeacon: true});

链接器参数

选填。

跨网域跟踪的链接器参数。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
linkerParam 文字 全部
值示例:_ga=1.231587807.1974034684.1435105198
用法示例:
// Alerts the linker parameter for the default tracker.
ga(function(tracker) {
  alert(tracker.get('linkerParam'));
});

匹配回调

选填。

一个在处理匹配后调用的函数。此回调函数始终都会被调用,不是在成功发送匹配后直接调用,就是在确定匹配不能发送或发送失败时调用。调用时,将没有参数会传递给该函数。您最好避免使用 hitcallBack 来执行您应用的关键代码,因为在极少数情况下(例如服务器未响应或 analytics.js 加载失败)该函数可能不会被调用。不过在这种情况下,您也可以设置一个超时,以确保代码得到执行。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
hitCallback function 全部
用法示例:
// Alerts the user when a hit is sent.
ga('send', 'pageview', {
  'hitCallback': function() {
    alert('hit sent');
  }
});

// Use a timeout to ensure the execution of critical application code.
ga('send', 'pageview', {'hitCallback': criticalCode});
setTimeout(criticalCode, 2000);

// Only run the critical code once.
var alreadyCalled = false;
function criticalCode() {
  if (alreadyCalled) return;
  alreadyCalled = true;

  // Run critical code here...
}

用户

User ID

选填。

如果请求中未指定 Client ID (cid),则此字段为必填字段。此值应该是由网站所有者/跟踪库用户提供的已知用户标识符。此值本身不得为个人身份信息,不能长久储存在 GA Cookie 或 Google Analytics(分析)提供的其他存储中。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
userId uid 文字 全部
值示例:as8eknlll
用法示例:
// Set the user ID when creating the tracker.
ga('create', 'UA-XXXX-Y', {'userId': 'as8eknlll'});

// Alternatively, you may set the user ID via the `set` method.
ga('set', 'userId', 'as8eknlll');

会话

会话控制

选填。

用于控制会话持续时间。将值设为“start”将强制以此匹配开始新会话,而“end”则会强制当前对话以此匹配结束。所有其他值都会被忽略。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
sessionControl sc 文字 全部
值示例:start
用法示例:
// Starts a new session.
ga('send', 'pageview', {'sessionControl': 'start'});

流量来源

文档引荐来源网址

选填。

指明哪个引荐来源给网站带来了流量。此值也将用于计算流量来源。此值的格式为网址。此字段由 create 命令初始化,仅在当前的主机名与引荐来源网址主机名不同时设置,除非“alwaysSendReferrer”字段已设为“true”。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
referrer dr 文字 document.referrer 2048 字节 全部
值示例:http://example.com
用法示例:
ga('set', 'referrer', 'http://example.com');

广告系列名称

选填。

指定广告系列名称。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
campaignName cn 文字 100 字节 全部
值示例:(direct)
用法示例:
ga('set', 'campaignName', '(direct)');

广告系列来源

选填。

指定广告系列来源。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
campaignSource cs 文字 100 字节 全部
值示例:(direct)
用法示例:
ga('set', 'campaignSource', '(direct)');

广告系列媒介

选填。

指定广告系列媒介。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
campaignMedium cm 文字 50 字节 全部
值示例:organic
用法示例:
ga('set', 'campaignMedium', 'organic');

广告系列关键字

选填。

指定广告系列关键字。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
campaignKeyword ck 文字 500 字节 全部
值示例:Blue Shoes
用法示例:
ga('set', 'campaignKeyword', 'Blue Shoes');

广告系列内容

选填。

指定广告系列内容。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
campaignContent cc 文字 500 字节 全部
值示例:content
用法示例:
ga('set', 'campaignContent', 'content');

广告系列 ID

选填。

指定广告系列 ID。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
campaignId ci 文字 100 字节 全部
值示例:ID
用法示例:
ga('set', 'campaignId', 'ID');

系统信息

屏幕分辨率

选填。

指定屏幕分辨率。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
screenResolution sr 文字 20 字节 全部
值示例:800x600
用法示例:
ga('set', 'screenResolution', '800x600');

视口大小

选填。

指定浏览器/设备的可视区域大小。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
viewportSize vp 文字 20 字节 全部
值示例:123x456
用法示例:
ga('set', 'viewportSize', '123x456');

文档编码

选填。

指定用于给网页/文档编码的字符集。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
encoding de 文字 UTF-8 20 字节 全部
值示例:UTF-8
用法示例:
ga('set', 'encoding', 'UTF-16');

屏幕颜色

选填。

指定屏幕颜色深度。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
screenColors sd 文字 20 字节 全部
值示例:24-bits
用法示例:
ga('set', 'screenColors', '8-bit');

用户语言

选填。

指定语言。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
language ul 文字 20 字节 全部
值示例:en-us
用法示例:
ga('set', 'language', 'en-us');

已启用 Java

选填。

指定是否启用了 Java。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
javaEnabled je 布尔值 不适用 全部
值示例:true
用法示例:
ga('set', 'javaEnabled', true);

Flash 版本

选填。

指定 Flash 版本。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
flashVersion fl 文字 20 字节 全部
值示例:10 1 r103
用法示例:
ga('set', 'flashVersion', '10 1 r103');

匹配

匹配类型

对所有匹配类型而言都是必填项。

匹配的类型。必须是“pageview”、“screenview”、“event”、“transaction”、“item”、“social”、“exception”、“timing”中的一个。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
hitType t 文字 全部
值示例:pageview
用法示例:
ga('send', {
  'hitType': 'pageview',
  'page': '/home'
});

非互动匹配

选填。

指定是否将匹配视为非互动性质。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
nonInteraction ni 布尔值 不适用 全部
值示例:true
用法示例:
ga('set', 'nonInteraction', true);

内容信息

文档位置网址

选填。

指定网页的完整网址(不包括定位点)。此字段由 create 命令初始化。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
location dl 文字 2048 字节 全部
值示例:http://foo.com/home?a=b
用法示例:
ga('set', 'location', 'http://foo.com/home?a=b');

文档主机名

选填。

指定托管内容的主机名称。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
hostname dh 文字 100 字节 全部
值示例:foo.com
用法示例:
ga('set', 'hostname', 'foo.com');

文档路径

选填。

网页网址的路径部分,应以“/”开头。对于“pageview”匹配,必须指定 &dl,或同时指定 &dh 与 &dp,以使相应匹配有效。用于指定虚拟网页路径。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
page dp 文字 2048 字节 全部
值示例:/foo
用法示例:
ga('set', 'page', '/foo');

文档标题

选填。

网页/文档的标题。默认值为 document.title。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
title dt 文字 1500 字节 全部
值示例:Settings
用法示例:
ga('set', 'title', 'Settings');

屏幕名称

对于屏幕浏览匹配类型来说是必填项。

在网络媒体资源上,此参数是选填项,而对移动媒体资源上的屏幕浏览匹配而言,此参数是必填项,因为在移动媒体资源上,此参数会被用做屏幕浏览匹配的“屏幕名称”。在网络媒体资源上,此字段将默认设为网页的专属网址,原样使用 &dl 参数或组合使用 &dh 和 &dp。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
screenName cd 文字 2048 字节 screenview
值示例:High Scores
用法示例:
ga('set', 'screenName', 'High Scores');

内容组

选填。

您最多可以有 5 个内容分组,每个内容分组都有关联的索引(1-5,含 1 和 5)。每个内容分组最多可以有 100 个内容组。内容组的值是由“/”分隔的分层文字。所有头尾端斜杠都将被移除,所有重复的斜杠也都会删减为单个斜杠。例如,“/a//b/”将转换为“a/b”。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
contentGroup cg<groupIndex> 文字 100 字节 全部
值示例:news/sports
用法示例:
ga('set', 'contentGroup5', '/news/sports');

链接 ID

选填。

用户所点击的 DOM 元素的 ID,在为媒体资源启用了增强的链接归因的情况下,用于在网页内分析报告中区分指向同一个网址的多个链接。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
linkid linkid 文字 全部
值示例:nav_bar
用法示例:
ga('set', '&linkid', 'html-element-id');

应用跟踪

应用名称

选填。

指定应用名称。此字段对具有应用相关数据(例如,应用版本、应用 ID 或应用安装程序 ID)的任何匹配而言都是必填项。对发送到网络媒体资源的匹配而言,此字段为选填项。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
appName an 文字 100 字节 全部
值示例:My App
用法示例:
ga('set', 'appName', 'My App');

应用 ID

选填。

应用标识符。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
appId aid 文字 150 字节 全部
值示例:com.company.app
用法示例:
ga('set', 'appId', 'com.company.app');

应用版本

选填。

指定应用版本。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
appVersion av 文字 100 字节 全部
值示例:1.2
用法示例:
ga('set', 'appVersion', '1.2');

应用安装程序 ID

选填。

应用安装程序标识符。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
appInstallerId aiid 文字 150 字节 全部
值示例:com.platform.vending
用法示例:
ga('set', 'appInstallerId', 'com.platform.vending');

事件跟踪

事件类别

对于事件匹配类型是必填项。

指定事件类别。值不能为空。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
eventCategory ec 文字 150 字节 event
值示例:Category
用法示例:
ga('send', 'event', {
  'eventCategory': 'Category',
  'eventAction': 'Action'
});

事件操作

对于事件匹配类型是必填项。

指定事件操作。值不能为空。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
eventAction ea 文字 500 字节 event
值示例:Action
用法示例:
ga('send', 'event', {
  'eventCategory': 'Category',
  'eventAction': 'Action'
});

事件标签

选填。

指定事件标签。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
eventLabel el 文字 500 字节 event
值示例:Label
用法示例:
ga('send', 'event', {
  'eventCategory': 'Category',
  'eventAction': 'Action',
  'eventLabel': 'Label'
});

事件价值

选填。

指定事件价值。值不得为负数。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
eventValue ev 整数 event
值示例:55
用法示例:
ga('send', 'event', {
  'eventCategory': 'Category',
  'eventAction': 'Action',
  'eventValue': 55
});

增强型电子商务

产品 SKU

选填。

产品 SKU。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) id pr<productIndex>id 文字 500 字节 全部
值示例:P12345
用法示例:
ga('ec:addProduct', {'id': 'P12345'});

产品名称

选填。

产品名称。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) name pr<productIndex>nm 文字 500 字节 全部
值示例:Android T-Shirt
用法示例:
ga('ec:addProduct', {'name': 'Android T-Shirt'});

产品品牌

选填。

与产品相关联的品牌。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) brand pr<productIndex>br 文字 500 字节 全部
值示例:Google
用法示例:
ga('ec:addProduct', {'brand': 'Google'});

产品类别

选填。

产品所属的类别。产品索引必须是 1-200(含 1 和 200)之间的正整数。产品类别参数可以分为多个层级。使用 / 作为分隔符可指定最多 5 个层级。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) category pr<productIndex>ca 文字 500 字节 全部
值示例:Apparel
用法示例:
ga('ec:addProduct', {'category': 'Apparel'});

产品款式

选填。

产品的款式。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) variant pr<productIndex>va 文字 500 字节 全部
值示例:Black
用法示例:
ga('ec:addProduct', {'variant': 'Black'});

产品价格

选填。

产品的单价。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) price pr<productIndex>pr 货币 全部
值示例:29.20
用法示例:
ga('ec:addProduct', {'price': '29.20'});

产品数量

选填。

产品的数量。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) quantity pr<productIndex>qt 整数 全部
值示例:2
用法示例:
ga('ec:addProduct', {'quantity': 2});

产品优惠券代码

选填。

与产品关联的优惠券代码。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) coupon pr<productIndex>cc 文字 500 字节 全部
值示例:SUMMER_SALE13
用法示例:
ga('ec:addProduct', {'coupon': 'SUMMER_SALE13'});

产品位置

选填。

产品在列表或集合中的位置。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) position pr<productIndex>ps 整数 全部
值示例:2
用法示例:
ga('ec:addProduct', {'position': 2});

产品自定义维度

选填。

产品级自定义维度,其索引为 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) dimension pr<productIndex>cd<dimensionIndex> 文字 150 字节 全部
值示例:Member
用法示例:
ga('ec:addProduct', {'dimension1': 'Member'});

产品自定义指标

选填。

产品级自定义指标,其索引为 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product) metric pr<productIndex>cm<metricIndex> 整数 全部
值示例:28
用法示例:
ga('ec:addProduct', {'metric1': 28});

产品操作

选填。

匹配中所包含产品的角色。如果未指定产品操作,则该匹配中包含的所有产品定义都将被忽略。 必须为下列某个值:detail、click、add、remove、checkout、checkout_option、purchase、refund。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) pa 文字 全部
值示例:detail
用法示例:
ga('ec:setAction', 'detail');

交易 ID

选填。

交易 ID。这是一个可以在“产品操作”设置为“purchase”或“refund”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) id ti 文字 全部
值示例:T1234
用法示例:
ga('ec:setAction', 'purchase', {'id': 'T1234'});

关联商户

选填。

发生此交易的商店或关联商户。这是一个可以在“产品操作”设置为“purchase”或“refund”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) affiliation ta 文字 全部
值示例:Google Store
用法示例:
ga('ec:setAction', 'purchase', {'affiliation': 'Google Store'});

收入

选填。

交易的总价值,包括税费和运费。如果未发送,此值将根据同一匹配中所有产品的数量和价格字段自动计算得出。这是一个可以在“产品操作”设置为“purchase”或“refund”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) revenue tr 货币 全部
值示例:123.21
用法示例:
ga('ec:setAction', 'purchase', {'revenue': '123.21'});

税费

选填。

交易对应的总税费。这是一个可以在“产品操作”设置为“purchase”或“refund”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) tax tt 货币 全部
值示例:10.78
用法示例:
ga('ec:setAction', 'purchase', {'tax': '10.78'});

运费

选填。

交易对应的运费。这是一个可以在“产品操作”设置为“purchase”或“refund”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) shipping ts 货币 全部
值示例:3.55
用法示例:
ga('ec:setAction', 'purchase', {'shipping': '3.55'});

优惠券代码

选填。

在交易中使用的优惠券。这是一个可以在“产品操作”设置为“purchase”或“refund”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) coupon tcc 文字 全部
值示例:SUMMER08
用法示例:
ga('ec:setAction', 'purchase', {'coupon': 'SUMMER08'});

产品操作列表

选填。

发生产品操作的列表或集合。这是一个可以在“产品操作”设置为“detail”或“click”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) list pal 文字 全部
值示例:Search Results
用法示例:
ga('ec:setAction', 'click', {'list': 'Search Results'});

结帐步骤

选填。

结帐渠道中的步骤编号。这是一个可以在“产品操作”设置为“checkout”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) step cos 整数 全部
值示例:2
用法示例:
ga('ec:setAction', 'checkout', {'step': 2});

结帐步骤选项

选填。

关于结帐步骤的额外信息。这是一个可以在“产品操作”设置为“checkout”时发送的附加参数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(product action) option col 文字 全部
值示例:Visa
用法示例:
ga('ec:setAction', 'checkout', {'option': 'Visa'});

产品展示列表名称

选填。

产品所在的列表或集合。展示列表索引必须是 1-200(含)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) list il<listIndex>nm 文字 全部
值示例:Search Results
用法示例:
ga('ec:addImpression', {'list': 'Search Results'});

产品展示 SKU

选填。

产品的 ID 或 SKU。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) id il<listIndex>pi<productIndex>id 文字 全部
值示例:P67890
用法示例:
ga('ec:addImpression', {'id': 'P67890'});

产品展示名称

选填。

产品名称。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) name il<listIndex>pi<productIndex>nm 文字 全部
值示例:Android T-Shirt
用法示例:
ga('ec:addImpression', {'name': 'Android T-Shirt'});

产品展示品牌

选填。

与产品相关联的品牌。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) brand il<listIndex>pi<productIndex>br 文字 全部
值示例:Google
用法示例:
ga('ec:addImpression', {'brand': 'Google'});

产品展示类别

选填。

产品所属的类别。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) category il<listIndex>pi<productIndex>ca 文字 全部
值示例:Apparel
用法示例:
ga('ec:addImpression', {'category': 'Apparel'});

产品展示款式

选填。

产品的款式。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) variant il<listIndex>pi<productIndex>va 文字 全部
值示例:Black
用法示例:
ga('ec:addImpression', {'variant': 'Black'});

产品展示位置

选填。

产品在列表或集合中的位置。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) position il<listIndex>pi<productIndex>ps 整数 全部
值示例:2
用法示例:
ga('ec:addImpression', {'position': 2});

产品展示价格

选填。

产品的价格。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) price il<listIndex>pi<productIndex>pr 货币 全部
值示例:29.20
用法示例:
ga('ec:addImpression', {'price': '29.20'});

产品展示自定义维度

选填。

产品级自定义维度,其索引为 1-200(含)之间的正整数。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) dimension il<listIndex>pi<productIndex>cd<dimensionIndex> 文字 全部
值示例:Member
用法示例:
ga('ec:addImpression', {'dimension1': 'Member'});

产品展示自定义指标

选填。

产品级自定义指标,其索引为 1-200(含)之间的正整数。展示列表索引必须是 1-200(含)之间的正整数。产品索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(impression) metric il<listIndex>pi<productIndex>cm<metricIndex> 整数 全部
值示例:28
用法示例:
ga('ec:addImpression', {'metric1': '28'});

促销 ID

选填。

促销活动的 ID。促销索引必须是 1-200(含 1 和 200)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(promo) id promo<promoIndex>id 文字 全部
值示例:SHIP
用法示例:
ga('ec:addPromo', {'id': 'SHIP'});

促销名称

选填。

促销活动的名称。促销索引必须是 1-200(含)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(promo) name promo<promoIndex>nm 文字 全部
值示例:Free Shipping
用法示例:
ga('ec:addPromo', {'name': 'Free Shipping'});

促销广告素材

选填。

与促销活动关联的广告素材。促销索引必须是 1-200(含)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(promo) creative promo<promoIndex>cr 文字 全部
值示例:Shipping Banner
用法示例:
ga('ec:addPromo', {'creative': 'Shipping Banner'});

促销位置

选填。

广告素材的位置。促销索引必须是 1-200(含)之间的正整数。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(promo) position promo<promoIndex>ps 文字 全部
值示例:banner_slot_1
用法示例:
ga('ec:addPromo', {'position': 'banner_slot_1'});

促销操作

选填。

指定匹配中所包含促销信息的角色。如果未指定促销操作,则会将其值视为默认促销操作“view”。要衡量用户对促销信息的点击,请将值设为“promo_click”。对于 analytics.js,在使用此字段之前必须先安装增强型电子商务插件。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
(promo) action promoa 文字 全部
值示例:click
用法示例:
ga('ec:setAction', 'promo_click'});

货币代码

选填。

若指定此参数,则表示所有交易货币值所采用的本地货币。值应当是有效的 ISO 4217 货币代码。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
currencyCode cu 文字 10 字节 全部
值示例:EUR
用法示例:
ga('set', 'currencyCode', 'EUR');

社交互动

社交网络

对于社交匹配类型是必填项。

指定社交网络,例如 Facebook 或 Google+。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
socialNetwork sn 文字 50 字节 social
值示例:facebook
用法示例:
ga('send', 'social', {
  'socialNetwork': 'facebook',
  'socialAction': 'like',
  'socialTarget': 'http://foo.com'
})

社交操作

对于社交匹配类型是必填项。

指定社交互动操作。例如在 Google+ 上,当用户点击“+1”按钮时,社交操作为“plus”。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
socialAction sa 文字 50 字节 social
值示例:like
用法示例:
ga('send', 'social', {
  'socialNetwork': 'facebook',
  'socialAction': 'like',
  'socialTarget': 'http://foo.com'
})

社交操作目标

对于社交匹配类型是必填项。

指定社交互动的目标。此值通常是网址,但也可以是任意文字。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
socialTarget st 文字 2048 字节 social
值示例:http://foo.com
用法示例:
ga('send', 'social', {
  'socialNetwork': 'facebook',
  'socialAction': 'like',
  'socialTarget': 'http://foo.com'
})

计时

用户计时类别

对于计时匹配类型是必填项。

指定用户计时类别。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
timingCategory utc 文字 150 字节 timing
值示例:category
用法示例:
ga('send', 'timing', {
  'timingCategory': 'category',
  'timingVar': 'lookup',
  'timingValue': 123
});

用户计时变量名称

对于计时匹配类型是必填项。

指定用户计时变量。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
timingVar utv 文字 500 字节 timing
值示例:lookup
用法示例:
ga('send', 'timing', {
  'timingCategory': 'category',
  'timingVar': 'lookup',
  'timingValue': 123
});

用户计时时间

对于计时匹配类型是必填项。

指定用户计时值。值以毫秒为单位。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
timingValue utt 整数 timing
值示例:123
用法示例:
ga('send', 'timing', {
  'timingCategory': 'category',
  'timingVar': 'lookup',
  'timingValue': 123
});

用户计时标签

选填。

指定用户计时标签。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
timingLabel utl 文字 500 字节 timing
值示例:label
用法示例:
ga('send', 'timing', {
  'timingCategory': 'category',
  'timingVar': 'lookup',
  'timingValue': 123,
  'timingLabel': 'label'
});

异常

异常说明

选填。

提供对异常情况的说明。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
exDescription exd 文字 150 字节 exception
值示例:DatabaseError
用法示例:
ga('send', 'exception', {
  'exDescription': 'DatabaseError'
});

异常是否严重?

选填。

指定异常是否严重。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
exFatal exf 布尔值 1 不适用 exception
值示例:true
用法示例:
ga('send', 'exception', {
  'exFatal': true
});

自定义维度/指标

自定义维度

选填。

每个自定义维度都有关联的索引。自定义维度最多可以有 20 个(Analytics 360 帐号为 200 个)。维度索引必须是 1-200(含)之间的正整数。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
dimension cd<dimensionIndex> 文字 150 字节 全部
值示例:Sports
用法示例:
ga('set', 'dimension14', 'Sports');

自定义指标

选填。

每个自定义指标都有关联的索引。自定义指标最多可以有 20 个(Analytics 360 帐号为 200 个)。指标索引必须是 1-200(含)之间的正整数。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
metric cm<metricIndex> number 全部
值示例:47
用法示例:
ga('set', 'metric7', 47);

内容实验

实验 ID

选填。

此参数指明此用户参与了采用指定 ID 的实验。此参数应与实验变体参数一起发送。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
expId xid 文字 40 字节 全部
值示例:Qp0gahJ3RAO3DJ18b0XoUQ
用法示例:
ga('set', 'expId', 'Qp0gahJ3RAO3DJ18b0XoUQ');

实验变体

选填。

此参数指明此用户参与了特定的实验变体。此参数应与实验 ID 参数一起发送。

字段名称 协议参数 值类型 默认值 长度上限 支持的匹配类型
expVar xvar 文字 全部
值示例:1
用法示例:
ga('set', 'expVar', '1');