REST Resource: orders

Ressource: Bestellung

Ein Auftrag ist eine Sammlung von Lines, die festlegen, wann und wo Anzeigen ausgeliefert werden.

JSON-Darstellung 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Bestellung im Format: orders/{id}.
externalId

string

Optional. Eine ID, mit der diese Entität externen Quellen zugeordnet wird.
displayName

string

Nur Ausgabe. Der Anzeigename des Auftrags.

Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein.
description

string

Nur Ausgabe. Zusätzliches Feld in freiem Format zur Beschreibung der Bestellung.
orderState

enum (OrderState)

Nur Ausgabe. Stellt den berechneten Status der Bestellung basierend auf dem Status der Linien dar.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung des Auftrags.

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".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung der Bestellung.

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".
advertiserInfo

object (AdvertiserInfo)

Nur Ausgabe. Informationen zum Werbetreibenden.

OrderState

Der Status der Bestellung.

Enums
ORDER_STATE_UNSPECIFIED Der Standardwert, wenn der Bestellstatus nicht angegeben wurde oder in dieser Version unbekannt ist.
ORDER_STATE_PENDING_RESERVATION

Die Bestellung enthält Folgendes:

  • eine oder mehrere Zeilen mit ausstehender Reservierung.
  • Null oder mehr Zeilen im Status „Reserviert“.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_RESERVED

Die Bestellung enthält Folgendes:

  • Nullzeilen im Status „Ausstehend“.
  • eine oder mehrere Zeilen im Status „Reserviert“.
  • Null oder mehr Zeilen im Status „Abgelehnt“ durch Verkäufer.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_PENDING_BOOKING

Die Bestellung enthält Folgendes:

  • Nullzeilen im Status „Ausstehend“.
  • Nullzeilen im Status „Reserviert“.
  • Mindestens eine Zeile mit dem Status „Buchung ausstehend“
  • Null oder mehr Zeilen im Status „Abgelehnt“ durch Verkäufer.
  • null oder mehr Zeilen vom Käufer storniert.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_BOOKED

Die Bestellung enthält Folgendes:

  • Nullzeilen im Status „Ausstehend“.
  • Nullzeilen im Status „Reserviert“.
  • Keine Zeilen im Buchungsstatus „Ausstehend“.
  • eine oder mehrere Zeilen im Status „Gebucht“.
  • Null oder mehr Zeilen im Status „Abgelehnt“ durch Verkäufer.
  • null oder mehr Zeilen vom Käufer storniert.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_REJECTED_BY_SELLER

Die Bestellung enthält Folgendes:

  • Nullzeilen im Status „Ausstehend“.
  • Nullzeilen im Status „Reserviert“.
  • Keine Zeilen im Buchungsstatus „Ausstehend“.
  • keine Zeilen im gebuchten Status.
  • mindestens eine Zeile im Status „Abgelehnt“.
  • Nullzeilen vom Käufer storniert.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_CANCELLED_BY_BUYER

Die Bestellung enthält Folgendes:

  • Nullzeilen im Status „Ausstehend“.
  • Nullzeilen im Status „Reserviert“.
  • Keine Zeilen im Buchungsstatus „Ausstehend“.
  • keine Zeilen im gebuchten Status.
  • Nullzeilen im Status „Abgelehnt“ des Verkäufers.
  • Mindestens eine Zeile wurde vom Käufer storniert.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

Die Bestellung enthält Folgendes:

  • Mindestens eine Zeile in der ausstehenden Reservierung ist abgelaufen.
  • Nulllinien in allen anderen Bundesstaaten.
ORDER_STATE_RESERVED_EXPIRED

Die Bestellung enthält Folgendes:

  • eine oder mehrere Zeilen in reservierten abgelaufen sind.
  • Nulllinien in allen anderen Bundesstaaten.

Methoden

get

 Ruft eine einzelne Bestellung ab.

list

 Listet Bestellungen auf.

patch

 Aktualisiert eine vorhandene Bestellung.