Method: providers.deliveryVehicles.list

Restituisce tutti i valori DeliveryVehicle che soddisfano i criteri di filtro specificati.

Richiesta HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Deve essere nel formato providers/{provider}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project.

Parametri di query

Parametri
header

object (DeliveryRequestHeader)

(Facoltativo) L'intestazione della richiesta API Delivery standard.
pageSize

integer

(Facoltativo) Il numero massimo di veicoli da restituire. Il servizio potrebbe restituire un numero inferiore a questo. Se non specifichi questo numero, il server determina il numero di risultati da restituire.
pageToken

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata a deliveryVehicles.list. Devi fornirlo per poter recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a deliveryVehicles.list devono corrispondere alla chiamata che ha fornito il token della pagina.
filter

string

(Facoltativo) Una query di filtro da applicare quando vengono elencati i veicoli per la consegna. Vedi http://aip.dev/160 per esempi di sintassi dei filtri. Se non specifichi un valore o specifichi una stringa vuota per il filtro, verranno restituiti tutti i veicoli per la consegna.

Tieni presente che le uniche query supportate per deliveryVehicles.list riguardano gli attributi del veicolo (ad es. attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Inoltre, tutti gli attributi vengono memorizzati come stringhe, pertanto gli unici confronti supportati con gli attributi sono quelli di stringhe. Per eseguire il confronto con valori numerici o booleani, i valori devono essere tra virgolette in modo esplicito per essere trattati come stringhe (ad esempio, attributes.<key> = "10" o attributes.<key> = "true").

Il numero massimo di restrizioni consentite in una query di filtro è 50. Una restrizione fa parte della query nel formato attribute.<KEY> <COMPARATOR> <VALUE>, ad esempio attributes.foo = bar è 1 restrizione.
viewport

object (Viewport)

(Facoltativo) Un filtro che limita i veicoli restituiti a quelli la cui ultima posizione nota era nell'area rettangolare definita dall'area visibile.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Il messaggio di risposta di deliveryVehicles.list.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campi
deliveryVehicles[]

object (DeliveryVehicle)

L'insieme di veicoli per la consegna che soddisfano i criteri di filtro richiesti. Se non viene specificato alcun filtro, la richiesta restituisce tutti i veicoli per la consegna. Una risposta corretta può anche essere vuota. Una risposta vuota indica che non sono stati trovati veicoli per la consegna che soddisfano i criteri di filtro richiesti.
nextPageToken

string

Puoi passare questo token in ListDeliveryVehiclesRequest per continuare a elencare i risultati. Quando vengono restituiti tutti i risultati, questo campo non sarà presente nella risposta o sarà una stringa vuota.
totalSize

string (int64 format)

Il numero totale di veicoli per la consegna che corrispondono ai criteri della richiesta, in tutte le pagine.

Area visibile

Un'area visibile di latitudine e longitudine, rappresentata come due punti diagonalmente opposti a low e high. Un'area visibile è considerata un'area chiusa, ovvero include il proprio confine. I limiti di latitudine devono essere compresi tra -90 e 90 gradi inclusi, mentre quelli di longitudine devono essere compresi tra -180 e 180 gradi inclusi. I vari casi includono:

  • Se low = high, l'area visibile è composta da quel singolo punto.

  • Se low.longitude > high.longitude, l'intervallo di longitudine è invertito (l'area visibile supera la linea di longitudine di 180 gradi).

  • Se low.longitude = -180 gradi e high.longitude = 180 gradi, l'area visibile include tutte le longitudini.

  • Se low.longitude = 180 gradi e high.longitude = -180 gradi, l'intervallo di longitudine è vuoto.

  • Se low.latitude > high.latitude, l'intervallo di latitudine è vuoto.

È necessario compilare entrambi i campi low e high e la casella rappresentata non può essere vuota (come specificato dalle definizioni precedenti). Un'area visibile vuota genererà un errore.

Ad esempio, questa area visibile racchiude completamente New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 }

Rappresentazione JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campi
low

object (LatLng)

Obbligatorio. Il punto inferiore dell'area visibile.
high

object (LatLng)

Obbligatorio. Il punto più alto dell'area visibile.