Package maps.fleetengine.v1

Índice

TripService

Serviço de gerenciamento de viagens.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Cria uma viagem no Fleet Engine e a retorna.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Veja informações sobre uma única viagem.
ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Informe o uso faturável da viagem.
SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Confira todas as viagens de um veículo específico.
UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Atualiza os dados da viagem.

VehicleService

Serviço de gerenciamento de veículos.

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Cria um novo veículo associado a um provedor de transporte sob demanda ou entregas. Cada Vehicle precisa ter um ID de veículo exclusivo.

Os campos Vehicle a seguir são obrigatórios ao criar um Vehicle:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Os campos Vehicle a seguir são ignorados ao criar um Vehicle:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Todos os outros campos são opcionais e usados se fornecidos.
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Retorna um veículo do Fleet Engine.
ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

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

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Retorna uma lista de veículos que correspondem às opções de solicitação.
UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

Grava dados atualizados do veículo no Fleet Engine.

Ao atualizar uma Vehicle, os seguintes campos não podem ser atualizados porque são gerenciados pelo servidor:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

Também não é possível atualizar o veículo name.

Se o campo attributes for atualizado, todos os atributos do veículo serão substituídos pelos atributos fornecidos na solicitação. Se você quiser atualizar apenas alguns atributos, consulte o método UpdateVehicleAttributes. Da mesma forma, o campo waypoints pode ser atualizado, mas precisa conter todos os waypoints atuais no veículo e nenhum outro.
UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

Atualiza parcialmente os atributos de um veículo. Somente os atributos mencionados na solicitação serão atualizados. Outros atributos NÃO serão alterados. Observação: isso é diferente em UpdateVehicle, em que o campo attributes inteiro é substituído pelo campo em UpdateVehicleRequest, e os atributos que não estão na solicitação são removidos.

BatteryInfo

Informações sobre a bateria do dispositivo.

Campos
battery_status

BatteryStatus

Status da bateria, se está cheia ou carregando etc.
power_source

PowerSource

Status da fonte de energia da bateria.
battery_percentage

float

Porcentagem atual da bateria [0-100].

BatteryStatus

Status da bateria, se está cheia ou 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.

BillingPlatformIdentifier

Um conjunto de valores que indicam em qual plataforma a solicitação foi emitida.

Enums
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED Padrão. Usado para plataformas não especificadas.
SERVER A plataforma é um servidor cliente.
WEB A plataforma é um navegador da Web.
ANDROID A plataforma é um dispositivo móvel Android.
IOS A plataforma é um dispositivo móvel iOS.
OTHERS Outras plataformas que não estão listadas nesta enumeração.

ConsumableTrafficPolyline

Densidade de trânsito ao longo do caminho de um veículo.

Campos
speed_reading_interval[]

SpeedReadingInterval

Velocidade do trânsito no caminho desde o waypoint anterior até o waypoint atual.
encoded_path_to_waypoint

string

O caminho que o motorista está seguindo do waypoint anterior até o atual. Este caminho contém pontos de referência para que os clientes possam mostrar marcadores de tráfego ao longo do caminho (consulte speed_reading_interval). Ainda não há suporte para decodificação.

CreateTripRequest

Mensagem de solicitação CreateTrip.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
trip_id

string

Obrigatório. ID exclusivo da viagem. Sujeito às seguintes restrições:

  • Precisa ser uma string Unicode válida.
  • Limitado a um comprimento máximo de 64 caracteres.
  • Normalizado de acordo com o Formulário de normalização C do Unicode.
  • Não pode conter os seguintes caracteres ASCII: "/", ':', '?', ',' ou '#'.
trip

Trip

Obrigatório. Entidade de viagem a ser criada.

Ao criar uma viagem, os seguintes campos são obrigatórios:

  • trip_type
  • pickup_point

Os campos a seguir são usados se você os fornecer:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Todos os outros campos de viagem são ignorados. Por exemplo, todas as viagens começam com um trip_status de NEW, mesmo que você transmita um trip_status de CANCELED na solicitação de criação.

Apenas viagens de EXCLUSIVE aceitam intermediate_destinations.

Quando vehicle_id é definido para uma viagem compartilhada, você precisa fornecer a lista de Trip.vehicle_waypoints para especificar a ordem dos pontos de passagem restantes do veículo. Caso contrário, a ordem dos pontos de passagem não será determinada.

Quando você especifica Trip.vehicle_waypoints, a lista precisa conter todos os waypoints restantes das viagens do veículo, sem outros waypoints. Você precisa ordenar esses waypoints para que, em uma determinada viagem, o ponto de embarque fique antes dos destinos intermediários e todos os destinos intermediários fiquem antes do ponto de desembarque. Os pontos de passagem de uma viagem EXCLUSIVE não podem se intercalar com outras viagens.

Os campos trip_id, waypoint_type e location são usados, e todos os outros campos de Ponto de parada do trajeto em vehicle_waypoints são ignorados.

CreateVehicleRequest

Mensagem de solicitação CreateVehicle.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
vehicle_id

string

Obrigatório. ID exclusivo do veículo. Sujeito às seguintes restrições:

  • Precisa ser uma string Unicode válida.
  • Limitado a um comprimento máximo de 64 caracteres.
  • Normalizado de acordo com o Formulário C de normalização Unicode.
  • Não pode conter os seguintes caracteres ASCII: "/", ':', '?', ',' ou '#'.
vehicle

Vehicle

Obrigatório. A entidade "Veículo" a ser criada. Ao criar um veículo, os seguintes campos são obrigatórios:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Ao criar um veículo, os seguintes campos são ignorados:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Todos os outros campos são opcionais e usados se informados.

DeviceSettings

Informações sobre diversas configurações do dispositivo móvel.

Campos
location_power_save_mode

LocationPowerSaveMode

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

bool

Se o dispositivo está no modo de economia de energia no momento.
is_interactive

bool

Se o dispositivo está em um estado interativo.
battery_info

BatteryInfo

Informações sobre o estado da bateria.

GetTripRequest

Mensagem de solicitação GetTrip.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/trips/{trip}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud em que a conta de serviço que faz a chamada é membro.
view

TripView

O subconjunto de campos de viagem que precisam ser retornados e a interpretação deles.
current_route_segment_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) para o qual os dados Trip.route ou Trip.current_route_segment são recuperados. Se os dados da rota não tiverem mudado desde esse carimbo de data/hora, o campo de rota não será definido na resposta. Se um mínimo não for especificado, os dados da rota serão sempre recuperados.
remaining_waypoints_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) para o qual Trip.remaining_waypoints são recuperados. Se eles não tiverem sido alterados desde esse carimbo de data/hora, o remaining_waypoints não será definido na resposta. Se esse campo não for especificado, remaining_waypoints será sempre recuperado.
route_format_type

