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 retorna a nova viagem.

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Receba informações sobre uma única viagem.

ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Informar o uso de viagens faturáveis.

SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Veja todas as viagens de um veículo específico.

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Atualiza dados de viagens.

VehicleService

Serviço de gerenciamento de veículos.

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Instanciar um novo veículo associado a um provedor de serviços de transporte por aplicativo ou de entregas sob demanda. Cada Vehicle precisa ter um ID de veículo exclusivo.

Os seguintes campos Vehicle 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 serão 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 corresponde às opções de solicitação.

SearchFuzzedVehicles

rpc SearchFuzzedVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Obsoleto: use SearchVehicles.

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 um Vehicle, os campos a seguir 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 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 no veículo, exceto outros.

UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

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

UpdateVehicleLocation

rpc UpdateVehicleLocation(UpdateVehicleLocationRequest) returns (VehicleLocation)

Obsoleto: use o método UpdateVehicle. UpdateVehicleLocation atualiza a localização do veículo.

BatteryInfo

Informações sobre a bateria do dispositivo.

Campos
battery_status

BatteryStatus

O status da bateria, se ela está cheia, carregando etc.

power_source

PowerSource

Status da fonte de energia da bateria.

battery_percentage

float

Porcentagem atual da bateria [0-100].

BatteryStatus

O status da bateria, se ela está 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.

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 do tráfego ao longo do caminho de um Veículo.

Campos
speed_reading_interval[]

SpeedReadingInterval

Velocidade do tráfego ao longo do caminho do waypoint anterior até o waypoint atual.

encoded_path_to_waypoint

string

O caminho que o motorista está fazendo do waypoint anterior até o waypoint 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 a 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 C de normalização Unicode.
  • Não pode conter nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.
trip

Trip

Obrigatório. Entidade "Trip" a ser criada.

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

  • trip_type
  • pickup_point

Os campos a seguir serão usados quando você os informar:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Todos os outros campos "Viagem" serã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 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 waypoints restantes para o veículo. Caso contrário, a ordem dos waypoints é indeterminada.

Quando você especifica Trip.vehicle_waypoints, a lista precisa conter todos os waypoints restantes das viagens do veículo, sem waypoints extras. Você precisa ordenar esses waypoints de forma que, para uma determinada viagem, o ponto de embarque ocorra antes dos destinos intermediários, e todos os destinos intermediários cheguem antes do ponto de desembarque. Os waypoints de uma viagem de 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 TripWaypoint no vehicle_waypoints são ignorados.

CreateVehicleRequest

Mensagem de solicitação de 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 nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.
vehicle

Vehicle

Obrigatório. A entidade do 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 serã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 serão usados se fornecidos.

DeviceSettings

Informações sobre várias configurações no 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.

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 de que a conta de serviço que está fazendo a chamada faz parte.

view

TripView

O subconjunto de campos "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 do trajeto não forem alterados desde o carimbo de data/hora, o campo da rota não será definido na resposta. Se um mínimo não for especificado, os dados do trajeto serão sempre recuperados.

remaining_waypoints_version

Timestamp

Indica o carimbo de data/hora mínimo (exclusivo) de que Trip.remaining_waypoints é recuperado. Se elas não forem alteradas desde o carimbo de data/hora, as remaining_waypoints não serão definidas 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) de que Trip.current_route_segment_traffic é recuperado. Se os dados de tráfego não forem alterados desde o 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 forem alterados desde o 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 de 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) de que Vehicle.current_route_segment é recuperado. Se a rota não for alterada desde o 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) de onde os dados de Vehicle.waypoints são recuperados. Se os waypoints não forem alterados desde o carimbo de data/hora, os dados de vehicle.waypoints não são definidos na resposta. Se esse campo não for especificado, vehicle.waypoints será sempre recuperado.

LicensePlate

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.

Campos
country_code

string

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

last_character

string

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

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

ListVehiclesRequest

Mensagem de solicitação de 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 de 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 iguais aos da chamada anterior para ListVehicles.

minimum_capacity

Int32Value

