REST Resource: orders.lines

Ressource: Ligne

Ligne de commande unique représentant un produit configuré.

Représentation JSON 
{
  "name": string,
  "product": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "lineState": enum (LineState),
  "rejection": {
    object (Rejection)
  },
  "startTime": string,
  "endTime": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "lineTerms": {
    object (LineTerms)
  },
  "pendingReservationExpirationTime": string,
  "reservationExpirationTime": string,
  "targeting": {
    object (Targeting)
  },
  "createTime": string,
  "updateTime": string
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la ligne au format orders/{order_id}/lines/{id}.
product

string

Uniquement en sortie. Nom du Product configuré par cette ligne. Format = products/123
externalId

string

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

string

Uniquement en sortie. Nom à afficher pour la ligne.
description

string

Uniquement en sortie. Champ de forme libre supplémentaire pour décrire la ligne.
lineState

enum (LineState)

Uniquement en sortie. État de la ligne. Consultez LineState pour connaître le cycle de vie d'une ligne.

Le vendeur peut utiliser les méthodes personnalisées suivantes: Reserve, Book et Reject pour définir l'une des méthodes suivantes:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

Tous les autres états de ligne sont définis par l'acheteur.
rejection

object (Rejection)

Facultatif. Détails du refus pour la ligne concernée.
startTime
(deprecated)

string (Timestamp format)

Uniquement en sortie. Date de début de diffusion de la ligne (incluse).

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".
endTime
(deprecated)

string (Timestamp format)

Uniquement en sortie. Date à laquelle la diffusion de la ligne est interrompue (exclusif).

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

object (Date)

Uniquement en sortie. Date à laquelle la ligne commencera à être diffusée (incluse). Même fuseau horaire que celui du bloc d'annonces.
endDate

object (Date)

Uniquement en sortie. Date de fin de diffusion de la ligne (incluse). Même fuseau horaire que celui du bloc d'annonces.
budget

object (Money)

Uniquement en sortie. Budget de la ligne.
lineTerms

object (LineTerms)

Uniquement en sortie. Conditions de garantie du vendeur pour cette ligne.
pendingReservationExpirationTime

string (Timestamp format)

Uniquement en sortie. Code temporel d'expiration de la réservation en attente. Le vendeur doit effectuer une réservation ou la refuser avant l'expiration d'une réservation en attente, sans quoi elle sera considérée comme refusée.

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

string (Timestamp format)

Uniquement en sortie. Code temporel d'expiration de la réservation. L'acheteur doit effectuer la réservation avant son expiration. Dans le cas contraire, elle sera considérée comme annulée.

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

object (Targeting)

Uniquement en sortie. Ciblage de la ligne.
createTime

string (Timestamp format)

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

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 ligne.

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

LineState

État d'une ligne.

Enums
LINE_STATE_UNSPECIFIED Valeur par défaut lorsque l'état de la ligne n'a pas été spécifié ou est inconnu dans cette version.
LINE_STATE_PENDING_RESERVATION La ligne a été créée par l'acheteur et demande à ce que les produits soient réservés et mis à jour avec les informations de prix et de disponibilité.
LINE_STATE_RESERVED La ligne a été réservée par le vendeur. Cet état n'est possible que si l'état précédent est en attente de réservation.
LINE_STATE_PENDING_BOOKING L'acheteur a accepté la réservation et demande la réservation de la ligne.
LINE_STATE_BOOKED Le vendeur a réservé la ligne. Cet état n'est possible que si l'état précédent est en attente de réservation. Aucun refus n'est attendu pour le moment.
LINE_STATE_REJECTED_BY_SELLER Le vendeur a refusé la ligne. Cet état n'est possible que si l'état précédent est en attente de réservation.
LINE_STATE_CANCELLED_BY_BUYER La ligne a été annulée par l'acheteur.
LINE_STATE_PENDING_RESERVATION_EXPIRED La ligne a expiré pendant la réservation en attente.
LINE_STATE_RESERVED_EXPIRED La ligne a expiré alors qu'elle était réservée, en attente de la réponse de l'acheteur.

Méthodes

book

 Consigne une ligne existante.

get

 Récupère une ligne individuelle d'un ordre.

list

 Liste les lignes d'un ordre.

patch

 Met à jour une ligne existante.

reject

 Rejete une ligne existante.

reserve

 Réserve une ligne existante.