Índice
TripService
(interface)VehicleService
(interface)BatteryInfo
(mensagem)BatteryStatus
(enum)BillingPlatformIdentifier
(enum)ConsumableTrafficPolyline
(mensagem)CreateTripRequest
(mensagem)CreateVehicleRequest
(mensagem)DeviceSettings
(mensagem)GetTripRequest
(mensagem)GetVehicleRequest
(mensagem)LicensePlate
(mensagem)ListVehiclesRequest
(mensagem)ListVehiclesResponse
(mensagem)LocationPowerSaveMode
(enum)LocationSensor
(enum)NavigationStatus
(enum)PolylineFormatType
(enum)PowerSource
(enum)ReportBillableTripRequest
(mensagem)ReportBillableTripRequest.SolutionType
(enum)RequestHeader
(mensagem)RequestHeader.Platform
(enum)RequestHeader.SdkType
(enum)SearchTripsRequest
(mensagem)SearchTripsResponse
(mensagem)SearchVehiclesRequest
(mensagem)SearchVehiclesRequest.CurrentTripsPresent
(enum)SearchVehiclesRequest.VehicleMatchOrder
(enum)SearchVehiclesResponse
(mensagem)SpeedReadingInterval
(mensagem)SpeedReadingInterval.Speed
(enum)StopLocation
(mensagem)TerminalLocation
(mensagem)TerminalPointId
(mensagem) (descontinuado)TrafficPolylineData
(mensagem)Trip
(mensagem)TripStatus
(enum)TripType
(enum)TripView
(enum)TripWaypoint
(mensagem)UpdateTripRequest
(mensagem)UpdateVehicleAttributesRequest
(mensagem)UpdateVehicleAttributesResponse
(mensagem)UpdateVehicleRequest
(mensagem)Vehicle
(mensagem)Vehicle.VehicleType
(mensagem)Vehicle.VehicleType.Category
(enum)VehicleAttribute
(mensagem)VehicleAttributeList
(mensagem)VehicleLocation
(mensagem)VehicleMatch
(mensagem)VehicleMatch.VehicleMatchType
(enum)VehicleState
(enum)VisualTrafficReportPolylineRendering
(mensagem)VisualTrafficReportPolylineRendering.RoadStretch
(mensagem)VisualTrafficReportPolylineRendering.RoadStretch.Style
(enum)Waypoint
(mensagem)WaypointType
(tipo enumerado)
TripService
Serviço de gerenciamento de viagens.
CreateTrip |
---|
Cria uma viagem no Fleet Engine e retorna a nova viagem. |
GetTrip |
---|
Receba informações sobre uma única viagem. |
ReportBillableTrip |
---|
Informar o uso de viagens faturáveis. |
SearchTrips |
---|
Veja todas as viagens de um veículo específico. |
UpdateTrip |
---|
Atualiza dados de viagens. |
VehicleService
Serviço de gerenciamento de veículos.
CreateVehicle |
---|
Instanciar um novo veículo associado a um provedor de serviços de transporte por aplicativo ou de entregas sob demanda. Cada Os seguintes campos
Os campos
Todos os outros campos são opcionais e serão usados se fornecidos. |
GetVehicle |
---|
Retorna um veículo do Fleet Engine. |
ListVehicles |
---|
Retorna uma lista paginada de veículos associados a um provedor que corresponde às opções de solicitação. |
SearchVehicles |
---|
Retorna uma lista de veículos que correspondem às opções de solicitação. |
UpdateVehicle |
---|
Grava dados atualizados do veículo no Fleet Engine. Ao atualizar um
Também não é possível atualizar o veículo Se o campo |
UpdateVehicleAttributes |
---|
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 |
BatteryInfo
Informações sobre a bateria do dispositivo.
Campos | |
---|---|
battery_status |
O status da bateria, se ela está cheia, carregando etc. |
power_source |
Status da fonte de energia da bateria. |
battery_percentage |
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[] |
Velocidade do tráfego ao longo do caminho do waypoint anterior até o waypoint atual. |
encoded_path_to_waypoint |
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 |
CreateTripRequest
Mensagem de solicitação CreateTrip.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
parent |
Obrigatório. Precisa estar no formato |
trip_id |
Obrigatório. ID exclusivo da viagem. Sujeito às seguintes restrições:
|
trip |
Obrigatório. Entidade "Trip" a ser criada. Ao criar uma viagem, os seguintes campos são obrigatórios:
Os campos a seguir serão usados quando você os informar:
Todos os outros campos "Viagem" serão ignorados. Por exemplo, todas as viagens começam com um Apenas viagens Quando Quando você especifica Os campos |
CreateVehicleRequest
Mensagem de solicitação de CreateVehicle
.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
parent |
Obrigatório. Precisa estar no formato |
vehicle_id |
Obrigatório. ID exclusivo do veículo Sujeito às seguintes restrições:
|
vehicle |
Obrigatório. A entidade do veículo a ser criada. Ao criar um Veículo, os seguintes campos são obrigatórios:
Ao criar um Veículo, os seguintes campos serão ignorados:
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 |
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 |
Se o dispositivo está no modo de economia de energia. |
is_interactive |
Se o dispositivo está em um estado interativo. |
battery_info |
Informações sobre o estado da bateria. |
GetTripRequest
Mensagem de solicitação GetTrip.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
name |
Obrigatório. Precisa estar no formato |
view |
O subconjunto de campos "Viagem" que precisam ser retornados e a interpretação deles. |
current_route_segment_version |
Indica o carimbo de data/hora mínimo (exclusivo) para o qual os dados |
remaining_waypoints_version |
Indica o carimbo de data/hora mínimo (exclusivo) de que |
route_format_type |
O formato do trajeto atual retornado, |
current_route_segment_traffic_version |
Indica o carimbo de data/hora mínimo (exclusivo) de que |
remaining_waypoints_route_version |
Indica o carimbo de data/hora mínimo (exclusivo) para o qual os dados |
GetVehicleRequest
Mensagem de solicitação de GetVehicle
.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
name |
Obrigatório. Precisa estar no formato |
current_route_segment_version |
Indica o carimbo de data/hora mínimo (exclusivo) de que |
waypoints_version |
Indica o carimbo de data/hora mínimo (exclusivo) de onde os dados de |
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 |
Obrigatório. Código do país/região CLDR. Por exemplo, |
last_character |
O último dígito da placa ou "-1", para indicar que não há valor numérico, está presente.
|
ListVehiclesRequest
Mensagem de solicitação de ListVehicles
.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
parent |
Obrigatório. Precisa estar no formato |
page_size |
O número máximo de veículos a serem retornados. Valor padrão: 100. |
page_token |
O valor de |
minimum_capacity |
Especifica a capacidade mínima necessária do veículo. Todos os veículos retornados vão ter um |
trip_types[] |
Restringe a resposta a veículos que aceitam pelo menos um dos tipos de viagem especificados. |
maximum_staleness |
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[] |
Obrigatório. Restringe a resposta a veículos com uma das categorias de tipo especificadas. A política |
required_attributes[] |
Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos
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[] |
Restringe a resposta a veículos com pelo menos um dos atributos especificados em cada |
required_one_of_attribute_sets[] |
Assim como
Restringe a resposta aos veículos que correspondem a todos os atributos em uma |
vehicle_state |
Restringe a resposta a veículos que têm esse estado. |
on_trip_only |
Devolva apenas os veículos com as viagens atuais. |
filter |
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 Esse filtro funciona como uma cláusula "E" com outras restrições, como As únicas consultas aceitas são em atributos do veículo (por exemplo, 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, |
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[] |
Veículos que correspondem aos critérios da solicitação. O número máximo de veículos retornados é determinado pelo campo |
next_page_token |
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 |
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. |
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 |
Obrigatório. Precisa estar no formato |
country_code |
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 |
A plataforma em que a solicitação foi emitida. |
related_ids[] |
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 |
solution_type |
O tipo de solução de produto do GMP (por exemplo, |
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 |
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: |
region_code |
Obrigatório. Código regional CLDR da região de origem da solicitação. Exemplo de valor do campo: |
sdk_version |
Versão do SDK de chamada, se aplicável. O formato da versão é "major.minor.patch", por exemplo: |
os_version |
Versão do sistema operacional em que o SDK de chamada está sendo executado. Exemplos de valor de campo: |
device_model |
Modelo do dispositivo em que o SDK de chamada está sendo executado. Exemplos de valor de campo: |
sdk_type |
O tipo de SDK que envia a solicitação. |
maps_sdk_version |
Versão do MapSDK de que o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por exemplo: |
nav_sdk_version |
Versão do NavSDK de que o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por exemplo: |
platform |
Plataforma do SDK de chamada. |
manufacturer |
Fabricante do dispositivo Android do SDK de chamada, aplicável somente aos SDKs do Android. Exemplo de valor do campo: |
android_api_level |
Nível da API do Android do SDK de chamada, aplicável apenas aos SDKs do Android. Exemplo de valor do campo: |
trace_id |
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 |
O cabeçalho de solicitação padrão do Fleet Engine. |
parent |
Obrigatório. Precisa estar no formato |
vehicle_id |
O veículo associado às viagens na solicitação. Se não for especificado, as viagens retornadas não vão conter:
|
active_trips_only |
Se definido como verdadeiro, a resposta incluirá viagens que influenciam o trajeto do motorista. |
page_size |
Se não for definido, o servidor decidirá o número de resultados a serem retornados. |
page_token |
Defina-o como um valor retornado anteriormente no |
minimum_staleness |
Se especificado, retorna as viagens que não foram atualizadas após o horário |
SearchTripsResponse
Mensagem de resposta de SearchTrips.
Campos | |
---|---|
trips[] |
Lista de viagens do veículo solicitado. |
next_page_token |
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 |
O cabeçalho de solicitação padrão do Fleet Engine. |
parent |
Obrigatório. Precisa estar no formato |
pickup_point |
Obrigatório. O ponto de partida para pesquisar por perto. |
dropoff_point |
O local de desembarque do cliente. O campo será obrigatório se |
pickup_radius_meters |
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 |
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 |
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[] |
Obrigatório. Representa o tipo de viagem proposta. É preciso incluir exatamente um tipo. A política |
maximum_staleness |
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[] |
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 |
required_attributes[] |
Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos
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[] |
Restringe a pesquisa apenas aos veículos com pelo menos um dos atributos especificados em cada |
required_one_of_attribute_sets[] |
Assim como
Restringe a pesquisa apenas aos veículos com todos os atributos em uma |
order_by |
Obrigatório. Especifica o critério de ordenação desejado para resultados. |
include_back_to_back |
Isso indica se veículos com uma única viagem ativa estão qualificados para a pesquisa. Esse campo só é usado quando O valor padrão é |
trip_id |
Indica a viagem associada a |
current_trips_present |
Isso indica se veículos com viagens ativas estão qualificados para essa pesquisa. Precisa ser definido como algo diferente de |
filter |
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 Esse filtro funciona como uma cláusula "E" com outras restrições, como As únicas consultas aceitas são em atributos do veículo (por exemplo, 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, |
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[] |
Lista de veículos que correspondem aos critérios |
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 |
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 |
O índice final desse intervalo no caminho. Em JSON, quando o índice for 0, o campo vai parecer não preenchido. |
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 |
Obrigatório. Indica a localização real. |
timestamp |
Indica quando a parada aconteceu. |
stop_time |
Somente entrada. Obsoleto. Use o campo de carimbo de data/hora. |
TerminalLocation
Descreve a localização de um waypoint.
Campos | |
---|---|
point |
Obrigatório. Indica a localização de um waypoint da viagem. |
terminal_point_id |
Obsoleto: especifique o campo |
access_point_id |
Obsoleto: especifique o campo |
trip_id |
Obsoleto. |
terminal_location_type |
Obsoleto: |
TerminalPointId
Obsoleto: TerminalPoints não tem mais suporte no Fleet Engine. Use TerminalLocation.point
Campos | |
---|---|
value |
Obsoleto. |
Campo de união Id . Obsoleto. Id pode ser apenas de um dos tipos a seguir: |
|
place_id |
Obsoleto. |
generated_id |
Obsoleto. |
TrafficPolylineData
Condições de trânsito ao longo do trajeto esperado do veículo.
Campos | |
---|---|
traffic_rendering |
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 |
Apenas saída. No formato "providers/{provider}/trips/{trip}". |
vehicle_id |
ID do veículo que está fazendo esta viagem. |
trip_status |
Status atual da viagem. |
trip_type |
O tipo da viagem. |
pickup_point |
Local em que o cliente indica que será retirado. |
actual_pickup_point |
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 |
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 |
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[] |
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 |
Indica a última vez que o |
intermediate_destination_index |
Quando |
actual_intermediate_destination_arrival_points[] |
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[] |
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 |
Local em que o cliente indica que será entregue. |
actual_dropoff_point |
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 |
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[] |
Apenas saída. O caminho completo do local atual até o ponto de desembarque. Esse caminho pode incluir waypoints de outras viagens. |
vehicle_waypoints[] |
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 |
route[] |
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 |
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 |
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 |
Apenas saída. Indica as condições de trânsito ao longo da Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK. |
current_route_segment_traffic_version |
Apenas saída. Indica a última vez que o Observação: esse campo é destinado apenas para uso do SDK do Driver e do Consumer SDK. |
current_route_segment_end_point |
Apenas saída. O waypoint onde |
remaining_distance_meters |
Apenas saída. A distância de carro restante no campo |
eta_to_first_waypoint |
Apenas saída. O HEC até o próximo waypoint (a primeira entrada no campo |
remaining_time_to_first_waypoint |
Apenas saída. A duração entre o momento em que os dados de viagem são retornados até o horário no |
remaining_waypoints_version |
Apenas saída. Indica a última vez em que |
remaining_waypoints_route_version |
Apenas saída. Indica a última vez que o |
number_of_passengers |
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 |
last_location |
Apenas saída. Indica o último local informado do veículo ao longo do trajeto. |
last_location_snappable |
Apenas saída. Indica se o |
view |
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 |
O local deste waypoint. |
trip_id |
A viagem associada a este waypoint. |
waypoint_type |
A função que o waypoint desempenha na viagem, por exemplo, em embarque ou desembarque. |
path_to_waypoint[] |
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 |
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 |
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 |
A distância do caminho entre o waypoint anterior e o waypoint atual. Indefinido para o primeiro waypoint em uma lista. |
eta |
O horário previsto de chegada neste waypoint. Indefinido para o primeiro waypoint em uma lista. |
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 |
O cabeçalho de solicitação padrão do Fleet Engine. |
name |
Obrigatório. Precisa estar no formato |
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.
Ao atualizar o Quando você especifica Para evitar uma disputa para viagens com vários destinos, forneça |
update_mask |
Obrigatório. A máscara de campo que indica quais campos em "Viagem" serão atualizados. O |
UpdateVehicleAttributesRequest
Mensagem de solicitação de UpdateVehicleAttributes
.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
name |
Obrigatório. Precisa estar no formato |
attributes[] |
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[] |
Obrigatório. Lista completa atualizada de atributos do veículo, incluindo atributos novos, alterados e intactos. |
UpdateVehicleRequest
Mensagem de solicitação UpdateVehicle.
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
name |
Obrigatório. Precisa estar no formato |
vehicle |
Obrigatório. Os valores de entidade
Se o campo Da mesma forma, o campo |
update_mask |
Obrigatório. Uma máscara de campo que indica quais campos do |
Veículo
Metadados do veículo.
Campos | |
---|---|
name |
Apenas saída. O nome exclusivo deste veículo. O formato é |
vehicle_state |
O estado do veículo. |
supported_trip_types[] |
Tipos de viagem aceitos por este veículo. |
current_trips[] |
Apenas saída. Lista de |
last_location |
Último local informado do veículo. |
maximum_capacity |
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[] |
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 |
Obrigatório. O tipo deste veículo. Pode ser usado para filtrar veículos nos resultados de |
license_plate |
Informações da placa do veículo. |
route[] |
Obsoleto: use |
current_route_segment |
A polilinha que especifica o trajeto que o app do motorista pretende seguir até o próximo waypoint. Essa lista também é retornada em Observação: esse campo é destinado somente ao uso do SDK do Driver. A decodificação ainda não é compatível. |
current_route_segment_traffic |
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 |
Apenas saída. Hora em que |
current_route_segment_end_point |
O waypoint onde |
remaining_distance_meters |
A distância de carro restante do |
eta_to_first_waypoint |
O HEC para a primeira entrada no campo Ao atualizar um veículo, |
remaining_time_seconds |
Apenas entrada. O tempo restante de condução do Ao atualizar um veículo, |
waypoints[] |
Os waypoints restantes atribuídos a este Veículo. |
waypoints_version |
Apenas saída. Mostra a última vez que o campo |
back_to_back_enabled |
Indica se o motorista aceita viagens de ida e volta. Se |
navigation_status |
Status de navegação do veículo. |
device_settings |
Apenas entrada. Informações sobre as configurações no dispositivo móvel usado pelo motorista. |
VehicleType
O tipo de veículo.
Campos | |
---|---|
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 |
A chave do atributo. As chaves não podem conter dois-pontos (:). |
value |
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 |
Valor do atributo com tipo string. Observação: ele é idêntico ao campo |
bool_value |
Valor do atributo tipo booleano. |
number_value |
Valor de atributo de dois tipos. |
VehicleAttributeList
Uma lista de tipos de dados de listas para atributos do veículo.
Campos | |
---|---|
attributes[] |
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 |
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 |
horizontal_accuracy |
Obsoleto: use |
latlng_accuracy |
Precisão de |
heading |
Direção em que o veículo está se movendo, em graus. 0 representa Norte. O intervalo válido é [0,360). |
bearing_accuracy |
Obsoleto: use |
heading_accuracy |
Precisão de |
altitude |
Altitude em metros acima de WGS84. |
vertical_accuracy |
Obsoleto: use |
altitude_accuracy |
Precisão de |
speed_kmph |
Velocidade do veículo em quilômetros por hora. Obsoleto: use |
speed |
Velocidade do veículo em metros/segundo |
speed_accuracy |
Precisão de |
update_time |
O horário em que |
server_time |
Apenas saída. A hora em que o servidor recebeu as informações de localização. |
location_sensor |
Provedor de dados de local (por exemplo, |
is_road_snapped |
Define se |
is_gps_sensor_enabled |
Apenas entrada. Indica se o sensor de GPS está ativado no dispositivo móvel. |
time_since_update |
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 |
Apenas entrada. Obsoleto: outros indicadores agora são usados para determinar se um local está desatualizado. |
raw_location |
Local bruto do veículo (não processado pelo carrapato). |
raw_location_time |
Carimbo de data/hora associado ao local bruto. |
raw_location_sensor |
Origem da localização bruta. O valor padrão é |
raw_location_accuracy |
Precisão de |
supplemental_location |
Local complementar fornecido pelo app de integração. |
supplemental_location_time |
Carimbo de data/hora associado ao local complementar. |
supplemental_location_sensor |
Origem do local complementar. O valor padrão é |
supplemental_location_accuracy |
Precisão de |
road_snapped |
Obsoleto: use |
VehicleMatch
Contém o veículo e as estimativas relacionadas que correspondem aos pontos de viagens ativas do veículo SearchVehiclesRequest
.
Campos | |
---|---|
vehicle |
Obrigatório. Um veículo que corresponde à solicitação. |
vehicle_pickup_eta |
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 |
vehicle_pickup_distance_meters |
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 |
Obrigatório. A distância em linha reta entre o veículo e o ponto de embarque especificado na solicitação. |
vehicle_dropoff_eta |
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 |
vehicle_pickup_to_dropoff_distance_meters |
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 |
trip_type |
Obrigatório. O tipo de viagem da solicitação usado para calcular o HEC até o ponto de embarque. |
vehicle_trips_waypoints[] |
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 |
Tipo de correspondência do veículo. |
requested_ordered_by |
O pedido solicitado para classificar correspondências de veículo. |
ordered_by |
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 |
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[] |
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 |
Obrigatório. O estilo a ser aplicado. |
offset_meters |
Obrigatório. O estilo precisa ser aplicado entre |
length_meters |
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 |
O local deste waypoint. |
eta |
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. |