Method: providers.deliveryVehicles.list

Restituisce tutti i 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 progetto Google Cloud. Ad esempio: sample-cloud-project.

Parametri di ricerca

Parametri
header

object (DeliveryRequestHeader)

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
pageSize

integer

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

string

Campo facoltativo. Un token di pagina, ricevuto da una precedente chiamata a deliveryVehicles.list. Devi fornire questi dati per 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

Campo facoltativo. Una query di filtro da applicare quando vengono elencati i veicoli per la consegna. Visita la pagina http://aip.dev/160 per alcuni esempi di sintassi dei filtri. Se non specifichi un valore o specifichi una stringa vuota per il filtro, vengono restituiti tutti i veicoli per la consegna.

Tieni presente che le uniche query supportate per deliveryVehicles.list sono relative agli attributi dei veicoli (ad esempio attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Inoltre, tutti gli attributi sono memorizzati come stringhe, pertanto gli unici confronti supportati con gli attributi sono i confronti tra stringhe. Per effettuare un confronto con valori numerici o booleani, questi devono essere racchiusi esplicitamente tra virgolette in modo da essere trattati come stringhe (ad esempio, attributes.<key> = "10" o attributes.<key> = "true").

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

object (Viewport)

Campo facoltativo. Un filtro che limita i veicoli restituiti a quelli la cui ultima posizione nota si trovava nell'area rettangolare definita dall'area visibile.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Il messaggio di risposta 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 nell'ListDeliveryVehiclesRequest per continuare a visualizzare 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 pubblicazione che corrispondono ai criteri della richiesta in tutte le pagine.

Area visibile

Un'area visibile di latitudine e longitudine, rappresentata da due punti diagonalmente opposti a low e high. Un'area visibile è considerata una regione chiusa, ovvero include il proprio confine. I limiti di latitudine devono essere compresi tra -90 e 90 gradi inclusi, mentre i limiti di longitudine devono essere compresi tra -180 e 180 gradi inclusi. Ecco alcuni casi:

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

  • Se low.longitude > high.longitude, l'intervallo di longitudine viene invertito (l'area visibile attraversa 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 causerà un errore.

Ad esempio, questa area visibile include completamente New York:

{ "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 basso dell'area visibile.
high

object (LatLng)

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