Method: orders.patch

Bestellung von 3P auf AOG aktualisieren Gibt INVALID_ARGUMENT zurück, wenn die ID des Auftrags leer ist oder nicht mit einem vorhandenen Auftrag ü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 Aktualisierungen der Bestellung erforderlich. Diese ID kann auf die angegebene googleOrderId oder einen anderen eindeutigen Wert festgelegt werden. Beachten Sie, dass die ID, die Nutzern präsentiert wird, die uservisibleOrderId ist, bei der es sich möglicherweise um einen anderen, nutzerfreundlicheren Wert handelt. Die maximal zulässige 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)

Überschrift für die Anfrage zur Bestellaktualisierung.

orderUpdate.type
(deprecated)

enum (Type)

Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Wenn der Typ = SNAPSHOT lautet, sollte OrderUpdate.order die gesamte Bestellung sein. Wenn der Typ = ORDER_STATUS, entspricht dies der Statusänderung auf Auftragsebene. Nur „order.last_update_time“ und dieser Branchenstatus werden abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur PurcahaseOrderExtension-Statusaktualisierungen. Es ist nicht geplant, diesen Support zu erweitern. Stattdessen empfehlen wir „updateMask“, da es 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 für den Nutzer sichtbare ID, die auf die aktuelle Bestellung verweist. Diese ID sollte mit der ID übereinstimmen, die in anderen Kontexten wie Websites, Apps und E-Mails für diese Bestellung angezeigt wird.

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 Auftragserstellung.

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 des Auftrags. 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 ermöglicht hat. Dieser kann sich von einem Anbieter auf Werbebuchungsebene unterscheiden. Beispiel: Expedia-Auftrag mit Werbebuchung von ANA

orderUpdate.order.contents

object (Contents)

Erforderlich: Auftragsinhalte, die eine Gruppe von Werbebuchungen sind.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Preise, 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/den vorgeschlagenen Auftrag gelten.

orderUpdate.order.note

string

Notizen, die einer Bestellung zugeordnet sind.

orderUpdate.order.promotions[]

object (Promotion)

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

orderUpdate.order.disclosures[]

object (Disclosure)

Offenlegungen im Zusammenhang mit dieser Bestellung.

orderUpdate.order.vertical
(deprecated)

object

Eingestellt: Verwenden Sie stattdessen Branchen. Diese Eigenschaften gelten für alle Werbebuchungen, sofern sie nicht in einer Werbebuchung ü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 mit Feldern eines beliebigen Typs. 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: Für die folgenden Sonderfelder gibt es folgende Hinweise bzw. Empfehlungen: 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“ bereitgestellt werden.

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

orderUpdate.userNotification

object (UserNotification)

Wenn dieses Flag angegeben ist, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Das Angeben einer Benachrichtigung ist ein Vorschlag für die 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 nicht in einer Werbebuchung ü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 eine Bestellung.

JSON-Darstellung
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Felder
type
(deprecated)

enum (Type)

Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Wenn der Typ = SNAPSHOT lautet, sollte OrderUpdate.order die gesamte Bestellung sein. Wenn der Typ = ORDER_STATUS, entspricht dies der Statusänderung auf Auftragsebene. Nur „order.last_update_time“ und dieser Branchenstatus werden abgerufen. Hinweis: type.ORDER_STATUS unterstützt nur PurcahaseOrderExtension-Statusaktualisierungen. Es ist nicht geplant, diesen Support zu erweitern. Stattdessen empfehlen wir „updateMask“, da es allgemeiner und erweiterbar ist und für alle Branchen verwendet werden kann.

order

object (Order)

updateMask

string (FieldMask format)

Hinweis: Für die folgenden Sonderfelder gibt es folgende Hinweise bzw. Empfehlungen: 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“ bereitgestellt werden.

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

userNotification

object (UserNotification)

Wenn dieses Flag angegeben ist, wird dem Nutzer eine Benachrichtigung mit dem angegebenen Titel und Text angezeigt. Das Angeben einer Benachrichtigung ist ein Vorschlag für die Benachrichtigung und führt nicht zwangsläufig zu einer Benachrichtigung.

reason

string

Grund für die Änderung/Aktualisierung.

Typ

Eingestellt: Verwende stattdessen „OrderUpdate.update_mask“. Aktualisierungen für einen Auftrag sind 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 im Rahmen der Bestellaktualisierung angezeigt wird.

JSON-Darstellung
{
  "title": string,
  "text": string
}
Felder
title

string

Der Titel für die 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.