Method: providers.vehicles.list

Restituisce un elenco impaginato di veicoli associati a un fornitore che corrisponde 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

string

Obbligatorio. Deve essere nel formato providers/{provider}. Il provider deve essere l'ID progetto (ad esempio sample-cloud-project) del progetto Google Cloud di cui l'account di servizio che effettua questa chiamata è membro.

Parametri di query

Parametri
header

object (RequestHeader)

L'intestazione della richiesta di Fleet Engine standard.
pageSize

integer

Il numero massimo di veicoli da restituire. Valore predefinito: 100.
pageToken

string

Il valore del valore nextPageToken fornito da una precedente chiamata a vehicles.list per consentire l'impaginazione in base ai gruppi di veicoli. Il valore è non definito se i criteri di filtro della richiesta non sono gli stessi della chiamata precedente a vehicles.list.
minimumCapacity

integer

Specifica la capacità minima richiesta del veicolo. Tutti i veicoli restituiti avranno un valore maximumCapacity maggiore o uguale a questo valore. Se impostato, deve essere maggiore o uguale a 0.
tripTypes[]

enum (TripType)

Limita la risposta ai veicoli che supportano almeno uno dei tipi di corsa specificati.
maximumStaleness

string (Duration format)

Limita la risposta ai veicoli che hanno inviato aggiornamenti di posizione a Fleet Engine entro il periodo di tempo specificato. I veicoli fissi che trasmettono ancora 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 "s". Esempio: "3.5s".
vehicleTypeCategories[]

enum (Category)

Obbligatorio. Limita la risposta ai veicoli con una delle categorie di tipo specificate. Non consentito: UNKNOWN.
requiredAttributes[]

string

I chiamanti possono formare operazioni logiche complesse utilizzando qualsiasi combinazione dei campi requiredAttributes, requiredOneOfAttributes e requiredOneOfAttributeSets.

requiredAttributes è un elenco; requiredOneOfAttributes utilizza un messaggio che consente un elenco di elenchi. La combinazione dei due campi consente di comporre questa espressione:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

Limita la risposta ai veicoli con gli attributi specificati. Questo campo è un'operazione di congiunzione/AND. Sono consentiti massimo 50 attributi obbligatori. Corrisponde al numero massimo di attributi consentiti su un veicolo. Ogni stringa ripetuta deve avere il formato "chiave:valore".
requiredOneOfAttributes[]

string

Limita la risposta ai veicoli con almeno uno degli attributi specificati in ogni VehicleAttributeList. All'interno di ogni elenco, un veicolo deve corrispondere ad almeno uno degli attributi. Questo campo è un'operazione di disgiunzione inclusiva/OR in ogni VehicleAttributeList e un'operazione di congiunzione/AND nella raccolta di VehicleAttributeList. Ogni stringa ripetuta deve avere il formato "chiave1:valore1|chiave2:valore2|chiave3:valore3".
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets fornisce funzionalità aggiuntive.

Analogamente a requiredOneOfAttributes, requiredOneOfAttributeSets utilizza un messaggio che consente un elenco di elenchi, consentendo espressioni come questa:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Limita la risposta ai veicoli che corrispondono a tutti gli attributi in un VehicleAttributeList. All'interno di ogni elenco, un veicolo deve corrispondere a tutti gli attributi. Questo campo è un'operazione di congiunzione/AND in ogni operazione VehicleAttributeList e di disgiunzione/OR incluse nella raccolta di VehicleAttributeList. Ogni stringa ripetuta deve avere il formato "chiave1:valore1|chiave2:valore2|chiave3:valore3".
vehicleState

enum (VehicleState)

Limita la risposta ai veicoli con questo stato.
onTripOnly

boolean

Restituisci solo i veicoli con le corse in corso.
filter

string

(Facoltativo) Una query di filtro da applicare alla scheda dei veicoli. Visita la pagina http://aip.dev/160 per esempi di sintassi dei filtri.

Questo campo è progettato per sostituire i campi requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets. Se in questo campo viene specificato un valore non vuoto, i seguenti campi devono essere vuoti: requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets.

Questo filtro funziona come una clausola AND con altri vincoli, ad esempio vehicleState o onTripOnly.

Tieni presente che le uniche query supportate riguardano gli attributi del veicolo (ad es. attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Il numero massimo di limitazioni consentite in una query di filtro è 50.

Inoltre, tutti gli attributi vengono archiviati come stringhe, pertanto gli unici confronti supportati per gli attributi sono i confronti 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").
viewport

object (Viewport)

(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 (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campi
vehicles[]

object (Vehicle)

Veicoli che corrispondono ai criteri della richiesta. Il numero massimo di veicoli restituiti è determinato dal campo pageSize della richiesta.
nextPageToken

string

Token per recuperare la pagina successiva dei veicoli o vuoto se non ci sono altri veicoli che soddisfano i criteri della richiesta.
totalSize

string (int64 format)

Obbligatorio. Numero totale di veicoli corrispondenti 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 viewport è considerato una regione chiusa, ovvero include il suo 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. 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 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.

Sia low che high devono essere compilati e la casella rappresentata non può essere vuota (come specificato dalle definizioni precedenti). Un viewport vuoto comporterà un errore.

Ad esempio, questa visualizzazione inclusa racchiude 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 più basso dell'area visibile.
high

object (LatLng)

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