- Richiesta HTTP
- Parametri percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Viewport
Restituisce un elenco impaginato di veicoli associati a un fornitore che corrisponde alle opzioni della 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'elemento |
minimumCapacity |
Specifica la capacità minima richiesta per il 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 della posizione a Fleet Engine entro la durata specificata. I veicoli fissi che trasmettono ancora le loro posizioni 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 tipo specificate. Non consentito: |
requiredAttributes[] |
I chiamanti possono formare operazioni logiche complesse utilizzando qualsiasi combinazione dei campi
Limita la risposta ai veicoli con gli attributi specificati. Questo campo è un'operazione di congiunzione/AND. Sono consentiti massimo 50 attributiAttributes. 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 un |
vehicleState |
Limita la risposta ai veicoli con questo stato del veicolo. |
onTripOnly |
Restituire solo i veicoli con corse attuali. |
filter |
Campo facoltativo. Una query di filtro da applicare quando si elencano i veicoli. Vedi http://aip.dev/160 per alcuni esempi della sintassi del filtro. Questo campo è progettato per sostituire i campi Questo filtro funziona come una clausola AND con altri vincoli, ad esempio Tieni presente che le uniche query supportate sono sugli attributi dei veicoli, ad esempio Inoltre, tutti gli attributi sono memorizzati come stringhe, quindi gli unici confronti supportati per gli attributi sono stringhe. Per fare un confronto con valori numerici o booleani, i valori devono essere esplicitamente racchiusi come stringhe 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
vehicles.list
messaggio di risposta.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"vehicles": [
{
object ( |
Campi | |
---|---|
vehicles[] |
Veicoli che soddisfano i criteri della richiesta. Il numero massimo di veicoli restituiti è determinato dal campo |
nextPageToken |
Token per recuperare la pagina successiva dei 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 diagonali di fronte a low
e high
punti. Un'area visibile è considerata una regione chiusa, ovvero include il suo confine. I limiti di latitudine devono essere compresi tra -90 e 90 gradi inclusi e i limiti di longitudine devono essere compresi tra -180 e 180 gradi inclusi. Vari casi includono:
Se
low
=high
, l'area visibile è composta dal singolo punto.Se
low.longitude
>high.longitude
, l'intervallo di longitudine è invertito (l'area visibile attraversa la linea di longitudine a 180°).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 sia low
sia high
e la casella rappresentata non può essere vuota (come specificato dalle definizioni riportate sopra). Se viene visualizzata un'area visibile vuota, verrà restituito un errore.
Ad esempio, questa area visibile comprende interamente New York:
{ "low": { "longitudine": 40.477398, "longitudine": -74.259087 }, "alto": { "longitudine": 40.91618, "longitudine": -73.70018 } }
Rappresentazione JSON |
---|
{ "low": { object ( |
Campi | |
---|---|
low |
Obbligatorio. Il punto basso dell'area visibile. |
high |
Obbligatorio. Il punto più alto dell'area visibile. |