Method: orders.patch

Bestellung von Drittanbieter auf AOG aktualisieren Gibt INVALID_ARGUMENT zurück, wenn die ID der Bestellung leer ist oder nicht mit einer vorhandenen Bestellung übereinstimmt.

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

string

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 maximale Länge beträgt 64 Zeichen.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
Felder
header

object (OrderRequestHeader)

Header für die Anfrage zur Aktualisierung der Bestellung.

orderUpdate.type
(deprecated)

enum (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

string

Von Google zugewiesene Bestell-ID.

orderUpdate.order.userVisibleOrderId

string

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
(deprecated)

string

Eingestellt: Verwenden Sie stattdessen den Status „OrderExtensions“. Für den Nutzer sichtbares Label für den Status dieser Bestellung.

orderUpdate.order.buyerInfo

object (UserInfo)

Informationen zum Käufer.

orderUpdate.order.image

object (Image)

Mit der Bestellung verknüpftes Bild.

orderUpdate.order.createTime

string (Timestamp format)

Erforderlich: Datum und Uhrzeit der Erstellung der Bestellung.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.lastUpdateTime

string (Timestamp format)

Datum und Uhrzeit der letzten Aktualisierung der Bestellung. Erforderlich für OrderUpdate.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.transactionMerchant

object (Merchant)

Händler, der den Bezahlvorgang abgewickelt hat. Dieser kann sich vom Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA

orderUpdate.order.contents

object (Contents)

Erforderlich: Auftragsinhalt, der eine Gruppe von Werbebuchungen ist.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Preis, Rabatte, Steuern usw.

orderUpdate.order.followUpActions[]

object (Action)

Folgeaktionen auf Auftragsebene.

orderUpdate.order.paymentData

object (PaymentData)

Zahlungsbezogene Daten für die Bestellung.

orderUpdate.order.termsOfServiceUrl

string

Ein Link zu den Nutzungsbedingungen, die für die Bestellung bzw. vorgeschlagene Bestellung gelten.

orderUpdate.order.note

string

Mit einer Bestellung verknüpfte Notizen.

orderUpdate.order.promotions[]

object (Promotion)

Alle Angebote, die mit dieser Bestellung verknüpft sind.

orderUpdate.order.disclosures[]

object (Disclosure)

Mit dieser Anordnung verbundene Offenlegungen.

orderUpdate.order.vertical
(deprecated)

object

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: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

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. Die Werte „order.create_time“, „order.google_order_id“ und „order.merchant_order_id“ werden ignoriert, wenn sie als Teil der Updatemaske angegeben werden.

Eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
orderUpdate.userNotification

object (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

string

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

object (PurchaseOrderExtension)

Auftrag

orderUpdate.order.ticket

object (TicketOrderExtension)

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 (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Felder
type
(deprecated)

enum (Type)

Verworfen: Verwenden Sie stattdessen „OrderUpdate.update_mask“. Wenn Typ = SNAPSHOT, sollte „OrderUpdate.order“ die gesamte Bestellung enthalten. Wenn „type“ = „ORDER_STATUS“, handelt es sich um eine Statusänderung auf Bestellebene. Es werden nur „order.last_update_time“ und dieser vertikale Status übernommen. Hinweis: „type.ORDER_STATUS“ unterstützt nur Statusaktualisierungen für die Kaufbestellerweiterung. Eine Erweiterung dieser Unterstützung ist nicht geplant. Wir empfehlen stattdessen die Verwendung von „updateMask“, da es allgemeiner, erweiterbar und für alle Branchen geeignet ist.
order

object (Order)
updateMask

string (FieldMask format)

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. Die Werte „order.create_time“, „order.google_order_id“ und „order.merchant_order_id“ werden ignoriert, wenn sie als Teil der Updatemaske angegeben werden.

Eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
userNotification

object (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

string

Grund für die Änderung/Aktualisierung.

Typ

Verworfen: Verwenden Sie stattdessen OrderUpdate.update_mask. Zulässige Änderungen an einer Bestellung.

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

string

Der Titel der Nutzerbenachrichtigung. Die maximal zulässige Länge beträgt 30 Zeichen.

text

string

Der Inhalt der Benachrichtigung. Die maximal zulässige Länge beträgt 100 Zeichen.