PolylineFormatType

O formato do trajeto atual retornado, LAT_LNG_LIST_TYPE (em Trip.route) ou ENCODED_POLYLINE_TYPE (em Trip.current_route_segment). O padrão é LAT_LNG_LIST_TYPE.
current_route_segment_traffic_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) para o qual Trip.current_route_segment_traffic é recuperado. Se os dados de tráfego não tiverem mudado desde esse carimbo de data/hora, o campo current_route_segment_traffic não será definido na resposta. Se um mínimo não for especificado, os dados de tráfego serão sempre recuperados. O tráfego só está disponível para clientes da solução de viagens e entregas sob demanda.
remaining_waypoints_route_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) para o qual os dados Trip.remaining_waypoints.traffic_to_waypoint e Trip.remaining_waypoints.path_to_waypoint são recuperados. Se os dados não tiverem sido alterados desde esse carimbo de data/hora, os campos acima não serão definidos na resposta. Se remaining_waypoints_route_version não for especificado, o tráfego e o caminho serão sempre recuperados.

GetVehicleRequest

Mensagem de solicitação GetVehicle.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/vehicles/{vehicle}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
current_route_segment_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) para o qual Vehicle.current_route_segment é recuperado. Se a rota não tiver mudado desde esse carimbo de data/hora, o campo current_route_segment não será definido na resposta. Se um mínimo não for especificado, o current_route_segment será sempre recuperado.
waypoints_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) para o qual os dados Vehicle.waypoints são recuperados. Se os pontos de passagem não tiverem mudado desde esse carimbo de data/hora, os dados de vehicle.waypoints não serão definidos na resposta. Se esse campo não for especificado, vehicle.waypoints será sempre recuperado.

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.

Campos
country_code

string

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

string

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

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

ListVehiclesRequest

Mensagem de solicitação ListVehicles.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
page_size

int32

O número máximo de veículos a serem retornados. Valor padrão: 100.
page_token

string

O valor do next_page_token fornecido por uma chamada anterior para ListVehicles, para que você possa paginar grupos de veículos. O valor será indefinido se os critérios de filtro da solicitação não forem os mesmos da chamada anterior para ListVehicles.
minimum_capacity

Int32Value

Especifica a capacidade mínima exigida do veículo. Todos os veículos retornados terão um maximum_capacity maior ou igual a esse valor. Se definido, precisa ser maior ou igual a 0.
trip_types[]

TripType

Restringe a resposta a veículos compatíveis com pelo menos um dos tipos de viagem especificados.
maximum_staleness

Duration

Restringe a resposta a veículos que enviaram atualizações de localização para o Fleet Engine no período especificado. Veículos estacionários que ainda transmitam suas localizações não são considerados desatualizados. Se presente, precisa ser uma duração positiva válida.
vehicle_type_categories[]

Category

Obrigatório. Restringe a resposta a veículos com uma das categorias de tipo especificadas. A política UNKNOWN não é permitida.
required_attributes[]

string

Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos required_attributes, required_one_of_attributes e required_one_of_attribute_sets.

required_attributes é uma lista. required_one_of_attributes usa uma mensagem que permite uma lista de listas. Em conjunto, os dois campos permitem a composição desta expressão:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restringe a resposta a veículos com os atributos especificados. Esse campo é uma operação de conjunção/AND. São permitidos no máximo 50 required_attributes. Esse valor corresponde ao número máximo de atributos permitidos em um veículo. Cada string repetida precisa ter o formato "chave:valor".
required_one_of_attributes[]

string

Restringe a resposta a veículos com pelo menos um dos atributos especificados em cada VehicleAttributeList. Em cada lista, um veículo precisa corresponder a pelo menos um dos atributos. Esse campo é uma operação de disjunção/E inclusiva em cada VehicleAttributeList e uma operação de conjunção/E na coleção de VehicleAttributeList. Cada string repetida precisa estar no formato "key1:value1|key2:value2|key3:value3".
required_one_of_attribute_sets[]

string

required_one_of_attribute_sets oferece mais funcionalidades.

Semelhante a required_one_of_attributes, required_one_of_attribute_sets usa uma mensagem que permite uma lista de listas, permitindo expressões como esta:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restringe a resposta a veículos que correspondem a todos os atributos em uma VehicleAttributeList. Em cada lista, um veículo precisa corresponder a todos os atributos. Esse campo é uma operação de conjunção/E em cada VehicleAttributeList e uma operação inclusiva de disjunção/OU na coleção de VehicleAttributeList. Cada string repetida precisa ter o formato "chave1:valor1|chave2:valor2|chave3:valor3".
vehicle_state

VehicleState

Restringe a resposta a veículos que têm esse estado.
on_trip_only

bool

Só devolver os veículos com as viagens em andamento.
filter

string

Opcional. Uma consulta de filtro a ser aplicada ao listar veículos. Consulte http://aip.dev/160 para ver exemplos de sintaxe de filtro.

Esse campo foi criado para substituir os campos required_attributes, required_one_of_attributes e required_one_of_attributes_sets. Se um valor não vazio for especificado aqui, os seguintes campos precisarão estar vazios: required_attributes, required_one_of_attributes e required_one_of_attributes_sets.

Esse filtro funciona como uma cláusula AND com outras restrições, como vehicle_state ou on_trip_only.

As únicas consultas compatíveis são sobre atributos do veículo (por exemplo, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). O número máximo de restrições permitidas em uma consulta de filtro é 50.

Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações compatíveis com os atributos são aquelas de strings. Para comparar com valores numéricos ou booleanos, os valores precisam ser citados explicitamente para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").
viewport

Viewport

Opcional. Um filtro que limita os veículos retornados àqueles cujo último local conhecido estava na área retangular definida pela janela de visualização.

ListVehiclesResponse

ListVehicles mensagem de resposta.

Campos
vehicles[]

Vehicle

Veículos que correspondem aos critérios da solicitação. O número máximo de veículos retornados é determinado pelo campo page_size na solicitação.
next_page_token

string

Token para recuperar a próxima página de veículos ou vazia se não houver mais veículos que atendam aos critérios de solicitação.
total_size

int64

Obrigatório. Número total de veículos que correspondem aos critérios de solicitação em todas as páginas.

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 indefinido
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 baseado em GPS precisa ser desativado quando o modo Economia de bateria está ativado e o dispositivo não é interativo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Todos os provedores de local precisam ser desativados quando o modo de economia de bateria está ativado e o dispositivo não é interativo.
LOCATION_MODE_FOREGROUND_ONLY Todos os provedores de localização vão continuar disponíveis, mas as correções de local só vão ser 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 para provedores quando o dispositivo não estiver interativo.

