Method: googleAudiences.list

Возвращает список сегментов аудитории Google.

Порядок определяется параметром orderBy.

HTTP-запрос

GET https://displayvideo.googleapis.com/v5/googleAudiences

URL имеет синтаксис gRPC Transcoding.

Параметры запроса

Параметры
pageSize

integer

Запрошенный размер страницы. Значение должно быть в диапазоне от 1 до 200. Если не указано, по умолчанию будет использоваться 100. Если указано недопустимое значение, возвращается код ошибки INVALID_ARGUMENT.
pageToken

string

Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken, возвращенное предыдущим вызовом метода googleAudiences.list. Если значение не указано, будет возвращена первая страница результатов.
orderBy

string

Поле, по которому нужно отсортировать список. Допустимые значения:

  • googleAudienceId (по умолчанию)
  • displayName

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс desc. Пример: displayName desc.
filter

string

Позволяет фильтровать по полям сегмента аудитории Google.

Поддерживаемый синтаксис:

  • Выражения фильтров для сегментов аудитории Google могут содержать не более одного ограничения.
  • Ограничение имеет следующий формат: {field} {operator} {value}.
  • Во всех полях должен использоваться оператор HAS (:).

Поддерживаемые поля:

  • displayName

Примеры:

  • Все сегменты аудитории Google, в отображаемом названии которых есть слово "Google": displayName:"Google".

Длина этого поля не должна превышать 500 символов.

Подробную информацию вы найдете в руководстве по фильтрации запросов LIST.
Обязательно. Идентификатор объекта DV360, в рамках которого выполняется запрос. Запрос LIST возвращает только те сегменты аудитории Google, которые доступны объекту DV360, указанному в accessor. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
partnerId

string (int64 format)

Идентификатор партнера, у которого есть доступ к полученным сегментам аудитории Google.
advertiserId

string (int64 format)

Идентификатор рекламодателя, у которого есть доступ к полученным сегментам аудитории Google.
Конец взаимоисключающих полей.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление 
{
  "googleAudiences": [
    {
      object (GoogleAudience)
    }
  ],
  "nextPageToken": string
}
Поля
googleAudiences[]

object (GoogleAudience)

Список сегментов аудитории Google.

Если список пуст, он не будет показан.
nextPageToken

string

Токен для загрузки следующей страницы результатов. Передайте это значение в поле pageToken в последующем вызове метода googleAudiences.list, чтобы получить следующую страницу результатов.

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

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/display-video

Дополнительную информацию вы найдете в OAuth 2.0 Overview.