Method: providers.vehicles.list

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

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 la chiamata è membro.

Parametri di ricerca

Parametri
header

object (RequestHeader)

L'intestazione della richiesta standard di Fleet Engine.

pageSize

integer

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

pageToken

string

Il valore dell'elemento nextPageToken fornito da una chiamata precedente a vehicles.list in modo da poter impaginare i gruppi di veicoli. Il valore non è definito se i criteri del filtro della richiesta non corrispondono a quelli della chiamata precedente a vehicles.list.

minimumCapacity

integer

Specifica la capacità minima richiesta per il 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 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 "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. In combinazione, i due campi consentono la composizione di 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 attributiAttributes. Corrisponde al numero massimo di attributi consentiti su un veicolo. Ogni stringa ripetuta deve essere nel formato "key:value".

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 disgiuntiva/OR inclusiva in ogni VehicleAttributeList e un'operazione di congiunzione/AND nella raccolta di VehicleAttributeList. Ogni stringa ripetuta deve essere nel formato "key1:value1|key2:value2|key3:value3".

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets fornisce funzionalità aggiuntive.

Analogamente a requiredOneOfAttributes, requiredOneOfAttributeSets utilizza un messaggio che consente un elenco di elenchi, che consentono 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 congiuntiva/AND in ogni VehicleAttributeList e l'operazione disgiuntiva/OR inclusiva nella raccolta di VehicleAttributeList. Ogni stringa ripetuta deve essere nel formato "key1:value1|key2:value2|key3:value3".

vehicleState

enum (VehicleState)

Limita la risposta ai veicoli con questo stato del veicolo.

onTripOnly

boolean

Restituire solo i veicoli con corse attuali.

filter

string

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 requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets. Se qui viene specificato un valore non vuoto, i campi seguenti 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 sono sugli attributi dei veicoli, ad esempio attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>. Il numero massimo di limitazioni consentito in una query di filtro è 50.

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 attributes.<key> = "10" o attributes.<key> = "true").

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

vehicles.list messaggio di risposta.

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 soddisfano i criteri della richiesta. Il numero massimo di veicoli restituiti è determinato dal campo pageSize nella 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 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 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 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 (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.