- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Ventana gráfica
Muestra una lista paginada de vehículos asociados con un proveedor que coinciden con las opciones de solicitud.
Solicitud HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
parent |
Obligatorio. Debe tener el formato |
Parámetros de consulta
Parámetros | |
---|---|
header |
El encabezado de solicitud estándar de Fleet Engine. |
pageSize |
La cantidad máxima de vehículos que se devolverán. Valor predeterminado: 100. |
pageToken |
El valor de |
minimumCapacity |
Especifica la capacidad mínima requerida del vehículo. Todos los vehículos que se muestren tendrán un |
tripTypes[] |
Restringe la respuesta a los vehículos que admiten al menos uno de los tipos de viaje especificados. |
maximumStaleness |
Restringe la respuesta a los vehículos que enviaron actualizaciones de ubicación a Fleet Engine dentro de la duración especificada. Los vehículos estacionarios que aún transmiten sus ubicaciones no se consideran inactivos. Si está presente, debe ser una duración positiva válida. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
vehicleTypeCategories[] |
Obligatorio. Restringe la respuesta a los vehículos con una de las categorías de tipos especificadas. No se permite |
requiredAttributes[] |
Los emisores pueden realizar operaciones lógicas complejas con cualquier combinación de los campos
Restringe la respuesta a los vehículos con los atributos especificados. Este campo es una conjunción/operación AND. Se permite un máximo de 50 requiredAttributes. Esto coincide con la cantidad máxima de atributos permitidos en un vehículo. Cada cadena repetida debe tener el formato "key:value". |
requiredOneOfAttributes[] |
Restringe la respuesta a los vehículos con al menos uno de los atributos especificados en cada |
requiredOneOfAttributeSets[] |
Al igual que
Restringe la respuesta a los vehículos que coinciden con todos los atributos en una |
vehicleState |
Restringe la respuesta a los vehículos que tienen este estado. |
onTripOnly |
Solo devuelve los vehículos con los viajes actuales. |
filter |
Opcional. Una búsqueda de filtro para aplicar cuando se publican vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro. Este campo se diseñó 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 para los atributos son las comparaciones de cadenas. Con el fin de compararlos con valores numéricos o booleanos, los valores se deben entrecomillar de forma explícita para que se los trate como strings (por ejemplo, |
viewport |
Opcional. Es un filtro que limita los vehículos que se muestran a aquellos cuya última ubicación conocida fue en el área rectangular definida por el viewport. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Mensaje de respuesta vehicles.list
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"vehicles": [
{
object ( |
Campos | |
---|---|
vehicles[] |
Vehículos que coinciden con los criterios de la solicitud El campo |
nextPageToken |
Token para recuperar la página siguiente de vehículos o vaciar si no hay más vehículos que cumplan con los criterios de la solicitud. |
totalSize |
Obligatorio. Cantidad total de vehículos que coinciden con los criterios de solicitud en todas las páginas. |
Viewport
Un viewport de latitud y longitud, representado por dos puntos low
y high
opuestos en diagonal. Un viewport se considera una región cerrada, es decir, incluye su límite. Los límites de latitud deben oscilar entre -90 y 90 grados inclusive, y los límites de longitud deben oscilar entre -180 y 180 grados inclusive. Varios casos incluyen los siguientes:
Si
low
=high
, el viewport consta de ese solo punto.Si
low.longitude
>high.longitude
, el rango de longitud se invierte (el viewport cruza la línea de longitud de 180 grados).Si
low.longitude
= -180 grados yhigh.longitude
= 180 grados, el viewport incluye todas las longitudes.Si
low.longitude
= 180 grados yhigh.longitude
= -180 grados, el rango de longitud está vacío.Si
low.latitude
>high.latitude
, el rango de latitud está vacío.
Tanto low
como high
se deben completar, y el cuadro representado no puede estar vacío (como se especifica en las definiciones anteriores). Si el viewport está vacío, se producirá un error.
Por ejemplo, este viewport abarca por completo la ciudad de Nueva York:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
Representación JSON |
---|
{ "low": { object ( |
Campos | |
---|---|
low |
Obligatorio. Es el punto inferior del viewport. |
high |
Obligatorio. Es el punto superior del viewport. |