- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Punto de referencia
- VehicleMatchType
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 la 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 los vehículos que estén dentro del radio de búsqueda. El valor debe ser de entre 400 y 10,000 metros (inclusive). |
count |
Obligatorio. Especifica la cantidad máxima de vehículos que se devolverá. El valor debe estar entre 1 y 50 (inclusive). |
minimumCapacity |
Obligatorio. Especifica la cantidad de pasajeros que se tienen en cuenta 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. Se 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 fijos que 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 terminen 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 los tipos de vehículos con la categoría |
requiredAttributes[] |
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/AND. Se permite un máximo de 50 requiredAttributes. Corresponde a la cantidad máxima de atributos permitidos en un vehículo. |
requiredOneOfAttributes[] |
Restringe la búsqueda solo a los vehículos con 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, por lo que las únicas comparaciones admitidas con los atributos son las de cadenas. Para compararlos con valores numéricos o booleanos, los valores deben estar entre comillas de forma explícita para que se los trate como cadenas (por ejemplo, |
Cuerpo de la respuesta
vehicles.search
mensaje de respuesta.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"matches": [
{
object ( |
Campos | |
---|---|
matches[] |
Lista de vehículos que coinciden con los criterios de |
VehicleAttributeList
Una lista de tipos de datos para los atributos del vehículo.
Representación JSON |
---|
{
"attributes": [
{
object ( |
Campos | |
---|---|
attributes[] |
Una lista de atributos de esta colección. |
VehicleMatchOrder
Especifica el orden de las coincidencias del vehículo en la respuesta.
Enumeradores | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Predeterminado: se usa para el pedido de coincidencias de vehículos no especificado o no reconocido. |
PICKUP_POINT_ETA |
Orden ascendente por tiempo de conducción del vehículo hasta el punto de partida. |
PICKUP_POINT_DISTANCE |
Orden ascendente por distancia en automóvil 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 destino. Este pedido solo se puede usar si se especifica el punto de destino en la solicitud. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Orden ascendente por distancia en línea recta desde la última ubicación informada del vehículo hasta el punto de partida. |
COST |
Orden ascendente por el costo de coincidencia configurado. El costo de coincidencia se define como un cálculo ponderado entre la distancia lineal y el ETA. Las ponderaciones se establecen con valores predeterminados y se pueden modificar por cliente. Comunícate con Atención al cliente de Google si es necesario modificar estas ponderaciones para tu proyecto. |
CurrentTripsPresent
Especifica los tipos de restricciones que se aplican a los viajes actuales de un vehículo.
Enumeradores | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
La disponibilidad de vehículos con viajes está regida 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 vehículos con un máximo de 5 viajes y 10 puntos de referencia. Cuando se usa este valor, includeBackToBack no puede ser true . |
VehicleMatch
Contiene el vehículo y las estimaciones relacionadas para un vehículo que coinciden con los puntos de viajes activos del vehículo SearchVehiclesRequest
.
Representación JSON |
---|
{ "vehicle": { object ( |
Campos | |
---|---|
vehicle |
Obligatorio. Un vehículo que coincida con la solicitud |
vehiclePickupEta |
Es la hora de llegada estimada del vehículo hasta el punto de partida especificado en la solicitud. Un valor vacío indica que no se pudo calcular 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: |
vehiclePickupDistanceMeters |
Es la distancia desde la ubicación actual del vehículo hasta el punto de partida especificado en la solicitud, incluidos los puntos intermedios de partida o llegada para los viajes existentes. Esta distancia incluye la distancia calculada de conducción (ruta), más la distancia en línea recta entre el punto de destino de la navegación y el punto de partida solicitado. (La distancia entre el extremo de 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. |
vehiclePickupStraightLineDistanceMeters |
Obligatorio. La distancia lineal entre el vehículo y el punto de partida especificado en la solicitud. |
vehicleDropoffEta |
Es la hora de llegada estimada del vehículo completo hasta el punto de llegada especificado en la solicitud. La hora de llegada estimada incluye la parada 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: |
vehiclePickupToDropoffDistanceMeters |
La distancia en automóvil del vehículo (en metros) desde el punto de partida hasta el punto de llegada especificado en la solicitud. La distancia solo se establece 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 este visite el punto de partida o de destino. El valor solo se propagará cuando se especifique un |
tripType |
Obligatorio. Es el tipo de viaje de la solicitud que se utilizó para calcular la hora de llegada estimada al punto de partida. |
vehicleTripsWaypoints[] |
La lista ordenada de puntos de referencia utilizados para calcular la hora de llegada estimada. La lista incluye la ubicación del vehículo, los puntos de retiro de los viajes activos y los puntos de retiro proporcionados en la solicitud. Si la lista está vacía, significa que no se pudo calcular la hora de llegada estimada del vehículo. |
vehicleMatchType |
Tipo de coincidencia de vehículo. |
requestedOrderedBy |
El pedido solicitado para ordenar las coincidencias de vehículos. |
orderedBy |
Es el pedido real que se usó para este vehículo. Normalmente, este coincidirá con el campo "orderBy" de la solicitud. Sin embargo, en algunas circunstancias como un error interno del servidor, se puede usar un método diferente (como |
Waypoint
Describe los puntos intermedios de una ruta para un VehicleMatch
en un SearchVehiclesResponse
. Este concepto se representa como una TripWaypoint
en todos los demás extremos.
Representación JSON |
---|
{
"latLng": {
object ( |
Campos | |
---|---|
latLng |
La ubicación de este punto de referencia. |
eta |
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
Tipo de coincidencia de vehículo.
Enumeradores | |
---|---|
UNKNOWN |
Tipo de concordancia 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 continuar hasta el 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 realizar un viaje compartido. |
CARPOOL_BACK_TO_BACK |
El vehículo finalizará su viaje actual y activo 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. |