REST Resource: orders.lines

Ressource: Zeile

Eine einzelne Bestellzeile, die ein konfiguriertes Produkt repräsentiert.

JSON-Darstellung 
{
  "name": string,
  "product": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "lineState": enum (LineState),
  "rejection": {
    object (Rejection)
  },
  "startTime": string,
  "endTime": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "lineTerms": {
    object (LineTerms)
  },
  "pendingReservationExpirationTime": string,
  "reservationExpirationTime": string,
  "targeting": {
    object (Targeting)
  },
  "createTime": string,
  "updateTime": string
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Zeile im Format orders/{order_id}/lines/{id}.
product

string

Nur Ausgabe. Der Name des Product, den diese Zeile konfiguriert. Format = Produkte/123
externalId

string

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

string

Nur Ausgabe. Der Anzeigename der Zeile.
description

string

Nur Ausgabe. Zusätzliches Freiform-Feld zur Beschreibung der Linie.
lineState

enum (LineState)

Nur Ausgabe. Der Status der Linie. Informationen zum Lebenszyklus einer Linie findest du unter LineState.

Der Verkäufer kann die benutzerdefinierten Methoden Reserve, Book und Reject verwenden, um eine der folgenden Optionen festzulegen:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

Alle anderen Zeilenstatus werden vom Käufer festgelegt.
rejection

object (Rejection)

Optional. Ablehnungsdetails für die Leitung.
startTime
(deprecated)

string (Timestamp format)

Nur Ausgabe. Wann die Werbebuchung ausgeliefert wird (einschließlich)

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".
endTime
(deprecated)

string (Timestamp format)

Nur Ausgabe. Wann die Werbebuchung nicht mehr ausgeliefert wird (exklusiv)

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

object (Date)

Nur Ausgabe. Das Datum, ab dem die Werbebuchung ausgeliefert wird (einschließlich) Dieselbe Zeitzone wie der Anzeigenblock.
endDate

object (Date)

Nur Ausgabe. Das Datum, ab dem die Werbebuchung nicht mehr ausgeliefert wird (einschließlich) Dieselbe Zeitzone wie der Anzeigenblock.
budget

object (Money)

Nur Ausgabe. Das Budget der Linie.
lineTerms

object (LineTerms)

Nur Ausgabe. Die garantierten Bedingungen des Verkäufers für diese Position.
pendingReservationExpirationTime

string (Timestamp format)

Nur Ausgabe. Ablaufzeitstempel für die ausstehende Reservierung. Der Verkäufer muss reservieren oder ablehnen, bevor eine ausstehende Reservierung abläuft. Andernfalls wird sie als abgelehnt behandelt.

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

string (Timestamp format)

Nur Ausgabe. Ablaufzeitstempel für die Reservierung. Der Käufer muss buchen, bevor eine Reservierung abläuft. Andernfalls wird sie als storniert behandelt.

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

object (Targeting)

Nur Ausgabe. Das Targeting für die Linie.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der Zeile.

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 für Zeile.

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

LineState

Status einer Linie.

Enums
LINE_STATE_UNSPECIFIED Der Standardwert, wenn der Zeilenstatus nicht angegeben wurde oder in dieser Version unbekannt ist.
LINE_STATE_PENDING_RESERVATION Die Zeile wurde vom Käufer erstellt und verlangt, dass die Produkte reserviert und mit Preis- und Verfügbarkeitsinformationen aktualisiert werden.
LINE_STATE_RESERVED Die Position wurde vom Verkäufer reserviert. Dieser Status ist nur möglich, wenn der vorherige Status „Reservierung ausstehend“ lautet.
LINE_STATE_PENDING_BOOKING Der Käufer hat die Reservierung angenommen und fordert die Buchung der Werbebuchung an.
LINE_STATE_BOOKED Der Verkäufer hat die Position gebucht. Dieser Status ist nur möglich, wenn der vorherige Status „Buchung ausstehend“ lautet. In dieser Phase sind keine Ablehnungen zu erwarten.
LINE_STATE_REJECTED_BY_SELLER Die Position wurde vom Verkäufer abgelehnt. Dieser Status ist nur möglich, wenn der vorherige Status „Reservierung ausstehend“ lautet.
LINE_STATE_CANCELLED_BY_BUYER Die Werbebuchung wurde vom Käufer abgebrochen.
LINE_STATE_PENDING_RESERVATION_EXPIRED Die Zeile ist abgelaufen, da eine Reservierung aussteht.
LINE_STATE_RESERVED_EXPIRED Die Zeile ist abgelaufen, da sie reserviert wurde. Es wird auf die Antwort des Käufers gewartet.

Methoden

book

 Bucht eine bestehende Leitung.

get

 Ruft eine einzelne Zeile für einen Auftrag ab.

list

 Listet die Zeilen für einen Auftrag auf.

patch

 Aktualisiert eine vorhandene Linie.

reject

 Lehnt eine vorhandene Leitung ab.

reserve

 Reserviert eine vorhandene Linie.