Method: orders.patch

Aggiorna l'ordine dalle 3 alle AOG. Restituisce INVALID_REMOVED se l'ID dell'ordine è vuoto o non corrisponde a un ordine esistente.

Richiesta HTTP

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
orderUpdate.order.merchantOrderId

string

Obbligatorio: ID ordine interno assegnato dal commerciante. Questo ID deve essere univoco ed è obbligatorio per le successive operazioni di aggiornamento dell'ordine. Questo ID può essere impostato sul valore googleOrderId fornito o su qualsiasi altro valore univoco. Tieni presente che l'ID presentato agli utenti è userVisibileOrderId, che può essere un valore diverso e più facile da usare. La lunghezza massima consentita è 64 caratteri.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "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
  }
}
Campi
header

object (OrderRequestHeader)

Intestazione per la richiesta di aggiornamento dell'ordine.

orderUpdate.type
(deprecated)

enum (Type)

Deprecato: utilizza OrderUpdate.update_mask. Se type = SNAPSHOT, OrderUpdate.order deve essere l'intero ordine. Se type = ORDER_STATUS, questa è la modifica dello stato a livello di ordine. Vengono presi in considerazione solo order.last_update_time e questo stato verticale. Nota: type.ORDER_STATUS supporta solo gli aggiornamenti dello stato PurcahaseOrderExtension e non è previsto l'estensione di questo supporto. Consigliamo invece di utilizzare updateMask, poiché è più generico, estendibile e può essere utilizzato per tutti i verticali.

orderUpdate.order.googleOrderId

string

ID ordine assegnato da Google.

orderUpdate.order.userVisibleOrderId

string

L'ID rivolto all'utente che fa riferimento all'ordine corrente. Questo ID deve essere coerente con quello visualizzato per questo ordine in altri contesti, tra cui siti web, app ed email.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Deprecato: utilizza lo stato Order Extensions. Etichetta visibile all'utente per lo stato di questo ordine.

orderUpdate.order.buyerInfo

object (UserInfo)

Informazioni sull'acquirente.

orderUpdate.order.image

object (Image)

Immagine associata all'ordine.

orderUpdate.order.createTime

string (Timestamp format)

Obbligatorio: data e ora di creazione dell'ordine.

Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.lastUpdateTime

string (Timestamp format)

La data e l'ora dell'ultimo aggiornamento dell'ordine. Obbligatorio per OrderUpdate.

Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.transactionMerchant

object (Merchant)

Il commerciante che ha facilitato il pagamento. Questo potrebbe essere diverso da un fornitore a livello di elemento pubblicitario. Esempio: ordine Expedia con elemento pubblicitario di ANA.

orderUpdate.order.contents

object (Contents)

Obbligatorio: i contenuti dell'ordine, che sono un gruppo di elementi pubblicitari.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Prezzo, sconti, tasse e così via.

orderUpdate.order.followUpActions[]

object (Action)

Azioni successive a livello di ordine.

orderUpdate.order.paymentData

object (PaymentData)

Dati relativi al pagamento dell'ordine.

orderUpdate.order.termsOfServiceUrl

string

Un link ai termini di servizio applicabili all'ordine/ordine proposto.

orderUpdate.order.note

string

Note allegate a un ordine.

orderUpdate.order.promotions[]

object (Promotion)

Tutte le promozioni associate a questo ordine.

orderUpdate.order.disclosures[]

object (Disclosure)

Informative associate a questo ordine.

orderUpdate.order.vertical
(deprecated)

object

Obsoleto: utilizza i verticali. Queste proprietà verranno applicate a tutti gli elementi pubblicitari, a meno che non vengano sostituite in alcuni elementi. Questo verticale deve corrispondere al tipo di verticale a livello di elemento pubblicitario. Valori possibili: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

Nota: vi sono i seguenti suggerimenti/considerazioni per i seguenti campi speciali: 1. order.last_update_time sarà sempre aggiornato come parte della richiesta di aggiornamento. 2. order.create_time, order.google_order_id e order.merchant_order_id verranno ignorati se forniti come parte di updateMask.

Un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
orderUpdate.userNotification

object (UserNotification)

Se specificato, mostra una notifica all'utente con il titolo e il testo specificati. La specifica di una notifica è un suggerimento per inviare una notifica e non è garantito che venga inviata una notifica.

orderUpdate.reason

string

Motivo della modifica o dell'aggiornamento.

Campo di unione verticals. Queste proprietà verranno applicate a tutti gli elementi pubblicitari, a meno che non vengano sostituite in alcuni elementi. Questo verticale deve corrispondere al tipo di verticale a livello di elemento pubblicitario. verticals può essere solo uno dei seguenti:
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Ordine di acquisto

orderUpdate.order.ticket

object (TicketOrderExtension)

Vendita di biglietti

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Order.

OrderUpdate

Aggiorna un ordine.

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

enum (Type)

Deprecato: utilizza OrderUpdate.update_mask. Se type = SNAPSHOT, OrderUpdate.order deve essere l'intero ordine. Se type = ORDER_STATUS, questa è la modifica dello stato a livello di ordine. Vengono presi in considerazione solo order.last_update_time e questo stato verticale. Nota: type.ORDER_STATUS supporta solo gli aggiornamenti dello stato PurcahaseOrderExtension e non è previsto l'estensione di questo supporto. Consigliamo invece di utilizzare updateMask, poiché è più generico, estendibile e può essere utilizzato per tutti i verticali.
order

object (Order)
updateMask

string (FieldMask format)

Nota: vi sono i seguenti suggerimenti/considerazioni per i seguenti campi speciali: 1. order.last_update_time sarà sempre aggiornato come parte della richiesta di aggiornamento. 2. order.create_time, order.google_order_id e order.merchant_order_id verranno ignorati se forniti come parte di updateMask.

Un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
userNotification

object (UserNotification)

Se specificato, mostra una notifica all'utente con il titolo e il testo specificati. La specifica di una notifica è un suggerimento per inviare una notifica e non è garantito che venga inviata una notifica.

reason

string

Motivo della modifica o dell'aggiornamento.

Tipo

Deprecato: utilizza OrderUpdate.update_mask. Aggiornamenti consentiti per un ordine.

Enum
TYPE_UNSPECIFIED Tipo non specificato. Non deve essere impostato in modo esplicito.
ORDER_STATUS Aggiorna solo lo stato dell'ordine.
SNAPSHOT Aggiorna l'istantanea dell'ordine.

UserNotification

Notifica utente facoltativa da visualizzare nell'ambito dell'aggiornamento dell'ordine.

Rappresentazione JSON 
{
  "title": string,
  "text": string
}
Campi
title

string

Il titolo della notifica per gli utenti. La lunghezza massima consentita è di 30 caratteri.

text

string

Il contenuto della notifica. La lunghezza massima consentita è 100 caratteri.