Order

Entité de commande. Remarque: 1. Sauf indication contraire, toutes les chaînes, quel que soit leur niveau, doivent comporter moins de 1 000 caractères. 2. Sauf indication contraire, tous les champs répétés, à tous les niveaux, doivent être inférieurs à 50. 3. S'ils sont spécifiés, tous les codes temporels de tous les niveaux doivent être valides.

Représentation JSON 
{
  "googleOrderId": string,
  "merchantOrderId": 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.
}
Champs
googleOrderId

string

ID de commande attribué par Google.
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 128 caractères.
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.
userVisibleStateLabel
(deprecated)

string

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

object (UserInfo)

des informations sur l'acheteur.
image

object (Image)

Image associée à la commande.
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"
lastUpdateTime

string (Timestamp format)

la date et l'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"
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.
contents

object (Contents)

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

object (PriceAttribute)

Prix, remises, taxes, etc.
followUpActions[]

object (Action)

Actions de suivi au niveau de la commande
paymentData

object (PaymentData)

Données relatives au paiement de la commande.
termsOfServiceUrl

string

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

string

Notes associées à un ordre.
promotions[]

object (Promotion)

Toutes les promotions associées à cette commande.
disclosures[]

object (Disclosure)

Divulgation associée à cette ordonnance
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" }.
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 :
purchase

object (PurchaseOrderExtension)

Bon de commande
ticket

object (TicketOrderExtension)

Commande de billets

Sommaire

Enveloppe pour les éléments de campagne.

Représentation JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Champs
lineItems[]

object (LineItem)

Liste des éléments de campagne. Vous devez ajouter au moins un article, et 50 éléments maximum. Tous les éléments de campagne doivent appartenir au même secteur.

PaymentData

Données de paiement liées à une commande.

Représentation JSON 
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Champs
paymentResult

object (PaymentResult)

Résultat du paiement utilisé par l'intégrateur pour finaliser une transaction. Ce champ sera renseigné par des actions sur Google si l'expérience de paiement est gérée par actions-on-Google.
paymentInfo

object (PaymentInfo)

Informations de paiement concernant la commande, permettant une interaction directe avec l'utilisateur.

PaymentResult

Résultat du paiement utilisé par l'intégrateur pour finaliser une transaction.

Représentation JSON 
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
Champs
Champ d'union result. Les données de paiement Google ou le mode de paiement du marchand sont fournis. result ne peut être qu'un des éléments suivants :
googlePaymentData

string

Google a fourni les données du mode de paiement. Si votre société de traitement des paiements est répertoriée comme société de traitement des paiements acceptée par Google: https://developers.google.com/pay/api/, cliquez sur le lien afin d'obtenir plus d'informations. Sinon, reportez-vous à la documentation suivante pour en savoir plus sur la charge utile. https://developers.google.com/pay/api/payment-data-cryptography
merchantPaymentMethodId

string

Mode de paiement fourni par le marchand/l'action, choisi par l'utilisateur.

PaymentInfo

Informations de paiement concernant la commande en cours de réalisation. Ce proto capture des informations utiles pour les interactions avec l'utilisateur.

Représentation JSON 
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Champs
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Informations à afficher sur le mode de paiement utilisé pour la transaction.
paymentMethodProvenance

enum (PaymentMethodProvenance)

Provenance du mode de paiement utilisé pour la transaction. Il est possible que l'utilisateur ait enregistré le même mode de paiement auprès de Google et du marchand.

PaymentMethodDisplayInfo

Résultat du paiement utilisé par l'intégrateur pour finaliser une transaction.

Représentation JSON 
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
Champs
paymentType

enum (PaymentType)

Type de paiement.
paymentMethodDisplayName

string

Nom visible de l'utilisateur pour le mode de paiement. Par exemple, VISA **** 1234 Compte courant **** 5678

Promotion

Promotions/offres ajoutées au panier.

Représentation JSON 
{
  "coupon": string
}
Champs
coupon

string

Obligatoire: code promotionnel appliqué à cette offre.

PurchaseOrderExtension

Extension de commande pour le secteur des achats. Ces propriétés s'appliquent à tous les éléments de ligne dans l'ordre, sauf si elles sont remplacées dans un élément de ligne.

Représentation JSON 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
Champs
status

enum (PurchaseStatus)

Obligatoire: état général de la commande.
userVisibleStatusLabel

string

Libellé/Chaîne visible par l'utilisateur de l'état. La longueur maximale autorisée est de 50 caractères.
type

enum (PurchaseType)

Obligatoire: type d'achat.
returnsInfo

object (PurchaseReturnsInfo)

Informations de retour pour la commande.
fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informations de traitement de la commande.
extension

object

Tout champ supplémentaire échangé entre le marchand et Google.

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" }.
purchaseLocationType

enum (PurchaseLocationType)

Lieu de l'achat (en magasin / en ligne)
errors[]

object (PurchaseError)

Facultatif: erreurs entraînant le refus de cette commande.

PurchaseError

Erreurs pour lesquelles un bon de commande peut être refusé.

Représentation JSON 
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Champs
type

enum (ErrorType)

Obligatoire: explique précisément pourquoi une commande est refusée par le marchand.
description

string

Description supplémentaire de l'erreur.
entityId

string

ID d'entité correspondant à l'erreur. Exemple : cela peut correspondre à LineItemId / ItemOptionId.
updatedPrice

object (PriceAttribute)

Pertinent si le type d'erreur est de PRICE_CHANGED / INCORRECT_PRICE.
availableQuantity

integer

Quantité disponible. Applicable en cas de AVAILABILITY_CHANGED.

TicketOrderExtension

Ordonnez le contenu des billets (films, sports, etc.).

Représentation JSON 
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Champs
ticketEvent

object (TicketEvent)

Événement appliqué à tous les tickets d'éléments de campagne.

TicketEvent

Représente un seul événement.

Représentation JSON 
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
Champs
type

enum (Type)

Obligatoire: type d'événement de billet (par exemple, film, concert.
name

string

Obligatoire: nom de l'événement. Par exemple, s'il s'agit d'un film, il doit s'agir du nom du film.
description

string

la description de l'événement.
url

string

URL des informations sur l'événement.
location

object (Location)

Lieu où se déroule l'événement ou où se trouve une organisation.
eventCharacters[]

object (EventCharacter)

Personnages associés à cet événement. Il peut s'agir de réalisateurs ou d'acteurs d'un film, d'artistes de concert, etc.
startDate

object (Time)

Heure de début
endDate

object (Time)

Heure de fin
doorTime

object (Time)

Heure d'entrée, qui peut être différente de l'heure de début de l'événement. Ex. : l'événement commence à 9h, mais l'heure d'entrée est 8h30.

EventCharacter

Un caractère d'événement, par exemple organisateur, artiste, etc.

Représentation JSON 
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Champs
type

enum (Type)

Type du caractère d'événement (par exemple, un acteur ou un réalisateur.
name

string

le nom du caractère.
image

object (Image)

Images du personnage.