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

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

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

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

Обзор

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

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

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

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

Для всех методов 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 . Список параметров, поддерживаемых этим методом, можно найти в документации схемы экспорта аудитории . В экспорт аудитории включаются только данные по параметрам, упомянутым в этом поле.

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

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
}