Method: providers.vehicles.search

Restituisce un elenco di veicoli che corrispondono alle opzioni di richiesta.

Richiesta HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search

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.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
Campi
header

object (RequestHeader)

L'intestazione della richiesta standard di Fleet Engine.

pickupPoint

object (TerminalLocation)

Obbligatorio. Il punto di prelievo da cercare nelle vicinanze.

dropoffPoint

object (TerminalLocation)

Il punto di consegna previsto dal cliente. Il campo è obbligatorio se tripTypes contiene TripType.SHARED.

pickupRadiusMeters

integer

Obbligatorio. Definisce il raggio di ricerca del veicolo intorno al punto di prelievo. Verranno restituiti solo i veicoli all'interno del raggio di ricerca. Il valore deve essere compreso tra 400 e 10.000 metri (inclusi).

count

integer

Obbligatorio. Specifica il numero massimo di veicoli da restituire. Il valore deve essere compreso tra 1 e 50 (inclusi).

minimumCapacity

integer

Obbligatorio. Specifica il numero di passeggeri presi in considerazione per una corsa. Il valore deve essere maggiore o uguale a uno. Il conducente non è considerato nel valore della capacità.

tripTypes[]

enum (TripType)

Obbligatorio. Rappresenta il tipo di corsa proposta. Deve includere esattamente un tipo. Non consentito: UNKNOWN_TRIP_TYPE. Limita la ricerca solo ai veicoli che supportano quel tipo di corsa.

maximumStaleness

string (Duration format)

Limita la ricerca solo 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 questo campo non viene impostato, il server utilizza cinque minuti come valore predefinito.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

vehicleTypes[]

object (VehicleType)

Obbligatorio. Limita la ricerca ai veicoli con uno dei tipi specificati. È necessario specificare almeno un tipo di veicolo. I VehicleType con categoria UNKNOWN non sono consentiti.

requiredAttributes[]

object (VehicleAttribute)

I chiamanti possono creare 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 ricerca solo 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.

requiredOneOfAttributes[]

object (VehicleAttributeList)

Limita la ricerca solo 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 rappresenta un'operazione di disgiunzione/OR inclusiva in ogni VehicleAttributeList e un'operazione di congiunzione/AND nella raccolta di VehicleAttributeList.

requiredOneOfAttributeSets[]

object (VehicleAttributeList)

requiredOneOfAttributeSets fornisce funzionalità aggiuntive.

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

(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 ricerca solo ai veicoli con tutti gli attributi in un VehicleAttributeList. In ogni elenco, un veicolo deve corrispondere a tutti gli attributi. Questo campo è un'operazione di congiunzione/AND in ogni operazione VehicleAttributeList e disgiunzione/OR inclusiva nella raccolta di VehicleAttributeList.

orderBy

enum (VehicleMatchOrder)

Obbligatorio. Specifica il criterio di ordinamento desiderato per i risultati.

includeBackToBack

boolean

Indica se veicoli con una singola corsa attiva sono idonei per questa ricerca. Questo campo viene utilizzato solo quando currentTripsPresent non è specificato. Se currentTripsPresent non è specificato e questo campo è false, i veicoli con corse assegnate vengono esclusi dai risultati di ricerca. Se currentTripsPresent non è specificato e questo campo è true, i risultati di ricerca possono includere i veicoli con una corsa attiva con stato ENROUTE_TO_DROPOFF. Se currentTripsPresent è specificato, questo campo non può essere impostato su true.

Il valore predefinito è false.

tripId

string

Indica la corsa associata a questo SearchVehicleRequest.

currentTripsPresent

enum (CurrentTripsPresent)

Indica se veicoli con corse attive sono idonei per questa ricerca. Deve essere impostato su un valore diverso da CURRENT_TRIPS_PRESENT_UNSPECIFIED se tripType include SHARED.

filter

string

Campo facoltativo. Una query di filtro da applicare durante la ricerca di veicoli. Visita la pagina http://aip.dev/160 per alcuni esempi di sintassi dei filtri.

Questo campo è stato progettato per sostituire i campi requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets. Se qui 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, come minimumCapacity o vehicleTypes.

Tieni presente che le uniche query supportate sono relative agli attributi dei veicoli (ad esempio, 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, 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, attributes.<key> = "10" o attributes.<key> = "true").

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di SearchVehiclesResponse.