Muestra una lista de vehículos que coinciden con las opciones de 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. |
pickupPoint |
Obligatorio. El punto de partida para buscar cerca |
dropoffPoint |
La ubicación de destino prevista del cliente. El campo es obligatorio si |
pickupRadiusMeters |
Obligatorio. Define el radio de búsqueda del vehículo alrededor del punto de partida. Solo se mostrarán vehículos dentro del radio de búsqueda. Debe ser un valor 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). |
minimumCapacity |
Obligatorio. Especifica la cantidad de pasajeros que se consideran para un viaje. El valor debe ser mayor o igual que uno. El controlador no se considera en el valor de capacidad. |
tripTypes[] |
Obligatorio. Representa el tipo de viaje propuesto. Debe incluir exactamente un tipo. No se permite |
maximumStaleness |
Restringe la búsqueda solo a los vehículos que enviaron actualizaciones de ubicación a Fleet Engine dentro de la duración especificada. Los vehículos estáticos que aún transmiten sus ubicaciones no se consideran inactivos. Si no estableces este campo, el servidor utilizará cinco minutos como valor predeterminado. Es una duración en segundos con hasta nueve dígitos decimales que termina en " |
vehicleTypes[] |
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 |
requiredAttributes[] |
Los emisores 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. Coincide con la cantidad máxima de atributos permitidos en un vehículo. |
requiredOneOfAttributes[] |
Restringe la búsqueda solo a los vehículos que tengan al menos uno de los atributos especificados en cada |
requiredOneOfAttributeSets[] |
Al igual que
Restringe la búsqueda solo a los vehículos con todos los atributos en una |
orderBy |
Obligatorio. Especifica el criterio de ordenamiento deseado para los resultados. |
includeBackToBack |
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 |
tripId |
Indica el viaje asociado con este |
currentTripsPresent |
Indica si los vehículos con viajes activos son aptos para esta búsqueda. Se debe configurar en un valor distinto de |
filter |
Opcional. Una consulta de filtro que se aplicará cuando se busquen vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del 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 búsquedas admitidas son sobre atributos de vehículos (por ejemplo, Además, todos los atributos se almacenan como cadenas, de manera que las únicas comparaciones admitidas con los atributos son las comparaciones de cadenas. Para compararlos con valores numéricos o booleanos, los valores deben estar entre comillas explícitamente para tratarse como strings (por ejemplo, |
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SearchVehiclesResponse
.