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)

仅限输出。脚本所属的自定义出价算法的唯一 ID。

customBiddingScriptId

string (int64 format)

仅限输出。自定义出价脚本的唯一 ID。

createTime

string (Timestamp format)

仅限输出。脚本的创建时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 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 为 REJECTED 时,系统才会填充此字段。

script

object (CustomBiddingScriptRef)

对上传的脚本文件的引用。

自定义出价脚本的可能状态。

枚举
STATE_UNSPECIFIED 在此版本中,脚本状态未指定或未知。
ACCEPTED 脚本已被接受,可用于对展示进行评分。
REJECTED 脚本已被后端流水线拒绝。可能存在错误。
PENDING 脚本正在由后端流水线处理。

ScriptError

自定义出价脚本的错误消息。

JSON 表示法
{
  "errorCode": enum (ErrorCode),
  "line": string,
  "column": string,
  "errorMessage": string
}
字段
errorCode

enum (ErrorCode)

错误类型。

line

string (int64 format)

脚本中抛出错误的行号。

column

string (int64 format)

脚本中抛出错误的列号。

errorMessage

string

详细的错误消息。

ErrorCode

自定义出价脚本错误的可能错误代码。

枚举
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

列出属于指定算法的自定义出价脚本。