REST Resource: availabilityOrders

Ressource: AvailabilityOrder

Une commande de disponibilité est une collection de AvailabilityLines. La commande de disponibilité est créée par l'acheteur. Le vendeur met à jour la disponibilité avec la réponse.

Le workflow s'effectue comme suit :

  • L'acheteur crée une commande et des lignes de disponibilité, puis définit l'état sur "En attente". L'acheteur ne peut plus apporter de modifications à la commande ou à la ligne de disponibilité.
  • Le vendeur agit sur toutes les lignes de disponibilité en remplissant les conditions de disponibilité ou en marquant comme refusé. Les actions "Terminer" ou "Refuser" ne sont possibles que lorsque la commande et les lignes sont à l'état "En attente".
  • Le vendeur utilise l'action personnalisée complete pour marquer la demande de disponibilité comme terminée. Une fois l'opération terminée, vous n'êtes plus autorisé à modifier l'ordre de disponibilité ni les lignes enfants.
Représentation JSON 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "pendingExpirationTime": string,
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la commande de disponibilité au format availabilityOrders/{id}.
description

string

Uniquement en sortie. Champ de forme libre supplémentaire pour décrire la commande de disponibilité.
state

enum (State)

Uniquement en sortie. État de cette commande de disponibilité. Consultez la section AvailabilityOrder.State pour connaître le cycle de vie d'un objet AvailabilityOrder.

Le vendeur peut utiliser la méthode personnalisée Complete pour la définir sur STATE_COMPLETED.
pendingExpirationTime

string (Timestamp format)

Uniquement en sortie. Code temporel d'expiration de la commande avec disponibilité en attente. Le vendeur doit terminer la commande avant l'expiration d'une commande avec disponibilité en attente, sans quoi celle-ci sera considérée comme terminée et sans disponibilité.

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".
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de création Attribué par le système.

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. Attribué par le système.

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.

État

Valeurs possibles pour l'état de la commande de disponibilité.

Enums
STATE_UNSPECIFIED Valeur par défaut lorsque l'état de la commande de disponibilité n'a pas été spécifié ou est inconnu dans cette version.
STATE_PENDING Disponibilité en attente lorsque l'acheteur a défini les paramètres de la demande de disponibilité.
STATE_COMPLETED État de disponibilité terminé lorsque le vendeur a fourni la réponse de disponibilité pour toutes les lignes.
STATE_CANCELLED État de disponibilité annulé lorsque l'acheteur a envoyé la demande d'annulation avant que le vendeur ne fournisse la réponse de disponibilité pour toutes les lignes.
STATE_EXPIRED État de disponibilité expirée lorsque la commande a expiré avant que le vendeur ne l'ait finalisée.

Méthodes

complete

 Marque une commande de disponibilité existante comme terminée.

get

 Récupère une commande de disponibilité individuelle.

list

 Liste les commandes de disponibilité.