Обзор Google Analytics Data API

Вы можете использовать Data API для программного доступа к данным отчетов Google Аналитики.

Подробнее о ресурсах Google Аналитики…

Данные, возвращаемые API, соответствуют данным, которые показываются в пользовательском интерфейсе Google Аналитики, и полностью учитывают способы идентификации для отчетов, заданные для ресурса Google Аналитики, например смешанную, наблюдаемую или основанную на устройствах.

Вот несколько примеров отчетов, которые можно создать с помощью Google Analytics Data API v1:

  • Сколько активных пользователей за день было у вашего приложения Android за последнюю неделю?
  • Сколько просмотров получили 10 самых популярных страниц вашего сайта за последние 28 дней.
  • Сколько активных пользователей по странам было у вашего приложения для iOS за последние 30 минут.

С помощью Google Analytics Data API v1 также можно:

  • создавать специальные сводки для просмотра данных Google Analytics;
  • автоматизировать создание сложных отчетов;
  • использовать данные Google Analytics в других бизнес-приложениях.

Согласованность данных и способы идентификации

Google Analytics Data API версии 1 позволяет получать доступ к тем же данным отчетов, что и интерфейс Google Аналитики. Данные, возвращаемые API, полностью соответствуют настройкам способа идентификации, заданным для ресурса Google Аналитики. Таким образом, количество пользователей, дедупликация и моделирование данных будут соответствовать выбранной области идентификации, например смешанной, наблюдаемой или на основе устройств, в настройках ресурса.

Подробнее о том, как способы идентификации влияют на отчеты…

Начать

Чтобы начать работу с клиентской библиотекой на Java, Python, Node.js, PHP, C#, Go или Ruby, ознакомьтесь с кратким руководством по клиентской библиотеке. Чтобы узнать, как создавать запросы, фильтровать параметры и читать ответы, ознакомьтесь со статьей Как создать отчет или протестируйте запросы в интерактивном режиме в Query Explorer.

Пример запроса и ответа runReport

Чтобы запросить данные о событиях через REST, отправьте запрос POST к конечной точке runReport с телом JSON RunReportRequest, в котором указаны dateRanges, dimensions и metrics:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

Или выполните эквивалентную команду curl, используя Application Default Credentials:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

API возвращает RunReportResponse, содержащий заголовки столбцов и строки данных:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Доступные методы

Ниже приведен список методов Data API. Подробную информацию вы найдете в справочной документации.

  • runReport Этот метод возвращает специальный отчет с данными о событиях Google Аналитики и является предпочтительным для простых запросов отчетов.
  • batchRunReports Это пакетная версия метода runReport, которая позволяет создавать несколько отчетов с помощью одного вызова API.
  • runPivotReport Этот метод возвращает специальный сводный отчет с данными о событиях Google Аналитики. Сводные отчеты – это более продвинутый и выразительный формат, чем обычные отчеты. Каждая сводка описывает видимые столбцы и строки параметров в ответе отчета.
  • batchRunPivotReports Это пакетная версия метода runPivotReport, которая позволяет создавать несколько отчетов с помощью одного вызова API.
  • getMetadata Этот метод возвращает метаданные для параметров и показателей, доступных в методах создания отчетов. Используется для изучения параметров и показателей. Ответ этого метода также включает специальные параметры и показатели, доступные для указанного ресурса Google Аналитики.
  • checkCompatibility Этот метод позволяет получить список параметров и показателей, которые можно добавить в запрос отчета без потери совместимости.
  • runRealtimeReport Этот метод возвращает отчет о событиях в реальном времени для вашего ресурса. События появляются в отчетах в реальном времени через несколько секунд после того, как они были отправлены в Google Аналитику. Отчеты в реальном времени содержат данные о событиях и использовании за интервал времени от текущего момента до 30 минут назад (до 60 минут назад для ресурсов Google Аналитики 360).
  • properties.audienceExports Группа методов, позволяющих создавать экспорты аудиторий, которые включают снимок пользователей в аудитории.
  • properties.recurringAudienceLists (Ранняя предварительная версия) Группа методов, позволяющих управлять регулярным экспортом аудиторий. При повторяющемся экспорте аудитории новые списки аудитории создаются каждый день.
  • runFunnelReport (Предварительная версия) Этот метод возвращает отчет о воронке с данными о событиях Google Аналитики, созданный на основе заданных вами параметров. Исследование воронки позволяет визуализировать шаги пользователей на пути к выполнению определенного действия и быстро узнать, насколько успешно клиенты проходят каждый из этапов.
  • properties.chat (Предварительная версия) Этот метод обеспечивает программный доступ к Ask Advisor в Google Аналитике в формате диалога. Вы можете задавать вопросы о данных о событиях на естественном языке, диагностировать изменения эффективности и получать структурированные текстовые и табличные подсказки.

Поддерживаемые параметры и показатели

Список всех параметров и показателей, поддерживаемых Data API, приведен в документации по схеме API.