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)

僅供輸出。指令碼的建立時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

active

boolean

僅供輸出。是否正在使用指令碼進行父項演算法的評分。

state

enum (State)

僅供輸出。自訂出價指令碼的狀態。

errors[]

object (ScriptError)

僅供輸出。遭拒自訂出價指令碼的錯誤詳細資料。只有在 [Script.state][] 設為拒絕時,系統才會填入這個欄位。

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

列出屬於指定演算法的自訂出價指令碼。