Í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
(enum)
TripService
Serviço de gerenciamento de viagens.
CreateTrip |
---|
Cria uma viagem no Fleet Engine e a retorna. |
GetTrip |
---|
Veja informações sobre uma única viagem. |
ReportBillableTrip |
---|
Informe o uso faturável da viagem. |
SearchTrips |
---|
Confira todas as viagens de um veículo específico. |
UpdateTrip |
---|
Atualiza os dados da viagem. |
VehicleService
Serviço de gerenciamento de veículos.
CreateVehicle |
---|
Instanciar um veículo novo associado a um provedor de transporte por aplicativo sob demanda ou de entregas. Cada Os seguintes campos
Os campos
Todos os outros campos são opcionais e usados quando informados. |
GetVehicle |
---|
Retorna um veículo do Fleet Engine. |
ListVehicles |
---|
Retorna uma lista paginada de veículos associados a um provedor que correspondem às opções da 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
Não foi 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. Outros atributos NÃO serão alterados. Observação: isso é diferente em |
BatteryInfo
Informações sobre a bateria do dispositivo.
Campos | |
---|---|
battery_status |
Status da bateria: cheia, carregando etc. |
power_source |
Status da fonte de energia da bateria. |
battery_percentage |
Porcentagem atual da bateria [0-100]. |
BatteryStatus
Status da bateria: cheia, carregando etc.
Enums | |
---|---|
UNKNOWN_BATTERY_STATUS |
Status da bateria desconhecido. |
BATTERY_STATUS_CHARGING |
A bateria está sendo carregada. |
BATTERY_STATUS_DISCHARGING |
A bateria está descarregando. |
BATTERY_STATUS_FULL |
A bateria está cheia. |
BATTERY_STATUS_NOT_CHARGING |
A bateria não está carregando. |
BATTERY_STATUS_POWER_LOW |
A bateria está com pouca energia. |
BillingPlatformIdentifier
Um conjunto de valores que indicam em qual plataforma a solicitação foi emitida.
Enums | |
---|---|
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED |
Padrão. Usado para plataformas não especificadas. |
SERVER |
A plataforma é um servidor cliente. |
WEB |
A plataforma é um navegador da Web. |
ANDROID |
A plataforma é um dispositivo móvel Android. |
IOS |
A plataforma é um dispositivo móvel iOS. |
OTHERS |
Outras plataformas que não estão listadas nesta enumeração. |
ConsumableTrafficPolyline
Densidade de trânsito ao longo do caminho de um veículo.
Campos | |
---|---|
speed_reading_interval[] |
Velocidade do trânsito no caminho desde o waypoint anterior até o waypoint atual. |
encoded_path_to_waypoint |
O caminho que o motorista está seguindo do waypoint anterior até o atual. Esse caminho contém pontos de referência para que os clientes possam mostrar marcadores de trânsito 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 de viagem a ser criada. Ao criar um grupo "Viagem", os seguintes campos são obrigatórios:
Os campos a seguir serão usados se forem informados:
Todos os outros campos "Viagem" são ignorados. Por exemplo, todas as viagens começam com um Apenas viagens de 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 "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 são ignorados:
Todos os outros campos são opcionais e usados quando informados. |
DeviceSettings
Informações sobre diversas configurações do 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 no momento. |
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 Trip que deve ser retornado 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) para o qual |
route_format_type |
O formato do trajeto atual retornado, |
current_route_segment_traffic_version |
Indica o carimbo de data/hora mínimo (exclusivo) para o qual |
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) para o qual |
waypoints_version |
Indica o carimbo de data/hora mínimo (exclusivo) para o qual os dados |
LicensePlate
As informações da placa do veículo. Para evitar o armazenamento de informações de identificação pessoal, apenas o mínimo de informações sobre a placa do carro é armazenado como parte da entidade.
Campos | |
---|---|
country_code |
Obrigatório. Código do país/região do CLDR. Por exemplo, |
last_character |
O último dígito da placa do carro ou "-1" para indicar que nenhum valor numérico está presente na placa.
|
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 do |
minimum_capacity |
Especifica a capacidade mínima exigida do veículo. Todos os veículos retornados terão um |
trip_types[] |
Restringe a resposta a veículos compatíveis com pelo menos um dos tipos de viagem especificados. |
maximum_staleness |
Restringe a resposta a veículos que enviaram atualizações de localização para o Fleet Engine no período especificado. Veículos parados que ainda transmitam suas localizações não são considerados desatualizados. Se presente, precisa ser uma duração positiva válida. |
vehicle_type_categories[] |
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. Esse campo é uma operação de conjunção/E. São permitidos no máximo 50 required_attributes. Esse valor corresponde ao número máximo de atributos permitidos em um veículo. Cada string repetida precisa 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[] |
Semelhante a
Restringe a resposta a 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 |
Só devolver os veículos com as viagens em andamento. |
filter |
Opcional. Uma consulta de filtro para aplicar ao listar veículos. Consulte http://aip.dev/160 para ver exemplos de sintaxe de filtro. Esse campo foi criado para substituir os campos Esse filtro funciona como uma cláusula AND com outras restrições, como As únicas consultas aceitas são nos 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 aquelas de strings. Para fazer uma comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, |
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
Mensagem de resposta de ListVehicles
.
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 vazia se não houver mais veículos que atendam aos critérios de solicitação. |
total_size |
Obrigatório. Número total de veículos que correspondem aos critérios de solicitação em todas as páginas. |
LocationPowerSaveMode
Como os recursos de localização são configurados para se comportar no dispositivo móvel quando os dispositivos "Economia de bateria" está ativado. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())
Enums | |
---|---|
UNKNOWN_LOCATION_POWER_SAVE_MODE |
LocationPowerSaveMode indefinida |
LOCATION_MODE_NO_CHANGE |
Os provedores de localização não devem ser afetados pela economia de bateria ou a economia de bateria está desativada. |
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF |
O provedor de localização com base em GPS deve ser desativado quando a economia de bateria estiver ativada e o dispositivo não estiver interativo. |
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF |
Todos os provedores de localização devem ser desativados quando a economia de bateria estiver ativada e o dispositivo não for interativo. |
LOCATION_MODE_FOREGROUND_ONLY |
Todos os provedores de localização vão continuar disponíveis, mas as correções de local só vão ser fornecidas aos apps em primeiro plano. |
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF |
A localização não será desativada, mas o LocationManager vai limitar todas as solicitações a provedores quando o dispositivo não for interativo. |
LocationSensor
O sensor ou a metodologia usado para determinar o local.
Enums | |
---|---|
UNKNOWN_SENSOR |
O sensor não foi especificado ou é desconhecido. |
GPS |
GPS ou GPS assistido. |
NETWORK |
GPS assistido, ID 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 na via. |
CUSTOMER_SUPPLIED_LOCATION |
Uma localização fornecida pelo cliente de uma fonte independente. Normalmente, esse valor é usado para um local fornecido por 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_SuppPLIED_LOCATION geralmente são fornecidos pelo last_location.supplemental_location_sensor do veículo. |
FLEET_ENGINE_LOCATION |
Um local calculado pelo Fleet Engine com base nos sinais disponíveis. Apenas saída. Esse valor será rejeitado se for recebido em uma solicitação. |
FUSED_LOCATION_PROVIDER |
Provedor de localização combinada do Android. |
CORE_LOCATION |
O provedor de localização nos sistemas operacionais da Apple. |
PolylineFormatType
O tipo de formato de polilinha.
Enums | |
---|---|
UNKNOWN_FORMAT_TYPE |
O formato não foi especificado ou é desconhecido. |
LAT_LNG_LIST_TYPE |
Uma lista de google.type.LatLng . |
ENCODED_POLYLINE_TYPE |
Uma polilinha codificada com um algoritmo de compactação de polilinha. Ainda não há suporte para decodificação. |
PowerSource
Tipo de carregador usado para carregar a bateria.
Enums | |
---|---|
UNKNOWN_POWER_SOURCE |
Fonte de energia desconhecida. |
POWER_SOURCE_AC |
A fonte de energia é um carregador CA. |
POWER_SOURCE_USB |
A fonte de energia é uma porta USB. |
POWER_SOURCE_WIRELESS |
A fonte de energia não tem fio. |
POWER_SOURCE_UNPLUGGED |
A bateria está desconectada. |
ReportBillableTripRequest
Mensagem de solicitação ReportBillableTrip.
Campos | |
---|---|
name |
Obrigatório. Precisa estar no formato |
country_code |
Obrigatório. Código do país com duas letras do país onde a viagem acontece. O preço é definido de acordo com o código do país. |
platform |
Plataforma em que a solicitação foi emitida. |
related_ids[] |
Os identificadores diretamente relacionados à viagem que está sendo informada. Geralmente, são IDs (por exemplo, IDs de sessão) de operações de pré-reserva realizadas antes da disponibilização do ID da viagem. O número de |
solution_type |
O tipo de solução de produto do GMP (por exemplo, |
SolutionType
Seletor para 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 vai usar ON_DEMAND_RIDESHARING_AND_DELIVERIES por padrão, que é o primeiro tipo de solução com suporte. |
ON_DEMAND_RIDESHARING_AND_DELIVERIES |
A solução é uma viagem de transporte por aplicativo sob demanda e entregas. |
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 para o inglês, se esse nome existir. 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", 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 da qual o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", 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", exemplo: |
platform |
Plataforma do SDK de chamada. |
manufacturer |
Fabricante do dispositivo Android do SDK de chamada, aplicável somente a SDKs do Android. Exemplo de valor de campo: |
android_api_level |
Nível da API do Android do SDK de chamada, aplicável apenas a SDKs do Android. Exemplo de valor de campo: |
trace_id |
ID opcional que pode ser fornecido para fins de registro em log a fim de identificar a solicitação. |
Plataforma
A plataforma do SDK de chamada.
Enums | |
---|---|
PLATFORM_UNSPECIFIED |
O valor padrão. Esse valor 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
Possíveis tipos de SDK.
Enums | |
---|---|
SDK_TYPE_UNSPECIFIED |
O valor padrão. Esse valor será usado se sdk_type for omitido. |
CONSUMER |
O SDK de chamada é o consumidor. |
DRIVER |
O SDK de chamada é o Driver. |
JAVASCRIPT |
O SDK de chamada é JavaScript. |
SearchTripsRequest
Mensagem de solicitação de 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 ela for definida como verdadeira, a resposta incluirá viagens que influenciam o trajeto de um motorista. |
page_size |
Se ela não for definida, 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 depois do horário |
SearchTripsResponse
Mensagem de resposta de SearchTrips.
Campos | |
---|---|
trips[] |
A lista de viagens para o veículo solicitado. |
next_page_token |
Transmita esse token no SearchTripsRequest para percorrer os resultados da lista. A API retorna uma lista de viagens em cada chamada e, quando não restam 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 encontro próximo ao qual pesquisar. |
dropoff_point |
O local de entrega pretendido do cliente. O campo é 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 driver não é considerado no valor da capacidade. |
trip_types[] |
Obrigatório. Representa o tipo de viagem proposta. Precisa 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 no período especificado. Veículos parados que ainda transmitam suas localizações não são considerados desatualizados. Se esse campo não for definido, o servidor usará cinco minutos como valor padrão. |
vehicle_types[] |
Obrigatório. Restringe a pesquisa a veículos com um dos tipos especificados. É necessário especificar pelo menos um tipo de veículo. 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. Esse campo é uma operação de conjunção/E. São permitidos no máximo 50 required_attributes. Esse valor corresponde ao número máximo de atributos permitidos em um veículo. |
required_one_of_attributes[] |
Restringe a pesquisa apenas aos veículos com pelo menos um dos atributos especificados em cada |
required_one_of_attribute_sets[] |
Semelhante a
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 os resultados. |
include_back_to_back |
Indica se veículos com uma única viagem ativa estão qualificados para essa pesquisa. Esse campo só é usado quando O valor padrão é |
trip_id |
Indica a viagem associada a este |
current_trips_present |
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 http://aip.dev/160 para ver exemplos de sintaxe de filtro. Esse campo foi criado para substituir os campos Esse filtro funciona como uma cláusula AND com outras restrições, como As únicas consultas aceitas são nos 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 aquelas de strings. Para fazer uma comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, |
CurrentTripsPresent
Especifica os tipos de restrições nas viagens atuais de um veículo.
Enums | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
A disponibilidade de veículos com as viagens é regida pelo campo include_back_to_back . |
NONE |
Veículos sem viagens podem aparecer nos resultados da pesquisa. Quando esse valor é usado, include_back_to_back não pode ser true . |
ANY |
Veículos com, no máximo, 5 viagens atuais e 10 waypoints são incluídos nos resultados da pesquisa. Quando esse valor é usado, include_back_to_back não pode ser true . |
VehicleMatchOrder
Especifica a ordem das correspondências do veículo na resposta.
Enums | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Padrão, usado para veículo não especificado ou não reconhecido corresponde ao pedido. |
PICKUP_POINT_ETA |
Ordem crescente por tempo de percurso do veículo até o ponto de embarque. |
PICKUP_POINT_DISTANCE |
Ordem crescente por distância de carro do veículo até o ponto de embarque. |
DROPOFF_POINT_ETA |
Ordem crescente por tempo de percurso do veículo até o ponto de entrega. Esse pedido só pode ser usado se o ponto de entrega for especificado na solicitação. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Pedido crescente por distância em linha reta do último local relatado do veículo até o ponto de embarque. |
COST |
Ordem crescente pelo custo de correspondência configurado. O custo da correspondência é definido como um cálculo ponderado entre a distância em linha reta e o ETA. Os pesos são definidos com valores padrão e podem ser modificados de acordo com o cliente. Entre em contato com o Suporte do Google se for preciso modificar os pesos no seu projeto. |
SearchVehiclesResponse
Mensagem de resposta de SearchVehicles
.
Campos | |
---|---|
matches[] |
Lista de veículos que correspondem aos critérios |
SpeedReadingInterval
Indicador de densidade de tráfego em um segmento contíguo de um caminho. Dado um caminho com pontos P_0, P_1, ... , P_N (índice baseado em zero), o SpeedReadingInterval define um intervalo e descreve o tráfego usando as seguintes categorias.
Campos | |
---|---|
start_polyline_point_index |
O índice inicial deste intervalo no caminho. No JSON, quando o índice for 0, o campo parecerá não preenchido. |
end_polyline_point_index |
O índice final deste intervalo no caminho. No JSON, quando o índice for 0, o campo 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 foi detectada, mas não houve engarrafamento. |
TRAFFIC_JAM |
Engarrafamento detectado. |
StopLocation
O local real em que ocorreu uma parada (embarque/desembarque).
Campos | |
---|---|
point |
Obrigatório. Indica o local real. |
timestamp |
Indica quando a parada aconteceu. |
stop_time |
Somente entrada. Obsoleto. Use o campo de carimbo de data/hora. |
TerminalLocation
Descreve o local de um waypoint.
Campos | |
---|---|
point |
Obrigatório. Indica o local 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 |
Descontinuado: |
TerminalPointId
Obsoleto: os TerminalPoints não têm 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 no trajeto esperado do veículo.
Campos | |
---|---|
traffic_rendering |
Uma renderização de polilinha que mostra a velocidade do trânsito para todas as regiões ao longo de um trecho de uma viagem com o cliente. |
Viagem
Metadados de viagem.
Campos | |
---|---|
name |
Apenas saída. Use o formato "providers/{provider}/trips/{trip}". |
vehicle_id |
ID do veículo que faz essa viagem. |
trip_status |
Status atual da viagem. |
trip_type |
O tipo de viagem. |
pickup_point |
Local onde o cliente indica que ele será retirado. |
actual_pickup_point |
Somente entrada. O local real quando e onde o cliente foi retirado. Este campo serve para o fornecedor enviar feedback sobre as informações de retirada. |
actual_pickup_arrival_point |
Somente entrada. A hora e o local reais de chegada do motorista no ponto de embarque. Este campo serve para o fornecedor enviar feedback sobre as informações reais de chegada ao ponto de embarque. |
pickup_time |
Apenas saída. A hora futura estimada em que os passageiros embarcarão ou a hora 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 haverá suporte para viagens compartilhadas. |
intermediate_destinations_version |
Indica a última vez que o |
intermediate_destination_index |
Quando |
actual_intermediate_destination_arrival_points[] |
Somente entrada. A hora e o local reais de chegada do motorista em um destino intermediário. Este campo serve para o provedor fornecer feedback sobre informações reais de chegada em destinos intermediários. |
actual_intermediate_destinations[] |
Somente entrada. A hora e o local reais quando e onde o cliente foi retirado de um destino intermediário. Este campo serve para o provedor enviar feedback sobre informações reais de embarque em destinos intermediários. |
dropoff_point |
Local onde o cliente indica que será deixado. |
actual_dropoff_point |
Somente entrada. A hora e o local reais quando e onde o cliente foi deixado. Este campo serve para o provedor fornecer feedback sobre as informações reais de desembarque. |
dropoff_time |
Apenas saída. A hora futura estimada em que os passageiros desembarcam no destino final ou a hora real em que desembarcam. |
remaining_waypoints[] |
Apenas saída. O caminho completo do local atual até o ponto de desembarque, inclusive. Esse caminho pode incluir waypoints de outras viagens. |
vehicle_waypoints[] |
Este campo permite a ordenação manual dos waypoints da viagem. Ele contém todos os waypoints restantes do veículo atribuído, além dos waypoints de embarque e desembarque dessa viagem. Se a viagem não tiver sido atribuída a um veículo, o Fleet Engine vai ignorar esse campo. Por motivos de privacidade, esse campo só é preenchido pelo servidor nas chamadas |
route[] |
Apenas saída. Trajeto previsto para esta viagem até a primeira entrada em quarter_waypoints. O primeiro waypoint pode pertencer a uma viagem diferente. |
current_route_segment |
Apenas saída. Um caminho codificado para o próximo ponto de referência. Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor. Ainda não há suporte para decodificação. |
current_route_segment_version |
Apenas saída. Indica a última vez que o trajeto foi modificado. Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor. |
current_route_segment_traffic |
Apenas saída. Indica as condições de trânsito ao longo da Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor. |
current_route_segment_traffic_version |
Apenas saída. Indica a última vez que o Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor. |
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 do retorno dos dados de viagem ao horário em |
remaining_waypoints_version |
Apenas saída. Indica a última vez que |
remaining_waypoints_route_version |
Apenas saída. Indica a última vez que |
number_of_passengers |
Imutável. Indica o número de passageiros nesta 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 relatado do veículo ao longo do trajeto. |
last_location_snappable |
Apenas saída. Indica se o |
view |
O subconjunto de campos "Viagem" preenchidos e como eles devem ser interpretados. |
TripStatus
O status de uma viagem que indica sua progressão.
Enums | |
---|---|
UNKNOWN_TRIP_STATUS |
Padrão, usada para status de viagem não especificado ou não reconhecido. |
NEW |
Viagem recém-criada. |
ENROUTE_TO_PICKUP |
O motorista está a caminho do ponto de embarque. |
ARRIVED_AT_PICKUP |
O motorista chegou ao ponto de embarque. |
ARRIVED_AT_INTERMEDIATE_DESTINATION |
O motorista chegou a um destino intermediário e está esperando o passageiro. |
ENROUTE_TO_INTERMEDIATE_DESTINATION |
O motorista está a caminho de um destino intermediário (não do ponto de desembarque). |
ENROUTE_TO_DROPOFF |
O motorista pegou o passageiro e está a caminho do próximo destino. |
COMPLETE |
O passageiro foi desembarcado e a viagem foi concluída. |
CANCELED |
A viagem foi cancelada antes do embarque pelo motorista, passageiro ou provedor de transporte por aplicativo. |
TripType
O tipo de viagem.
Enums | |
---|---|
UNKNOWN_TRIP_TYPE |
Padrão, usado para tipos de viagem não especificados ou não reconhecidos. |
SHARED |
A viagem pode compartilhar um veículo com outras. |
EXCLUSIVE |
A viagem é exclusiva para um veículo. |
TripView
Seletor de diferentes conjuntos de campos "Viagem" em uma resposta GetTrip
. Consulte o contexto em AIP-157 (em inglês). Outras visualizações provavelmente serão incluídas.
Enums | |
---|---|
TRIP_VIEW_UNSPECIFIED |
O valor padrão. Para compatibilidade com versões anteriores, a API usará uma visualização do SDK por padrão. Para garantir a estabilidade e o suporte, aconselhamos os clientes a selecionar um TripView diferente de SDK . |
SDK |
Inclui campos que podem não ser interpretáveis ou compatíveis com o uso de bibliotecas disponíveis publicamente. |
JOURNEY_SHARING_V1S |
Os campos de viagem são preenchidos para o caso de uso do Compartilhamento de jornada. Essa visualização é destinada a comunicações de servidor para servidor. |
TripWaypoint
Descreve um ponto de parada no trajeto de um veículo ou um ponto final na viagem de um veículo.
Campos | |
---|---|
location |
O local deste waypoint. |
trip_id |
A viagem associada a este waypoint. |
waypoint_type |
A função do waypoint na viagem, como embarque ou desembarque. |
path_to_waypoint[] |
O caminho do waypoint anterior até o waypoint atual. Indefinido para o primeiro ponto de referência de uma lista. Esse campo só é preenchido quando solicitado. |
encoded_path_to_waypoint |
O caminho codificado do ponto de referência anterior até o waypoint atual. Observação: este campo é destinado apenas para uso do SDK do Driver e do SDK do consumidor. Ainda não há suporte para decodificação. |
traffic_to_waypoint |
As condições de trânsito ao longo do caminho até este waypoint. O tráfego está disponível apenas para clientes da solução de viagens e entregas da Plataforma Google Maps. |
distance_meters |
A distância do caminho do waypoint anterior até o waypoint atual. Indefinido para o primeiro ponto de referência de uma lista. |
eta |
O horário previsto de chegada a este ponto de referência. Indefinido para o primeiro ponto de referência de uma lista. |
duration |
O tempo de viagem do ponto de referência anterior até este ponto. Indefinido para o primeiro ponto de referência de uma lista. |
UpdateTripRequest
Mensagem de solicitação 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 em viagens com vários destinos, informe |
update_mask |
Obrigatório. 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
Mensagem de resposta de UpdateVehicleAttributes
.
Campos | |
---|---|
attributes[] |
Obrigatório. A lista completa atualizada de atributos do veículo, incluindo atributos novos, alterados e intactos. |
UpdateVehicleRequest
"Mensagem de solicitação de 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 compatíveis com 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 transportar. O driver 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 de veículo. Pode ser usado para filtrar veículos em 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 para o próximo waypoint. Essa lista também é retornada no Observação: este campo é destinado apenas para uso pelo SDK do Driver. Ainda não há suporte para decodificação. |
current_route_segment_traffic |
Somente entrada. O Fleet Engine usa essas informações para melhorar o compartilhamento de jornadas. Observação: este campo é destinado apenas para uso pelo SDK do Driver. |
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 |
Somente entrada. O tempo restante do percurso do veículo Ao atualizar um veículo, |
waypoints[] |
Os waypoints restantes atribuídos a este Veículo. |
waypoints_version |
Apenas saída. Última vez que o campo |
back_to_back_enabled |
Indica se o motorista aceita viagens de ida e volta. Se for |
navigation_status |
O status de navegação do veículo. |
device_settings |
Somente 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 funcione como táxi (normalmente licenciado ou regulamentado). |
TRUCK |
Geralmente, um veículo com grande capacidade de armazenamento. |
TWO_WHEELER |
Uma moto, ciclomoto ou outro veículo de duas rodas |
BICYCLE |
Transporte impulsionado por humanos. |
PEDESTRIAN |
Um transportador humano, normalmente caminhando ou correndo, viajando ao longo de vias para pedestres. |
VehicleAttribute
Descreve um atributo de veículo como um par de chave-valor. "key:value" não pode ter mais de 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 string, booleano ou duplo. vehicle_attribute_value pode ser apenas de um dos tipos a seguir: |
|
string_value |
Valor do atributo tipado de string. Observação: ele é idêntico ao campo |
bool_value |
Valor do atributo tipado booleano. |
number_value |
Valor de atributo com dois tipos. |
VehicleAttributeList
Um tipo de dados de lista de listas para atributos do veículo.
Campos | |
---|---|
attributes[] |
Uma lista de atributos desta coleção. |
VehicleLocation
O local, a velocidade e a direção de um veículo em um momento específico.
Campos | |
---|---|
location |
A localização do veículo. Quando ele é enviado ao Fleet Engine, a localização do veículo é uma localização de GPS. Quando você a recebe em uma resposta, a localização do veículo pode ser uma localização de GPS, um local complementar ou algum outro local aproximado. 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 |
A hora em que |
server_time |
Apenas saída. A hora em que o servidor recebeu as informações de local. |
location_sensor |
Provedor de dados de local (por exemplo, |
is_road_snapped |
Indica se o |
is_gps_sensor_enabled |
Somente entrada. Indica se o sensor de GPS está ativado no dispositivo móvel. |
time_since_update |
Somente entrada. Tempo (em segundos) desde que esse local foi enviado pela primeira vez ao servidor. Esse valor 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 |
Somente entrada. Obsoleto: outros indicadores agora são usados para determinar se um local está desatualizado. |
raw_location |
Localização do veículo sem dados (não processado pelo Snapper da Estrada). |
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 |
Localização complementar fornecida 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 para um veículo que corresponde 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 |
vehicle_pickup_distance_meters |
A distância da localização atual do Veículo até o ponto de embarque especificado na solicitação, incluindo os pontos de embarque ou desembarque intermediários de viagens existentes. Essa distância compreende a distância de percurso (trajeto) calculada mais a distância em linha reta entre o ponto final da navegação e o ponto de embarque solicitado. A distância entre o ponto de destino da navegação e o ponto de embarque solicitado normalmente é 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 ETA inclui parada em qualquer waypoint antes do |
vehicle_pickup_to_dropoff_distance_meters |
A distância de carro (em metros) do veículo entre o ponto de embarque e 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 chegada do veículo ao ponto de embarque ou desembarque. O valor só será preenchido quando |
trip_type |
Obrigatório. O tipo de viagem da solicitação que foi usada 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 e os pontos de embarque das viagens ativas do veículo e fornecidos na solicitação. Uma lista vazia indica uma falha no cálculo do HEC do veículo. |
vehicle_match_type |
Tipo de correspondência do veículo. |
requested_ordered_by |
A ordem solicitada para classificar as correspondências do veículo. |
ordered_by |
O pedido real usado para este veículo. Normalmente, isso corresponde ao atributo 'order_by' da solicitação. No entanto, em determinadas circunstâncias, como um erro interno do servidor, outro método pode ser usado (como |
VehicleMatchType
Tipo de correspondência de veículo.
Enums | |
---|---|
UNKNOWN |
Tipo de correspondência de veículo desconhecido |
EXCLUSIVE |
No momento, o veículo não tem 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 prosseguir até o ponto de embarque depois de concluir a viagem em andamento. Os cálculos de HEC e distância consideram a viagem atual. |
CARPOOL |
O veículo tem capacidade suficiente para uma viagem compartilhada. |
CARPOOL_BACK_TO_BACK |
O veículo vai concluir a viagem atual e ativa antes de prosseguir para o ponto de embarque. Os cálculos de HEC e distância consideram a viagem atual. |
VehicleState
O estado de uma Vehicle
.
Enums | |
---|---|
UNKNOWN_VEHICLE_STATE |
Padrão, usado para estados de veículo não especificados ou não reconhecidos. |
OFFLINE |
O veículo não está aceitando novas viagens. Observação: o veículo pode continuar operando nesse estado durante 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 precisam ser renderizados ao longo da polilinha. Os trechos não se sobrepõem e não abrangem necessariamente todo o trajeto. Na ausência de um trecho de estrada para definir o estilo, o cliente deve aplicar o padrão para o trajeto. |
RoadStretch
Um trecho de via que precisa 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, que indica a velocidade do tráfego.
Enums | |
---|---|
STYLE_UNSPECIFIED |
Nenhum estilo selecionado. |
SLOWER_TRAFFIC |
O tráfego está diminuindo. |
TRAFFIC_JAM |
Há um engarrafamento. |
Ponto de referência
Descreve pontos intermediários ao longo de um trajeto para um VehicleMatch
em 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 este 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 desembarque de passageiros ou itens. |
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE |
Pontos de referência para destinos intermediários em uma viagem com vários destinos. |