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

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