LocationSensor

O sensor ou a metodologia usado para determinar o local.

Enums
UNKNOWN_SENSOR O sensor não foi especificado ou é desconhecido.
GPS GPS ou GPS assistido.
NETWORK GPS assistido, ID da torre de celular ou ponto de acesso Wi-Fi.
PASSIVE ID da torre de celular ou ponto de acesso Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Um local determinado pelo dispositivo móvel como a posição mais provável na via.
CUSTOMER_SUPPLIED_LOCATION Uma localização fornecida pelo cliente de uma fonte independente. Normalmente, esse valor é usado para um local fornecido de fontes diferentes do dispositivo móvel que executa o SDK do Driver. Se a origem original for descrita por um dos outros valores de tipo enumerado, use esse valor. Os locais marcados como CUSTOMER_SuppPLIED_LOCATION geralmente são fornecidos pelo last_location.supplemental_location_sensor do veículo.
FLEET_ENGINE_LOCATION Um local calculado pelo Fleet Engine com base nos sinais disponíveis. Apenas saída. Esse valor será rejeitado se for recebido em uma solicitação.
FUSED_LOCATION_PROVIDER Provedor de localização combinada do Android.
CORE_LOCATION O provedor de local em sistemas operacionais da Apple.

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

Enums
UNKNOWN_NAVIGATION_STATUS Status de navegação não especificado.
NO_GUIDANCE A navegação do app Driver está no modo FREE_NAV.
ENROUTE_TO_DESTINATION A navegação guiada está disponível, e a navegação do app Driver entrou no modo GUIDED_NAV.
OFF_ROUTE O veículo saiu do trajeto sugerido.
ARRIVED_AT_DESTINATION O veículo está a aproximadamente 50 m do destino.

PolylineFormatType

O tipo de formato de polilinha.

Enums
UNKNOWN_FORMAT_TYPE O formato não foi especificado ou é desconhecido.
LAT_LNG_LIST_TYPE Uma lista de google.type.LatLng.
ENCODED_POLYLINE_TYPE Uma polilinha codificada com um algoritmo de compactação de polilinha. Ainda não há suporte para decodificação.

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.

ReportBillableTripRequest

Mensagem de solicitação ReportBillableTrip.

Campos
name

string

Obrigatório. Precisa estar no formato providers/{provider}/billableTrips/{billable_trip}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
country_code

string

Obrigatório. Código do país com duas letras do país onde a viagem acontece. O preço é definido de acordo com o código do país.
platform

BillingPlatformIdentifier

Plataforma em que a solicitação foi emitida.
related_ids[]

string

Os identificadores diretamente relacionados à viagem que está sendo informada. Geralmente, são IDs (por exemplo, IDs de sessão) de operações de pré-reserva realizadas antes da disponibilização do ID da viagem. O número de related_ids é limitado a 50.
solution_type

SolutionType

O tipo de solução de produto do GMP (por exemplo, ON_DEMAND_RIDESHARING_AND_DELIVERIES) usado na viagem informada.

SolutionType

Seletor para diferentes tipos de solução de uma viagem denunciada.

Enums
SOLUTION_TYPE_UNSPECIFIED O valor padrão. Para garantir a compatibilidade com versões anteriores, a API vai usar ON_DEMAND_RIDESHARING_AND_DELIVERIES por padrão, que é o primeiro tipo de solução com suporte.
ON_DEMAND_RIDESHARING_AND_DELIVERIES A solução é um transporte sob demanda e entregas.

RequestHeader

Um RequestHeader contém campos comuns a todas as solicitações de RPC do Fleet Engine.

Campos
language_code

string

O código de idioma BCP-47, como "pt-BR" ou "en-US". Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Se nenhum for especificado, a resposta poderá ser em qualquer idioma, com preferência pelo inglês, se esse nome existir. Exemplo de valor do campo: en-US.
region_code

string

Obrigatório. Código regional CLDR da região de origem da solicitação. Exemplo de valor do campo: US.
sdk_version

string

Versão do SDK de chamada, se aplicável. O formato da versão é "major.minor.patch", exemplo: 1.1.2.
os_version

string

Versão do sistema operacional em que o SDK de chamada está sendo executado. Exemplos de valor de campo: 4.4.1, 12.1.
device_model

string

Modelo do dispositivo em que o SDK de chamada está sendo executado. Exemplos de valor de campo: iPhone12,1, SM-G920F.
sdk_type

SdkType

O tipo de SDK que envia a solicitação.
maps_sdk_version

string

Versão do MapSDK da qual o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", exemplo: 5.2.1.
nav_sdk_version

string

Versão do NavSDK de que o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por exemplo: 2.1.0.
platform

Platform

Plataforma do SDK que faz a chamada.
manufacturer

string

Fabricante do dispositivo Android do SDK de chamada, aplicável apenas a SDKs do Android. Exemplo de valor do campo: Samsung.
android_api_level

int32

Nível da API do Android do SDK de chamada, aplicável apenas a SDKs do Android. Exemplo de valor do campo: 23.
trace_id

string

ID opcional que pode ser fornecido para fins de registro em log a fim de identificar a solicitação.

Plataforma

A plataforma do SDK de chamada.

Enums
PLATFORM_UNSPECIFIED O valor padrão. Esse valor é usado se a plataforma for omitida.
ANDROID A solicitação vem do Android.
IOS A solicitação vem do iOS.
WEB A solicitação vem da Web.

SdkType

Possíveis tipos de SDK.

Enums
SDK_TYPE_UNSPECIFIED O valor padrão. Esse valor será usado se sdk_type for omitido.
CONSUMER O SDK de chamada é o consumidor.
DRIVER O SDK que faz a chamada é o driver.
JAVASCRIPT O SDK de chamada é JavaScript.

SearchTripsRequest

Mensagem de solicitação do SearchTrips.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
vehicle_id

string

O veículo associado às viagens na solicitação. Se não for especificado, as viagens retornadas não vão conter:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

Se ela for definida como verdadeira, a resposta incluirá viagens que influenciam o trajeto de um motorista.
page_size

int32

Se não for definido, o servidor decidirá o número de resultados a serem retornados.
page_token

string

Defina-o como um valor retornado anteriormente no SearchTripsResponse para continuar dos resultados anteriores.
minimum_staleness

Duration

Se especificado, retorna as viagens que não foram atualizadas depois do horário (current - minimum_staleness).

SearchTripsResponse

Mensagem de resposta do SearchTrips.

Campos
trips[]

Trip

A lista de viagens para o veículo solicitado.
next_page_token

string

Transmita esse token no SearchTripsRequest para percorrer os resultados da lista. A API retorna uma lista de viagens em cada chamada. Quando não há mais resultados, a lista de viagens fica vazia.