Especifica a capacidade mínima necessária do veículo. Todos os veículos retornados vão ter 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 que aceitam pelo menos um dos tipos de viagem especificados.

maximum_staleness

Duration

Restringe a resposta aos veículos que enviaram atualizações de localização ao Fleet Engine dentro da duração especificada. Veículos parados que ainda transmitem 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. O required_one_of_attributes usa uma mensagem que permite a criação de listas. Em combinação, os dois campos permitem a composição dessa 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. Este campo é uma operação conjunta/AND. São permitidos no máximo 50 required_attributes. Esse número corresponde ao número máximo de atributos permitidos em um veículo. Cada string repetida precisa estar no formato "key:value".

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. Este campo é uma operação inclusiva de disjunção/OU em cada VehicleAttributeList e uma operação de conjunção/E em toda a 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.

Assim como 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 aos veículos que correspondem a todos os atributos em uma VehicleAttributeList. Em cada lista, um veículo precisa corresponder a todos os atributos. Este campo é uma operação de conjunção/AND em cada VehicleAttributeList e operação de disjunção/OR inclusiva em todo o conjunto de VehicleAttributeList. Cada string repetida precisa estar no formato "key1:value1|key2:value2|key3:value3".

vehicle_state

VehicleState

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

on_trip_only

bool

Devolva apenas os veículos com as viagens atuais.

filter

string

Opcional. Uma consulta de filtro a ser aplicada ao listar veículos. Consulte exemplos da sintaxe de filtro em http://aip.dev/160 (em inglês).

Esse campo foi projetado 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 campos a seguir precisarão estar vazios: required_attributes, required_one_of_attributes e required_one_of_attributes_sets.

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

As únicas consultas aceitas são em 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 compatíveis com os atributos são as de strings. Para comparar com valores numéricos ou booleanos, os valores precisam ser explicitamente citados 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 vazio se não houver mais veículos que atendam aos critérios da solicitação.

total_size

int64

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

LocationPowerSaveMode

Como os recursos de localização estã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 localização não serão afetados pela Economia de bateria ou a Economia de bateria 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 deverão 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 permanecerão disponíveis, mas as correções de localização só devem ser fornecidas aos 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 a provedores quando o dispositivo não for interativo.

LocationSensor

O sensor ou a metodologia usada para determinar o local.

Enums
UNKNOWN_SENSOR O sensor não foi especificado ou é desconhecido.
GPS GPS ou GPS assistido.
NETWORK GPS assistido, ID de 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 para a estrada.
CUSTOMER_SUPPLIED_LOCATION Um local fornecido pelo cliente de uma fonte independente. Normalmente, esse valor é usado para um local fornecido de origens diferentes do dispositivo móvel que executa o SDK do Driver. Se a fonte original for descrita por um dos outros valores de tipo enumerado, use esse valor. Os locais marcados como CUSTOMER_AdapterPLIED_LOCATION normalmente são fornecidos pelo last_location.supplemental_location_sensor de um veículo.
FLEET_ENGINE_LOCATION Uma localização calculada 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 localização nos sistemas operacionais Apple.

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 do motorista está no modo FREE_NAV.
ENROUTE_TO_DESTINATION A navegação guiada está disponível, e a navegação no app do motorista 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 da 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 polilinhas. A decodificação ainda não é compatível.

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

a 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 em que a viagem acontece, com duas letras. O preço é definido de acordo com o código do país.

platform

BillingPlatformIdentifier

A plataforma em que a solicitação foi emitida.

related_ids[]

string

Os identificadores que estão 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 que o ID da viagem esteja disponível. O número de related_ids está limitado a 50.

solution_type

SolutionType

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

SolutionType

Seletor de diferentes tipos de solução de uma viagem informada.

Enums
SOLUTION_TYPE_UNSPECIFIED O valor padrão. Para compatibilidade com versões anteriores, a API usa 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 é uma viagem de transporte por aplicativo e entregas sob demanda.

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 en-US ou sr-Latn. Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Se nenhum for especificado, a resposta poderá estar em qualquer idioma, com preferência por inglês se existir tal nome. 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", por 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 de que o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por 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 de chamada.

