- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Ventana gráfica
Obtiene todos los DeliveryVehicle
que cumplen con los criterios de filtrado especificados.
Solicitud HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
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 |
Opcional. El encabezado de la solicitud estándar de la API de Delivery |
pageSize |
Opcional. Es la cantidad máxima de vehículos que se mostrarán. Es posible que el servicio muestre menos que este número. Si no especificas esta cantidad, el servidor determinará la cantidad de resultados que se mostrarán. |
pageToken |
Opcional. Un token de página, recibido desde una llamada Cuando se pagina, todos los demás parámetros proporcionados a |
filter |
Opcional. Una consulta de filtro para aplicar cuando se enumeren vehículos de entrega. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro. Si no especificas un valor o si especificas una string vacía para el filtro, se mostrarán todos los vehículos de entrega. Ten en cuenta que las únicas búsquedas admitidas para La cantidad máxima de restricciones permitidas en una consulta de filtro es de 50. Una restricción es una parte de la consulta con el formato |
viewport |
Opcional. Es un filtro que limita los vehículos que se muestran a aquellos cuya última ubicación conocida se encontraba 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
El mensaje de respuesta deliveryVehicles.list
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"deliveryVehicles": [
{
object ( |
Campos | |
---|---|
deliveryVehicles[] |
El conjunto de vehículos de entrega que cumplen con los criterios de filtrado solicitados. Cuando no se especifica ningún filtro, la solicitud muestra todos los vehículos de entrega. Una respuesta correcta también puede estar vacía. Si la respuesta está vacía, significa que no se encontraron vehículos de entrega que cumplan con los criterios de filtro solicitados. |
nextPageToken |
Puedes pasar este token en |
totalSize |
La cantidad total de vehículos de entrega que coinciden con los criterios de la solicitud en todas las páginas. |
Viewport
Un viewport de latitud y longitud, representado por dos puntos low
y high
opuestos en diagonal. Una viewport se considera una región cerrada, es decir, incluye su límite. Los límites de latitud deben variar entre -90 y 90 grados inclusive, y los límites de longitud deben estar entre -180 y 180 grados inclusive. Se incluyen varios casos:
Si
low
=high
, el viewport consta de ese único punto.Si
low.longitude
>high.longitude
, el intervalo 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
deben completarse, y el cuadro representado no puede estar vacío (como se especifica en las definiciones anteriores). Un viewport vacío generará 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 más alto del viewport. |