SearchVehiclesRequest

Mensagem de solicitação SearchVehicles.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
pickup_point

TerminalLocation

Obrigatório. O ponto de encontro próximo ao qual pesquisar.
dropoff_point

TerminalLocation

O local de entrega pretendido do cliente. O campo é obrigatório se trip_types contiver TripType.SHARED.
pickup_radius_meters

int32

Obrigatório. Define o raio de pesquisa do veículo ao redor do ponto de embarque. Somente os veículos dentro do raio de pesquisa serão retornados. O valor precisa estar entre 400 e 10.000 metros (inclusive).
count

int32

Obrigatório. Especifica o número máximo de veículos a serem retornados. O valor precisa estar entre 1 e 50 (inclusive).
minimum_capacity

int32

Obrigatório. Especifica o número de passageiros considerados para uma viagem. O valor precisa ser maior ou igual a 1. O driver não é considerado no valor da capacidade.
trip_types[]

TripType

Obrigatório. Representa o tipo de viagem proposta. Precisa incluir exatamente um tipo. A política UNKNOWN_TRIP_TYPE não é permitida. Restringe a pesquisa apenas aos veículos que podem oferecer esse tipo de viagem.
maximum_staleness

Duration

Restringe a pesquisa apenas aos veículos que enviaram atualizações de local ao Fleet Engine no período especificado. Veículos estacionários que ainda transmitam suas localizações não são considerados desatualizados. Se esse campo não for definido, o servidor usará cinco minutos como valor padrão.
vehicle_types[]

VehicleType

Obrigatório. Restringe a pesquisa a veículos com um dos tipos especificados. É necessário especificar pelo menos um tipo de veículo. Não são permitidos tipos de veículo com a categoria UNKNOWN.
required_attributes[]

VehicleAttribute

Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos required_attributes, required_one_of_attributes e required_one_of_attribute_sets.

required_attributes é uma lista. required_one_of_attributes usa uma mensagem que permite uma lista de listas. Em combinação, os dois campos permitem a composição desta expressão:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restringe a pesquisa apenas aos veículos com os atributos especificados. Esse campo é uma operação de conjunção/AND. São permitidos no máximo 50 required_attributes. Esse valor corresponde ao número máximo de atributos permitidos em um veículo.
required_one_of_attributes[]

VehicleAttributeList

Restringe a pesquisa apenas aos veículos com pelo menos um dos atributos especificados em cada VehicleAttributeList. Em cada lista, um veículo precisa corresponder a pelo menos um dos atributos. Esse campo é uma operação de disjunção/OR inclusiva em cada VehicleAttributeList e uma operação de conjunção/AND na coleção de VehicleAttributeList.
required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets oferece mais funcionalidades.

Assim como o required_one_of_attributes, o required_one_of_attribute_sets usa uma mensagem que permite uma lista de listas, permitindo expressões como esta:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restringe a pesquisa apenas aos veículos com todos os atributos em um VehicleAttributeList. Em cada lista, um veículo precisa corresponder a todos os atributos. Esse campo é uma operação de união/AND em cada VehicleAttributeList e uma operação de disjunção/OR inclusiva em toda a coleção de VehicleAttributeList.
order_by

VehicleMatchOrder

Obrigatório. Especifica o critério de ordenação desejado para os resultados.
include_back_to_back

bool

Indica se os veículos com uma única viagem ativa estão qualificados para essa pesquisa. Esse campo só é usado quando current_trips_present não é especificado. Quando current_trips_present não é especificado e esse campo é false, os veículos com viagens atribuídas são excluídos dos resultados da pesquisa. Quando current_trips_present não é especificado e esse campo é true, os resultados da pesquisa podem incluir veículos com uma viagem ativa com status ENROUTE_TO_DROPOFF. Quando current_trips_present é especificado, este campo não pode ser definido como verdadeiro.

O valor padrão é false.
trip_id

string

Indica a viagem associada a essa SearchVehicleRequest.
current_trips_present

CurrentTripsPresent

Indica se veículos com viagens ativas estão qualificados para essa pesquisa. Precisa ser definido como algo diferente de CURRENT_TRIPS_PRESENT_UNSPECIFIED se trip_type incluir SHARED.
filter

string

Opcional. Uma consulta de filtro a ser aplicada ao pesquisar veículos. Consulte http://aip.dev/160 para ver exemplos de sintaxe de filtro.

Esse campo foi criado para substituir os campos required_attributes, required_one_of_attributes e required_one_of_attributes_sets. Se um valor não vazio for especificado aqui, os seguintes campos precisarão estar vazios: required_attributes, required_one_of_attributes e required_one_of_attributes_sets.

Esse filtro funciona como uma cláusula AND com outras restrições, como minimum_capacity ou vehicle_types.

As únicas consultas aceitas são nos atributos do veículo (por exemplo, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). O número máximo de restrições permitido em uma consulta de filtro é 50.

Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações com suporte para atributos são comparações de string. Para fazer uma comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").

CurrentTripsPresent

Especifica os tipos de restrições nas viagens atuais de um veículo.

Enums
CURRENT_TRIPS_PRESENT_UNSPECIFIED A disponibilidade de veículos com as viagens é regida pelo campo include_back_to_back.
NONE Veículos sem viagens podem aparecer nos resultados da pesquisa. Quando esse valor é usado, include_back_to_back não pode ser true.
ANY Veículos com, no máximo, 5 viagens atuais e 10 waypoints são incluídos nos resultados da pesquisa. Quando esse valor é usado, include_back_to_back não pode ser true.

VehicleMatchOrder

Especifica a ordem das correspondências do veículo na resposta.

Enums
UNKNOWN_VEHICLE_MATCH_ORDER Padrão, usado para correspondências de veículos não especificados ou não reconhecidos.
PICKUP_POINT_ETA Ordem crescente pelo tempo de percurso até o ponto de retirada.
PICKUP_POINT_DISTANCE Ordem crescente por distância de carro do veículo até o ponto de embarque.
DROPOFF_POINT_ETA Ordem crescente pelo tempo de percurso do veículo até o ponto de entrega. Esse pedido só pode ser usado se o ponto de entrega for especificado na solicitação.
PICKUP_POINT_STRAIGHT_DISTANCE Pedido crescente por distância em linha reta do último local relatado do veículo até o ponto de embarque.
COST Ordem crescente pelo custo de correspondência configurado. O custo de correspondência é definido como um cálculo ponderado entre a distância em linha reta e a hora prevista de chegada. Os pesos são definidos com valores padrão e podem ser modificados por cliente. Entre em contato com o Suporte do Google se precisar modificar esses pesos para seu projeto.

SearchVehiclesResponse