manufacturer

string

Fabricante do dispositivo Android do SDK de chamada, aplicável somente aos 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 aos SDKs do Android. Exemplo de valor do campo: 23.

trace_id

string

ID opcional que pode ser fornecido para fins de registro e identificação da solicitação.

Plataforma

A plataforma do SDK de chamada.

Enums
PLATFORM_UNSPECIFIED O valor padrão. Esse valor será 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

Tipos possíveis de SDK.

Enums
SDK_TYPE_UNSPECIFIED O valor padrão. Esse valor será usado se o sdk_type for omitido.
CONSUMER O SDK de chamada é Consumer.
DRIVER O SDK de chamada é o Driver.
JAVASCRIPT O SDK de chamada é o JavaScript.

SearchTripsRequest

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 definido como verdadeiro, a resposta incluirá viagens que influenciam o trajeto do 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 a partir dos resultados anteriores.

minimum_staleness

Duration

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

SearchTripsResponse

Mensagem de resposta de SearchTrips.

Campos
trips[]

Trip

Lista de viagens do veículo solicitado.

next_page_token

string

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

SearchVehiclesRequest

Mensagem de solicitação de 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 partida para pesquisar por perto.

dropoff_point

TerminalLocation

O local de desembarque do cliente. O campo será 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 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 um. O motorista não é considerado no valor da capacidade.

trip_types[]

TripType

Obrigatório. Representa o tipo de viagem proposta. É preciso incluir exatamente um tipo. A política UNKNOWN_TRIP_TYPE não é permitida. Restringe a pesquisa apenas aos veículos que são compatíveis com esse tipo de viagem.

maximum_staleness

Duration

Restringe a pesquisa apenas aos veículos que enviaram atualizações de localização ao Fleet Engine dentro do período especificado. Veículos parados que ainda transmitem suas localizações não são considerados desatualizados. Se este 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 VehicleTypes com uma categoria de 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. O required_one_of_attributes usa uma mensagem que permite a criação de listas. Em combinação, os dois campos permitem a composição dessa 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. Este campo é uma operação conjunta/AND. São permitidos no máximo 50 required_attributes. Esse número 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. Este campo é uma operação inclusiva de disjunção/OU em cada VehicleAttributeList e uma operação de conjunção/E em toda a coleção de VehicleAttributeList.

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets oferece mais funcionalidades.

Assim como 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 pesquisa apenas aos veículos com todos os atributos em uma VehicleAttributeList. Em cada lista, um veículo precisa corresponder a todos os atributos. Este campo é uma operação de conjunção/AND em cada VehicleAttributeList e operação de disjunção/OR inclusiva em todo o conjunto de VehicleAttributeList.

order_by

VehicleMatchOrder

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

include_back_to_back

bool

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

O valor padrão é false.

trip_id

string

Indica a viagem associada a SearchVehicleRequest.

current_trips_present

CurrentTripsPresent

Isso 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 para aplicar ao pesquisar veículos. Consulte exemplos da sintaxe de filtro em http://aip.dev/160 (em inglês).

Esse campo foi projetado 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 campos a seguir precisarão estar vazios: required_attributes, required_one_of_attributes e required_one_of_attributes_sets.

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

As únicas consultas aceitas são em 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 compatíveis com os atributos são as de strings. Para comparar com valores numéricos ou booleanos, os valores precisam ser explicitamente citados 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 viagens presentes é 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 cinco viagens e 10 waypoints atuais 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 de veículos na resposta.

Enums
UNKNOWN_VEHICLE_MATCH_ORDER Padrão, usado para veículos não especificados ou não reconhecidos correspondem ao pedido.
PICKUP_POINT_ETA Pedido crescente por tempo de direção do veículo até o ponto de embarque.
PICKUP_POINT_DISTANCE Ordem crescente por distância de carro até o ponto de embarque.
DROPOFF_POINT_ETA Ordem crescente por tempo de direção do veículo até o ponto de desembarque. Esse pedido só pode ser usado se o ponto de desembarque for especificado na solicitação.
PICKUP_POINT_STRAIGHT_DISTANCE Ordem crescente por distância em linha reta do último local informado 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 o HEC. Os pesos são definidos com valores padrão e podem ser modificados por cliente. Entre em contato com o Suporte do Google se for preciso alterar esses pesos para o projeto.

