REST Resource: providers.vehicles

Recurso: Vehículo

Metadatos del vehículo.

Representación JSON 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "pastLocations": [
    {
      object (VehicleLocation)
    }
  ],
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
Campos
name

string

Solo salida. Es el nombre único de este vehículo. El formato es providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

Es el estado del vehículo.
supportedTripTypes[]

enum (TripType)

Son los tipos de viajes que admite este vehículo.
currentTrips[]

string

Solo salida. Es la lista de tripId de los viajes asignados actualmente a este vehículo.
lastLocation

object (VehicleLocation)

Es la última ubicación informada del vehículo.
pastLocations[]

object (VehicleLocation)

Solo entrada. Son las ubicaciones en las que estuvo este vehículo en el pasado y que aún no se informaron a Fleet Engine. Se usa en UpdateVehicleRequest para registrar ubicaciones que antes no se podían enviar al servidor. Por lo general, esto sucede cuando el vehículo no tiene conectividad a Internet.
maximumCapacity

integer

Es la cantidad total de pasajeros que puede transportar el vehículo. El conductor no se considera en este valor. Este valor debe ser mayor o igual que uno.
attributes[]

object (VehicleAttribute)

Es una lista de atributos del vehículo. Un vehículo puede tener un máximo de 100 atributos, y cada uno debe tener una clave única.
vehicleType

object (VehicleType)

Es obligatorio. Es el tipo de vehículo. Se puede usar para filtrar vehículos en los resultados de vehicles.search. También influye en los cálculos de la hora de llegada estimada y la ruta.
licensePlate

object (LicensePlate)

Información de la matrícula del vehículo.
route[]
(deprecated)

object (TerminalLocation)

Obsoleto: Usa Vehicle.waypoints en su lugar.
currentRouteSegment

string

Es la polilínea que especifica la ruta que la app del conductor tiene la intención de tomar hasta el siguiente punto de referencia. Esta lista también se muestra en Trip.current_route_segment para todos los viajes activos asignados al vehículo.

Nota: Este campo solo está diseñado para que lo use el SDK del controlador. Aún no se admite la decodificación.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Solo entrada. Fleet Engine usa esta información para mejorar el uso compartido de viajes. Nota: Este campo solo está diseñado para que lo use el SDK del controlador.
currentRouteSegmentVersion

string (Timestamp format)

Solo salida. Hora en la que se estableció currentRouteSegment. El cliente puede almacenarlo y pasarlo en solicitudes vehicles.get futuras para evitar que se muestren rutas que no hayan cambiado.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
currentRouteSegmentEndPoint

object (TripWaypoint)

El punto de referencia donde finaliza currentRouteSegment. Los conductores pueden proporcionar esta información en las llamadas a vehicles.update, ya sea como un punto de referencia de viaje completo, un LatLng de punto de referencia o como el último LatLng de la currentRouteSegment. Luego, Fleet Engine hará todo lo posible para interpolar un punto de referencia real si no se especifica por completo. Este campo se ignora en las llamadas a vehicles.update, a menos que también se especifique currentRouteSegment.
remainingDistanceMeters

integer

Es la distancia de conducción restante para el currentRouteSegment. Este valor también se muestra en Trip.remaining_distance_meters para todos los viajes activos asignados al vehículo. El valor no se especifica si el campo currentRouteSegment está vacío.
etaToFirstWaypoint

string (Timestamp format)

La hora de llegada estimada a la primera entrada del campo waypoints. El valor no se especifica si el campo waypoints o el campo Vehicle.current_route_segment están vacíos.

Cuando se actualiza un vehículo, remainingTimeSeconds tiene prioridad sobre etaToFirstWaypoint en la misma solicitud.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
remainingTimeSeconds

integer

Solo entrada. Es el tiempo de conducción restante para el currentRouteSegment. El valor no se especifica si el campo waypoints o el campo Vehicle.current_route_segment están vacíos. Este valor debe coincidir con etaToFirstWaypoint - current_time si todas las partes usan el mismo reloj.

Cuando se actualiza un vehículo, remainingTimeSeconds tiene prioridad sobre etaToFirstWaypoint en la misma solicitud.
waypoints[]

