Method: providers.deliveryVehicles.list

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

string

Obligatorio. Debe tener el formato providers/{provider}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project.

Parámetros de consulta

Parámetros
header

object (DeliveryRequestHeader)

Opcional. El encabezado de la solicitud estándar de la API de Delivery
pageSize

integer

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

string

Opcional. Un token de página, recibido desde una llamada deliveryVehicles.list anterior. Debes proporcionarla para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a deliveryVehicles.list deben coincidir con la llamada que proporcionó el token de la página.
filter

string

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 deliveryVehicles.list son sobre atributos de vehículos (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Además, todos los atributos se almacenan como strings, por lo que las únicas comparaciones admitidas con los atributos son las comparaciones de strings. Para compararlos con valores numéricos o booleanos, los valores deben estar entre comillas explícitamente para tratarse como strings (por ejemplo, attributes.<key> = "10" o attributes.<key> = "true").

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 attribute.<KEY> <COMPARATOR> <VALUE>, por ejemplo, attributes.foo = bar es 1 restricción.
viewport

object (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 (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campos
deliveryVehicles[]

object (DeliveryVehicle)

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

string

Puedes pasar este token en ListDeliveryVehiclesRequest para seguir mostrando los resultados. Cuando se muestren todos los resultados, este campo no aparecerá en la respuesta o se tratará de una string vacía.
totalSize

string (int64 format)

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 y high.longitude = 180 grados, el viewport incluye todas las longitudes.

  • Si low.longitude = 180 grados y high.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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

Obligatorio. Es el punto inferior del viewport.
high

object (LatLng)

Obligatorio. Es el punto más alto del viewport.