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 pertenece 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

La cantidad máxima de vehículos que se devolverán. Valor predeterminado: 100.

pageToken

string

El valor de nextPageToken proporcionado por una llamada anterior a vehicles.list para que puedas paginar 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 muestren tendrán un maximumCapacity mayor o igual que este valor. Si se establece, 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 viaje 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 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 “s”. Ejemplo: "3.5s".

vehicleTypeCategories[]

enum (Category)

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

requiredAttributes[]

string

Los emisores pueden realizar 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 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[]

string

Restringe la respuesta a los vehículos con al menos uno de los atributos especificados en cada VehicleAttributeList. En 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 AND en toda 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 permite una lista de listas y expresiones como esta:

(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 en una VehicleAttributeList. En cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una conjunción/operación AND 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 este estado.

onTripOnly

boolean

Solo devuelve los vehículos con los viajes actuales.

filter

string

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 requiredAttributes, requiredOneOfAttributes y required_one_of_attributes_sets. Si se especifica aquí un valor que no esté vacío, los siguientes campos deben estar 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 consultas 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 permitida en una consulta de filtro es de 50.

Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas para los atributos son las comparaciones de cadenas. Para comparar con valores numéricos o booleanos, los valores se deben entrecomillar de forma explícita para que se los trate 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 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 (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campos
vehicles[]

object (Vehicle)

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

nextPageToken

string

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

string (int64 format)

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 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 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, "length": -74.259087 }, "high": { "latitude": 40.91618, "length": -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 superior del viewport.