ga 命令队列参考

ga() 命令队列提供了一个接口，几乎所有需要利用 analytics.js 库来执行的任务都可以通过该接口完成。

JavaScript 跟踪代码段定义了初始的 ga() 命令队列函数，您甚至可以在 analytics.js 库完全加载之前使用该函数。analytics.js 库一旦加载完成，命令队列中的所有命令就会按其在队列中的顺序依次执行。这些命令执行完成后，新添加到命令队列中的命令就会立即执行。

为了让跟踪代码段尽可能小，ga() 命令队列以重载方式接受多种不同格式的参数。本文详细介绍调用 ga() 命令队列函数的各种方式。

将命令添加到队列

使用下列函数签名来调用 ga() 命令队列会将命令加入队列，以便在库载入后调度执行。

用法

ga(command, [...fields], [fieldsObject])

参数

[trackerName.][pluginName:]methodName

关于各字段的说明，请参阅字段参考。

示例

要查看各个命令的示例，请参阅命令方法部分。

回调函数准备就绪

如果在调用 ga() 命令队列函数时向其传递一个函数，会将该函数的执行安排在队列中的下一位置。

由于只有在 analytics.js 库完全载入之后才能执行命令，向命令队列传递函数最常见的情况是指定回调函数，以便在 analytics.js 库完全载入和可用时调用。

用法

ga(readyCallback)

参数

示例

// Queues a tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto');

// Once the tracker has been created, log the
// client ID to the console.
ga(function(tracker) {
  console.log(tracker.get('clientId'));
});

// Queues a named tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker');

// When there is no default tracker, the first
// argument of the ready callback is `undefined`.
ga(function(tracker) {
  console.log(tracker); // Logs `undefined`.
});

命令方法详情

下面列出了可以传递给 ga() 命令队列的所有方法（不包括插件方法）。

create

使用指定字段创建一个新的跟踪器实例。

用法

ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);

参数

关于各字段的说明，请参阅字段参考。

返回值

undefined

示例

// Creates a default tracker for the Property UA-XXXXX-Y
// and uses automatic cookie domain configuration.
ga('create', 'UA-XXXXX-Y', 'auto');

// Creates a tracker with the name "myTracker" for the Property
// UA-XXXXX-Y, sets the cookieDomain to "example.com", and specifies
// a transport mechanism of "beacon".
ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', {
  transport: 'beacon'
});

send

向 Google Analytics（分析）发送一个匹配。

用法

ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);

所发送的字段值是通过将 ...fields 参数和 fieldsObject 指定的值与跟踪器中当前存储的值合并到一起得到的。

参数

可以通过 ...fields 参数指定的字段因匹配类型而异。下表列出了与每种匹配类型对应的字段。其中未列出的匹配类型不接受 ...fields 参数，仅接受 fieldsObject。

关于各字段的说明，请参阅字段参考。

返回值

undefined

示例

// Sends a pageview hit.
ga('send', 'pageview');

// Sends an event hit for the tracker named "myTracker" with the
// following category, action, and label, and sets the nonInteraction
// field value to true.
ga('send', 'event', 'link', 'click', 'http://example.com', {
  nonInteraction: true
});

set

在跟踪器对象上设置一个或一组字段/值对。

用法

// Sets a single field and value.
ga('[trackerName.]set', fieldName, fieldValue);

// Sets a group of field/value pairs.
ga('[trackerName.]set', fieldsObject);

参数

关于各字段的说明，请参阅字段参考。

返回值

undefined

示例

// Sets the page field to "/about.html".
ga(set, 'page', '/about.html');

// Sets the page field to "/about.html" and the title to "About".
ga(set, {
  page: '/about.html',
  title: 'About'
});

require

请求一个 analytics.js 插件。

用法

ga('[trackerName.]require', pluginName, [pluginOptions]);

参数

返回值

undefined

示例

// Requires the Enhanced Ecommerce plugin.
ga('require', 'ec');

// Requires the Display Features plugin for the tracker
// named "myTracker" and override its default cookie name.
ga('myTracker.require', 'displayfeatures', {
  cookieName: 'display_features_cookie'
});

provide

提供一个 analytics.js 插件及其方法，以便在 ga() 命令队列中使用。

ga('provide', pluginName, pluginConstuctor);

参数

示例

// Defines a plugin constructor
function MyPlugin(tracker, options) {
  // ...
}

// Provides the plugin for use with the ga() command queue.
ga('provide', 'myplugin', MyPlugin);

remove

移除一个跟踪器对象。

用法

ga('[trackerName.]remove');

示例

// Remove the default tracker.
ga('remove');

// Remove the  tracker named "myTracker".
ga('myTracker.remove');