Method: customBiddingAlgorithms.list

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

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v3/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 для получения следующей страницы результатов. Если это поле равно NULL, это означает, что это последняя страница.

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

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

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

Для получения более подробной информации см.OAuth 2.0 Overview .