REST Resource: providers.vehicles

Recurso: veículo

Metadados do veículo.

Representação 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

Apenas saída. O nome exclusivo deste veículo. O formato é providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

O estado do veículo.
supportedTripTypes[]

enum (TripType)

Tipos de viagem compatíveis com este veículo.
currentTrips[]

string

Apenas saída. Lista de tripId para viagens atribuídas atualmente a este veículo.
lastLocation

object (VehicleLocation)

Último local informado do veículo.
maximumCapacity

integer

O número total de passageiros que este veículo pode transportar. O motorista não é considerado nesse valor. Esse valor precisa ser maior ou igual a um.
attributes[]

object (VehicleAttribute)

Lista de atributos do veículo. Um veículo pode ter no máximo 100 atributos, e cada um deles precisa ter uma chave exclusiva.
vehicleType

object (VehicleType)

Obrigatório. O tipo do veículo. Pode ser usado para filtrar veículos nos resultados de vehicles.search. Também influencia os cálculos de HEC e trajeto.
licensePlate

object (LicensePlate)

Informações da placa do veículo.
route[]
(deprecated)

object (TerminalLocation)

Obsoleto: use Vehicle.waypoints.
currentRouteSegment

string

A polilinha que especifica o trajeto que o app do motorista pretende seguir até o próximo waypoint. Essa lista também é retornada em Trip.current_route_segment para todas as viagens ativas atribuídas ao veículo.

Observação: esse campo é destinado somente ao uso do SDK do Driver. A decodificação ainda não está disponível.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Apenas entrada. O Fleet Engine usa essas informações para melhorar o compartilhamento de jornadas. Observação: esse campo é destinado somente ao uso do SDK do Driver.
currentRouteSegmentVersion

string (Timestamp format)

Apenas saída. Hora em que currentRouteSegment foi definido. Ele pode ser armazenado pelo cliente e transmitido em solicitações vehicles.get futuras para evitar o retorno de rotas que não foram alteradas.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

O waypoint em que currentRouteSegment termina. Ele pode ser informado pelos motoristas em chamadas vehicles.update como um waypoint completo da viagem, um waypoint LatLng ou o último LatLng do currentRouteSegment. O Fleet Engine fará o possível para interpolar com um waypoint real se ele não for totalmente especificado. Este campo é ignorado em chamadas vehicles.update, a menos que currentRouteSegment também seja especificado.
remainingDistanceMeters

integer

A distância de carro restante do currentRouteSegment. Esse valor também é retornado em Trip.remaining_distance_meters para todas as viagens ativas atribuídas ao veículo. O valor não será especificado se o campo currentRouteSegment estiver vazio.
etaToFirstWaypoint

string (Timestamp format)

O HEC para a primeira entrada no campo waypoints. O valor não será especificado se o campo waypoints estiver vazio ou o campo Vehicle.current_route_segment estiver vazio.

Ao atualizar um veículo, remainingTimeSeconds tem precedência sobre etaToFirstWaypoint na mesma solicitação.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
remainingTimeSeconds

integer

Apenas entrada. O tempo de viagem restante para o currentRouteSegment. O valor não será especificado se o campo waypoints estiver vazio ou o campo Vehicle.current_route_segment estiver vazio. Esse valor precisa corresponder a etaToFirstWaypoint - current_time se todas as partes estiverem usando o mesmo relógio.

Ao atualizar um veículo, remainingTimeSeconds tem precedência sobre etaToFirstWaypoint na mesma solicitação.
waypoints[]

object (TripWaypoint)

Os waypoints restantes atribuídos a este veículo.
waypointsVersion

string (Timestamp format)

Apenas saída. Última atualização do campo waypoints. Os clientes precisam armazenar esse valor em cache e transmiti-lo em GetVehicleRequest para garantir que o campo waypoints só seja retornado se for atualizado.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
backToBackEnabled

boolean

Indica se o motorista aceita viagens de ida e volta. Se true, vehicles.search poderá incluir o veículo mesmo que ele esteja atribuído a uma viagem. O valor padrão é false.
navigationStatus

enum (NavigationStatus)

Status de navegação do veículo.
deviceSettings

object (DeviceSettings)

Apenas entrada. Informações sobre as configurações no dispositivo móvel usado pelo motorista.

VehicleState

O estado de um Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Padrão, usado para estados de veículo não especificados ou não reconhecidos.
OFFLINE O veículo não está aceitando novas viagens. Observação: o veículo pode continuar operando nesse estado enquanto conclui uma viagem atribuída a ele.
ONLINE O veículo está aceitando novas viagens.

VehicleAttribute

Descreve um atributo de veículo como um par de chave-valor. O comprimento da string "key:value" não pode exceder 256 caracteres.

Representação 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

A chave do atributo. As chaves não podem conter dois-pontos (:).
value

string

O valor do atributo.
Campo de união vehicle_attribute_value. O valor do atributo, pode estar em string, bool ou tipo duplo. vehicle_attribute_value pode ser apenas de um dos tipos a seguir:
stringValue

string

Valor do atributo do tipo string.

Observação: ele é idêntico ao campo value, que terá o uso suspenso. Para métodos "create" ou "update", ambos os campos podem ser usados, mas é altamente recomendável usar stringValue. Se stringValue e value forem definidos, eles precisarão ser idênticos, ou um erro será gerado. Ambos os campos são preenchidos nas respostas.
boolValue

boolean

Valor de atributo tipo booleano.
numberValue

number

Valor de atributo de dois tipos.

VehicleType

O tipo de veículo.

Representação JSON 
{
  "category": enum (Category)
}
Campos
category

enum (Category)

Categoria do tipo de veículo

Categoria

