REST Resource: customBiddingAlgorithms.scripts

Ressource: CustomBiddingScript

Ein einzelnes Skript für die benutzerdefinierte Gebotseinstellung.

JSON-Darstellung
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "customBiddingScriptId": string,
  "createTime": string,
  "active": boolean,
  "state": enum (State),
  "errors": [
    {
      object (ScriptError)
    }
  ],
  "script": {
    object (CustomBiddingScriptRef)
  }
}
Felder
name

string

Nur Ausgabe Der Ressourcenname des Skripts für die benutzerdefinierte Gebotseinstellung.

customBiddingAlgorithmId

string (int64 format)

Nur Ausgabe Die eindeutige ID des Algorithmus für die benutzerdefinierte Gebotseinstellung, zu dem das Skript gehört.

customBiddingScriptId

string (int64 format)

Nur Ausgabe Die eindeutige ID des Skripts für die benutzerdefinierte Gebotseinstellung.

createTime

string (Timestamp format)

Nur Ausgabe Der Zeitpunkt, zu dem das Skript erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

active

boolean

Nur Ausgabe Gibt an, ob das Skript derzeit für die Bewertung durch den übergeordneten Algorithmus verwendet wird.

state

enum (State)

Nur Ausgabe Der Status des Skripts für die benutzerdefinierte Gebotseinstellung.

errors[]

object (ScriptError)

Nur Ausgabe Fehlerdetails eines abgelehnten Skripts für die benutzerdefinierte Gebotseinstellung. Dieses Feld wird nur gefüllt, wenn [Script.state][] ABGELEHNT ist.

script

object (CustomBiddingScriptRef)

Der Verweis auf die hochgeladene Skriptdatei.

Status

Mögliche Statuswerte eines Scripts für die benutzerdefinierte Gebotseinstellung.

Enums
STATE_UNSPECIFIED Der Skriptstatus ist in dieser Version nicht angegeben oder unbekannt.
ACCEPTED Das Skript wurde für das Bewerten von Impressionen akzeptiert.
REJECTED Das Skript wurde von Back-End-Pipelines abgelehnt. Sie enthält möglicherweise Fehler.
PENDING Das Skript wird für Back-End-Pipelines verarbeitet.

ScriptError

Eine Fehlermeldung für ein Script für die benutzerdefinierte Gebotseinstellung.

JSON-Darstellung
{
  "errorCode": enum (ErrorCode),
  "line": string,
  "column": string,
  "errorMessage": string
}
Felder
errorCode

enum (ErrorCode)

Die Art des Fehlers.

line

string (int64 format)

Nummer der Zeile im Skript, in der der Fehler ausgegeben wurde

column

string (int64 format)

Spaltennummer im Skript, in der der Fehler ausgegeben wurde

errorMessage

string

Detaillierte Fehlermeldung

ErrorCode

Mögliche Fehlercodes eines Scriptfehlers für die benutzerdefinierte Gebotseinstellung.

Enums
ERROR_CODE_UNSPECIFIED Der Skriptfehler wurde nicht angegeben oder ist in dieser Version unbekannt.
SYNTAX_ERROR Das Skript weist einen Syntaxfehler auf.
DEPRECATED_SYNTAX Das Skript verwendet eine veraltete Syntax.
INTERNAL_ERROR Beim Verarbeiten des Skripts sind interne Fehler aufgetreten.

CustomBiddingScriptRef

Verweis auf die hochgeladene Skriptdatei für die benutzerdefinierte Gebotseinstellung

JSON-Darstellung
{
  "resourceName": string
}
Felder
resourceName

string

Ein Ressourcenname, der in media.download zum Herunterladen der Skriptdateien verwendet werden soll. Oder media.upload, um die Skriptdateien hochzuladen. Ressourcennamen haben das Format customBiddingAlgorithms/{customBiddingAlgorithmId}/scriptRef/{ref_id}.

Methoden

create

Erstellt ein neues Script für die benutzerdefinierte Gebotseinstellung.

get

Ruft ein Skript für die benutzerdefinierte Gebotseinstellung ab.

list

Listet Skripts für die benutzerdefinierte Gebotseinstellung auf, die zum jeweiligen Algorithmus gehören.