Method: providers.vehicles.list

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

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

Parámetros de consulta

Parámetros
header

object (RequestHeader)

El encabezado de solicitud estándar de Fleet Engine.

pageSize

integer

Es la cantidad máxima de vehículos que se mostrarán. Valor predeterminado: 100.

pageToken

string

El valor de nextPageToken proporcionado por una llamada anterior a vehicles.list para que puedas paginar a través de grupos de vehículos El valor no está definido si los criterios de filtro de la solicitud no son los mismos que los de la llamada anterior a vehicles.list.

minimumCapacity

integer

Especifica la capacidad mínima requerida del vehículo. Todos los vehículos que se muestran tendrán un maximumCapacity mayor o igual que este valor. Si se configura, debe ser mayor o igual que 0.

tripTypes[]

enum (TripType)

Restringe la respuesta a los vehículos que admiten, al menos, uno de los tipos de viajes especificados.

maximumStaleness

string (Duration format)

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 estáticos que aún transmiten sus ubicaciones no se consideran inactivos. Si está presente, debe ser una duración positiva válida.

Es una duración en segundos con hasta nueve dígitos decimales que termina en "s". Ejemplo: "3.5s".

vehicleTypeCategories[]

enum (Category)

Obligatorio. Restringe la respuesta a los vehículos con una de las categorías de tipo especificadas. No se permite UNKNOWN.

requiredAttributes[]

string

Los emisores pueden formar operaciones lógicas complejas con cualquier combinación de los campos requiredAttributes, requiredOneOfAttributes y requiredOneOfAttributeSets.

requiredAttributes es una lista; requiredOneOfAttributes usa un mensaje que permite crear una lista de listas. En combinación, los dos campos permiten la composición de esta expresión:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

Restringe la respuesta 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. Cada cadena repetida debe tener el formato "clave:valor".

requiredOneOfAttributes[]

string

Restringe la respuesta a los vehículos con al menos uno de los atributos especificados en cada VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con al menos uno de los atributos. Este campo es una operación OR de disyunción inclusiva en cada VehicleAttributeList y una operación de conjunción/Y en la colección de VehicleAttributeList. Cada cadena repetida debe tener el formato "key1:value1|key2:value2|key3:value3".

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets proporciona funciones adicionales.

Al igual que requiredOneOfAttributes, requiredOneOfAttributeSets usa un mensaje que admite una lista de listas y admite expresiones como la siguiente:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Restringe la respuesta a los vehículos que coinciden con todos los atributos de un VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una operación de conjunción/Y en cada VehicleAttributeList y una operación de disyunción/OR inclusiva en la colección de VehicleAttributeList. Cada cadena repetida debe tener el formato "key1:value1|key2:value2|key3:value3".

vehicleState

enum (VehicleState)

Restringe la respuesta a los vehículos que tienen ese estado.

onTripOnly

boolean

Devuelve solo los vehículos con los viajes actuales.

filter

string

Opcional. Una consulta de filtro que se aplicará cuando se muestre una lista de vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro.

Este campo está diseñado para reemplazar los campos requiredAttributes, requiredOneOfAttributes y required_one_of_attributes_sets. Si aquí se especifica un valor que no está vacío, los siguientes campos deben quedar vacíos: requiredAttributes, requiredOneOfAttributes y required_one_of_attributes_sets.

Este filtro funciona como una cláusula AND con otras restricciones, como vehicleState o onTripOnly.

Ten en cuenta que las únicas búsquedas admitidas son sobre atributos de vehículos (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). La cantidad máxima de restricciones permitidas en una búsqueda de filtro es 50.

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, attributes.<key> = "10" o attributes.<key> = "true").

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

vehicles.list mensaje de respuesta.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campos
vehicles[]

object (Vehicle)

Vehículos que coinciden con los criterios de la solicitud. La cantidad máxima de vehículos que se muestran se determina mediante el campo pageSize de la solicitud.

nextPageToken

string

Es el token para recuperar la página siguiente de vehículos o vaciarla si no hay más vehículos que cumplan con los criterios de la solicitud.

totalSize

string (int64 format)

Obligatorio. Cantidad total de vehículos 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.