REST Resource: providers.vehicles

Recurso: Vehículo

Metadatos de vehículos

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

Tipos de viajes admitidos por este vehículo.

currentTrips[]

string

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

lastLocation

object (VehicleLocation)

Indica la última ubicación del vehículo.

maximumCapacity

integer

Es la cantidad total de pasajeros que puede transportar este vehículo. El controlador no se considera 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 100 atributos como máximo, y cada uno de ellos debe tener una clave única.

vehicleType

object (VehicleType)

Obligatorio. Indica el tipo de este 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 sobre 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 del conductor pretende tomar al siguiente punto de referencia. Esta lista también se devuelve en Trip.current_route_segment para todos los viajes activos asignados al vehículo.

Nota: Este campo está destinado solo para que lo use el SDK de Driver. Aún no se admite la decodificación.

currentRouteSegmentTraffic

object (TrafficPolylineData)

Solo entrada. Fleet Engine usa esta información para mejorar los viajes compartidos. Nota: Este campo está destinado solo para que lo use el SDK de Driver.

currentRouteSegmentVersion

string (Timestamp format)

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

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 en el que finaliza currentRouteSegment. Los conductores pueden proporcionar esta información en las llamadas a vehicles.update como un punto de referencia de viaje completo, un punto de referencia LatLng o como el último LatLng del currentRouteSegment. Fleet Engine hará lo posible para interpolar un punto de referencia real si no se especifica completamente. Este campo se ignora en las llamadas de 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)

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

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

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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. El tiempo de viaje restante del currentRouteSegment. El valor no se especifica si el campo waypoints está vacío o el campo Vehicle.current_route_segment está vacío. 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. 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.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 el valor es true, es posible que vehicles.search incluya el vehículo, incluso si está asignado a un viaje en ese momento. El valor predeterminado es false.

navigationStatus

enum (NavigationStatus)

El estado de navegación del vehículo.

deviceSettings

object (DeviceSettings)

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

VehicleState

El estado de un Vehicle.

Enumeradores
UNKNOWN_VEHICLE_STATE Predeterminado: se usa para los estados del vehículo no especificados o no reconocidos.
OFFLINE El vehículo no acepta viajes nuevos. Nota: El vehículo puede seguir funcionando en este estado mientras completa un viaje que se le asignó.
ONLINE El vehículo está aceptando viajes nuevos.

VehicleAttribute

Describe un atributo de vehículo como un par clave-valor. La longitud de la string "key:value" 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

El valor del atributo.

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

string

Valor del atributo escrito en cadena.

Nota: Este valor es idéntico al campo value, que con el tiempo 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; de lo contrario, se generará 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

Indica 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

Enumeradores
UNKNOWN Predeterminado: se usa para categorías de vehículos no especificadas o no reconocidas.
AUTO Un automóvil.
TAXI Cualquier vehículo que actúe 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, un ciclomotor o cualquier otro vehículo de dos ruedas
BICYCLE Transporte impulsado por seres humanos.
PEDESTRIAN Un transportador de personas que, por lo general, camina o corre a lo largo de caminos 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

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 ningún valor numérico en esta.

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

TrafficPolylineData

Condiciones de tráfico a lo largo de la ruta esperada 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 de un tramo del viaje de un cliente.

VisualTrafficReportPolylineRendering

Describe de qué manera los clientes deberían colorear una parte de la polilínea a lo largo de la ruta.

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

object (RoadStretch)

Opcional. Es el tramo de ruta que se debe representar a lo largo de la polilínea. Se garantiza que los estiramientos no se superponen y no abarcan toda la ruta.

Ante la ausencia de un tramo de ruta al estilo, 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. El estilo que se aplicará.

offsetMeters

integer

Obligatorio. El diseño debe aplicarse entre [offsetMeters, offsetMeters + lengthMeters).

lengthMeters

integer

Obligatorio. La longitud de la ruta donde se aplicará el estilo.

Estilo

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

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

DeviceSettings

Información sobre los distintos 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)

Indica cómo están configuradas 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á actualmente en el modo de ahorro de energía.

isInteractive

boolean

Indica si el dispositivo está en 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 comportarse en el dispositivo móvil cuando la función de "ahorro de batería" está activada. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enumeradores
UNKNOWN_LOCATION_POWER_SAVE_MODE Modo LocationPowerSaveMode no definido
LOCATION_MODE_NO_CHANGE El ahorro de batería no debería afectar a los proveedores de ubicación o el ahorro de batería está 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 sea interactivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Se deben inhabilitar todos los proveedores de ubicación cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_FOREGROUND_ONLY Todos los proveedores de ubicación estarán disponibles, pero las correcciones de ubicación solo deben proporcionarse a aplicaciones en primer plano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF No se desactivará la ubicación, 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 cargando, etc.

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 cargando, etc.

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

Enumeradores
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 entregas a pedido.

get

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

searchFuzzed
(deprecated)

Obsoleto: usa SearchVehicles en su lugar.

update

Escribe datos de vehículos actualizados en Fleet Engine.

updateAttributes

Actualiza parcialmente los atributos de un vehículo.

updateLocation
(deprecated)

Obsoleto: usa el método UpdateVehicle en su lugar.