- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Ponto de referência
- 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 encontro próximo ao qual pesquisar. |
dropoffPoint |
O local de entrega pretendido do cliente. O campo é 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 driver não é considerado no valor da capacidade. |
tripTypes[] |
Obrigatório. Representa o tipo de viagem proposta. Precisa 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 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. 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. 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. Esse campo é uma operação de conjunção/E. São permitidos no máximo 50 requiredAttributes. Esse valor 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[] |
Semelhante a
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 os resultados. |
includeBackToBack |
Indica se veículos com uma única viagem ativa estão qualificados para essa pesquisa. Esse campo só é usado quando O valor padrão é |
tripId |
Indica a viagem associada a este |
currentTripsPresent |
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, |
Corpo da resposta
Mensagem de resposta de vehicles.search
.
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
Um tipo de dados de lista de listas para atributos do veículo.
Representação JSON |
---|
{
"attributes": [
{
object ( |
Campos | |
---|---|
attributes[] |
Uma lista de atributos desta coleção. |
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. |
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 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, 5 viagens atuais e 10 waypoints 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 para um veículo que corresponde 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 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 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. |
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 ETA inclui 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 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 |
tripType |
Obrigatório. O tipo de viagem da solicitação que foi usada 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 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. |
vehicleMatchType |
Tipo de correspondência do veículo. |
requestedOrderedBy |
A ordem solicitada para classificar as correspondências do veículo. |
orderedBy |
O pedido real usado para este veículo. Normalmente, isso corresponde a "orderBy" da solicitação. No entanto, em determinadas circunstâncias, como um erro interno do servidor, outro método pode ser usado (como |
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 este 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 |
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. |