REST Resource: customBiddingAlgorithms.scripts

リソース: CustomBiddingScript

1 つのカスタム入札スクリプト。

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 正規化され、小数点以下は 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

 指定したアルゴリズムに属するカスタム入札スクリプトを一覧表示します。