REST Resource: guaranteedOrders

Ressource: GuaranteedOrder

Eine garantierte Bestellung.

Garantierte Aufträge sind die übergeordnete Entität von garantierten Inventarquellen. Wenn Sie eine garantierte Inventarquelle erstellen, muss der Inventarquelle eine Bestell-ID für garantierte Aufträge 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 Legacy-ID des garantierten Auftrags. Wird von der ursprünglichen Anzeigenplattform zugewiesen. Die Legacy-ID ist innerhalb einer Anzeigenplattform eindeutig, aber nicht unbedingt für alle garantierten Aufträge. Diese ID wird in SDFs und auf der Benutzeroberfläche verwendet.
exchange

enum (Exchange)

Erforderlich. Nicht veränderbar. Die Anzeigenplattform, von der der garantierte Auftrag stammt.
guaranteedOrderId

string

Nur Ausgabe. Die eindeutige Kennung des garantierten Auftrags. Die Bestell-IDs garantierter Aufträge haben das Format {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Erforderlich. Der Anzeigename des garantierten Auftrags.

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 der garantierte Auftrag zuletzt aktualisiert wurde. Wird 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 Name des Publishers 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 den garantierten Auftrag haben. Gilt nur, wenn readWritePartnerId festgelegt ist. Wenn „True“, 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, falls dieser festgelegt ist. Alle Werbetreibenden in diesem Feld müssen zu readWritePartnerId oder demselben Partner wie readWriteAdvertiserId gehören.
defaultAdvertiserId

string (int64 format)

Nur Ausgabe. Die ID des Standardwerbetreibenden des garantierten Auftrags.

Der Standardwerbetreibende ist entweder der readWriteAdvertiserId oder, falls dieser nicht festgelegt ist, der erste in readAdvertiserIds aufgeführte Werbetreibende. 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 der Felder, die sich gegenseitig ausschließen. 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. Dies 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 der garantierte Auftrag 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 dieses garantierten Auftrags.

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 des garantierten Auftrags.

Die zulässigen 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 einen garantierten Auftrag.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Der Freigabestatus ist in dieser Version nicht angegeben oder unbekannt.
PENDING Der Anfangsstatus eines garantierten Auftrags. Der garantierte Auftrag in diesem Status muss konfiguriert werden, bevor er ausgeliefert werden kann.
COMPLETED Der Status, nachdem der Käufer einen garantierten Auftrag konfiguriert hat.

Methoden

create

 Erstellt einen neuen garantierten Auftrag.

editGuaranteedOrderReadAccessors

 Bearbeitet die Werbetreibenden eines garantierten Auftrags.

get

 Ruft einen garantierten Auftrag ab.

list

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

patch

 Aktualisiert einen vorhandenen garantierten Auftrag.