REST Resource: guaranteedOrders

Ressource: Garantierter Auftrag

Eine garantierte Bestellung.

Garantierte Aufträge sind übergeordnete Elemente garantierter Inventarquellen. Wenn Sie eine garantierte Inventarquelle erstellen, muss ihr 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,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der garantierten Bestellung.
legacyGuaranteedOrderId

string

Nur Ausgabe. Die alte ID des garantierten Auftrags. Von der ursprünglichen Anzeigenplattform zugewiesen. Die alte ID ist innerhalb einer Anzeigenplattform eindeutig, aber nicht unbedingt für alle garantierten Aufträge gleich. Diese ID wird in der strukturierten Datendatei und 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 der garantierten Bestellung. Die garantierten Bestell-IDs 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 die garantierte Bestellung zuletzt aktualisiert wurde. Vom System zugewiesen.

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

Der Werbetreibende, der readWriteAdvertiserId zugewiesen ist, darf in diesem Feld nicht angegeben werden. 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 der erste in readAdvertiserIds aufgeführte Werbetreibende, falls dieser nicht festgelegt ist. Andernfalls ist kein Standardwerbetreibender angegeben.
defaultCampaignId

string (int64 format)

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

Die Standardkampagne muss zum Standardwerbetreibenden gehören.

Union-Feld read_write_accessor. Erforderlich.

Der Partner oder Werbetreibende mit Lese-/Schreibzugriff auf den garantierten Auftrag. Für read_write_accessor ist nur einer der folgenden Werte zulässig:
readWritePartnerId

string (int64 format)

Der Partner mit Lese-/Schreibzugriff auf die garantierte Bestellung.
readWriteAdvertiserId

string (int64 format)

Der Werbetreibende mit Lese-/Schreibzugriff auf den garantierten Auftrag. Dies ist auch der Standardwerbetreibende des garantierten Auftrags.

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

Muss UTF-8-codiert sein und eine maximale Länge von 100 Byte haben.

Gilt nur, wenn entityStatus auf ENTITY_STATUS_PAUSED gesetzt ist.
configStatus

enum (GuaranteedOrderConfigStatus)

Nur Ausgabe. Der Konfigurationsstatus des garantierten Auftrags.

Zulässige Werte sind PENDING und COMPLETED.

Ein garantierter Auftrag muss konfiguriert werden, bevor er ausgeliefert werden kann. Füllen Sie dazu die Pflichtfelder aus, wählen Sie Creatives aus und legen Sie eine Standardkampagne fest. Derzeit kann die Konfigurationsaktion nur über die Benutzeroberfläche ausgeführt werden.

GuaranteedOrderConfigStatus

Mögliche Konfigurationszustände für eine garantierte Bestellung.

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

Methoden

create

 Erstellt einen neuen garantierten Auftrag.

editGuaranteedOrderReadAccessors

 Bearbeitungen lesen Werbetreibende eines garantierten Auftrags.

get

 Damit erhalten Sie eine garantierte Bestellung.

list

 Listet garantierte Bestellungen auf, auf die der aktuelle Nutzer zugreifen kann.

patch

 Aktualisiert einen vorhandenen garantierten Auftrag.