Mensagem de resposta SearchVehicles.

Campos
matches[]

VehicleMatch

Lista de veículos que correspondem aos critérios de SearchVehiclesRequest, ordenados de acordo com o campo SearchVehiclesRequest.order_by.

SpeedReadingInterval

Indicador de densidade de tráfego em um segmento contíguo de um caminho. Dado um caminho com pontos P_0, P_1, ... , P_N (índice baseado em zero), o SpeedReadingInterval define um intervalo e descreve o tráfego usando as seguintes categorias.

Campos
start_polyline_point_index

int32

O índice inicial deste intervalo no caminho. No JSON, quando o índice é 0, o campo parece não estar preenchido.
end_polyline_point_index

int32

O índice final deste intervalo no caminho. No JSON, quando o índice é 0, o campo parece não estar preenchido.
speed

Speed

Velocidade do tráfego neste intervalo.

Velocidade

Classificação da velocidade da poligonal com base nos dados de tráfego.

Enums
SPEED_UNSPECIFIED Valor padrão. Esse valor não é usado.
NORMAL Velocidade normal, nenhuma lentidão é detectada.
SLOW Lentidão foi detectada, mas não houve engarrafamento.
TRAFFIC_JAM Congestionamento detectado.

StopLocation

O local real em que ocorreu uma parada (embarque/desembarque).

Campos
point

LatLng

Obrigatório. Indica o local real.
timestamp

Timestamp

Indica quando a parada aconteceu.
stop_time
(deprecated)

Timestamp

Somente entrada. Obsoleto. Use o campo de carimbo de data/hora.

TerminalLocation

Descreve a localização de um waypoint.

Campos
point

LatLng

Obrigatório. Indica o local de um waypoint da viagem.
terminal_point_id
(deprecated)

TerminalPointId

Obsoleto: especifique o campo point.
access_point_id
(deprecated)

string

Obsoleto: especifique o campo point.
trip_id
(deprecated)

string

Obsoleto.
terminal_location_type
(deprecated)

WaypointType

Descontinuado: Vehicle.waypoint vai ter esses dados.

TerminalPointId

Descontinuado: os pontos de terminação não são mais compatíveis com o Fleet Engine. Use TerminalLocation.point

Campos
value
(deprecated)

string

Obsoleto.
Campo de união Id. Obsoleto. Id pode ser apenas de um dos tipos a seguir:
place_id
(deprecated)

string

Obsoleto.
generated_id
(deprecated)

string

Obsoleto.

TrafficPolylineData

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

Campos
traffic_rendering

VisualTrafficReportPolylineRendering

Uma renderização de linha poligonal da velocidade do tráfego em todas as regiões ao longo de um trecho de um percurso do cliente.

Viagem

Metadados da viagem.

Campos
name

string

Apenas saída. No formato "providers/{provider}/trips/{trip}"
vehicle_id

string

ID do veículo que está fazendo essa viagem.
trip_status

TripStatus

Status atual da viagem.
trip_type

TripType

O tipo de viagem.
pickup_point

TerminalLocation

Local onde o cliente indica que será atendido.
actual_pickup_point

StopLocation

Somente entrada. O local real em que o cliente foi buscado. Este campo serve para o fornecedor enviar feedback sobre as informações de retirada.
actual_pickup_arrival_point

StopLocation

Somente entrada. A hora e o local reais de chegada do motorista no ponto de embarque. Este campo serve para o fornecedor enviar feedback sobre informações reais de chegada ao ponto de embarque.
pickup_time

Timestamp

Apenas saída. A hora futura estimada em que os passageiros embarcarão ou a hora real em que eles foram embarcados.
intermediate_destinations[]

TerminalLocation

Paradas intermediárias para que a viagem solicite (além dos embarques e desembarques). Inicialmente, isso não será compatível com viagens compartilhadas.
intermediate_destinations_version

Timestamp

Indica a última vez que o intermediate_destinations foi modificado. Seu servidor precisa armazenar esse valor em cache e transmiti-lo em UpdateTripRequest ao atualizar o intermediate_destination_index para garantir que o intermediate_destinations não seja modificado.
intermediate_destination_index

int32

Quando TripStatus for ENROUTE_TO_INTERMEDIATE_DESTINATION, um número entre [0..N-1] indica qual destino intermediário o veículo vai atravessar em seguida. Quando TripStatus é ARRIVED_AT_INTERMEDIATE_DESTINATION, um número entre [0..N-1] que indica em qual destino intermediário o veículo está. O provedor define esse valor. Se não houver intermediate_destinations, este campo será ignorado.
actual_intermediate_destination_arrival_points[]

StopLocation

Somente entrada. O horário e local reais de chegada do motorista a um destino intermediário. Este campo serve para o provedor fornecer feedback sobre informações reais de chegada em destinos intermediários.
actual_intermediate_destinations[]

StopLocation

Somente entrada. A hora e o local reais quando e onde o cliente foi retirado de um destino intermediário. Esse campo é para o provedor enviar feedback sobre as informações de coleta reais em destinos intermediários.
dropoff_point

TerminalLocation

Local onde o cliente indica que será deixado.
actual_dropoff_point

StopLocation

Somente entrada. O horário e local reais em que o cliente foi deixado. Esse campo é para o provedor dar feedback sobre as informações reais de entrega.
dropoff_time

Timestamp

Apenas saída. O horário futuro estimado em que os passageiros serão deixados no destino final ou o horário real em que foram deixados.
remaining_waypoints[]

TripWaypoint

Apenas saída. O caminho completo do local atual até o ponto de entrega. Esse caminho pode incluir waypoints de outras viagens.
vehicle_waypoints[]

TripWaypoint

Este campo permite a ordenação manual dos waypoints da viagem. Ele contém todos os pontos de referência restantes do veículo atribuído, bem como os pontos de coleta e de entrega da viagem. Se a viagem não tiver sido atribuída a um veículo, o Fleet Engine vai ignorar esse campo. Por motivos de privacidade, esse campo só é preenchido pelo servidor nas chamadas UpdateTrip e CreateTrip, NÃO em chamadas GetTrip.
route[]

LatLng

Apenas saída. Trajeto previsto para esta viagem até a primeira entrada em quarter_waypoints. O primeiro ponto de passagem pode pertencer a uma viagem diferente.
current_route_segment

string

Apenas saída. Um caminho codificado para o próximo ponto de referência.

Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor. Ainda não há suporte para decodificação.
current_route_segment_version

Timestamp

Apenas saída. Indica a última vez que o trajeto foi modificado.

Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor.
current_route_segment_traffic

ConsumableTrafficPolyline

Apenas saída. Indica as condições de trânsito ao longo da current_route_segment quando eles estão disponíveis.

