Справка по методам объекта ga

В этой статье описаны методы, доступные в объекте ga.

Обзор методов

После загрузки библиотеки analytics.js в объекте ga доступны приведенные ниже методы. Они не активируются автоматически – их следует вызывать с помощью функции ready callback очереди команд ga.

Не используйте методы объекта ga вне функции readyCallback, так как они могут быть недоступны.

var trackers = ga.getAll();

Используйте методы объекта ga внутри функции readyCallback, поскольку это гарантирует их работу.

ga(function() {
  var trackers = ga.getAll();
});
Методы
create([trackingId], [cookieDomain], [name], [fieldsObject]);

Возвращает: Tracker

Создает новый экземпляр счетчика с указанными полями.

getByName(name)

Возвращает: Tracker

Получает экземпляр счетчика с указанным названием.

getAll()

Возвращает: Array<Tracker>

Получает все экземпляры счетчика.

remove(name)

Возвращает: undefined

Удаляет экземпляр счетчика с указанным названием.

Описание методов

create

Создает новый экземпляр счетчика с указанными полями.

Использование

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

Параметры

Ознакомьтесь с документацией по полям.

Возвращаемое значение

Tracker

Примеры

// Creates a default tracker for the property UA-XXXXX-Y
// and uses automatic cookie domain configuration.
ga(function() {
  var tracker = 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(function() {
  var myTracker = ga.create('UA-XXXXX-Y', 'example.com', 'myTracker', {
    transport: 'beacon'
  });
});

getByName

Получает экземпляр счетчика с указанным названием.

Использование

ga.getByName(name);

Параметры

Название Тип Обязательно? Описание
name string Да Название счетчика, который нужно получить.

Возвращаемое значение

Tracker

Примеры

// Gets the default tracker.
ga(function() {
  ga.getByName('t0');
});
// Gets the tracker with the name "myTracker".
ga(function() {
  ga.getByName('myTracker');
});

getAll

Получает все экземпляры счетчика.

ga.getAll();

Возвращаемое значение

Array<Tracker>

Пример

// Logs a list of all tracker names to the console.
ga(function() {
  var trackers = ga.getAll();
  trackers.forEach(function(tracker) {
    console.log(tracker.get('name'));
  });
});

remove

Удаляет экземпляр счетчика с указанным названием.

Использование

ga.remove(name);

Параметры

Название Тип Обязательно? Описание
name string Да Название счетчика, который нужно удалить.

Возвращаемое значение

undefined

Примеры

// Removes the default tracker.
ga(function() {
  // Note that, unlike the ga command queue's remove method,
  // this method requires passing a tracker name, even when
  // removing the default tracker.
  ga.remove('t0');
});
// Removes the tracker with the name "myTracker".
ga(function() {
  ga.remove('myTracker');
});