REST Resource: orders

Risorsa: ordine

Un ordine è una raccolta di Lines che specifica quando e dove visualizzare gli annunci.

Rappresentazione JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Campi
name

string

Solo output. Il nome della risorsa dell'ordine nel formato: orders/{id}".
externalId

string

(Facoltativo) Un ID utilizzato per mappare questa entità a origini esterne.
displayName

string

Solo output. Il nome visualizzato dell'ordine.

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.
description

string

Solo output. Campo in formato libero aggiuntivo per descrivere l'ordine.
orderState

enum (OrderState)

Solo output. Rappresenta lo stato calcolato dell'ordine in base allo stato delle sue linee.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione dell'ordine.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento dell'ordine.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

Solo output. Informazioni sull'inserzionista.

OrderState

Lo stato dell'ordine.

Enum
ORDER_STATE_UNSPECIFIED Il valore predefinito quando lo stato dell'ordine non è stato specificato o è sconosciuto in questa versione.
ORDER_STATE_PENDING_RESERVATION

L'ordine contiene:

  • una o più righe con stato In attesa di prenotazione.
  • zero o più righe in stato riservato.
  • zero righe in tutti gli altri stati.
ORDER_STATE_RESERVED

L'ordine contiene:

  • con zero righe in stato di prenotazione In attesa.
  • una o più righe in stato riservato.
  • zero o più righe rifiutate dallo stato del venditore.
  • zero righe in tutti gli altri stati.
ORDER_STATE_PENDING_BOOKING

L'ordine contiene:

  • con zero righe in stato di prenotazione In attesa.
  • con zero righe in stato riservato.
  • una o più righe in stato di prenotazione in attesa.
  • zero o più righe rifiutate dallo stato del venditore.
  • zero o più righe annullate dall'acquirente.
  • zero righe in tutti gli altri stati.
ORDER_STATE_BOOKED

L'ordine contiene:

  • con zero righe in stato di prenotazione In attesa.
  • con zero righe in stato riservato.
  • con zero righe in stato di prenotazione in attesa.
  • su una o più righe in stato prenotato.
  • zero o più righe rifiutate dallo stato del venditore.
  • zero o più righe annullate dall'acquirente.
  • zero righe in tutti gli altri stati.
ORDER_STATE_REJECTED_BY_SELLER

L'ordine contiene:

  • con zero righe in stato di prenotazione In attesa.
  • con zero righe in stato riservato.
  • con zero righe in stato di prenotazione in attesa.
  • con zero righe in stato prenotato.
  • una o più righe sono rifiutate dallo stato del venditore.
  • zero righe annullate dall'acquirente.
  • zero righe in tutti gli altri stati.
ORDER_STATE_CANCELLED_BY_BUYER

L'ordine contiene:

  • con zero righe in stato di prenotazione In attesa.
  • con zero righe in stato riservato.
  • con zero righe in stato di prenotazione in attesa.
  • con zero righe in stato prenotato.
  • zero righe rifiutate dallo stato del venditore.
  • una o più righe annullate dall'acquirente.
  • zero righe in tutti gli altri stati.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

L'ordine contiene:

  • una o più righe nella prenotazione in attesa sono scadute.
  • zero righe in tutti gli altri stati.
ORDER_STATE_RESERVED_EXPIRED

L'ordine contiene:

  • una o più righe in riservato sono scadute.
  • zero righe in tutti gli altri stati.

Metodi

get

 Consente di recuperare un singolo ordine.

list

 Elenca gli ordini.

patch

 Consente di aggiornare un ordine esistente.