Observação: este campo é destinado apenas ao uso pelo SDK do driver e pelo SDK do consumidor.
current_route_segment_traffic_version

Timestamp

Apenas saída. Indica a última vez que o current_route_segment_traffic foi modificado.

Observação: este campo é destinado apenas ao uso pelo SDK do driver e pelo SDK do consumidor.
current_route_segment_end_point

TripWaypoint

Apenas saída. O waypoint onde current_route_segment termina.
remaining_distance_meters

Int32Value

Apenas saída. A distância de carro restante no campo current_route_segment. O valor não será especificado se a viagem não estiver atribuída a um veículo ou tiver sido concluída ou cancelada.
eta_to_first_waypoint

Timestamp

Apenas saída. O HEC até o próximo waypoint (a primeira entrada no campo remaining_waypoints). O valor não será especificado se a viagem não estiver atribuída a um veículo ou se estiver inativa (concluída ou cancelada).
remaining_time_to_first_waypoint

Duration

Apenas saída. A duração do retorno dos dados de viagem ao horário em Trip.eta_to_first_waypoint. O valor é indefinido se a viagem não for atribuída a um veículo ou se estiver inativa (concluída ou cancelada).
remaining_waypoints_version

Timestamp

Apenas saída. Indica a última vez que remaining_waypoints foi alterado (um waypoint foi adicionado, removido ou alterado).
remaining_waypoints_route_version

Timestamp

Apenas saída. Indica a última vez que remaining_waypoints.path_to_waypoint e remaining_waypoints.traffic_to_waypoint foram modificados. Seu app cliente precisa armazenar esse valor em cache e transmiti-lo para GetTripRequest para garantir que os caminhos e o tráfego de remaining_waypoints sejam retornados somente se atualizados.
number_of_passengers

int32

Imutável. Indica o número de passageiros na viagem e não inclui o motorista. Um veículo precisa ter capacidade disponível para ser retornado em uma resposta SearchVehicles.
last_location

VehicleLocation

Apenas saída. Indica o último local relatado do veículo ao longo do trajeto.
last_location_snappable

bool

Apenas saída. Indica se o last_location do veículo pode ser vinculado ao current_route_segment. Falso se last_location ou current_route_segment não existir. Ele é calculado pelo Fleet Engine. Todas as atualizações dos clientes serão ignoradas.
view

TripView

O subconjunto de campos "Viagem" preenchidos e como eles devem ser interpretados.

TripStatus

O status de uma viagem que indica sua progressão.

Enums
UNKNOWN_TRIP_STATUS Padrão, usada para status de viagem não especificado ou não reconhecido.
NEW Viagem recém-criada.
ENROUTE_TO_PICKUP O motorista está a caminho do ponto de partida.
ARRIVED_AT_PICKUP O motorista chegou ao ponto de embarque.
ARRIVED_AT_INTERMEDIATE_DESTINATION O motorista chegou a um destino intermediário e está esperando o passageiro.
ENROUTE_TO_INTERMEDIATE_DESTINATION O motorista está a caminho de um destino intermediário (não o ponto de entrega).
ENROUTE_TO_DROPOFF O motorista pegou o passageiro e está a caminho do próximo destino.
COMPLETE O passageiro foi deixado e a viagem foi concluída.
CANCELED A viagem foi cancelada antes do embarque pelo motorista, passageiro ou provedor de transporte por aplicativo.

TripType

O tipo de viagem.

Enums
UNKNOWN_TRIP_TYPE Padrão, usado para tipos de viagem não especificados ou não reconhecidos.
SHARED A viagem pode compartilhar um veículo com outras viagens.
EXCLUSIVE A viagem é exclusiva para um veículo.

TripView

Seletor para diferentes conjuntos de campos de viagem em uma resposta GetTrip. Consulte AIP-157 para mais contexto. É provável que outras visualizações sejam adicionadas.

Enums
TRIP_VIEW_UNSPECIFIED O valor padrão. Para compatibilidade com versões anteriores, a API usará uma visualização do SDK por padrão. Para garantir a estabilidade e o suporte, recomendamos que os clientes selecionem um TripView diferente de SDK.
SDK Inclui campos que podem não ser interpretáveis ou compatíveis com o uso de bibliotecas disponíveis publicamente.
JOURNEY_SHARING_V1S Os campos de viagem são preenchidos para o caso de uso do Compartilhamento de jornada. Essa visualização é destinada a comunicações de servidor para servidor.

TripWaypoint

Descreve um ponto de parada no trajeto de um veículo ou um ponto final na viagem de um veículo.

Campos
location

TerminalLocation

O local desse ponto de passagem.
trip_id

string

A viagem associada a este waypoint.
waypoint_type

WaypointType

A função desse ponto de passagem na viagem, como coleta ou entrega.
path_to_waypoint[]

LatLng

O caminho do waypoint anterior até o atual. Indefinido para o primeiro ponto de referência de uma lista. Esse campo só é preenchido quando solicitado.
encoded_path_to_waypoint

string

O caminho codificado do ponto de referência anterior até o waypoint atual.

Observação: este campo é destinado apenas ao uso pelo SDK do driver e pelo SDK do consumidor. Ainda não há suporte para decodificação.
traffic_to_waypoint

ConsumableTrafficPolyline

As condições de trânsito ao longo do caminho até este waypoint. O tráfego está disponível apenas para clientes da solução de viagens e entregas da Plataforma Google Maps.
distance_meters

Int32Value

A distância do caminho do waypoint anterior até o waypoint atual. Indefinido para o primeiro ponto de referência de uma lista.
eta

Timestamp

O horário estimado de chegada a esse ponto de passagem. Não definido para o primeiro ponto de passagem em uma lista.
duration

Duration

O tempo de viagem do ponto de referência anterior até este ponto. Indefinido para o primeiro ponto de referência de uma lista.

UpdateTripRequest

Mensagem de solicitação do UpdateTrip.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/trips/{trip}. O provedor precisa ser o ID do projeto (por exemplo, sample-consumer-project) do projeto do Google Cloud em que a conta de serviço que faz a chamada é membro.
trip

Trip

Obrigatório. A viagem associada à atualização.

Os campos a seguir são mantidos pelo Fleet Engine. Não atualize usando Trip.update.

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

Ao atualizar o Trip.vehicle_id de uma viagem compartilhada, você precisa fornecer a lista de Trip.vehicle_waypoints para especificar a ordem dos waypoints restantes. Caso contrário, a ordem será indeterminada.

