Method: customLists.list

Списки пользовательских списков.

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v3/customLists

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

Позволяет фильтровать по настраиваемым полям списка.

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

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

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

  • displayName

Примеры:

  • Все настраиваемые списки, отображаемое имя которых содержит "Google": displayName:"Google" .

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

Дополнительную информацию можно найти в нашем руководстве по запросам фильтров LIST .

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

string ( int64 format)

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

Тело запроса

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

Тело ответа

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

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

object ( CustomList )

Список пользовательских списков.

Этот список будет отсутствовать, если он пуст.

nextPageToken

string

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .