REST Resource: customBiddingAlgorithms

Ресурс: CustomBiddingAlgorithm

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
Поля
name

string

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

string (int64 format)

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

string

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

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

enum (EntityStatus)

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

Допустимые значения:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Обязательно. Не меняется. Тип алгоритма специальных ставок.
sharedAdvertiserIds[]

string (int64 format)

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

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

object (CustomBiddingModelDetails)

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

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

enum (ThirdPartyOptimizationPartnerType)

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

string (int64 format)

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

string (int64 format)

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

CustomBiddingAlgorithmType

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

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

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

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

CustomBiddingModelDetails

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

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

string (int64 format)

Уникальный идентификатор рекламодателя.
readinessState

enum (ReadinessState)

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

enum (SuspensionState)

Только для вывода. Статус блокировки модели специальных ставок.

ReadinessState

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

Перечисления
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 Предоставлен действительный скрипт, но не удалось выполнить его оценку. Это относится к скриптам, которые не удалось оценить за отведенное время.

SuspensionState

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

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

ThirdPartyOptimizationPartnerType

Возможные типы сторонних партнеров по оптимизации.

Перечисления
UNKNOWN Значение типа не указано или неизвестно в этой версии.
SCIBIDS Сторонний поставщик услуг по науке о данных, с которым могут сотрудничать партнеры и рекламодатели DV3.
ADELAIDE Сторонний поставщик услуг по оценке внимания, с которым могут сотрудничать партнеры и рекламодатели DV3.

Методы

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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