- Richiesta HTTP
- Parametri del percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Area visibile
Restituisce un elenco impaginato di veicoli associati a un fornitore che corrispondono alle opzioni di richiesta.
Richiesta HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
parent |
Obbligatorio. Deve essere nel formato |
Parametri di ricerca
Parametri | |
---|---|
header |
L'intestazione della richiesta standard di Fleet Engine. |
pageSize |
Il numero massimo di veicoli da restituire. Valore predefinito: 100. |
pageToken |
Il valore dell'attributo |
minimumCapacity |
Specifica la capacità minima richiesta del veicolo. Tutti i veicoli restituiti avranno un valore |
tripTypes[] |
Limita la risposta ai veicoli che supportano almeno uno dei tipi di corsa specificati. |
maximumStaleness |
Limita la risposta ai veicoli che hanno inviato aggiornamenti di posizione a Fleet Engine entro il periodo di tempo specificato. I veicoli fermi che continuano a trasmettere la loro posizione non sono considerati inattivi. Se presente, deve essere una durata positiva valida. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
vehicleTypeCategories[] |
Obbligatorio. Limita la risposta ai veicoli con una delle categorie di tipi specificate. Non consentito: |
requiredAttributes[] |
I chiamanti possono creare operazioni logiche complesse utilizzando qualsiasi combinazione dei campi
Limita la risposta ai veicoli con gli attributi specificati. Questo campo è un'operazione di congiunzione/AND. È consentito un massimo di 50 valori obbligatori. Corrisponde al numero massimo di attributi consentiti su un veicolo. Ogni stringa ripetuta deve essere nel formato "key:value". |
requiredOneOfAttributes[] |
Limita la risposta ai veicoli con almeno uno degli attributi specificati in ogni |
requiredOneOfAttributeSets[] |
Analogamente a
Limita la risposta ai veicoli che corrispondono a tutti gli attributi in |
vehicleState |
Limita la risposta ai veicoli con questo stato. |
onTripOnly |
Restituisci solo i veicoli con le corse attuali. |
filter |
Campo facoltativo. Una query di filtro da applicare quando vengono elencati veicoli. Visita la pagina http://aip.dev/160 per alcuni esempi di sintassi dei filtri. Questo campo è stato progettato per sostituire i campi Questo filtro funziona come una clausola AND con altri vincoli, come Tieni presente che le uniche query supportate sono relative agli attributi dei veicoli (ad esempio, Inoltre, tutti gli attributi vengono archiviati come stringhe, quindi gli unici confronti supportati con gli attributi sono quelli di 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, |
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
Messaggio di risposta vehicles.list
.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"vehicles": [
{
object ( |
Campi | |
---|---|
vehicles[] |
Veicoli che corrispondono ai criteri della richiesta. Il numero massimo di veicoli restituiti è determinato dal campo |
nextPageToken |
Token per recuperare la pagina successiva di veicoli o vuoto se non ci sono altri veicoli che soddisfano i criteri della richiesta. |
totalSize |
Obbligatorio. Numero totale di veicoli 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 ehigh.longitude
= 180 gradi, l'area visibile include tutte le longitudini.Se
low.longitude
= 180 gradi ehigh.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 ( |
Campi | |
---|---|
low |
Obbligatorio. Il punto basso dell'area visibile. |
high |
Obbligatorio. Il punto più alto dell'area visibile. |