Как создать экспорт аудитории

Аудитории в Google Аналитике позволяют сегментировать пользователей по различным параметрам, важным для достижения бизнес-целей. Аудитории позволяют группировать пользователей сайта или приложения по общим атрибутам.

Вы можете экспортировать аудитории, включая сводные данные о пользователях, с помощью Data API.

Ознакомьтесь с руководством по экспорту аудиторий, чтобы узнать больше о данных, которые вы видите в экспортированных аудиториях.

Обзор

Чтобы создать и запросить экспорт аудитории, выполните следующие запросы к Data API:

1. Вызовите метод audienceExports.create, чтобы создать экспорт аудитории.
2. Вызовите метод audienceExports.query, чтобы получить список пользователей в аудитории.

Чтобы получить метаданные конфигурации для определенного экспорта аудитории, вызовите метод audienceExports.get. Чтобы получить список всех экспортов аудиторий для определенного ресурса, вызовите метод audienceExports.list.

Выберите объект отчета

Для всех методов Data API требуется указать идентификатор ресурса Google Аналитики в пути запроса URL в формате properties/GA_PROPERTY_ID. Пример:

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

Отчет создается на основе данных о событиях Google Аналитики, собранных в указанном ресурсе Google Аналитики.

Если вы используете одну из клиентских библиотек Data API, вам не нужно менять путь URL запроса. Большинство API-клиентов предоставляют параметр property, который ожидает строку в формате properties/GA_PROPERTY_ID. Примеры использования клиентских библиотек можно найти в кратком руководстве.

Как создать экспорт аудитории

Чтобы создать экспорт аудитории, вызовите метод audienceExports.create, используя в запросе объект AudienceExport. Обязательные параметры:

• Действительное название аудитории в поле audience в формате properties/{propertyId}/audiences/{audienceId}. Чтобы получить это значение, используйте метод audiences.list Google Analytics Admin API версии 1. Поле Audience.name в ответе audiences.list содержит название аудитории.
• Допустимый список параметров в поле dimensions. Список параметров, поддерживаемых этим методом, можно найти в документации Схема экспорта аудитории. При экспорте аудитории в него включаются только данные по параметрам, указанным в этом поле.

Ниже приведен пример запроса на создание экспорта аудитории.

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Ответ метода audienceExports.create содержит название экспорта аудитории в поле name, например properties/1234567/audienceExports/123. Пример ответа:

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Вы можете использовать name, чтобы запрашивать пользователей из экспорта аудитории.

Запрос статуса готовности экспорта аудитории

После вызова audienceExports.create на создание экспорта аудитории может потребоваться несколько минут.

Проверить статус готовности экспорта аудитории можно с помощью метода audienceExports.get.

Чтобы указать экспорт аудитории в запросе, используйте название экспорта аудитории из ответа audienceExports.create.

Пример запроса:

GET https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123

Статус готовности экспорта аудитории возвращается в поле state ответа. Когда экспорт аудитории будет завершен, его статус изменится с CREATING на ACTIVE.

Пример ответа:

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Чтобы получить статус всех экспортов аудиторий, вызовите метод audienceExports.list.

Как получить пользователей из экспорта аудитории

После создания экспорта аудитории вызовите метод audienceExports.query и укажите в запросе name экспорта аудитории.

Пример запроса:

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Если экспорт аудитории готов, этот вызов возвращает список пользователей в аудитории.

Пример ответа:

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}