- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Waypoint
- VehicleMatchType
Restituisce un elenco di veicoli corrispondenti 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 |
Obbligatorio. 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 Fleet Engine standard. |
pickup |
Obbligatorio. Il punto di ritiro nelle vicinanze in cui effettuare la ricerca. |
dropoff |
La località di consegna prevista dal cliente. Il campo è obbligatorio se |
pickup |
Obbligatorio. Definisce il raggio di ricerca dei veicoli intorno al punto di ritiro. Verranno restituiti solo i veicoli all'interno del raggio di ricerca. Il valore deve essere compreso tra 400 e 10000 metri (inclusi). |
count |
Obbligatorio. Specifica il numero massimo di veicoli da restituire. Il valore deve essere compreso tra 1 e 50 (inclusi). |
minimum |
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à. |
trip |
Obbligatorio. Rappresenta il tipo di viaggio proposto. Deve includere esattamente un tipo. Non consentito: |
maximum |
Limita la ricerca solo ai veicoli che hanno inviato aggiornamenti sulla posizione a Fleet Engine entro la durata specificata. I veicoli fermi che continuano a trasmettere la propria 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 " |
vehicle |
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 |
required |
I chiamanti possono formare 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 attributi obbligatori. Corrisponde al numero massimo di attributi consentiti per un veicolo. |
required |
Limita la ricerca solo ai veicoli con almeno uno degli attributi specificati in ogni |
required |
Analogamente a
Limita la ricerca solo ai veicoli con tutti gli attributi in un |
order |
Obbligatorio. Specifica il criterio di ordinamento desiderato per i risultati. |
include |
Indica se i veicoli con una singola corsa attiva sono idonei per questa ricerca. Questo campo viene utilizzato solo quando Il valore predefinito è |
trip |
Indica il viaggio associato a questo |
current |
Indica se i veicoli con viaggi attivi sono idonei per questa ricerca. Questo valore deve essere impostato su un valore diverso da |
filter |
Facoltativo. Una query filtro da applicare durante la ricerca dei veicoli. Visita la pagina http://aip.dev/160 per esempi di sintassi dei filtri. Questo campo è progettato per sostituire i campi Questo filtro funziona come una clausola AND con altri vincoli, ad esempio Tieni presente che le uniche query supportate riguardano gli attributi del veicolo (ad es. Inoltre, tutti gli attributi vengono archiviati come stringhe, pertanto gli unici confronti supportati per gli attributi sono i confronti di stringhe. Per il confronto con valori numerici o booleani, i valori devono essere racchiusi tra virgolette esplicite per essere trattati come stringhe (ad esempio |
Corpo della risposta
Messaggio di risposta vehicles.search
.
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 delle corrispondenze del veicolo nella risposta.
Enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Valore predefinito, utilizzato per l'ordine delle corrispondenze dei veicoli non specificati o non riconosciuti. |
PICKUP_POINT_ETA |
In ordine crescente in base al tempo di guida del veicolo fino al punto di ritiro. |
PICKUP_POINT_DISTANCE |
Ordine crescente in base alla distanza in auto del veicolo dal punto di ritiro. |
DROPOFF_POINT_ETA |
Ordinamento in ordine crescente in base al tempo di guida del veicolo fino al punto di consegna. Questo ordine può essere utilizzato solo se il punto di consegna è specificato nella richiesta. |
PICKUP_POINT_STRAIGHT_DISTANCE |
In ordine crescente in base alla distanza in linea retta dall'ultima posizione segnalata del veicolo al punto di ritiro. |
COST |
In ordine crescente in base al costo di corrispondenza configurato. Il costo della corrispondenza è definito come un calcolo ponderato tra la distanza in linea retta e l'orario di arrivo stimato. I pesi vengono impostati con valori predefiniti e possono essere modificati in base al cliente. Contatta l'Assistenza Google se questi pesi devono essere modificati per il tuo progetto. |
CurrentTripsPresent
Specifica i tipi di limitazioni per i viaggi attuali di un veicolo.
Enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
La disponibilità dei veicoli con corse presenti è regolata dal campo includeBackToBack . |
NONE |
I veicoli senza corse possono essere visualizzati nei risultati di ricerca. Quando viene utilizzato questo valore, includeBackToBack non può essere true . |
ANY |
Nei risultati di ricerca sono inclusi i veicoli con al massimo 5 corse in corso e 10 waypoint. Quando viene utilizzato questo 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 |
Obbligatorio. Un veicolo che corrisponde alla richiesta. |
vehicle |
L'orario di arrivo stimato del veicolo al punto di ritiro specificato nella richiesta. Un valore vuoto indica un errore nel calcolo dell'orario di arrivo stimato del veicolo. Se Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: |
vehicle |
La distanza dalla posizione attuale del veicolo al punto di ritiro specificato nella richiesta, inclusi eventuali punti di ritiro o di consegna intermedi per i viaggi esistenti. Questa distanza comprende la distanza calcolata in auto (percorso), più la distanza in linea retta tra il punto di arrivo della navigazione e il punto di ritiro richiesto. La distanza tra il punto di arrivo della navigazione e il punto di ritiro richiesto è in genere ridotta. Un valore vuoto indica un errore nel calcolo della distanza. |
vehicle |
Obbligatorio. La distanza in linea retta tra il veicolo e il punto di ritiro specificato nella richiesta. |
vehicle |
L'orario di arrivo stimato del veicolo al punto di consegna specificato nella richiesta. L'orario di arrivo stimato include le soste presso eventuali waypoint prima del Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: |
vehicle |
La distanza in auto (in metri) del veicolo dal punto di ritiro 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 ritiro o quello di consegna. Il valore verrà inserito solo quando nella richiesta viene specificato un |
trip |
Obbligatorio. Il tipo di corsa della richiesta utilizzato per calcolare l'orario di arrivo stimato al punto di ritiro. |
vehicle |
L'elenco ordinato di waypoint utilizzati per calcolare l'orario di arrivo stimato. L'elenco include la posizione del veicolo, i punti di ritiro dei viaggi attivi per il veicolo e i punti di ritiro forniti nella richiesta. Un elenco vuoto indica un errore nel calcolo dell'orario di arrivo stimato del veicolo. |
vehicle |
Tipo di corrispondenza del veicolo. |
requested |
L'ordine richiesto per l'ordinamento delle corrispondenze dei veicoli. Equivalente a |
ordered |
L'ordine richiesto per l'ordinamento delle corrispondenze dei veicoli. Equivalente a |
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 | |
---|---|
lat |
La posizione di questo waypoint. |
eta |
L'ora stimata in cui il veicolo arriverà a questo waypoint. Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: |
VehicleMatchType
Tipo di corrispondenza del veicolo.
Enum | |
---|---|
UNKNOWN |
Tipo di corrispondenza del veicolo sconosciuto |
EXCLUSIVE |
Al momento al veicolo non è stato assegnato alcun viaggio e può procedere al punto di ritiro. |
BACK_TO_BACK |
Al momento il veicolo è assegnato a una corsa, ma può procedere al punto di ritiro dopo aver completato la corsa in corso. I calcoli di ETA e distanza tengono conto del viaggio esistente. |
CARPOOL |
Il veicolo ha una capacità sufficiente per una corsa condivisa. |
CARPOOL_BACK_TO_BACK |
Il veicolo completerà la corsa attiva attuale prima di procedere al punto di ritiro. I calcoli di ETA e distanza tengono conto del viaggio esistente. |