REST Resource: guaranteedOrders

Ressource: GuaranteedOrder

Eine garantierte Bestellung.

Garantierte Aufträge sind die übergeordnete Einheit von garantierten Inventarquellen. Beim Erstellen einer garantierten Inventarquelle muss der Inventarquelle eine garantierte Auftrags-ID zugewiesen werden.

JSON-Darstellung 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname des garantierten Auftrags.
legacyGuaranteedOrderId

string

Nur Ausgabe. Die alte ID des garantierten Auftrags. Von der ursprünglichen Börse zugewiesen. Die Legacy-ID ist innerhalb einer Börse eindeutig, aber nicht unbedingt für alle garantierten Aufträge. Diese ID wird im SDF und in der Benutzeroberfläche verwendet.
exchange

enum (Exchange)

Erforderlich. Nicht veränderbar. Die Börse, von der die garantierte Bestellung stammt.
guaranteedOrderId

string

Nur Ausgabe. Die eindeutige ID des garantierten Auftrags. Die garantierten Bestell-IDs haben das Format {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Erforderlich. Der Anzeigename der garantierten Bestellung.

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

object (GuaranteedOrderStatus)

Die Statuseinstellungen des garantierten Auftrags.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die garantierte Bestellung zuletzt aktualisiert wurde. Vom System zugewiesen.

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

string

Erforderlich. Der Publisher-Name des garantierten Auftrags.

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

boolean

Gibt an, ob alle Werbetreibenden von readWritePartnerId Lesezugriff auf die garantierte Bestellung haben. Gilt nur, wenn readWritePartnerId festgelegt ist. Wenn „True“ festgelegt ist, wird readAdvertiserIds überschrieben.
readAdvertiserIds[]

string (int64 format)

Die IDs der Werbetreibenden mit Lesezugriff auf den garantierten Auftrag.

Dieses Feld darf nicht den Werbetreibenden enthalten, der readWriteAdvertiserId zugewiesen ist, sofern es festgelegt ist. Alle Werbetreibenden in diesem Feld müssen zu readWritePartnerId oder zum selben Partner wie readWriteAdvertiserId gehören.
defaultAdvertiserId

string (int64 format)

Nur Ausgabe. Die ID des Standardwerbetreibenden des garantierten Auftrags.

Der Standardwerbetreibende ist entweder readWriteAdvertiserId oder, falls das nicht festgelegt ist, der erste Werbetreibende in readAdvertiserIds. Andernfalls gibt es keinen Standardwerbetreibenden.
defaultCampaignId

string (int64 format)

Die ID der Standardkampagne, die dem garantierten Auftrag zugewiesen ist.

Die Standardkampagne muss zum Standardwerbetreibenden gehören.

Erforderlich.

Der Partner oder Werbetreibende mit Lese-/Schreibzugriff auf den garantierten Auftrag. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
readWritePartnerId

string (int64 format)

Der Partner mit Lese-/Schreibzugriff auf den garantierten Auftrag.
readWriteAdvertiserId

string (int64 format)

Der Werbetreibende mit Lese-/Schreibzugriff auf den garantierten Auftrag. Das ist auch der Standardwerbetreibende des garantierten Auftrags.
Ende der sich gegenseitig ausschließenden Felder.

GuaranteedOrderStatus

Die Statuseinstellungen des garantierten Auftrags.

JSON-Darstellung 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Felder
entityStatus

enum (EntityStatus)

Gibt an, ob die garantierte Bestellung ausgeliefert werden kann.

Zulässige Werte sind ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED und ENTITY_STATUS_PAUSED. Der Standardwert ist ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Der vom Nutzer angegebene Grund für das Pausieren dieser garantierten Bestellung.

Muss UTF-8-codiert sein und darf maximal 100 Byte lang sein.

Gilt nur, wenn entityStatus auf ENTITY_STATUS_PAUSED festgelegt ist.
configStatus

enum (GuaranteedOrderConfigStatus)

Nur Ausgabe. Der Konfigurationsstatus der garantierten Bestellung.

Zulässige Werte sind PENDING und COMPLETED.

Ein garantierter Auftrag muss konfiguriert werden (Pflichtfelder ausfüllen, Creatives auswählen und eine Standardkampagne auswählen), bevor er ausgeliefert werden kann. Derzeit kann die Konfigurationsaktion nur über die Benutzeroberfläche ausgeführt werden.

GuaranteedOrderConfigStatus

Mögliche Konfigurationsstatus für eine Bestellung mit Garantie.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Der Freigabestatus ist in dieser Version nicht angegeben oder unbekannt.
PENDING Der Anfangsstatus einer garantierten Bestellung. Die garantierte Reihenfolge muss in diesem Status konfiguriert werden, bevor sie ausgeliefert werden kann.
COMPLETED Der Status, nachdem der Käufer eine Bestellung mit Garantie konfiguriert hat.

Methoden

create

 Erstellt einen neuen garantierten Auftrag.

editGuaranteedOrderReadAccessors

 Bearbeitungen von Werbetreibenden einer garantierten Bestellung lesen.

get

 Er erhält eine garantierte Bestellung.

list

 Listet garantierte Aufträge auf, auf die der aktuelle Nutzer Zugriff hat.

patch

 Aktualisiert eine vorhandene Bestellung mit Garantie.