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

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

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

Refer to the Audience export data expectations guide for important information about the data you see in audience exports.

Обзор

Make the following Data API requests to create and query an audience export:

1. Call the audienceExports.create method to create an audience export.
2. Call the audienceExports.query method is used to retrieve the users in the audience.

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

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

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

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

The report is generated based on the Google Analytics event data collected in the specified Google Analytics property.

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

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

To create an audience export, call the audienceExports.create method using the AudienceExport object in your request. The following parameters are required:

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

Here's a sample request to create an audience export:

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

A response of the audienceExports.create method contains the audience export's name in the name field, for example properties/1234567/audienceExports/123 . Here's a sample response:

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

You can use the name to query the users from the audience export.

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

It might take several minutes to generate the audience export after the audienceExports.create call.

You can check the readiness state of an audience export by calling the audienceExports.get method.

Use the audience export name from an audienceExports.create response to specify the audience export in your request.

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

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

The readiness state for an audience export is returned in the state field of the response. Once the audience export generation is complete, its state changes from CREATING to 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"
}

You can obtain the state of all audience exports by calling the audienceExports.list method.

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

Once the audience export is generated, call the audienceExports.query method, and specify the audience export's name in the request.

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

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

If the audience export is ready, this call returns the list of users in the audience.

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

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