- Справка по методам – Веб-отслеживание (analytics.js)
- Методы объекта ga
- create
- Параметры
- Примеры
- getByName
- Параметры
- Что будет возвращено
- Пример
- getAll
- Что будет возвращено
- Пример
- Методы объекта трекера
- send
- Параметры
- Пример
- set
- Параметры
- Параметры
- Примеры
- get
- Параметры
- Что будет возвращено
- Пример
- Синтаксис вызова
- Асинхронный вызов (трекер по умолчанию)
- Асинхронный вызов (трекер с именем)
- Синхронный вызов
- Асинхронная синхронизация
- Введение в Google Analytics API: краткое руководство по JavaScript для веб-приложений
- Шаг 1. Включите Google Analytics API
- Создайте идентификатор клиента
- Шаг 2. Настройте пример
- Hello Analytics
- Шаг 3. Запустите пример
Справка по методам – Веб-отслеживание (analytics.js)
Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Библиотека analytics.js предлагает два основных объекта для взаимодействия с Google Analytics, у каждого из которых есть свои методы.
Фрагмент кода analytics.js является частью сервиса Universal Analytics. Если вы используете классическую версию Google Analytics (ga.js), узнайте, как перевести свой ресурс на analytics.js, в Центре обновления.
Методы объекта ga
Когда вы размещаете на странице фрагмент кода JavaScript analytics.js, он создает глобальный объект ga . На его основе разработчики создают объекты трекера, которые затем передают данные на веб-ресурс.
create
Создает новый объект трекера по умолчанию.
ga('create', trackingId, opt_configObject);
Параметры
- String trackingId – идентификатор веб-ресурса отслеживаемого сайта.
- Object opt_configObject – необязательный объект, содержащий конфигурацию пар «поле/значение».
Примеры
Создание трекера по умолчанию:
Создание трекера с использованием собственного имени файла cookie:
Создание трекера с использованием синхронного синтаксиса:
var tracker = ga.create('UA-XXXX-Y', 'auto');
ga(‘create’, . ) может принимать как аргументы позиции, так и аргументы объекта в полях trackingId , cookieDomain и name . Порядок их следования имеет значение. Например, следующие два фрагмента идентичны:
ga('create', 'UA-XXXX-Y', 'auto', 'T1000');
getByName
Возвращает объект трекера с заданным именем или нулевое значение, если такого объекта нет.
Параметры
Что будет возвращено
Пример
Этот код возвращает объект трекера с именем shoehorn :
getAll
Возвращает массив, содержащий все существующие объекты трекера в том порядке, в котором они были созданы.
Что будет возвращено
Пример
Этот код возвращает все объекты отслеживания с указанием их имен:
Методы объекта трекера
Создав объект трекера с помощью метода create , используйте следующие методы для взаимодействия с Google Analytics.
send
Отправляет маркер отслеживания на серверы Google. Необязательный объект поля позволяет перезаписать одно или несколько значений полей только для этого обращения.
ga('send', hitType, opt_fieldObject);
Параметры
- String hitType – тип отправляемого обращения. Поддерживаемые значения:
- pageview (просмотр страницы);
- event (событие);
- social (социальное взаимодействие);
- timing (время).
Пример
Отправка обращения типа pageview (просмотр страницы) и переопределение заголовка страницы:
set
Обновляет значение, связанное с данным полем. Метод set можно вызывать с одним полем и значением:
Параметры
- String fieldName – название устанавливаемого поля.
- String|Number|Object|Boolean value – новое значение, присваиваемое полю.
Чтобы обновить значения нескольких полей, вызовите метод set с объектом, содержащим несколько пар «поле/значение».
Установленные значения будут использоваться при всех последующих вызовах метода send на протяжении жизненного цикла объекта трекера.
Параметры
Примеры
Установка поля page для всех последующих обращений:
Установка полей page и title для всех дальнейших обращений:
get
Возвращает значение, в данный момент присвоенное этому полю. Этот метод следует вызывать для экземпляра объекта трекера.
var fieldValue = tracker.get(fieldName);
Параметры
Что будет возвращено
Пример
Этот код позволяет получить текущую страницу трекера:
Эта функция будет выполнена, как только загрузится библиотека analytics.js. Параметр tracker будет ссылаться на трекер по умолчанию (при условии, что он был создан до вызова функции). Затем эта ссылка используется для получения значения page .
Синтаксис вызова
Далее описывается, как вызвать каждый метод объекта ga .
Асинхронный вызов (трекер по умолчанию)
Фрагмент кода anaytics.js загружается асинхронно, чтобы браузер не приостанавливал свою работу во время загрузки библиотеки. Чтобы не синхронизировать свой код с загрузкой библиотеки, вы можете использовать объект ga в качестве функции. Для этого передайте название метода в первом параметре:
ga('create', 'UA-XXXX-Y', 'auto'); ga('send', 'pageview');
Как только завершится загрузка библиотеки, метод create создаст объект трекера по умолчанию t0 , в отношении которого будет выполнен метод send (или любой другой метод, вызванный с помощью этого синтаксиса).
В данном случае объект трекера по умолчанию создается для удобства реализации.
Асинхронный вызов (трекер с именем)
Иногда на одной странице может понадобиться создать несколько трекеров. Чтобы их различать, вам нужно будет присвоить имя каждому дополнительному трекеру.
Чтобы создать объект трекера с именем, задайте поле конфигурации name , используя параметр объекта конфигурации метода create .
Затем вызовите методы трекера для проименованных трекеров. Для этого поставьте перед каждым методом имя трекера и точку ( . ):
Синхронный вызов
Библиотека anaytics.js поддерживает также и синхронные вызовы. В этом случае вы выполняете методы напрямую над объектами ga или tracker :
var tracker = ga.create('UA-XXXX-Y', 'auto'); tracker.send('pageview');
Примечание. Этот способ не будет работать, если библиотека analytics.js загружается с помощью стандартного фрагмента кода – он поддерживает только асинхронный синтаксис.
Асинхронная синхронизация
Некоторые методы необходимо вызывать только после загрузки библиотеки. Например, метод get сработает только после того, как будет загружена библиотека, создан трекер и установлены все необходимые поля. В этом случае вы можете передать объекту ga функцию, которая будет выполнена только по завершении загрузки библиотеки:
Эта функция принимает параметр, который после ее выполнения будет иметь значение трекера по умолчанию. Затем этот объект трекера можно использовать с синхронным синтаксисом. Пример:
ga('create', 'UA-XXXX-Y', 'auto'); ga(function(tracker) < tracker.send('pageview'); >);
Аналогичным образом можно отслеживать просмотры страниц на всех трекерах, которые вы создали:
Это особенно полезно, если вы хотите создать расширения, поскольку в этом случае вам может быть неизвестно, сколько трекеров имеется на сайте. Благодаря использованию этого синтаксиса функция сможет выполнять много дополнительных логических схем для каждого трекера на странице, после того как загрузится код отслеживания.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons «С указанием авторства 4.0», а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2015-09-21 UTC.
Введение в Google Analytics API: краткое руководство по JavaScript для веб-приложений
В этом руководстве описывается, как получить доступ к аккаунту Google Analytics, отправлять запросы в API этого сервиса, обрабатывать ответы и извлекать результаты обработки с применением Core Reporting API 3.0, Management API 3.0 и OAuth 2.0.
Примечание. Цель этих кратких руководств – помочь пользователю выполнить авторизацию API с помощью клиентских библиотек Google API. Поскольку эти библиотеки постоянно обновляются, информации о последних изменениях здесь может не быть. Если вы не нашли нужные сведения, ознакомьтесь с документацией по клиентским библиотекам и справочной информацией.
Шаг 1. Включите Google Analytics API
Перед началом работы с Google Analytics API используйте инструмент настройки, чтобы создать проект в Google API Console, включить API и зарегистрировать учетные данные.
Чтобы создать идентификатор веб-клиента или клиента установленного приложения, нужно указать название продукта в окне запроса доступа. Если вы ещё не указали название, вам будет предложено это сделать.
Создайте идентификатор клиента
Откройте раздел «Учетные данные» и выполните следующие действия:
- Нажмите Создать учетные данные и выберите вариант Идентификатор клиента OAuth.
- В разделе Тип приложения выберите Веб-приложение.
- Введите название.
- В поле Разрешенные источники JavaScript укажите http://localhost:8080.
- В поле Разрешенные URI перенаправления введите http://localhost:8080/oauth2callback.
- Нажмите кнопку Создать.
Шаг 2. Настройте пример
Вам необходимо создать файл с названием HelloAnalytics.html , где будет содержаться код HTML и JavaScript.
- Скопируйте или скачайте приведенный ниже исходный код для HelloAnalytics.html .
- Замените на свой идентификатор клиента, который создали ранее.
Hello Analytics
Шаг 3. Запустите пример
После того как вы включили Google Analytics API и настроили код образца, он готов к запуску.
- Загрузите HelloAnalytics.html на свой веб-сервер и откройте эту страницу в браузере.
- Нажмите кнопку «Авторизация», чтобы открыть доступ к Google Analytics.
После выполнения всех шагов будет выведено название первого профиля авторизованного пользователя в Google Analytics и количество сеансов за последние семь дней.
Примечание. Для успешного запуска примера нужно иметь по крайней мере один ресурс и профиль Google Analytics.
Имея авторизованный служебный объект Analytics, вы можете запустить любой из примеров кода, приведенных в справочных материалах по Management API. Например, можно попробовать изменить код, чтобы использовать метод accountSummaries.list.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons «С указанием авторства 4.0», а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2019-01-23 UTC.