REST Resource: customBiddingAlgorithms.scripts

Ресурс: CustomBiddingScript

Единый скрипт для индивидуальных торгов.

JSON-представление
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "customBiddingScriptId": string,
  "createTime": string,
  "active": boolean,
  "state": enum (State),
  "errors": [
    {
      object (ScriptError)
    }
  ],
  "script": {
    object (CustomBiddingScriptRef)
  }
}
Поля
name

string

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

customBiddingAlgorithmId

string ( int64 format)

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

customBiddingScriptId

string ( int64 format)

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

createTime

string ( Timestamp format)

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

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

active

boolean

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

state

enum ( State )

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

errors[]

object ( ScriptError )

Только вывод. Информация об ошибке отклоненного скрипта назначения ставок. Это поле заполняется только в state ОТКЛОНЕНО.

script

object ( CustomBiddingScriptRef )

Ссылка на загруженный файл сценария.

Состояние

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

Перечисления
STATE_UNSPECIFIED Состояние скрипта в этой версии не указано или неизвестно.
ACCEPTED Сценарий принят к оценке показов.
REJECTED Скрипт отклонен внутренними конвейерами. В нём могут быть ошибки.
PENDING Скрипт обрабатывается для внутренних конвейеров.

ОшибкаСкрипта

Сообщение об ошибке для пользовательского скрипта торгов.

JSON-представление
{
  "errorCode": enum (ErrorCode),
  "line": string,
  "column": string,
  "errorMessage": string
}
Поля
errorCode

enum ( ErrorCode )

Тип ошибки.

line

string ( int64 format)

Номер строки в скрипте, где возникла ошибка.

column

string ( int64 format)

Номер столбца в скрипте, где возникла ошибка.

errorMessage

string

Подробное сообщение об ошибке.

Код ошибки

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

Перечисления
ERROR_CODE_UNSPECIFIED Ошибка скрипта не указана или неизвестна в этой версии.
SYNTAX_ERROR В скрипте обнаружена синтаксическая ошибка.
DEPRECATED_SYNTAX Скрипт использует устаревший синтаксис.
INTERNAL_ERROR При обработке скрипта возникли внутренние ошибки.

CustomBiddingScriptRef

Ссылка на загруженный файл скрипта пользовательских торгов.

JSON-представление
{
  "resourceName": string
}
Поля
resourceName

string

Имя ресурса, которое будет использоваться в media.download для загрузки файлов скрипта. Или media.upload для загрузки файлов скрипта. Имена ресурсов имеют формат customBiddingAlgorithms/{customBiddingAlgorithmId}/scriptRef/{ref_id} .

Методы

create

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

get

Получает пользовательский сценарий торгов.

list

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