object (TripWaypoint)

Los puntos de referencia restantes asignados a este vehículo.
waypointsVersion

string (Timestamp format)

Solo salida. Es la última vez que se actualizó el campo waypoints. Los clientes deben almacenar en caché este valor y pasarlo en GetVehicleRequest para garantizar que el campo waypoints solo se muestre si se actualiza.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
backToBackEnabled

boolean

Indica si el conductor acepta viajes consecutivos. Si es true, vehicles.search puede incluir el vehículo, incluso si está asignado a un viaje. El valor predeterminado es false.
navigationStatus

enum (NavigationStatus)

Es el estado de navegación del vehículo.
deviceSettings

object (DeviceSettings)

Solo entrada. Información sobre la configuración del dispositivo móvil que usa el conductor.

VehicleState

Es el estado de un Vehicle.

Enumeraciones
UNKNOWN_VEHICLE_STATE Es el valor predeterminado que se usa para estados de vehículos no especificados o no reconocidos.
OFFLINE El vehículo no acepta viajes nuevos. Nota: Es posible que el vehículo siga funcionando en este estado mientras completa un viaje asignado.
ONLINE El vehículo acepta viajes nuevos.

VehicleAttribute

Describe un atributo del vehículo como un par clave-valor. La longitud de la cadena "clave:valor" no puede superar los 256 caracteres.

Representación JSON 
{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}
Campos
key

string

Es la clave del atributo. Las claves no pueden contener el carácter dos puntos (:).
value

string

Es el valor del atributo.
Campo de unión vehicle_attribute_value. El valor del atributo puede ser de tipo cadena, booleano o doble. Las direcciones (vehicle_attribute_value) solo pueden ser una de las siguientes opciones:
stringValue

string

Valor del atributo escrito como cadena.

Nota: Es idéntico al campo value, que eventualmente dejará de estar disponible. Para los métodos de creación o actualización, se puede usar cualquiera de los campos, pero se recomienda usar stringValue. Si se configuran stringValue y value, deben ser idénticos o se arrojará un error. Ambos campos se propagan en las respuestas.
boolValue

boolean

Valor de atributo escrito en formato booleano.
numberValue

number

Valor de atributo escrito dos veces.

VehicleType

Es el tipo de vehículo.

Representación JSON 
{
  "category": enum (Category)
}
Campos
category

enum (Category)

Categoría de tipo de vehículo

Categoría

Categorías de tipos de vehículos

Enumeraciones
UNKNOWN Es el valor predeterminado que se usa para las categorías de vehículos no especificadas o no reconocidas.
AUTO Un automóvil.
TAXI Cualquier vehículo que funcione como taxi (por lo general, con licencia o regulación)
TRUCK Por lo general, es un vehículo con una gran capacidad de almacenamiento.
TWO_WHEELER Una motocicleta, un ciclomotor o cualquier otro vehículo de dos ruedas
BICYCLE Transporte manual.
PEDESTRIAN Un medio de transporte humano, por lo general, a pie o corriendo, que se desplaza por senderos peatonales.

LicensePlate

La información de la matrícula del vehículo Para evitar almacenar información de identificación personal, solo se almacena la información mínima sobre la matrícula como parte de la entidad.

Representación JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
Campos
countryCode

string

Es obligatorio. Código de país o región de CLDR. Por ejemplo, US para Estados Unidos o IN para India.
lastCharacter

string

El último dígito de la matrícula o "-1" para indicar que no hay un valor numérico en la matrícula.

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • "ABCDEF" -> "-1"

TrafficPolylineData

Condiciones de tráfico en la ruta prevista del vehículo

Representación JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Campos
trafficRendering

object (VisualTrafficReportPolylineRendering)

Renderización de polilínea de la velocidad del tráfico en todas las regiones a lo largo de un tramo del viaje de un cliente.

VisualTrafficReportPolylineRendering

Describe cómo los clientes deben colorear una parte del polilinea a lo largo de la ruta.

Representación JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Campos
roadStretch[]

object (RoadStretch)