Quando você especifica Trip.vehicle_waypoints, a lista precisa conter todos os pontos de referência restantes das viagens do veículo, sem pontos de referência extras. Você precisa organizar esses pontos de passagem de modo que, para uma determinada viagem, o ponto de coleta seja antes dos destinos intermediários e todos os destinos intermediários sejam antes do ponto de entrega. Os pontos de passagem de uma viagem EXCLUSIVE não podem se intercalar com outras viagens. Os campos trip_id, waypoint_type e location são usados, e todos os outros campos do TripWaypoint em vehicle_waypoints são ignorados.

Para evitar uma disputa em viagens com vários destinos, informe Trip.intermediate_destinations_version ao atualizar o status da viagem para ENROUTE_TO_INTERMEDIATE_DESTINATION. O Trip.intermediate_destinations_version transmitido precisa ser consistente com a versão do Fleet Engine. Se não estiver, a solicitação falhará.
update_mask

FieldMask

Obrigatório. A máscara de campo que indica quais campos da viagem serão atualizados. O update_mask precisa conter pelo menos um campo.

UpdateVehicleAttributesRequest

Mensagem de solicitação UpdateVehicleAttributes.

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/vehicles/{vehicle}. O provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud de que a conta de serviço que está fazendo a chamada faz parte.
attributes[]

VehicleAttribute

Obrigatório. Os atributos do veículo a serem atualizados. Os atributos não mencionados não são alterados nem removidos.

UpdateVehicleAttributesResponse

Mensagem de resposta UpdateVehicleAttributes.

Campos
attributes[]

VehicleAttribute

Obrigatório. A lista completa atualizada de atributos do veículo, incluindo atributos novos, alterados e originais.

UpdateVehicleRequest

Mensagem de solicitação "UpdateVehicle".

Campos
header

RequestHeader

O cabeçalho de solicitação padrão do Fleet Engine.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/vehicles/{vehicle}. O {provider} precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud do qual a conta de serviço que faz essa chamada é membro.
vehicle

Vehicle

Obrigatório. Os valores de entidade Vehicle a serem aplicados. Ao atualizar um Vehicle, os campos a seguir podem não ser atualizados porque são gerenciados pelo servidor.

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

Se o campo attributes for atualizado, todos os atributos do veículo serão substituídos pelos atributos fornecidos na solicitação. Se você quiser atualizar apenas alguns atributos, consulte o método UpdateVehicleAttributes.

Da mesma forma, o campo waypoints pode ser atualizado, mas precisa conter todos os waypoints atuais no veículo e nenhum outro.
update_mask

FieldMask

Obrigatório. Uma máscara de campo que indica quais campos do Vehicle serão atualizados. É necessário fornecer pelo menos um nome de campo.

Veículo

Metadados do veículo.

Campos
name

string

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

VehicleState

O estado do veículo.
supported_trip_types[]

TripType

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

string

Apenas saída. Lista de trip_id para viagens atribuídas a este veículo no momento.
last_location

VehicleLocation

Último local informado do veículo.
maximum_capacity

int32

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

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

VehicleType

Obrigatório. O tipo do veículo. Pode ser usado para filtrar veículos em resultados de SearchVehicles. Também influencia os cálculos de ETA e rota.
license_plate

LicensePlate

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

TerminalLocation

Descontinuado: use Vehicle.waypoints.
current_route_segment

string

A poligonal que especifica a rota que o app do motorista pretende seguir até o próximo ponto de passagem. 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.
current_route_segment_traffic

TrafficPolylineData

Somente entrada. O Fleet Engine usa essas informações para melhorar o compartilhamento de trajetos. Observação: este campo é destinado apenas ao SDK do driver.
current_route_segment_version

Timestamp

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

TripWaypoint

O ponto de passagem em que current_route_segment termina. Isso pode ser fornecido pelos motoristas em chamadas UpdateVehicle como um ponto de passagem de viagem completo, um ponto de passagem LatLng ou como o último LatLng da current_route_segment. O Fleet Engine fará o possível para interpolar em um waypoint real se não for totalmente especificado. Esse campo é ignorado em chamadas UpdateVehicle, a menos que current_route_segment também seja especificado.
remaining_distance_meters

Int32Value

A distância restante para o current_route_segment. 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 current_route_segment estiver vazio.
eta_to_first_waypoint

Timestamp

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, remaining_time_seconds tem precedência sobre eta_to_first_waypoint na mesma solicitação.
remaining_time_seconds

Int32Value

Somente entrada. O tempo restante de percurso do veículo current_route_segment. 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 eta_to_first_waypoint - current_time se todas as partes estiverem usando o mesmo relógio.

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

TripWaypoint

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

Timestamp

Apenas saída. Última vez 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 só seja retornado se for atualizado.
back_to_back_enabled

bool

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

NavigationStatus

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

DeviceSettings

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

VehicleType

O tipo de veículo.

Campos
category

Category

Categoria do tipo de veículo

Categoria

Categorias de tipo 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.

VehicleAttribute

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

Campos
key

string

A chave do atributo. As chaves não podem conter o caractere 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:
string_value

string

Valor de atributo digitado em string.

Observação: esse campo é idêntico ao value, que será descontinuado. Para métodos de criação ou atualização, qualquer campo pode ser usado, mas é altamente recomendável usar string_value. Se string_value e value forem definidos, eles precisarão ser idênticos ou um erro será gerado. Ambos os campos são preenchidos nas respostas.
bool_value

bool

Valor de atributo do tipo booleano.
number_value

double

Valor de atributo com dois tipos.

VehicleAttributeList

Um tipo de dados de lista de listas para atributos do veículo.

Campos
attributes[]

VehicleAttribute

Uma lista de atributos desta coleção.

VehicleLocation

O local, a velocidade e a direção de um veículo em um momento específico.

Campos
location

LatLng

O local do veículo. Quando ele é enviado ao Fleet Engine, a localização do veículo é uma localização de GPS. Quando você receber a resposta, o local do veículo poderá ser um local do GPS, um local complementar ou algum outro local aproximado. A fonte é especificada em location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Obsoleto: use latlng_accuracy.
latlng_accuracy

DoubleValue

Precisão de location em metros como raio.
heading

Int32Value

Direção em que o veículo está se movendo em graus. 0 representa Norte. O intervalo válido é [0,360).
bearing_accuracy
(deprecated)

DoubleValue

Obsoleto: use heading_accuracy.
heading_accuracy

DoubleValue

Precisão de heading em graus.
altitude

DoubleValue

Altitude em metros acima do WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Descontinuado: use altitude_accuracy.
altitude_accuracy

DoubleValue

Precisão de altitude em metros.
speed_kmph
(deprecated)

Int32Value

Velocidade do veículo em quilômetros por hora. Descontinuado: use speed.
speed

DoubleValue

Velocidade do veículo em metros/segundo
speed_accuracy

DoubleValue

Precisão de speed em metros/segundo.
update_time

Timestamp

