REST Resource: customBiddingAlgorithms.scripts

Ressource: CustomBiddingScript

Ein einzelnes Script 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 Scripts 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 Scripts für die benutzerdefinierte Gebotseinstellung.

createTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der das Script erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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 Script derzeit vom übergeordneten Algorithmus für die Bewertung verwendet wird.

state

enum (State)

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

errors[]

object (ScriptError)

Nur Ausgabe. Fehlerdetails eines abgelehnten Scripts für die benutzerdefinierte Gebotseinstellung. Dieses Feld wird nur ausgefüllt, wenn state den Wert REJECTED hat.

script

object (CustomBiddingScriptRef)

Der Verweis auf die hochgeladene Scriptdatei.

Status

Mögliche Status eines Scripts für die benutzerdefinierte Gebotseinstellung

Enums
STATE_UNSPECIFIED Der Script-Status 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 Script 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)

Die Zeilennummer im Script, an der der Fehler aufgetreten ist.

column

string (int64 format)

Die Spaltennummer im Script, in der der Fehler aufgetreten ist.

errorMessage

string

Die detaillierte Fehlermeldung.

ErrorCode

Mögliche Fehlercodes für einen Fehler im Script für benutzerdefinierte Gebotseinstellungen.

Enums
ERROR_CODE_UNSPECIFIED Der Skriptfehler ist in dieser Version nicht angegeben oder unbekannt.
SYNTAX_ERROR Das Skript enthält einen Syntaxfehler.
DEPRECATED_SYNTAX Das Skript verwendet eine veraltete Syntax.
INTERNAL_ERROR Bei der Verarbeitung des Skripts sind interne Fehler aufgetreten.

CustomBiddingScriptRef

Der Verweis auf die hochgeladene Scriptdatei für die benutzerdefinierte Gebotseinstellung.

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

string

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

Methoden

create

Ein neues Script für die benutzerdefinierte Gebotseinstellung wird erstellt.

get

Hier wird ein Script für die benutzerdefinierte Gebotseinstellung abgerufen.

list

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