REST Resource: guaranteedOrders

Ressource: warrantyOrder

Eine garantierte Bestellung.

Garantierte Aufträge sind die übergeordnete Entität 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,

  // 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 der garantierten Bestellung. Von der ursprünglichen Anzeigenplattform zugewiesen. Die alte ID ist innerhalb einer Anzeigenplattform eindeutig, aber nicht zwangsläufig für alle garantierten Bestellungen eindeutig. Diese ID wird in strukturierten Datendateien und auf der Benutzeroberfläche verwendet.
exchange

enum (Exchange)

Erforderlich. Nicht veränderbar. Die Anzeigenplattform, von der die garantierte Bestellung 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 der garantierten Bestellung.

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

object (GuaranteedOrderStatus)

Die Statuseinstellungen der garantierten Bestellung.
updateTime

string (Timestamp format)

Nur Ausgabe Zeitstempel für die letzte Aktualisierung der garantierten Bestellung. Vom System zugewiesen.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 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 den readWriteAdvertiserId zugewiesenen Werbetreibenden nicht enthalten, wenn 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 nicht festgelegt, der erste in readAdvertiserIds aufgeführte Werbetreibende. Andernfalls ist kein Standardwerbetreibender vorhanden.
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 der garantierten Bestellung.

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 gesetzt ist.
configStatus

enum (GuaranteedOrderConfigStatus)

Nur Ausgabe Der Konfigurationsstatus der garantierten Bestellung.

Zulässige Werte sind PENDING und COMPLETED.

Ein garantierter Auftrag muss konfiguriert werden, damit 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 UI ausgeführt werden.

GuaranteedOrderConfigStatus

Mögliche Konfigurationsstatus für eine garantierte Bestellung.

Enums
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Der Freigabestatus 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

 Änderungen lesen Werbetreibende eines garantierten Auftrags.

get

 Ruft eine garantierte Bestellung ab.

list

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

patch

 Aktualisiert eine vorhandene garantierte Bestellung.