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

Аудитории в 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
}