Method: orders.patch

Mise à jour de la commande de 3p à AOG. Renvoie INVALID_ARGUMENT si l'ID de la commande est vide ou s'il n'est pas identique à celui d'une commande existante.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
orderUpdate.order.merchantOrderId

string

Obligatoire: ID de commande interne attribué par le marchand. Cet identifiant doit être unique. Il est obligatoire pour toute opération ultérieure de mise à jour de commandes. Cet identifiant peut être défini sur l'ID googleOrderId fourni ou sur toute autre valeur unique. Notez que l'ID présenté aux utilisateurs est "userVisibleOrderId", qui peut être une valeur différente et plus conviviale. La longueur maximale autorisée est de 64 caractères.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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
  }
}
Champs
header

object (OrderRequestHeader)

En-tête de la requête de mise à jour de la commande.

orderUpdate.type
(deprecated)

enum (Type)

Obsolète: utilisez OrderUpdate.update_mask à la place. Si la valeur est de type SNAPSHOT, OrderUpdate.order doit correspondre à l'intégralité de la commande. Si le type est ORDER_STATUS, il s'agit de la modification de l'état au niveau de la commande. Seuls "order.last_update_time" et cet état vertical sont pris en compte. Remarque: Le type.ORDER_STATUS prend uniquement en charge les mises à jour de l'état de PurcahaseOrderExtension. Nous ne prévoyons pas d'étendre cette prise en charge. Nous vous recommandons plutôt d'utiliser updateMask, car il est plus générique, extensible et peut être utilisé pour tous les secteurs.

orderUpdate.order.googleOrderId

string

ID de commande attribué par Google.

orderUpdate.order.userVisibleOrderId

string

ID visible par l'utilisateur qui fait référence à la commande en cours. Cet identifiant doit correspondre à celui affiché pour cette commande dans les autres contextes, y compris sur les sites Web, les applications et les e-mails.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Obsolète: utilisez plutôt l'état OrderExtensions. Libellé visible par l'utilisateur indiquant l'état de cette commande.

orderUpdate.order.buyerInfo

object (UserInfo)

Informations sur l'acheteur.

orderUpdate.order.image

object (Image)

Image associée à la commande.

orderUpdate.order.createTime

string (Timestamp format)

(obligatoire) : date et heure de création de la commande.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"
orderUpdate.order.lastUpdateTime

string (Timestamp format)

Date et heure de la dernière mise à jour de la commande. Obligatoire pour OrderUpdate.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"
orderUpdate.order.transactionMerchant

object (Merchant)

Marchand ayant facilité le paiement. Il peut être différent de celui d'un fournisseur au niveau de l'élément de campagne. Exemple: Commande Expedia avec une ligne de l'ANA.

orderUpdate.order.contents

object (Contents)

Obligatoire: contenu de la campagne (groupe d'éléments de campagne).

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Prix, remises, taxes, etc.

orderUpdate.order.followUpActions[]

object (Action)

Actions de suivi au niveau de la commande

orderUpdate.order.paymentData

object (PaymentData)

Données relatives au paiement de la commande.

orderUpdate.order.termsOfServiceUrl

string

Lien vers les conditions d'utilisation qui s'appliquent à la commande/commande proposée.

orderUpdate.order.note

string

Notes associées à un ordre.

orderUpdate.order.promotions[]

object (Promotion)

Toutes les promotions associées à cette commande.

orderUpdate.order.disclosures[]

object (Disclosure)

Divulgation associée à cette ordonnance

orderUpdate.order.vertical
(deprecated)

object

Obsolète: utilisez plutôt des secteurs. Ces propriétés s'appliqueront à tous les éléments de ligne, sauf si elles sont remplacées dans certains éléments de ligne. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. Valeurs possibles: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

Remarque: Voici quelques considérations/recommandations concernant les champs spéciaux suivants: 1. order.last_update_time sera toujours mis à jour dans le cadre de la demande de mise à jour. 2. Les commandes "order.create_time", "order.google_order_id" et "order.merchant_order_id" seront ignorées si elles sont fournies dans le cadre de "updateMask".

Liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"
orderUpdate.userNotification

object (UserNotification)

Le cas échéant, affiche une notification contenant le titre et le texte spécifiés pour l'utilisateur. La spécification d'une notification est une suggestion de notification et n'entraîne pas nécessairement une notification.

orderUpdate.reason

string

Motif de la modification/mise à jour.

Champ d'union verticals. Ces propriétés s'appliqueront à tous les éléments de ligne, sauf si elles sont remplacées dans certains éléments de ligne. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. verticals ne peut être qu'un des éléments suivants :
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Bon de commande

orderUpdate.order.ticket

object (TicketOrderExtension)

Commande de billets

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Order.

OrderUpdate

Mise à jour d'une commande

Représentation JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Champs
type
(deprecated)

enum (Type)

Obsolète: utilisez OrderUpdate.update_mask à la place. Si la valeur est de type SNAPSHOT, OrderUpdate.order doit correspondre à l'intégralité de la commande. Si le type est ORDER_STATUS, il s'agit de la modification de l'état au niveau de la commande. Seuls "order.last_update_time" et cet état vertical sont pris en compte. Remarque: Le type.ORDER_STATUS prend uniquement en charge les mises à jour de l'état de PurcahaseOrderExtension. Nous ne prévoyons pas d'étendre cette prise en charge. Nous vous recommandons plutôt d'utiliser updateMask, car il est plus générique, extensible et peut être utilisé pour tous les secteurs.
order

object (Order)
updateMask

string (FieldMask format)

Remarque: Voici quelques considérations/recommandations concernant les champs spéciaux suivants: 1. order.last_update_time sera toujours mis à jour dans le cadre de la demande de mise à jour. 2. Les commandes "order.create_time", "order.google_order_id" et "order.merchant_order_id" seront ignorées si elles sont fournies dans le cadre de "updateMask".

Liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"
userNotification

object (UserNotification)

Le cas échéant, affiche une notification contenant le titre et le texte spécifiés pour l'utilisateur. La spécification d'une notification est une suggestion de notification et n'entraîne pas nécessairement une notification.

reason

string

Motif de la modification/mise à jour.

Type

Obsolète: utilisez OrderUpdate.update_mask à la place. Mises à jour autorisées d'une commande.

Enums
TYPE_UNSPECIFIED Type non spécifié, ne doit pas être défini explicitement.
ORDER_STATUS Mettre à jour uniquement l'état de la commande
SNAPSHOT Mettre à jour l'instantané de la commande

UserNotification

Notification utilisateur facultative à afficher dans le cadre de la mise à jour de la commande.

Représentation JSON 
{
  "title": string,
  "text": string
}
Champs
title

string

Titre de la notification utilisateur. La longueur maximale autorisée est de 30 caractères.

text

string

Contenu de la notification. La longueur maximale autorisée est de 100 caractères.