Method: customLists.list

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

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v4/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 .

Обязательно. Указывает, в какой сущности DV360 выполняется запрос. Запрос LIST вернет только пользовательские списки сущностей, доступные для сущности DV360, указанной в 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 .