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)

出力のみ。スクリプトが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
active

boolean

出力のみ。親アルゴリズムによるスコアリングにスクリプトが現在使用されているかどうか。
state

enum (State)

出力のみ。カスタム入札スクリプトのステータス。
errors[]

object (ScriptError)

出力のみ。拒否されたカスタム入札スクリプトのエラーの詳細。このフィールドは、[Script.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} です。

Methods

create

 新しいカスタム入札スクリプトを作成します。

get

 カスタム入札スクリプトを取得します。

list

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