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 Overview .