Method: properties.audienceLists.query

Получает список аудитории пользователей. После создания аудитории пользователи не сразу доступны для листинга. Во-первых, запрос audienceLists.create необходим для создания списка аудитории пользователей, а затем, во-вторых, этот метод используется для получения пользователей в списке аудитории.

См. Создание списка аудитории для ознакомления со списками аудитории с примерами.

Аудитории в Google Analytics 4 позволяют сегментировать пользователей по критериям, важным для вашего бизнеса. Дополнительную информацию см. на странице https://support.google.com/analytics/answer/9267572 .

Этот метод доступен на стадии бета-тестирования на сайте AudienceExports.query . Чтобы оставить отзыв об этом API, заполните форму отзыва об API экспорта аудитории Google Analytics .

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Необходимый. Имя списка аудитории, из которого извлекаются пользователи. Формат: properties/{property}/audienceLists/{audienceList}

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "offset": string,
  "limit": string
}
Поля
offset

string ( int64 format)

Необязательный. Количество строк в начальной строке. Первая строка считается строкой 0.

При пейджинге первый запрос не указывает смещение; или, что то же самое, устанавливает смещение в 0; первый запрос возвращает первый limit строк. Второй запрос устанавливает смещение, равное limit первого запроса; второй запрос возвращает второй limit строк.

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

limit

string ( int64 format)

Необязательный. Количество возвращаемых строк. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit .

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

Тело ответа

Список пользователей в списке аудитории.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Поля
audience Rows[]

object ( AudienceRow )

Строки для каждого пользователя в списке аудитории. Количество строк в этом ответе будет меньше или равно размеру страницы запроса.

audience List

object ( AudienceList )

Данные конфигурации запрашиваемого списка AudienceList. Вернулся, чтобы помочь интерпретировать строки аудитории в этом ответе. Например, размеры в этом AudienceList соответствуют столбцам в AudienceRows.

row Count

integer

Общее количество строк в результате AudienceList. rowCount не зависит от количества строк, возвращаемых в ответе, параметра запроса limit и параметра запроса offset . Например, если запрос возвращает 175 строк и включает limit в 50 в запросе API, ответ будет содержать rowCount равный 175, но только 50 строк.

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

Атрибуты значений измерения для строки пользователя аудитории.

JSON-представление 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Поля
dimension Values[]

object ( AudienceDimensionValue )

Каждый атрибут значения измерения для пользователя аудитории. Одно значение измерения будет добавлено для каждого запрошенного столбца измерения.

АудиторияИзмерениеЗначение

Значение измерения.

JSON-представление 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Поля
Поле объединения one_value . Один из видов размерных значений. one_value can be only one of the following:
value

string

Значение в виде строки, если тип измерения является строкой.