REST Resource: customBiddingAlgorithms.scripts

Ressource: CustomBiddingScript

Ein einzelnes Script für benutzerdefinierte Gebote.

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 benutzerdefinierten Gebotsskripts.

customBiddingAlgorithmId

string (int64 format)

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

customBiddingScriptId

string (int64 format)

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

createTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

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 Scripts für benutzerdefinierte Gebote.

errors[]

object (ScriptError)

Nur Ausgabe. Fehlerdetails eines abgelehnten Skripts 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 Skriptdatei.

Bundesland

Mögliche Status eines Scripts für benutzerdefinierte Gebote.

Enums
STATE_UNSPECIFIED Der Skriptstatus ist in dieser Version nicht angegeben oder unbekannt.
ACCEPTED Das Script wurde für die Bewertung von Impressionen akzeptiert.
REJECTED Das Skript wurde von Backend-Pipelines abgelehnt. Es kann Fehler enthalten.
PENDING Das Script wird für Backend-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)

Der Fehlertyp.

line

string (int64 format)

Die Zeilennummer im Script, in 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 Gebote.

Enums
ERROR_CODE_UNSPECIFIED Der Skriptfehler ist nicht angegeben oder in dieser Version unbekannt.
SYNTAX_ERROR Das Script enthält einen Syntaxfehler.
DEPRECATED_SYNTAX Das Script verwendet nicht mehr unterstützte Syntax.
INTERNAL_ERROR Beim Verarbeiten des Scripts 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 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 benutzerdefinierte Gebote.

get

Ruft ein Script für benutzerdefinierte Gebote ab.

list

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