REST Resource: customBiddingAlgorithms.scripts

リソース: CustomBidScript

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)

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

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