SearchVehiclesResponse

SearchVehicles mensagem de resposta.

Campos
matches[]

VehicleMatch

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

SpeedReadingInterval

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

Campos
start_polyline_point_index

int32

O índice inicial desse intervalo no caminho. Em JSON, quando o índice for 0, o campo vai parecer não preenchido.

end_polyline_point_index

int32

O índice final desse intervalo no caminho. Em JSON, quando o índice for 0, o campo vai parecer não preenchido.

speed

Speed

Velocidade do tráfego neste intervalo.

Velocidade

A classificação da velocidade da polilinha com base nos dados de trânsito.

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

StopLocation

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

Campos
point

LatLng

Obrigatório. Indica a localização 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 a localização de um waypoint da viagem.

terminal_point_id

TerminalPointId

ID do ponto terminal.

access_point_id
(deprecated)

string

Obsoleto.

trip_id
(deprecated)

string

Obsoleto.

terminal_location_type
(deprecated)

WaypointType

Obsoleto: Vehicle.waypoint terá esses dados.

TerminalPointId

Identifica um ponto terminal.

Campos
value

string

ID exclusivo do ponto de terminal.

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 ao longo do trajeto esperado do veículo.

Campos
traffic_rendering

VisualTrafficReportPolylineRendering

Uma polilinha que mostra a velocidade do tráfego de todas as regiões em um trecho da viagem de um cliente.

Viagem

Metadados de viagem.

Campos
name

string

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

vehicle_id

string

ID do veículo que está fazendo esta viagem.

trip_status

TripStatus

Status atual da viagem.

trip_type

TripType

O tipo da viagem.

pickup_point

TerminalLocation

Local em que o cliente indica que será retirado.

actual_pickup_point

StopLocation

Apenas entrada. O local real onde e quando o cliente foi retirado. Este campo serve para o fornecedor enviar feedback sobre as informações de retirada reais.

actual_pickup_arrival_point

StopLocation

Apenas entrada. O horário e o local reais de chegada do motorista ao ponto de embarque. Este campo serve para o fornecedor enviar feedback sobre as informações reais de chegada no ponto de retirada.

pickup_time

Timestamp

Apenas saída. O horário futuro estimado em que os passageiros serão embarcados ou o horário real em que eles foram embarcados.

intermediate_destinations[]

TerminalLocation

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

intermediate_destinations_version

Timestamp

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

intermediate_destination_index

int32

Quando TripStatus for ENROUTE_TO_INTERMEDIATE_DESTINATION, um número entre [0..N-1] que indica qual destino intermediário o veículo vai atravessar em seguida. Quando TripStatus for 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, esse campo será ignorado.

actual_intermediate_destination_arrival_points[]

StopLocation

Apenas entrada. O horário e o local reais de chegada do motorista a um destino intermediário. Este campo serve para que o provedor forneça feedback sobre as informações reais de chegada em destinos intermediários.

actual_intermediate_destinations[]

StopLocation

Apenas entrada. A hora e o local reais quando e onde o cliente foi retirado em um destino intermediário. Este campo serve para o provedor enviar feedback sobre as informações de embarque reais em destinos intermediários.

dropoff_point

TerminalLocation

Local em que o cliente indica que será entregue.

actual_dropoff_point

StopLocation

Apenas entrada. A hora e o local reais quando e onde o cliente foi entregue. Este campo serve para o provedor enviar feedback sobre as informações reais de desembarque.

dropoff_time

Timestamp

Apenas saída. O horário futuro estimado em que os passageiros chegarão ao destino final ou o horário real em que eles foram desembarcados.

remaining_waypoints[]

TripWaypoint

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

vehicle_waypoints[]

TripWaypoint

Este campo permite a ordem manual dos waypoints para a viagem. Ela contém todos os waypoints restantes do veículo atribuído, bem como os de embarque e desembarque 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 em chamadas UpdateTrip e CreateTrip, NÃO em chamadas GetTrip.

