REST Resource: orders

Ressource: Order

Un ordre est un ensemble de Lines qui spécifient quand et où afficher les annonces.

Représentation JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la commande au format: orders/{id}.
externalId

string

Facultatif. Identifiant utilisé pour mapper cette entité à des sources externes.
displayName

string

Uniquement en sortie. Nom à afficher de l'ordre.

Doit être encodé au format UTF-8 avec une taille maximale de 240 octets.
description

string

Uniquement en sortie. Champ libre supplémentaire permettant de décrire la commande.
orderState

enum (OrderState)

Uniquement en sortie. Représente l'état calculé de l'ordre en fonction de l'état de ses lignes.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de la commande.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la commande.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

Uniquement en sortie. Informations sur l'annonceur.

OrderState

État de la commande.

Enums
ORDER_STATE_UNSPECIFIED Valeur par défaut lorsque l'état de la commande n'a pas été spécifié ou est inconnu dans cette version.
ORDER_STATE_PENDING_RESERVATION

La commande contient:

  • une ou plusieurs lignes à l'état de réservation en attente.
  • zéro ou plusieurs lignes à l'état réservé.
  • zéro ligne dans tous les autres états.
ORDER_STATE_RESERVED

La commande contient:

  • aucune ligne dans l'état de réservation en attente.
  • une ou plusieurs lignes à l'état réservé.
  • à zéro ligne ou plus, à l'état "Refusé" par l'état du vendeur.
  • zéro ligne dans tous les autres états.
ORDER_STATE_PENDING_BOOKING

La commande contient:

  • aucune ligne dans l'état de réservation en attente.
  • zéro ligne à l'état réservé.
  • une ou plusieurs lignes en attente de réservation.
  • à zéro ligne ou plus, à l'état "Refusé" par l'état du vendeur.
  • zéro ou plusieurs lignes sont annulées par l'acheteur.
  • zéro ligne dans tous les autres états.
ORDER_STATE_BOOKED

La commande contient:

  • aucune ligne dans l'état de réservation en attente.
  • zéro ligne à l'état réservé.
  • aucune ligne dans l'état de réservation en attente.
  • une ou plusieurs lignes à l'état "réservé".
  • à zéro ligne ou plus, à l'état "Refusé" par l'état du vendeur.
  • zéro ou plusieurs lignes sont annulées par l'acheteur.
  • zéro ligne dans tous les autres états.
ORDER_STATE_REJECTED_BY_SELLER

La commande contient:

  • aucune ligne dans l'état de réservation en attente.
  • zéro ligne à l'état réservé.
  • aucune ligne dans l'état de réservation en attente.
  • zéro ligne à l'état réservé.
  • une ou plusieurs lignes sont refusées par l'état du vendeur.
  • sans ligne dans les annonces annulées par l'acheteur.
  • zéro ligne dans tous les autres états.
ORDER_STATE_CANCELLED_BY_BUYER

La commande contient:

  • aucune ligne dans l'état de réservation en attente.
  • zéro ligne à l'état réservé.
  • aucune ligne dans l'état de réservation en attente.
  • zéro ligne à l'état réservé.
  • zéro ligne à l'état "Refusé" par le vendeur.
  • une ou plusieurs lignes sont annulées par l'acheteur.
  • zéro ligne dans tous les autres états.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

La commande contient:

  • une ou plusieurs lignes de réservation en attente ont expiré.
  • zéro ligne dans tous les autres états.
ORDER_STATE_RESERVED_EXPIRED

La commande contient:

  • une ou plusieurs lignes des réservations ont expiré.
  • zéro ligne dans tous les autres états.

Méthodes

get

 Récupère une commande individuelle.

list

 Liste les commandes.

patch

 Met à jour une commande existante.