O horário em que o location foi informado pelo sensor de acordo com o relógio do sensor.
server_time

Timestamp

Apenas saída. O horário em que o servidor recebeu as informações de local.
location_sensor

LocationSensor

Provedor de dados de local (por exemplo, GPS).
is_road_snapped

BoolValue

Indica se location está fixado a uma via.
is_gps_sensor_enabled

BoolValue

Somente entrada. Indica se o sensor de GPS está ativado no dispositivo móvel.
time_since_update

Int32Value

Somente entrada. Tempo (em segundos) desde que o local foi enviado pela primeira vez ao servidor. Esse valor será zero para a primeira atualização. Se o horário for desconhecido (por exemplo, quando o app for reiniciado), esse valor será redefinido para zero.
num_stale_updates
(deprecated)

Int32Value

Somente entrada. Obsoleto: outros indicadores agora são usados para determinar se um local está desatualizado.
raw_location

LatLng

Localização do veículo sem dados (não processado pelo Snapper da Estrada).
raw_location_time

Timestamp

Carimbo de data/hora associado ao local bruto.
raw_location_sensor

LocationSensor

Origem da localização bruta. O valor padrão é GPS.
raw_location_accuracy

DoubleValue

Precisão de raw_location como um raio, em metros.
supplemental_location

LatLng

Localização complementar fornecida pelo app de integração.
supplemental_location_time

Timestamp

Carimbo de data/hora associado ao local complementar.
supplemental_location_sensor

LocationSensor

Origem do local complementar. O valor padrão é CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Precisão de supplemental_location como um raio, em metros.
road_snapped
(deprecated)

bool

Obsoleto: use is_road_snapped.

VehicleMatch

Contém o veículo e as estimativas relacionadas para um veículo que corresponde aos pontos de viagens ativas do veículo SearchVehiclesRequest.

Campos
vehicle

Vehicle

Obrigatório. Um veículo que corresponde à solicitação.
vehicle_pickup_eta

Timestamp

O HEC de carro do veículo até o ponto de embarque especificado na solicitação. Um valor vazio indica uma falha no cálculo do ETA do veículo. Se SearchVehiclesRequest.include_back_to_back era true e este veículo tem uma viagem ativa, vehicle_pickup_eta vai incluir o tempo necessário para concluir a viagem ativa atual.
vehicle_pickup_distance_meters

Int32Value

A distância da localização atual do Veículo até o ponto de embarque especificado na solicitação, incluindo os pontos de embarque ou desembarque intermediários de viagens existentes. Essa distância compreende a distância de percurso (trajeto) calculada mais a distância em linha reta entre o ponto final da navegação e o ponto de embarque solicitado. Geralmente, a distância entre o ponto de destino da navegação e o ponto de embarque solicitado é pequena. Um valor vazio indica um erro no cálculo da distância.
vehicle_pickup_straight_line_distance_meters

Int32Value

Obrigatório. A distância em linha reta entre o veículo e o ponto de embarque especificado na solicitação.
vehicle_dropoff_eta

Timestamp

O tempo estimado de chegada do veículo até o ponto de entrega especificado na solicitação. O ETA inclui paradas em todos os waypoints antes do dropoff_point especificado na solicitação. O valor só será preenchido quando um ponto de entrega for especificado na solicitação. Um valor vazio indica um erro no cálculo do ETA.
vehicle_pickup_to_dropoff_distance_meters

Int32Value

A distância percorrida pelo veículo (em metros) do ponto de embarque ao de desembarque especificado na solicitação. A distância é apenas entre os dois pontos e não inclui a localização do veículo ou qualquer outro ponto que precise ser visitado antes da chegada do veículo ao ponto de embarque ou desembarque. O valor só será preenchido quando dropoff_point for especificado na solicitação. Um valor vazio indica uma falha no cálculo da distância do ponto de embarque ao desembarque especificado na solicitação.
trip_type

TripType

Obrigatório. O tipo de viagem da solicitação que foi usada para calcular o HEC até o ponto de embarque.
vehicle_trips_waypoints[]

Waypoint

A lista ordenada de pontos de passagem usados para calcular a hora estimada de chegada. A lista inclui a localização e os pontos de embarque das viagens ativas do veículo e fornecidos na solicitação. Uma lista vazia indica uma falha no cálculo do ETA do veículo.
vehicle_match_type

VehicleMatchType

Tipo de correspondência do veículo.
requested_ordered_by

VehicleMatchOrder

A ordem solicitada para classificar as correspondências do veículo.
ordered_by

VehicleMatchOrder

O pedido real usado para este veículo. Normalmente, isso corresponde ao campo "order_by" da solicitação. No entanto, em determinadas circunstâncias, como um erro interno do servidor, um método diferente pode ser usado (como PICKUP_POINT_STRAIGHT_DISTANCE).

VehicleMatchType

Tipo de correspondência de veículo.

Enums
UNKNOWN Tipo de correspondência de veículo desconhecido
EXCLUSIVE No momento, o veículo não tem nenhuma viagem atribuída e pode seguir para o ponto de retirada.
BACK_TO_BACK O veículo está atribuído a uma viagem, mas pode prosseguir até o ponto de embarque depois de concluir a viagem em andamento. Os cálculos de HEC e distância consideram a viagem atual.
CARPOOL O veículo tem capacidade suficiente para uma corrida compartilhada.
CARPOOL_BACK_TO_BACK O veículo vai concluir a viagem atual e ativa antes de prosseguir para o ponto de embarque. Os cálculos de HEC e distância consideram a viagem atual.

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.

VisualTrafficReportPolylineRendering

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

Campos
road_stretch[]

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.

Campos
style

Style

Obrigatório. O estilo a ser aplicado.
offset_meters

int32

Obrigatório. O estilo precisa ser aplicado entre [offset_meters, offset_meters + length_meters).
length_meters

int32

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

Estilo

O estilo do trânsito, que indica a velocidade do tráfego.

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

Ponto de referência

Descreve pontos intermediários ao longo de um trajeto para um VehicleMatch em uma SearchVehiclesResponse. Esse conceito é representado como TripWaypoint em todos os outros endpoints.

Campos
lat_lng

LatLng

O local deste ponto de referência.
eta

Timestamp

O horário estimado de chegada do veículo a esse ponto de passagem.

WaypointType

O tipo de waypoint.

Enums
UNKNOWN_WAYPOINT_TYPE Tipo de waypoint desconhecido ou não especificado.
PICKUP_WAYPOINT_TYPE Pontos de passagem para pegar passageiros ou itens.
DROP_OFF_WAYPOINT_TYPE Pontos de passagem para deixar passageiros ou itens.
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Pontos de referência para destinos intermediários em uma viagem com vários destinos.