Method: customBiddingAlgorithms.list

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

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

HTTP-запрос

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

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

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

Параметры
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 .

accessor к параметру объединения. Необходимый. Определяет, в рамках какого объекта DV360 делается запрос. Запрос LIST вернет только те объекты алгоритма специального назначения ставок, которые доступны объекту DV360, указанному в accessor . Чтобы выполнить запрос LIST, пользователю необходимо иметь разрешение на доступ к объекту accessor . 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 .