route[]

LatLng

Apenas saída. Trajeto previsto para esta viagem até a primeira entrada em will_waypoints. O primeiro traçado pode pertencer a outra viagem.

current_route_segment

string

Apenas saída. Um caminho codificado para o próximo waypoint.

Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK. A decodificação ainda não é compatível.

current_route_segment_version

Timestamp

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

Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK.

current_route_segment_traffic

ConsumableTrafficPolyline

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

Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK.

current_route_segment_traffic_version

Timestamp

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

Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK.

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 for 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 estiver inativa (concluída ou cancelada).

remaining_time_to_first_waypoint

Duration

Apenas saída. A duração entre o momento em que os dados de viagem são retornados até o horário no Trip.eta_to_first_waypoint. O valor não será especificado se a viagem não estiver atribuída a um veículo ou estiver inativa (concluída ou cancelada).

remaining_waypoints_version

Timestamp

Apenas saída. Indica a última vez em 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 o remaining_waypoints.path_to_waypoint e o remaining_waypoints.traffic_to_waypoint foram modificados. Seu app cliente precisa armazenar esse valor em cache e transmiti-lo em GetTripRequest para garantir que os caminhos e o tráfego da remaining_waypoints só sejam retornados se forem atualizados.

number_of_passengers

int32

Imutável. Indica o número de passageiros nessa 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 informado do veículo ao longo do trajeto.

last_location_snappable

bool

Apenas saída. Indica se o last_location do veículo pode ser ajustado ao current_route_segment. Falso se last_location ou current_route_segment não existirem. Isso é calculado pelo Fleet Engine. Todas as atualizações de clientes serão ignoradas.

view

TripView

O subconjunto de campos "Viagem" que são preenchidos e como eles devem ser interpretados.

TripStatus

O status de uma viagem que indica a progressão dela.

Enums
UNKNOWN_TRIP_STATUS Padrão, usado 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 embarque.
ARRIVED_AT_PICKUP O motorista chegou ao local 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 desembarque).
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 uma 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.
EXCLUSIVE A viagem é exclusiva para um veículo.

TripView

Seletor para diferentes conjuntos de campos "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 oferecer compatibilidade com versões anteriores, o padrão da API será uma visualização do SDK. 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 aceitos usando bibliotecas disponíveis publicamente.
JOURNEY_SHARING_V1S Os campos "Viagem" são preenchidos para o caso de uso "Compartilhamento de jornada". Essa visualização é destinada à comunicação 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 deste waypoint.

trip_id

string

A viagem associada a este waypoint.

waypoint_type

WaypointType

A função que o waypoint desempenha na viagem, por exemplo, em embarque ou desembarque.

path_to_waypoint[]

LatLng

O caminho do waypoint anterior até o waypoint atual. Indefinido para o primeiro waypoint em uma lista. Esse campo só é preenchido quando solicitado.

encoded_path_to_waypoint

string

O caminho codificado do waypoint anterior até o waypoint atual.

Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK. A decodificação ainda não é compatível.

traffic_to_waypoint

ConsumableTrafficPolyline

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

distance_meters

Int32Value

A distância do caminho entre o waypoint anterior e o waypoint atual. Indefinido para o primeiro waypoint em uma lista.

eta

Timestamp

O horário previsto de chegada neste waypoint. Indefinido para o primeiro waypoint em uma lista.

duration

Duration

O tempo de viagem desde o waypoint anterior até este ponto. Indefinido para o primeiro waypoint em uma lista.

UpdateTripRequest

Mensagem de solicitação 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 de que a conta de serviço que está fazendo a chamada faz parte.

trip

Trip

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

Os campos a seguir são mantidos pelo Fleet Engine. Não os 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 para 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 waypoints restantes das viagens do veículo, sem waypoints extras. Você precisa ordenar esses waypoints de forma que, para uma determinada viagem, o ponto de embarque ocorra antes dos destinos intermediários, e todos os destinos intermediários cheguem antes do ponto de desembarque. Os waypoints de uma viagem de 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 TripWaypoint no vehicle_waypoints são ignorados.

