Обзор 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.