- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- OrderUpdate
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
Aktualisiere die Bestellung von 3p auf AOG. Gibt INVALID_ARGUMENT zurück, wenn die ID des Auftrags leer ist oder keinem vorhandenen Auftrag entspricht.
HTTP-Anfrage
PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
orderUpdate.order.merchantOrderId |
Erforderlich: Dem Händler zugewiesene interne Bestell-ID. Diese ID muss eindeutig sein und ist für nachfolgende Auftragsaktualisierungen erforderlich. Diese ID kann auf die angegebene googleOrderId oder einen anderen eindeutigen Wert festgelegt werden. Hinweis: Die ID, die Nutzern angezeigt wird, ist die userVisibleOrderId, die ein anderer, nutzerfreundlicherer Wert sein kann. Die maximal zulässige Länge beträgt 64 Zeichen. |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung | |
---|---|
{ "header": { object ( |
Felder | ||
---|---|---|
header |
Header für die Anfrage zur Aktualisierung der Bestellung. |
|
orderUpdate.type |
Verworfen: Verwenden Sie stattdessen OrderUpdate.update_mask. Wenn Typ = SNAPSHOT, sollte „OrderUpdate.order“ die gesamte Bestellung enthalten. Wenn Typ = ORDER_STATUS, ist dies die Statusänderung auf Auftragsebene. Es werden nur „order.last_update_time“ und dieser Branchenstatus abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur Statusaktualisierungen für PurcahaseOrderExtension und es ist nicht geplant, diesen Support zu verlängern. Stattdessen empfehlen wir die Verwendung von „updateMask“, da sie allgemeiner und erweiterbar ist und für alle Branchen verwendet werden kann. |
|
orderUpdate.order.googleOrderId |
Von Google zugewiesene Bestell-ID. |
|
orderUpdate.order.userVisibleOrderId |
Die an den Nutzer gerichtete ID, die auf die aktuelle Bestellung verweist. Diese ID muss mit der ID übereinstimmen, die in anderen Kontexten für diese Bestellung angezeigt wird, z. B. für Websites, Apps und E-Mails. |
|
orderUpdate.order.userVisibleStateLabel |
Eingestellt: Verwenden Sie stattdessen den Status „OrderExtensions“. Für den Nutzer sichtbares Label für den Status dieser Bestellung. |
|
orderUpdate.order.buyerInfo |
Informationen zum Käufer. |
|
orderUpdate.order.image |
Mit der Bestellung verknüpftes Bild. |
|
orderUpdate.order.createTime |
Erforderlich: Datum und Uhrzeit der Auftragserstellung. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: |
|
orderUpdate.order.lastUpdateTime |
Datum und Uhrzeit der letzten Aktualisierung der Bestellung. Erforderlich für OrderUpdate. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: |
|
orderUpdate.order.transactionMerchant |
Händler, der den Bezahlvorgang vereinfacht hat. Dies kann sich von einem Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA |
|
orderUpdate.order.contents |
Erforderlich: Auftragsinhalt, der eine Gruppe von Werbebuchungen ist. |
|
orderUpdate.order.priceAttributes[] |
Preise, Rabatte, Steuern usw. |
|
orderUpdate.order.followUpActions[] |
Folgeaktionen auf Auftragsebene. |
|
orderUpdate.order.paymentData |
Zahlungsbezogene Daten für die Bestellung. |
|
orderUpdate.order.termsOfServiceUrl |
Ein Link zu den Nutzungsbedingungen, die für die Bestellung bzw. vorgeschlagene Bestellung gelten. |
|
orderUpdate.order.note |
Mit einer Bestellung verknüpfte Notizen. |
|
orderUpdate.order.promotions[] |
Alle Angebote, die mit dieser Bestellung verknüpft sind. |
|
orderUpdate.order.disclosures[] |
Mit dieser Anordnung verbundene Offenlegungen. |
|
orderUpdate.order.vertical |
Eingestellt: Verwenden Sie stattdessen Branchen. Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie in einer Werbebuchung nicht überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Mögliche Werte: Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld |
|
orderUpdate.updateMask |
Hinweis: Beachten Sie die folgenden Hinweise bzw. Empfehlungen für die folgenden speziellen Felder: 1. „order.last_update_time“ wird immer im Rahmen der Aktualisierungsanfrage aktualisiert. 2. „order.create_time“, „order.google_order_id“ und „order.merchant_order_id“ werden ignoriert, wenn sie als Teil von „updateMask“ angegeben sind. Eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: |
|
orderUpdate.userNotification |
Wenn angegeben, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Die Angabe einer Benachrichtigung ist nur ein Vorschlag für eine Benachrichtigung und führt nicht zwangsläufig zu einer Benachrichtigung. |
|
orderUpdate.reason |
Grund für die Änderung/Aktualisierung. |
|
Union-Feld verticals . Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie in einer Werbebuchung nicht überschrieben werden. Diese Branche muss dem Branchentyp auf Werbebuchungsebene entsprechen. Für verticals ist nur einer der folgenden Werte zulässig: |
||
orderUpdate.order.purchase |
Auftrag |
|
orderUpdate.order.ticket |
Ticketbestellung |
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Order
.
OrderUpdate
Aktualisieren Sie einen Auftrag.
JSON-Darstellung | |
---|---|
{ "type": enum ( |
Felder | |
---|---|
type |
Verworfen: Verwenden Sie stattdessen OrderUpdate.update_mask. Wenn Typ = SNAPSHOT, sollte „OrderUpdate.order“ die gesamte Bestellung enthalten. Wenn Typ = ORDER_STATUS, ist dies die Statusänderung auf Auftragsebene. Es werden nur „order.last_update_time“ und dieser Branchenstatus abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur Statusaktualisierungen für PurcahaseOrderExtension und es ist nicht geplant, diesen Support zu verlängern. Stattdessen empfehlen wir die Verwendung von „updateMask“, da sie allgemeiner und erweiterbar ist und für alle Branchen verwendet werden kann. |
order |
|
updateMask |
Hinweis: Beachten Sie die folgenden Hinweise bzw. Empfehlungen für die folgenden speziellen Felder: 1. „order.last_update_time“ wird immer im Rahmen der Aktualisierungsanfrage aktualisiert. 2. „order.create_time“, „order.google_order_id“ und „order.merchant_order_id“ werden ignoriert, wenn sie als Teil von „updateMask“ angegeben sind. Eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: |
userNotification |
Wenn angegeben, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Die Angabe einer Benachrichtigung ist nur ein Vorschlag für eine Benachrichtigung und führt nicht zwangsläufig zu einer Benachrichtigung. |
reason |
Grund für die Änderung/Aktualisierung. |
Typ
Verworfen: Verwenden Sie stattdessen OrderUpdate.update_mask. Aktualisierungen für einen Auftrag zulässig.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Typ nicht angegeben, sollte nicht explizit festgelegt werden. |
ORDER_STATUS |
Aktualisieren Sie nur den Status der Bestellung. |
SNAPSHOT |
Bestellübersicht aktualisieren. |
UserNotification
Optionale Nutzerbenachrichtigung, die als Teil der Bestellaktualisierung angezeigt wird.
JSON-Darstellung | |
---|---|
{ "title": string, "text": string } |
Felder | |
---|---|
title |
Der Titel der Nutzerbenachrichtigung. Die maximal zulässige Länge beträgt 30 Zeichen. |
text |
Der Inhalt der Benachrichtigung. Die maximal zulässige Länge beträgt 100 Zeichen. |