Method: providers.vehicles.search

{
  "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
}

object (RequestHeader)

L'intestazione della richiesta di Fleet Engine standard.

object (TerminalLocation)

Obbligatorio. Il punto di ritiro nelle vicinanze in cui effettuare la ricerca.

object (TerminalLocation)

La località di consegna prevista dal cliente. Il campo è obbligatorio se tripTypes contiene TripType.SHARED.

integer

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

integer

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

integer

Obbligatorio. Specifica il numero di passeggeri presi in considerazione per un viaggio. Il valore deve essere maggiore o uguale a 1. Il conducente non viene considerato nel valore della capacità.

enum (TripType)

Obbligatorio. Rappresenta il tipo di viaggio proposto. Deve includere esattamente un tipo. Non consentito: UNKNOWN_TRIP_TYPE. Restringe la ricerca solo ai veicoli in grado di supportare quel tipo di viaggio.

string (Duration format)

Limita la ricerca 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 questo campo non è 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".

object (VehicleType)

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

object (VehicleAttribute)

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 ricerca ai veicoli con gli attributi specificati. Questo campo è un'operazione congiunzione/AND. È consentito un massimo di 50 attributi obbligatori. Corrisponde al numero massimo di attributi consentiti per un veicolo.

object (VehicleAttributeList)

Limita la ricerca ai soli 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.

object (VehicleAttributeList)

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 ricerca solo ai veicoli con 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.

enum (VehicleMatchOrder)

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

boolean

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

Il valore predefinito è false.

string

Indica il viaggio associato a SearchVehicleRequest.

enum (CurrentTripsPresent)

Indica se i 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.

string

(Facoltativo) Una query filtro da applicare durante la ricerca di 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 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, ad esempio minimumCapacity o vehicleTypes.

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 memorizzati come stringhe, pertanto gli unici confronti supportati con gli attributi sono quelli 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").