REST Resource: customBiddingAlgorithms

Ресурс: CustomBiddingAlgorithm

Единый специальный алгоритм назначения ставок.

JSON-представление 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
Поля
name

string

Только вывод. Имя ресурса специального алгоритма назначения ставок.

custom Bidding Algorithm Id

string ( int64 format)

Только вывод. Уникальный идентификатор специального алгоритма назначения ставок. Назначается системой.

display Name

string

Необходимый. Отображаемое название специального алгоритма назначения ставок.

Должен быть в кодировке UTF-8 с максимальным размером 240 байт.

entity Status

enum ( EntityStatus )

Определяет, можно ли использовать специальный алгоритм назначения ставок в качестве стратегии назначения ставок.

Принятые значения:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
custom Bidding Algorithm Type

enum ( CustomBiddingAlgorithmType )

Необходимый. Неизменяемый. Тип специального алгоритма назначения ставок.

shared Advertiser Ids[]

string ( int64 format)

Идентификаторы рекламодателей, имеющих доступ к этому алгоритму. Если задан advertiserId , это поле будет состоять только из этого значения.

Это поле не будет задано, если owner алгоритма является партнером и извлекается с помощью accessor рекламодателя.

model Details[]

object ( CustomBiddingModelDetails )

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

Это поле может включать сведения о запрашиваемом рекламодателе только в том случае, если owner алгоритма является партнером и извлекается с помощью accessor рекламодателя.

owner поля Союза. Идентифицирует объект DV360, которому принадлежит специальный алгоритм назначения ставок. Это может быть как партнер, так и рекламодатель. owner может быть только один из следующих:
partner Id

string ( int64 format)

Неизменяемый. Уникальный идентификатор партнера, которому принадлежит специальный алгоритм назначения ставок.

advertiser Id

string ( int64 format)

Неизменяемый. Уникальный идентификатор рекламодателя, которому принадлежит специальный алгоритм назначения ставок.

CustomBiddingAlgorithmType

Возможные типы пользовательских алгоритмов назначения ставок.

Перечисления
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED В этой версии тип алгоритма не указан или неизвестен.
SCRIPT_BASED Алгоритм генерируется на основе файлов сценариев специального назначения ставок, загруженных клиентом.
ADS_DATA_HUB_BASED Алгоритм, созданный с помощью продукта Ads Data Hub.
GOAL_BUILDER_BASED Алгоритм создан с помощью конструктора целей в пользовательском интерфейсе DV3.
RULE_BASED

Алгоритм, основанный на определенных правилах. Эти правила определяются в API с помощью объекта AlgorithmRules .

Этот тип алгоритма доступен только клиентам из белого списка. Другие клиенты, пытающиеся использовать этот тип, получат сообщение об ошибке.

CustomBiddingModelDetails

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

JSON-представление 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Поля
advertiser Id

string ( int64 format)

Уникальный идентификатор соответствующего рекламодателя.

readiness State

enum ( ReadinessState )

Состояние готовности специальной модели назначения ставок.

suspension State

enum ( SuspensionState )

Только вывод. Состояние приостановки специальной модели назначения ставок.

Состояние готовности

Возможные состояния готовности модели.

Перечисления
READINESS_STATE_UNSPECIFIED В этой версии состояние не указано или неизвестно.
READINESS_STATE_ACTIVE Модель обучена и готова к обслуживанию.
READINESS_STATE_INSUFFICIENT_DATA Недостаточно данных для обучения модели обслуживания.
READINESS_STATE_TRAINING Модель обучается и не готова к обслуживанию.
READINESS_STATE_NO_VALID_SCRIPT Не предоставлен действительный специальный сценарий назначения ставок для обучения модели. Это состояние будет применяться только к алгоритмам, у которых customBiddingAlgorithmType имеет SCRIPT_BASED .
READINESS_STATE_EVALUATION_FAILURE Был предоставлен действительный сценарий, но оценка не прошла. Это применимо для сценариев, которые не удалось оценить за отведенное время.

Состояние приостановки

Возможные состояния приостановки моделей специальных ставок.

Перечисления
SUSPENSION_STATE_UNSPECIFIED В этой версии состояние не указано или неизвестно.
SUSPENSION_STATE_ENABLED Модель включена: она либо недавно использовалась, либо используется в настоящее время, либо запланирована к использованию. Алгоритм активно подсчитывает показы для этого рекламодателя.
SUSPENSION_STATE_DORMANT Модель в последнее время не использовалась. Хотя модель по-прежнему действует как ENABLED , в конечном итоге она будет приостановлена, если не будет использоваться.
SUSPENSION_STATE_SUSPENDED Модель отстранена от оценки показов и не может обслуживаться. Если алгоритм назначен позиции этого рекламодателя или иным образом обновлен, он снова перейдет в состояние ENABLED и потребуется время для повторной подготовки модели показа.

Методы

create

 Создает новый специальный алгоритм назначения ставок.

get

 Получает собственный алгоритм назначения ставок.

list

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

patch

 Обновляет существующий алгоритм специального назначения ставок.

upload Rules

 Создает объект ссылки на правила для файла AlgorithmRules .

upload Script

 Создает объект ссылки на сценарий специального назначения ставок для файла сценария.