- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Waypoint
- VehicleMatchType
Muestra una lista de vehículos que coinciden con las opciones de la solicitud.
Solicitud HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
parent |
Obligatorio. Debe tener el formato |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header |
El encabezado de solicitud estándar de Fleet Engine. |
pickup |
Obligatorio. El punto de partida cerca del que se debe realizar la búsqueda |
dropoff |
La ubicación de destino del cliente El campo es obligatorio si |
pickup |
Obligatorio. Define el radio de búsqueda de vehículos alrededor del punto de partida. Solo se mostrarán los vehículos dentro del radio de búsqueda. El valor debe estar entre 400 y 10,000 metros (inclusive). |
count |
Obligatorio. Especifica la cantidad máxima de vehículos que se mostrarán. El valor debe estar entre 1 y 50 (inclusive). |
minimum |
Obligatorio. Especifica la cantidad de pasajeros que se consideran para un viaje. El valor debe ser mayor o igual que uno. El conductor no se considera en el valor de capacidad. |
trip |
Obligatorio. Representa el tipo de viaje propuesto. Debe incluir exactamente un tipo. No se permite |
maximum |
Limita la búsqueda solo a los vehículos que hayan enviado actualizaciones de ubicación a Fleet Engine durante el período especificado. Los vehículos detenidos que aún transmiten sus ubicaciones no se consideran inactivos. Si no se establece este campo, el servidor usa cinco minutos como valor predeterminado. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
vehicle |
Obligatorio. Restringe la búsqueda a vehículos con uno de los tipos especificados. Se debe especificar al menos un tipo de vehículo. No se permiten VehicleTypes con una categoría de |
required |
Los llamadores pueden formar operaciones lógicas complejas con cualquier combinación de los campos
Restringe la búsqueda solo a los vehículos con los atributos especificados. Este campo es una operación de conjunción/Y. Se permite un máximo de 50 requiredAttributes. Esto coincide con la cantidad máxima de atributos permitidos en un vehículo. |
required |
Restringe la búsqueda solo a los vehículos con al menos uno de los atributos especificados en cada |
required |
De manera similar a
Restringe la búsqueda solo a los vehículos con todos los atributos en un |
order |
Obligatorio. Especifica el criterio de ordenamiento deseado para los resultados. |
include |
Indica si los vehículos con un solo viaje activo son aptos para esta búsqueda. Este campo solo se usa cuando no se especifica El valor predeterminado es |
trip |
Indica el viaje asociado con este |
current |
Indica si los vehículos con viajes activos son aptos para esta búsqueda. Se debe establecer en un valor que no sea |
filter |
Opcional. Es una consulta de filtro que se aplica cuando se buscan vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis de filtro. Este campo está diseñado para reemplazar los campos Este filtro funciona como una cláusula AND con otras restricciones, como Ten en cuenta que las únicas consultas admitidas son sobre atributos de vehículos (por ejemplo, Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas con los atributos son las comparaciones de cadenas. Para compararlos con valores numéricos o booleanos, los valores deben incluirse entre comillas de forma explícita para que se traten como cadenas (por ejemplo, |
Cuerpo de la respuesta
Mensaje de respuesta vehicles.search
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"matches": [
{
object ( |
Campos | |
---|---|
matches[] |
Es la lista de vehículos que coinciden con los criterios de |
VehicleAttributeList
Es un tipo de datos de lista de listas para los atributos de los vehículos.
Representación JSON |
---|
{
"attributes": [
{
object ( |
Campos | |
---|---|
attributes[] |
Es una lista de los atributos de esta colección. |
VehicleMatchOrder
Especifica el orden de las coincidencias de vehículos en la respuesta.
Enumeraciones | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Es el valor predeterminado que se usa para el orden de coincidencias de vehículos no especificados o no reconocidos. |
PICKUP_POINT_ETA |
Orden ascendente por tiempo de conducción del vehículo hasta el punto de partida. |
PICKUP_POINT_DISTANCE |
Orden ascendente según la distancia de conducción del vehículo hasta el punto de partida. |
DROPOFF_POINT_ETA |
Orden ascendente por tiempo de conducción del vehículo hasta el punto de entrega. Este orden solo se puede usar si se especifica el punto de entrega en la solicitud. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Orden ascendente por distancia en línea recta desde la última ubicación registrada del vehículo hasta el punto de partida. |
COST |
Orden ascendente según el costo de concordancia configurado El costo de coincidencia se define como un cálculo ponderado entre la distancia en línea recta y la hora de llegada estimada. Los pesos se establecen con valores predeterminados y se pueden modificar por cliente. Comunícate con Atención al cliente de Google si necesitas modificar estos pesos para tu proyecto. |
CurrentTripsPresent
Especifica los tipos de restricciones de los viajes actuales de un vehículo.
Enumeraciones | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
La disponibilidad de los vehículos con viajes presentes se rige por el campo includeBackToBack . |
NONE |
Los vehículos sin viajes pueden aparecer en los resultados de la búsqueda. Cuando se usa este valor, includeBackToBack no puede ser true . |
ANY |
En los resultados de la búsqueda, se incluyen los vehículos con un máximo de 5 viajes actuales y 10 puntos de referencia. Cuando se usa este valor, includeBackToBack no puede ser true . |
VehicleMatch
Contiene el vehículo y las estimaciones relacionadas con un vehículo que coinciden con los puntos de los viajes activos del vehículo SearchVehiclesRequest
.
Representación JSON |
---|
{ "vehicle": { object ( |
Campos | |
---|---|
vehicle |
Obligatorio. Un vehículo que coincida con la solicitud |
vehicle |
La hora de llegada estimada en automóvil del vehículo al punto de partida especificado en la solicitud. Un valor vacío indica que se produjo un error en el cálculo de la hora de llegada estimada del vehículo. Si Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
vehicle |
Es la distancia entre la ubicación actual del vehículo y el punto de partida especificado en la solicitud, incluidos los puntos de partida o destino intermedios de los viajes existentes. Esta distancia comprende la distancia de conducción (ruta) calculada, más la distancia en línea recta entre el punto final de navegación y el punto de partida solicitado. (La distancia entre el punto de destino de la navegación y el punto de partida solicitado suele ser pequeña). Un valor vacío indica un error en el cálculo de la distancia. |
vehicle |
Obligatorio. Es la distancia en línea recta entre el vehículo y el punto de partida especificado en la solicitud. |
vehicle |
La hora de llegada estimada (ETA) en automóvil completa al punto de destino especificado en la solicitud. La hora de llegada estimada incluye las paradas en cualquier punto de referencia antes del Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
vehicle |
Es la distancia de conducción (en metros) del vehículo desde el punto de partida hasta el punto de destino especificado en la solicitud. La distancia es solo entre los dos puntos y no incluye la ubicación del vehículo ni ningún otro punto que se deba visitar antes de que el vehículo visite el punto de partida o el de destino. El valor solo se propagará cuando se especifique un |
trip |
Obligatorio. Es el tipo de viaje de la solicitud que se usó para calcular la hora de llegada estimada al punto de partida. |
vehicle |
Es la lista ordenada de puntos de referencia que se usa para calcular la hora de llegada estimada. La lista incluye la ubicación del vehículo, los puntos de partida de los viajes activos del vehículo y los puntos de partida proporcionados en la solicitud. Una lista vacía indica que se produjo un error en el cálculo de la hora de llegada estimada del vehículo. |
vehicle |
Es el tipo de coincidencia de vehículo. |
requested |
Es el orden solicitado para ordenar las coincidencias de vehículos. Equivale a |
ordered |
Es el orden solicitado para ordenar las coincidencias de vehículos. Equivale a |
Punto de referencia
Describe los puntos intermedios a lo largo de una ruta para un VehicleMatch
en un SearchVehiclesResponse
. Este concepto se representa como un TripWaypoint
en todos los demás extremos.
Representación JSON |
---|
{
"latLng": {
object ( |
Campos | |
---|---|
lat |
Es la ubicación de este punto de referencia. |
eta |
Es la hora estimada a la que el vehículo llegará a este punto de referencia. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
VehicleMatchType
Es el tipo de coincidencia de vehículos.
Enumeraciones | |
---|---|
UNKNOWN |
Tipo de coincidencia de vehículo desconocido |
EXCLUSIVE |
Actualmente, el vehículo no tiene ningún viaje asignado y puede dirigirse al punto de partida. |
BACK_TO_BACK |
Actualmente, el vehículo está asignado a un viaje, pero puede dirigirse al punto de partida después de completar el viaje en curso. Los cálculos de la hora de llegada estimada y la distancia tienen en cuenta el viaje existente. |
CARPOOL |
El vehículo tiene capacidad suficiente para un viaje compartido. |
CARPOOL_BACK_TO_BACK |
El vehículo terminará su viaje activo actual antes de dirigirse al punto de partida. Los cálculos de la hora de llegada estimada y la distancia tienen en cuenta el viaje existente. |