Para evitar uma disputa para viagens com vários destinos, forneça 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 em "Viagem" serão atualizados. O update_mask precisa conter pelo menos um campo.

UpdateVehicleAttributesRequest

Mensagem de solicitação de 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

UpdateVehicleAttributes mensagem de resposta.

Campos
attributes[]

VehicleAttribute

Obrigatório. Lista completa atualizada de atributos do veículo, incluindo atributos novos, alterados e intactos.

UpdateVehicleLocationRequest

Mensagem de solicitação de UpdateVehicleLocation.

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 (por exemplo, sample-cloud-project) do projeto do Google Cloud do qual a conta de serviço que está fazendo a chamada faz parte.

current_location

VehicleLocation

Obrigatório. O local mais recente do veículo. Os subcampos location e update_time são obrigatórios.

current_state

VehicleState

Defina o estado do veículo como ONLINE ou OFFLINE. Se for definido como UNKNOWN_VEHICLE_STATE, o estado do veículo não vai mudar.

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 (por exemplo, sample-cloud-project) do projeto do Google Cloud do qual a conta de serviço que está fazendo a chamada faz parte.

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 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 no veículo, e nenhum outro.

update_mask

FieldMask

Obrigatório. Uma máscara de campo que indica quais campos do Vehicle precisam ser 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 deste veículo. O formato é providers/{provider}/vehicles/{vehicle}.

vehicle_state

VehicleState

O estado do veículo.

supported_trip_types[]

TripType

Tipos de viagem aceitos por este veículo.

current_trips[]

string

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

last_location

VehicleLocation

Último local informado do veículo.

maximum_capacity

int32

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

attributes[]

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.

vehicle_type

VehicleType

Obrigatório. O tipo deste veículo. Pode ser usado para filtrar veículos nos resultados de SearchVehicles. Isso também influencia os cálculos de HEC e trajeto.

license_plate

LicensePlate

Informações da placa do veículo.

route[]
(deprecated)

TerminalLocation

Obsoleto: use Vehicle.waypoints.

current_route_segment

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 é compatível.

current_route_segment_traffic

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.

current_route_segment_version

Timestamp

Apenas saída. Hora em que current_route_segment foi definido. Ela pode ser armazenada pelo cliente e transmitida em futuras solicitações GetVehicle para evitar o retorno de rotas que não mudaram.

current_route_segment_end_point

TripWaypoint

O waypoint onde current_route_segment termina. Ele pode ser fornecido pelos motoristas em chamadas UpdateVehicle como um waypoint completo da viagem, um waypoint LatLng ou como o último LatLng da current_route_segment. O Fleet Engine fará o possível para interpolar para um waypoint real se não estiver 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 de carro restante do 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 ou 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

Apenas entrada. O tempo restante de condução do current_route_segment. O valor não será especificado se o campo waypoints ou Vehicle.current_route_segment estiver vazio. Esse valor precisa corresponder entre eta_to_first_waypoint e 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. Mostra a ú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 poderá incluir o veículo mesmo que ele esteja atribuído a uma viagem. O valor padrão é false.

navigation_status

NavigationStatus

Status de navegação do veículo.

device_settings

DeviceSettings

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

VehicleType

O tipo de veículo.

Campos
category

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 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 energia humana.
PEDESTRIAN Um transportador humano, normalmente caminhando ou correndo, viajando ao longo de vias de pedestres.

VehicleAttribute

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

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 do tipo string, booleano ou duplo. vehicle_attribute_value pode ser apenas de um dos tipos a seguir:
string_value

string

Valor do atributo com tipo string.

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

bool_value

bool

Valor do atributo tipo booleano.

number_value

double

Valor de atributo de dois tipos.

VehicleAttributeList

Uma lista de tipos de dados de listas para atributos do veículo.

Campos
attributes[]

VehicleAttribute

Uma lista de atributos nesta coleção.

VehicleLocation

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

Campos
location

LatLng