Opcional. Tramo de ruta que se debe renderizar a lo largo de la polilínea. Se garantiza que los tramos no se superpongan y no necesariamente abarcan toda la ruta.

Si no hay un tramo de ruta para aplicarle diseño, el cliente debe aplicar el predeterminado de la ruta.

RoadStretch

Es un tramo de ruta que se debe renderizar.

Representación JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Campos
style

enum (Style)

Es obligatorio. Es el estilo que se aplicará.
offsetMeters

integer

Es obligatorio. El estilo se debe aplicar entre [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Es obligatorio. Es la longitud de la ruta en la que se aplicará el estilo.

Estilo

El estilo de tráfico, que indica la velocidad del tráfico.

Enumeraciones
STYLE_UNSPECIFIED No se seleccionó ningún estilo.
SLOWER_TRAFFIC El tráfico se ralentiza.
TRAFFIC_JAM Hay un embotellamiento.

DeviceSettings

Información sobre varios parámetros de configuración del dispositivo móvil

Representación JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Campos
locationPowerSaveMode

enum (LocationPowerSaveMode)

Cómo se configuran las funciones de ubicación para que se comporten en el dispositivo cuando el ahorro de batería está activado
isPowerSaveMode

boolean

Indica si el dispositivo está en modo de ahorro de energía.
isInteractive

boolean

Indica si el dispositivo está en un estado interactivo.
batteryInfo

object (BatteryInfo)

Información sobre el estado de la batería.

LocationPowerSaveMode

Cómo se configuran las funciones de ubicación para que se comporten en el dispositivo móvil cuando la función "ahorro de batería" del dispositivo está activada (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enumeraciones
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode no definido
LOCATION_MODE_NO_CHANGE Los proveedores de ubicación no deben verse afectados por el Ahorro de batería, o bien este debe estar desactivado.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF El proveedor de ubicación basado en GPS debe estar inhabilitado cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Todos los proveedores de ubicación deben estar inhabilitados cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_FOREGROUND_ONLY Todos los proveedores de ubicación seguirán disponibles, pero las correcciones de ubicación solo se deben proporcionar a las apps en primer plano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La ubicación no se desactivará, pero LocationManager limitará todas las solicitudes a los proveedores cuando el dispositivo no sea interactivo.

BatteryInfo

Información sobre la batería del dispositivo

Representación JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Campos
batteryStatus

enum (BatteryStatus)

Estado de la batería (si está completa o en carga, etcétera)
powerSource

enum (PowerSource)

Estado de la fuente de alimentación de la batería.
batteryPercentage

number

Porcentaje actual de batería [0-100].

BatteryStatus

Estado de la batería (si está completa o en carga, etcétera)

Enumeraciones
UNKNOWN_BATTERY_STATUS Se desconoce el estado de la batería.
BATTERY_STATUS_CHARGING La batería se está cargando.
BATTERY_STATUS_DISCHARGING La batería se está descargando.
BATTERY_STATUS_FULL La batería está completa.
BATTERY_STATUS_NOT_CHARGING La batería no se está cargando.
BATTERY_STATUS_POWER_LOW La batería está baja.

PowerSource

Es el tipo de cargador que se usa para cargar la batería.

Enumeraciones
UNKNOWN_POWER_SOURCE Fuente de alimentación desconocida.
POWER_SOURCE_AC La fuente de alimentación es un cargador de CA.
POWER_SOURCE_USB La fuente de alimentación es un puerto USB.
POWER_SOURCE_WIRELESS La fuente de alimentación es inalámbrica.
POWER_SOURCE_UNPLUGGED La batería está desconectada.

Métodos

create

 Crea una instancia de un vehículo nuevo asociado con un proveedor de viajes compartidos o entregas a pedido.

delete

 Borra un vehículo del motor de la flota.

get

 Devuelve un vehículo del motor de flota.

list

 Muestra una lista paginada de vehículos asociados con un proveedor que coincida con las opciones de la solicitud.
Muestra una lista de vehículos que coinciden con las opciones de la solicitud.

update

 Escribe datos de vehículos actualizados en Fleet Engine.

updateAttributes

 Actualiza parcialmente los atributos de un vehículo.