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

customBiddingAlgorithmId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des benutzerdefinierten Gebotsalgorithmus, zu dem das Script gehört.

customBiddingScriptId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des benutzerdefinierten Gebotsscripts.

createTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der 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 die benutzerdefinierte Gebotseinstellung.

errors[]

object (ScriptError)

Nur Ausgabe. Fehlerdetails eines abgelehnten benutzerdefinierten Gebotseinstellungsskripts. Dieses Feld wird nur ausgefüllt, wenn state REJECTED ist.

script

object (CustomBiddingScriptRef)

Der Verweis auf die hochgeladene Skriptdatei.

Status

Mögliche Status 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 die Bewertung von Impressionen akzeptiert.
REJECTED Das Skript wurde von Back-End-Pipelines abgelehnt. Es kann Fehler enthalten.
PENDING Das Skript 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)

Die Art des Fehlers.

line

string (int64 format)

Die Zeilennummer im Skript, in der der Fehler aufgetreten ist.

column

string (int64 format)

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

errorMessage

string

Die detaillierte Fehlermeldung.

ErrorCode

Mögliche Fehlercodes für Fehler in benutzerdefinierten Gebotsscripts.

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 Script verwendet nicht mehr unterstützte Syntax.
INTERNAL_ERROR Bei der Verarbeitung des Skripts sind interne Fehler aufgetreten.

CustomBiddingScriptRef

Die Referenz zur hochgeladenen Datei mit dem benutzerdefinierten Script für die Gebotseinstellung.

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

string

Ein Ressourcenname, der in media.download zum Herunterladen der Skriptdateien verwendet werden soll. Oder klicken Sie auf media.upload, um die Scriptdateien 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 die benutzerdefinierte Gebotseinstellung ab.

list

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