- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Waypoint
- VehicleMatchType
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 |
Obbligatoria. Deve essere nel formato |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "header": { object ( |
Campi | |
---|---|
header |
L'intestazione della richiesta standard Fleet Engine. |
pickupPoint |
Obbligatoria. Il punto di prelievo da cercare nelle vicinanze. |
dropoffPoint |
La località di consegna prevista del cliente. Il campo è obbligatorio se |
pickupRadiusMeters |
Obbligatoria. 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 |
Obbligatoria. Specifica il numero massimo di veicoli da restituire. Il valore deve essere compreso tra 1 e 50 (inclusi). |
minimumCapacity |
Obbligatoria. Specifica il numero di passeggeri presi in considerazione per una corsa. Il valore deve essere maggiore o uguale a 1. Il conducente non è considerato nel valore della capacità. |
tripTypes[] |
Obbligatoria. Rappresenta il tipo di viaggio proposto. Deve includere esattamente un tipo. Non consentito: |
maximumStaleness |
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 propria posizione non sono considerati inattivi. Se questo campo non viene configurato, il server utilizza il valore predefinito di cinque minuti. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
vehicleTypes[] |
Obbligatoria. Limita la ricerca ai veicoli con uno dei tipi specificati. È necessario specificare almeno un tipo di veicolo. I VehicleType con una categoria di |
requiredAttributes[] |
I chiamanti possono creare operazioni logiche complesse utilizzando qualsiasi combinazione dei campi
Limita la ricerca solo ai veicoli con gli attributi specificati. Questo campo è un'operazione di congiunzione/AND. È consentito un massimo di 50 requiredAttributes. Corrisponde al numero massimo di attributi consentiti su un veicolo. |
requiredOneOfAttributes[] |
Limita la ricerca solo ai veicoli con almeno uno degli attributi specificati in ogni |
requiredOneOfAttributeSets[] |
Simile a
Limita la ricerca solo ai veicoli con tutti gli attributi in un |
orderBy |
Obbligatoria. Specifica il criterio di ordinamento desiderato per i risultati. |
includeBackToBack |
Indica se i veicoli con una singola corsa attiva sono idonei per questa ricerca. Questo campo viene utilizzato solo quando Il valore predefinito è |
tripId |
Indica la corsa associata a questo |
currentTripsPresent |
Indica se i veicoli con corse attive sono idonei per questa ricerca. Deve essere impostato su un valore diverso da |
filter |
Campo facoltativo. Una query di filtro da applicare per la ricerca di veicoli. Vedi http://aip.dev/160 per esempi di sintassi del filtro. Questo campo è progettato per sostituire i campi Questo filtro funziona come una clausola AND con altri vincoli, come Tieni presente che le uniche query supportate sono relative agli attributi dei veicoli (ad es. Inoltre, tutti gli attributi vengono memorizzati come stringhe, pertanto gli unici confronti supportati con gli attributi sono i confronti di stringhe. Per eseguire un confronto con valori numerici o booleani, i valori devono essere racchiusi esplicitamente tra virgolette per essere trattati come stringhe (ad esempio |
Corpo della risposta
vehicles.search
messaggio di risposta.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"matches": [
{
object ( |
Campi | |
---|---|
matches[] |
Elenco di veicoli che soddisfano i criteri |
VehicleAttributeList
Un tipo di dati elenco di elenchi per gli attributi del veicolo.
Rappresentazione JSON |
---|
{
"attributes": [
{
object ( |
Campi | |
---|---|
attributes[] |
Un elenco di attributi in questa raccolta. |
VehicleMatchOrder
Specifica l'ordine del veicolo corrispondente nella risposta.
Enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Predefinita, utilizzata per veicoli non specificati o non riconosciuti corrispondenti all'ordine. |
PICKUP_POINT_ETA |
Ordine crescente in base al tempo di guida del veicolo fino al punto di ritiro. |
PICKUP_POINT_DISTANCE |
Ordine crescente in base alla distanza percorsa dal veicolo fino al punto di ritiro. |
DROPOFF_POINT_ETA |
Ordine crescente per tempo di guida del veicolo fino al punto di consegna. Questo ordine può essere utilizzato solo se nella richiesta è specificato il punto di consegna. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Ordine crescente in base alla distanza in linea retta dall'ultima posizione segnalata del veicolo al punto di prelievo. |
COST |
Ordine crescente in base al costo di corrispondenza configurato. Il costo di corrispondenza è definito come un calcolo ponderato tra la distanza in linea retta e l'orario di arrivo stimato. Le ponderazioni vengono impostate con valori predefiniti e possono essere modificate per cliente. Contatta l'Assistenza Google se devi modificare questi pesi per il tuo progetto. |
CurrentTripsPresent
Specifica i tipi di limitazioni per le corse correnti di un veicolo.
Enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
La disponibilità dei veicoli con corse presenti è regolata dal campo includeBackToBack . |
NONE |
I veicoli privi di corsa possono essere visualizzati nei risultati di ricerca. Se viene utilizzato questo valore, il valore includeBackToBack non può essere true . |
ANY |
Nei risultati di ricerca sono inclusi i veicoli con al massimo 5 corse correnti e 10 tappe. Se viene utilizzato questo valore, il valore includeBackToBack non può essere true . |
VehicleMatch
Contiene il veicolo e le stime correlate per un veicolo che corrispondono ai punti delle corse attive per il veicolo SearchVehiclesRequest
.
Rappresentazione JSON |
---|
{ "vehicle": { object ( |
Campi | |
---|---|
vehicle |
Obbligatoria. Un veicolo che soddisfa la richiesta. |
vehiclePickupEta |
L'orario di arrivo stimato del veicolo fino al punto di prelievo specificato nella richiesta. Un valore vuoto indica un errore nel calcolo dell'orario di arrivo stimato per il veicolo. Se Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
vehiclePickupDistanceMeters |
La distanza dalla posizione attuale del veicolo al punto di prelievo specificato nella richiesta, inclusi eventuali punti di prelievo o di discesa intermedi per le corse esistenti. Questa distanza comprende la distanza calcolata in auto (percorso) e la distanza in linea retta tra il punto di arrivo della navigazione e il punto di prelievo richiesto. (La distanza tra il punto di arrivo della navigazione e il punto di prelievo richiesto è in genere ridotta.) Un valore vuoto indica un errore nel calcolo della distanza. |
vehiclePickupStraightLineDistanceMeters |
Obbligatoria. La distanza in linea retta tra il veicolo e il punto di prelievo specificato nella richiesta. |
vehicleDropoffEta |
L'orario di arrivo stimato di guida del veicolo completo fino al punto di consegna specificato nella richiesta. L'orario di arrivo stimato include la sosta in qualsiasi waypoint prima del giorno Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
vehiclePickupToDropoffDistanceMeters |
La distanza percorsa dal veicolo (in metri) dal punto di prelievo al punto di consegna specificato nella richiesta. La distanza è solo tra i due punti e non include la posizione del veicolo o altri punti che devono essere visitati prima che il veicolo visiti il punto di prelievo o di discesa. Il valore verrà compilato solo quando nella richiesta viene specificato un |
tripType |
Obbligatoria. Il tipo di corsa della richiesta utilizzata per calcolare l'orario di arrivo stimato al punto di prelievo. |
vehicleTripsWaypoints[] |
L'elenco ordinato di waypoint utilizzati per calcolare l'orario di arrivo stimato. L'elenco include la posizione del veicolo, i punti di prelievo delle corse attive per il veicolo e i punti di prelievo forniti nella richiesta. Un elenco vuoto indica un errore nel calcolo dell'orario di arrivo stimato per il veicolo. |
vehicleMatchType |
Tipo di corrispondenza del veicolo. |
requestedOrderedBy |
L'ordine richiesto per ordinare le corrispondenze dei veicoli. |
orderedBy |
L'ordine effettivo utilizzato per questo veicolo. Normalmente corrisponde al campo "orderBy" della richiesta; tuttavia, in determinate circostanze, ad esempio in un errore interno del server, è possibile utilizzare un metodo diverso (ad esempio |
Waypoint
Descrive i punti intermedi lungo un percorso per un VehicleMatch
in un SearchVehiclesResponse
. Questo concetto è rappresentato come TripWaypoint
in tutti gli altri endpoint.
Rappresentazione JSON |
---|
{
"latLng": {
object ( |
Campi | |
---|---|
latLng |
La posizione di questo waypoint. |
eta |
L'ora stimata di arrivo del veicolo a questo waypoint. Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
VehicleMatchType
Tipo di corrispondenza del veicolo.
Enum | |
---|---|
UNKNOWN |
Tipo di corrispondenza veicolo sconosciuto |
EXCLUSIVE |
Al momento non è stato assegnato alcun percorso al veicolo, pertanto puoi procedere fino al punto di prelievo. |
BACK_TO_BACK |
Il veicolo è attualmente assegnato a una corsa, ma può procedere al punto di ritiro una volta completata la corsa in corso. I calcoli dell'orario di arrivo stimato e della distanza tengono conto della corsa esistente. |
CARPOOL |
Il veicolo ha una capacità sufficiente per un giro condiviso. |
CARPOOL_BACK_TO_BACK |
Il veicolo completerà la corsa attuale e attiva prima di raggiungere il punto di prelievo. I calcoli dell'orario di arrivo stimato e della distanza tengono conto della corsa esistente. |