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

В Google Analytics аудитории позволяют сегментировать пользователей в соответствии с их потребностями, важными для вашего бизнеса. С помощью аудиторий вы можете группировать пользователей вашего сайта или приложения на основе общих характеристик.

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

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

Обзор

Выполните следующие запросы к Data API для создания и запроса экспорта данных об аудитории:

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

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

Выберите отчитывающуюся организацию

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

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

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

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

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

Для создания экспорта аудитории вызовите метод audienceExports.create , используя объект AudienceExport в вашем запросе. Необходимы следующие параметры:

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

Вот пример запроса на экспорт данных об аудитории:

HTTP-запрос 

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

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

HTTP-ответ 

{
  "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 , чтобы указать экспорт аудитории в вашем запросе.

Вот пример запроса:

HTTP-запрос 

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

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

Вот пример ответа:

HTTP-ответ 

{
  "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 файла экспорта аудитории в запросе.

Вот пример запроса:

HTTP-запрос 

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

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

Вот пример ответа:

HTTP-ответ 

{
  "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
}