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

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

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 рекламодателю.

owner поля Union. Определяет сущность DV360, которой принадлежит алгоритм назначения ставок. Это может быть как партнёр, так и рекламодатель. owner может быть только одним из следующих:
partnerId

string ( int64 format)

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

advertiserId

string ( int64 format)

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

CustomBiddingAlgorithmType

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

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

УСТАРЕВШЕЕ: ADS_DATA_HUB_BASED устарел. Алгоритм создан на основе продукта Ads Data Hub.

GOAL_BUILDER_BASED

УСТАРЕВШЕЕ: GOAL_BUILDER_BASED устарел, больше не поддерживается и заменён на RULE_BASED. Алгоритм создан с помощью конструктора целей в пользовательском интерфейсе DV3.

Существующие алгоритмы этого типа были перенесены в RULE_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 Был предоставлен корректный сценарий, но он не прошёл оценку. Это правило применяется к сценариям, которые не удалось оценить за отведённое время.

SuspensionState

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

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

Методы

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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