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
}
Поля
audienceRows[]

object ( AudienceRow )

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

audienceList

object ( AudienceList )

Конфигурационные данные для запрашиваемого списка аудитории. Возвращаются для помощи в интерпретации строк аудитории в этом ответе. Например, измерения в этом списке аудитории соответствуют столбцам в строках аудитории.

rowCount

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)
    }
  ]
}
Поля
dimensionValues[]

object ( AudienceDimensionValue )

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

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

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Поля
Один тип значения измерения. Ниже приведен список взаимоисключающих полей. В ответе будет установлено не более одного из полей:
value

string

Если тип измерения — строка, значение указывается в виде строки.

Конец взаимоисключающих областей.