REST Resource: providers.vehicles

Recurso: Vehicle

Metadatos del vehículo.

Representación JSON 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    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. El nombre único de este vehículo. El formato es providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

El estado del vehículo.
supportedTripTypes[]

enum (TripType)

Tipos de viaje admitidos en este vehículo.
currentTrips[]

string

Solo salida. Lista de tripId para los viajes asignados actualmente a este vehículo.
lastLocation

object (VehicleLocation)

Última ubicación informada del vehículo.
maximumCapacity

integer

La cantidad total de pasajeros que puede transportar este vehículo. No se considera el controlador en este valor. Este valor debe ser mayor o igual que uno.
attributes[]

object (VehicleAttribute)

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

object (VehicleType)

Obligatorio. 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 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

La polilínea que especifica la ruta que la app de conductor intenta 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 está diseñado únicamente 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 los recorridos compartidos. Nota: Este campo está diseñado únicamente para que lo use el SDK del controlador.
currentRouteSegmentVersion

string (Timestamp format)

Solo salida. Hora a la que se configuró el currentRouteSegment. El cliente puede almacenarla y pasarla en solicitudes vehicles.get futuras para evitar que se devuelvan rutas que no hayan cambiado.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

El punto de referencia donde termina currentRouteSegment. Los conductores pueden proporcionarlo en llamadas a vehicles.update como un punto de referencia de viaje completo, un punto de referencia LatLng o como el último LatLng de la currentRouteSegment. Fleet Engine luego hará todo lo posible para interpolar un punto de referencia real si no está especificado por completo. Este campo se ignora en las llamadas vehicles.update, a menos que también se especifique currentRouteSegment.
remainingDistanceMeters

integer

La distancia en automóvil 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)

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

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

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
remainingTimeSeconds

integer

Solo entrada. Tiempo de conducción restante: currentRouteSegment. El valor no se especifica si el campo waypoints está vacío o si el campo Vehicle.current_route_segment está vacío. Este valor debe coincidir con etaToFirstWaypoint y current_time si todos los grupos usan el mismo reloj.

Cuando actualizas 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. Ú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.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
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)

El estado de navegación del vehículo.
deviceSettings

object (DeviceSettings)

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

VehicleState

Es el estado de un Vehicle.

Enumeraciones
UNKNOWN_VEHICLE_STATE Esta opción es predeterminada y se usa para estados de vehículo no especificados o no reconocidos.
OFFLINE El vehículo no acepta viajes nuevos. Nota: Es posible que el vehículo continúe funcionando en este estado mientras completa el viaje que se le asignó.
ONLINE El vehículo acepta viajes nuevos.

VehicleAttribute

Describe un atributo de vehículo como un par clave-valor. La función “key:value” la longitud de la cadena 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

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

string

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

string

Valor del atributo de tipo de 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 cualquier campo, pero es muy recomendable usar stringValue. Si se configuran stringValue y value, deben ser idénticos; de lo contrario, se mostrará un error. Ambos campos se propagan en las respuestas.
boolValue

boolean

Valor de atributo de tipo booleano.
numberValue

number

Valor de atributo de doble tipo.

VehicleType

El tipo de vehículo.

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

enum (Category)

Categoría del tipo de vehículo

Categoría

Categorías de tipos de vehículos

Enumeraciones
UNKNOWN Esta opción es predeterminada y se usa para 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 regulado)
TRUCK Por lo general, es un vehículo con una gran capacidad de almacenamiento.
TWO_WHEELER Una motocicleta, ciclomotor y otro vehículo de dos ruedas
BICYCLE Transporte impulsado por personas.
PEDESTRIAN Un transportador humano, generalmente caminando o corriendo, que viaja 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 como parte de la entidad la información mínima sobre la matrícula.

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

string

Obligatorio. Es el 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 la matrícula no contiene ningún valor numérico.

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

TrafficPolylineData

Condiciones de tráfico en la ruta prevista para el vehículo.

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

object (VisualTrafficReportPolylineRendering)

Una renderización de polilíneas que indica qué tan rápido es el tráfico para todas las regiones a lo largo de un tramo de viaje de un cliente.

VisualTrafficReportPolylineRendering

Describe cómo los clientes deben colorear una parte de la polilínea a lo largo de la ruta.

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

object (RoadStretch)

Opcional. Tramos de ruta que deben representarse a lo largo de la polilínea Se garantiza que los estiramientos no se superpongan y no abarquen necesariamente toda la ruta.

Ante la ausencia de un tramo de ruta para aplicar diseño, el cliente debe aplicar el valor predeterminado para la ruta.

RoadStretch

Un tramo de ruta que se debe renderizar.

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

enum (Style)

Obligatorio. Es el estilo que se aplicará.
offsetMeters

integer

Obligatorio. El estilo debe aplicarse entre [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Obligatorio. Es la longitud de la ruta en la que se aplicará el diseño.

Estilo

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

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

DeviceSettings

Información sobre las distintas opciones de configuración del dispositivo móvil.

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

enum (LocationPowerSaveMode)

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

boolean

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

boolean

Indica si el dispositivo se encuentra en estado interactivo.
batteryInfo

object (BatteryInfo)

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

LocationPowerSaveMode

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

Enumeraciones
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode no definido
LOCATION_MODE_NO_CHANGE El ahorro de batería no debería afectar a los proveedores de ubicación, o bien este está desactivado.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF El proveedor de ubicación basada en GPS debe inhabilitarse cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Cuando el ahorro de batería está activado y el dispositivo no es interactivo, deben inhabilitarse todos los proveedores de ubicación.
LOCATION_MODE_FOREGROUND_ONLY Todos los proveedores de ubicación se mantendrán disponibles, pero las correcciones de ubicación solo deben proporcionarse a las aplicaciones 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, ya sea completa o cargándose, 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, ya sea completa o cargándose, etcétera

Enumeraciones
UNKNOWN_BATTERY_STATUS Se desconoce el estado de la batería.
BATTERY_STATUS_CHARGING Se está cargando la batería.
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 tiene poca carga.

PowerSource

Tipo de cargador que se utiliza para cargar la batería.

Enumeraciones
UNKNOWN_POWER_SOURCE La fuente de alimentación es 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 transporte compartido o de entregas a pedido.

get

 Devuelve un vehículo de Fleet Engine.

list

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

update

 Escribe datos actualizados del vehículo en Fleet Engine.

updateAttributes

 Actualiza parcialmente los atributos de un vehículo.