Method: customBiddingAlgorithms.list

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

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

HTTP-запрос

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

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

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

Параметры
pageSize

integer

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

string

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

string

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

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

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

string

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

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

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

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

  • customBiddingAlgorithmType
  • displayName

Примеры:

  • Все алгоритмы специальных ставок, в отображаемом названии которых есть слово "politics": displayName:"politics".
  • Все алгоритмы специальных ставок типа SCRIPT_BASED: customBiddingAlgorithmType=SCRIPT_BASED

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

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

string (int64 format)

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

string (int64 format)

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

Тело запроса

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

Тело ответа

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

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

object (CustomBiddingAlgorithm)

Список алгоритмов специальных ставок.

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

string

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

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

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

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

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