O local do veículo. Quando é enviado ao Fleet Engine, a localização do veículo é uma localização de GPS. Quando você o receber em uma resposta, a localização do veículo pode ser uma localização de GPS, uma localização suplementar ou outra localização estimada. A origem é especificada em location_sensor.

horizontal_accuracy
(deprecated)

DoubleValue

Obsoleto: use latlng_accuracy.

latlng_accuracy

DoubleValue

Precisão de location em metros como um 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 de WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Obsoleto: 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. Obsoleto: 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 location foi informado pelo sensor de acordo com o relógio.

server_time

Timestamp

Apenas saída. A hora em que o servidor recebeu as informações de localização.

location_sensor

LocationSensor

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

is_road_snapped

BoolValue

Define se location está alinhado a uma via.

is_gps_sensor_enabled

BoolValue

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

time_since_update

Int32Value

Apenas entrada. Tempo (em segundos) desde o primeiro envio do local ao servidor. Esse número será zero na primeira atualização. Se a hora for desconhecida (por exemplo, quando o app for reiniciado), esse valor será redefinido como zero.

num_stale_updates
(deprecated)

Int32Value

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

raw_location

LatLng

Local bruto do veículo (não processado pelo carrapato).

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 raio, em metros.

supplemental_location

LatLng

Local complementar fornecido 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 raio, em metros.

road_snapped
(deprecated)

bool

Obsoleto: use is_road_snapped.

VehicleMatch

Contém o veículo e as estimativas relacionadas que correspondem 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 HEC do veículo. Se o valor de SearchVehiclesRequest.include_back_to_back era true e esse veículo tem uma viagem ativa, o vehicle_pickup_eta inclui o tempo necessário para concluir a viagem ativa.

vehicle_pickup_distance_meters

Int32Value

A distância entre a localização atual do Veículo e o ponto de embarque especificado na solicitação, incluindo pontos intermediários de embarque ou desembarque de viagens atuais. Essa distância compreende a distância de carro (trajeto) calculada mais a distância em linha reta entre o ponto de destino da navegação e o ponto de embarque solicitado. A distância entre o ponto de destino da navegação e o ponto de embarque solicitado geralmente é 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 HEC completo do veículo até o ponto de desembarque especificado na solicitação. O HEC inclui uma parada em qualquer waypoint antes do dropoff_point especificado na solicitação. O valor só será preenchido quando um ponto de desembarque for especificado na solicitação. Um valor vazio indica um erro no cálculo do HEC.

vehicle_pickup_to_dropoff_distance_meters

Int32Value

A distância de carro (em metros) do ponto de embarque até o ponto 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 visita do veículo ao ponto de embarque ou desembarque. O valor só será preenchido quando um dropoff_point for especificado na solicitação. Um valor vazio indica uma falha no cálculo da distância entre o ponto de partida e o desembarque especificado na solicitação.

trip_type

TripType

Obrigatório. O tipo de viagem da solicitação usado para calcular o HEC até o ponto de embarque.

vehicle_trips_waypoints[]

Waypoint

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

vehicle_match_type

VehicleMatchType

Tipo de correspondência do veículo.

requested_ordered_by

VehicleMatchOrder

O pedido solicitado para classificar correspondências de 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 O veículo não tem uma viagem atribuída e pode prosseguir até o ponto de embarque.
BACK_TO_BACK O veículo está atribuído a uma viagem, mas pode ir 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 viagem compartilhada.
CARPOOL_BACK_TO_BACK O veículo vai terminar a viagem atual antes de seguir 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 conclui uma viagem atribuída a ele.
ONLINE O veículo está aceitando novas viagens.

VisualTrafficReportPolylineRendering

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

Campos
road_stretch[]

RoadStretch

Opcional. Trechos de estrada que devem ser renderizados ao longo da polilinha. É garantido que os trechos não se sobreponham e não cobrem necessariamente o trajeto completo.

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.

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 tamanho do caminho em que o estilo será aplicado.

Estilo

O estilo do 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.

Ponto de referência

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

Campos
lat_lng

LatLng

O local deste waypoint.

eta

Timestamp

O tempo estimado que o veículo chegará a esse waypoint.

WaypointType

O tipo de waypoint.

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