- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Waypoint
- VehicleMatchType
Retorna uma lista de veículos que correspondem às opções de solicitação.
Solicitação HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
parent |
Obrigatório. Precisa estar no formato |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header |
O cabeçalho de solicitação padrão do Fleet Engine. |
pickupPoint |
Obrigatório. O ponto de partida para pesquisar por perto. |
dropoffPoint |
O local de desembarque do cliente. O campo será obrigatório se |
pickupRadiusMeters |
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). |
minimumCapacity |
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. |
tripTypes[] |
Obrigatório. Representa o tipo de viagem proposta. É preciso incluir exatamente um tipo. A política |
maximumStaleness |
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. Uma duração em segundos com até nove dígitos fracionários, terminando em " |
vehicleTypes[] |
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 |
requiredAttributes[] |
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 requiredAttributes. Esse número corresponde ao número máximo de atributos permitidos em um veículo. |
requiredOneOfAttributes[] |
Restringe a pesquisa apenas aos veículos com pelo menos um dos atributos especificados em cada |
requiredOneOfAttributeSets[] |
Assim como
Restringe a pesquisa apenas aos veículos com todos os atributos em uma |
orderBy |
Obrigatório. Especifica o critério de ordenação desejado para resultados. |
includeBackToBack |
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 é |
tripId |
Indica a viagem associada a |
currentTripsPresent |
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, |
Corpo da resposta
vehicles.search
mensagem de resposta.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"matches": [
{
object ( |
Campos | |
---|---|
matches[] |
Lista de veículos que correspondem aos critérios |
VehicleAttributeList
Uma lista de tipos de dados de listas para atributos do veículo.
Representação JSON |
---|
{
"attributes": [
{
object ( |
Campos | |
---|---|
attributes[] |
Uma lista de atributos nesta coleção. |
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. |
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 includeBackToBack . |
NONE |
Veículos sem viagens podem aparecer nos resultados da pesquisa. Quando esse valor é usado, includeBackToBack 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, includeBackToBack não pode ser true . |
VehicleMatch
Contém o veículo e as estimativas relacionadas que correspondem aos pontos de viagens ativas do veículo SearchVehiclesRequest
.
Representação JSON |
---|
{ "vehicle": { object ( |
Campos | |
---|---|
vehicle |
Obrigatório. Um veículo que corresponde à solicitação. |
vehiclePickupEta |
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 Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
vehiclePickupDistanceMeters |
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. |
vehiclePickupStraightLineDistanceMeters |
Obrigatório. A distância em linha reta entre o veículo e o ponto de embarque especificado na solicitação. |
vehicleDropoffEta |
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 Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
vehiclePickupToDropoffDistanceMeters |
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 |
tripType |
Obrigatório. O tipo de viagem da solicitação usado para calcular o HEC até o ponto de embarque. |
vehicleTripsWaypoints[] |
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. |
vehicleMatchType |
Tipo de correspondência do veículo. |
requestedOrderedBy |
O pedido solicitado para classificar correspondências de veículo. |
orderedBy |
O pedido real usado para este veículo. Normalmente, esse valor corresponderá ao campo "orderBy" da solicitação. No entanto, em determinadas circunstâncias, como em um erro interno do servidor, é possível usar um método diferente (por exemplo, |
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.
Representação JSON |
---|
{
"latLng": {
object ( |
Campos | |
---|---|
latLng |
O local deste waypoint. |
eta |
O tempo estimado que o veículo chegará a esse waypoint. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
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. |