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 do 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 a este veículo no momento.
lastLocation

object (VehicleLocation)

Último local informado do veículo.
maximumCapacity

integer

O número total de passageiros que este veículo pode transportar. O driver não é considerado nesse valor. O 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 atributo precisa ter uma chave exclusiva.
vehicleType

object (VehicleType)

Obrigatório. O tipo do veículo. Pode ser usado para filtrar veículos em resultados de vehicles.search. Também influencia os cálculos de ETA e rota.
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 para 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: este campo é destinado apenas para uso pelo SDK do Driver. Ainda não há suporte para decodificação.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Somente entrada. O Fleet Engine usa essas informações para melhorar o compartilhamento de jornadas. Observação: este campo é destinado apenas para uso pelo 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 rotas de retorno que não foram alteradas.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", 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 onde currentRouteSegment termina. Isso pode ser fornecido pelos motoristas em chamadas vehicles.update como um ponto de passagem de viagem completo, um ponto de passagem LatLng ou como o último LatLng da currentRouteSegment. O Fleet Engine vai fazer o possível para interpolar para um waypoint real se ele não for totalmente especificado. Esse campo é ignorado em chamadas vehicles.update, a menos que currentRouteSegment também seja especificado.
remainingDistanceMeters

integer

A distância de carro restante do percurso 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 RFC3339 UTC "Zulu", 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

Somente entrada. O tempo restante de percurso do veículo 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 vez em que o campo waypoints foi atualizado. Os clientes precisam armazenar esse valor em cache e transmiti-lo em GetVehicleRequest para garantir que o campo waypoints seja retornado apenas se for atualizado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", 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 pode incluir o veículo mesmo que ele esteja atribuído a uma viagem. O valor padrão é false.
navigationStatus

enum (NavigationStatus)

O status de navegação do veículo.
deviceSettings

object (DeviceSettings)

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

VehicleState

O estado de uma 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 realiza uma viagem atribuída a ele.
ONLINE O veículo está aceitando novas viagens.

VehicleAttribute

Descreve um atributo do veículo como um par de chave-valor. O comprimento da string "chave:valor" 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 ser string, booleano ou duplo. vehicle_attribute_value pode ser apenas de um dos tipos a seguir:
stringValue

string

Valor do atributo tipado de string.

Observação: ele é idêntico ao campo value, que será descontinuado. Para os métodos de criação ou atualização, qualquer um dos campos pode ser usado, 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 do atributo tipado booleano.
numberValue

number

Valor de atributo com 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 funcione como táxi (normalmente licenciado ou regulamentado).
TRUCK Geralmente, um veículo com grande capacidade de armazenamento.
TWO_WHEELER Uma moto, ciclomoto ou outro veículo de duas rodas
BICYCLE Transporte movido por pessoas.
PEDESTRIAN Um transportador humano, geralmente caminhando ou correndo, viajando por vias de pedestres.

LicensePlate

As informações da placa do veículo. Para evitar o armazenamento de informações de identificação pessoal, apenas o mínimo de informações sobre a placa do carro é armazenado como parte da entidade.

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

string

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

string

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

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

TrafficPolylineData

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

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

object (VisualTrafficReportPolylineRendering)

Uma renderização de polilinha que mostra a velocidade do trânsito para todas as regiões ao longo de um trecho de uma viagem com o cliente.

VisualTrafficReportPolylineRendering

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

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

object (RoadStretch)

Opcional. Trecho de via que precisa ser renderizado ao longo da polilinha. Os trechos não se sobrepõem e não abrangem necessariamente todo o trajeto.

Na ausência de um trecho de estrada para estilizar, o cliente deve aplicar o padrão da rota.

RoadStretch

Um trecho de via que precisa 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 do trânsito, indicando a velocidade.

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 no momento.
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 são configurados para se comportar 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 indefinida
LOCATION_MODE_NO_CHANGE Os provedores de local não podem ser afetados pela Economia de bateria ou ela precisa estar desativada.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF O provedor de localização com base em GPS deve ser desativado quando a economia de bateria estiver ativada e o dispositivo não estiver 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 local vão continuar disponíveis, mas as correções de local só serão fornecidas aos apps em primeiro plano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF A localização não será desativada, mas o LocationManager vai limitar todas as solicitações a 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, se está cheia ou carregando etc.
powerSource

enum (PowerSource)

Status da fonte de energia da bateria.
batteryPercentage

number

Porcentagem atual da bateria [0-100].

BatteryStatus

Status da bateria: cheia, carregando 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 CA.
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 veículo novo associado a um provedor de transporte por aplicativo sob demanda ou de entregas.

get

 Retorna um veículo do Fleet Engine.

list

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

update

 Grava dados atualizados do veículo no Fleet Engine.

updateAttributes

 Atualiza parcialmente os atributos de um veículo.