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 )

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

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

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

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

ThirdPartyOptimizationPartnerType

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

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

Методы

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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