Categorias de tipos de veículo

Enums
UNKNOWN Padrão, usado para categorias de veículos não especificadas ou não reconhecidas.
AUTO Um automóvel.
TAXI Qualquer veículo que atue como um táxi (normalmente licenciado ou regulamentado).
TRUCK Geralmente, um veículo com grande capacidade de armazenamento.
TWO_WHEELER Uma motocicleta, ciclomoto ou outro veículo de duas rodas
BICYCLE Transporte com recursos humanos.
PEDESTRIAN Um transportador humano, normalmente andando ou correndo, percorrendo caminhos de pedestres.

LicensePlate

As informações da placa do veículo. Para evitar o armazenamento de informações de identificação pessoal, apenas as informações mínimas sobre a placa do veículo são armazenadas como parte da entidade.

Representação JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
Campos
countryCode

string

Obrigatório. Código do país/região do CLDR. Por exemplo, US para Estados Unidos ou IN para Índia.
lastCharacter

string

O último dígito da placa ou "-1" para indicar que não há valor numérico está presente nela.

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

TrafficPolylineData

Condições de trânsito ao longo do trajeto esperado do veículo.

Representação JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Campos
trafficRendering

object (VisualTrafficReportPolylineRendering)

Uma polilinha que mostra a velocidade do trânsito em todas as regiões ao longo de um trecho de uma viagem do cliente.

VisualTrafficReportPolylineRendering

Descreve como os clientes devem colorir uma parte da polilinha ao longo do trajeto.

Representação JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Campos
roadStretch[]

object (RoadStretch)

Opcional. Trechos de estrada que precisam ser renderizados ao longo da polilinha. Os trechos não se sobrepõem e não abrangem necessariamente o trajeto inteiro.

Na ausência de um trecho de via para estilizar, o cliente deve aplicar o padrão para o trajeto.

RoadStretch

Um trecho de estrada que deve ser renderizado.

Representação JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Campos
style

enum (Style)

Obrigatório. O estilo a ser aplicado.
offsetMeters

integer

Obrigatório. O estilo precisa ser aplicado entre [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Obrigatório. O tamanho do caminho em que o estilo será aplicado.

Estilo

O estilo de trânsito, indicando a velocidade do trânsito.

Enums
STYLE_UNSPECIFIED Nenhum estilo selecionado.
SLOWER_TRAFFIC O tráfego está diminuindo.
TRAFFIC_JAM Há um engarrafamento.

DeviceSettings

Informações sobre várias configurações no dispositivo móvel.

Representação JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Campos
locationPowerSaveMode

enum (LocationPowerSaveMode)

Como os recursos de localização são configurados para se comportar no dispositivo quando a economia de bateria está ativada.
isPowerSaveMode

boolean

Se o dispositivo está no modo de economia de energia.
isInteractive

boolean

Se o dispositivo está em um estado interativo.
batteryInfo

object (BatteryInfo)

Informações sobre o estado da bateria.

LocationPowerSaveMode

Como os recursos de localização estão configurados para funcionar no dispositivo móvel quando o recurso "Economia de bateria" está ativado. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode indefinido
LOCATION_MODE_NO_CHANGE A economia de bateria não afeta os provedores de localização ou ela está desativada.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF O provedor de localização por GPS deve ser desativado quando a economia de bateria estiver ativada e o dispositivo não for interativo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Todos os provedores de localização devem ser desativados quando a Economia de bateria estiver ativada e o dispositivo não for interativo.
LOCATION_MODE_FOREGROUND_ONLY Todos os provedores de localização serão mantidos, mas as correções de localização só devem ser fornecidas para apps em primeiro plano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF A localização não será desativada, mas o LocationManager limitará todas as solicitações aos provedores quando o dispositivo não for interativo.

BatteryInfo

Informações sobre a bateria do dispositivo.

Representação JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Campos
batteryStatus

enum (BatteryStatus)

Status da bateria: cheia, carregada etc.
powerSource

enum (PowerSource)

Status da fonte de energia da bateria.
batteryPercentage

number

Porcentagem atual da bateria [0-100].

BatteryStatus

Status da bateria: cheia, carregada etc.

Enums
UNKNOWN_BATTERY_STATUS Status da bateria desconhecido.
BATTERY_STATUS_CHARGING A bateria está sendo carregada.
BATTERY_STATUS_DISCHARGING A bateria está descarregando.
BATTERY_STATUS_FULL A bateria está cheia.
BATTERY_STATUS_NOT_CHARGING A bateria não está carregando.
BATTERY_STATUS_POWER_LOW A bateria está fraca.

PowerSource

Tipo de carregador usado para carregar a bateria.

Enums
UNKNOWN_POWER_SOURCE Fonte de energia desconhecida.
POWER_SOURCE_AC A fonte de energia é um carregador de parede.
POWER_SOURCE_USB A fonte de energia é uma porta USB.
POWER_SOURCE_WIRELESS A fonte de energia é sem fio.
POWER_SOURCE_UNPLUGGED A bateria está desconectada.

Métodos

create

 Instanciar um novo veículo associado a um fornecedor de serviço de transporte por aplicativo ou entregas sob demanda.

get

 Retorna um veículo do Fleet Engine.

list

 Retorna uma lista paginada de veículos associados a um provedor que corresponde às opções de solicitação.
Retorna uma lista de veículos que correspondem às opções de solicitação.

searchFuzzed
(deprecated)

 Obsoleto: use SearchVehicles.

update

 Grava dados atualizados do veículo no Fleet Engine.

updateAttributes

 Atualiza parcialmente os atributos de um veículo.

updateLocation
(deprecated)

 Obsoleto: use o método UpdateVehicle.