Zwraca listę pojazdów pasujących do opcji w żądaniu.
Żądanie HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
To pole jest wymagane. Musi mieć format |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "header": { object ( |
Pola | |
---|---|
header |
Standardowy nagłówek żądania Fleet Engine. |
pickupPoint |
To pole jest wymagane. Miejsce odbioru, które chcesz wyszukać. |
dropoffPoint |
Planowane miejsce docelowe klienta. Pole jest wymagane, jeśli |
pickupRadiusMeters |
To pole jest wymagane. Określa promień wyszukiwania pojazdów wokół punktu odbioru. Zwrócone zostaną tylko pojazdy znajdujące się w promieniu wyszukiwania. Wartość musi mieścić się w przedziale od 400 do 10 000 metrów (włącznie). |
count |
To pole jest wymagane. Określa maksymalną liczbę pojazdów do zwrócenia. Wartość musi mieścić się w zakresie od 1 do 50 (włącznie). |
minimumCapacity |
To pole jest wymagane. Określa liczbę pasażerów uwzględnianych podczas podróży. Wartość nie może być mniejsza niż 1. Kierowca nie jest uwzględniany w wartości pojemności. |
tripTypes[] |
To pole jest wymagane. Reprezentuje typ proponowanej podróży. Musi zawierać dokładnie 1 typ. |
maximumStaleness |
Ogranicza wyszukiwanie tylko do tych pojazdów, które w określonym czasie wysłały aktualizacje lokalizacji do Fleet Engine. Nieruchome pojazdy przesyłające swoją lokalizację nie są uznawane za nieaktualne. Jeśli to pole nie jest skonfigurowane, serwer użyje wartości domyślnej 5 minut. Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „ |
vehicleTypes[] |
To pole jest wymagane. Ogranicza wyszukiwanie do pojazdów jednego z określonych typów. Musisz określić co najmniej jeden typ pojazdu. Pojazdy typu VehicleType z kategorii |
requiredAttributes[] |
Wywołujący mogą tworzyć złożone operacje logiczne, korzystając z dowolnej kombinacji pól
Ogranicza wyszukiwanie tylko do pojazdów o określonych atrybutach. To pole to operacja koniunkcji/ORAZ. Dozwolonych jest maksymalnie 50 atrybutów wymaganych. Ta wartość odpowiada maksymalnej liczbie atrybutów dozwolonych w pojeździe. |
requiredOneOfAttributes[] |
Ogranicza wyszukiwanie tylko do pojazdów, w których każdy element |
requiredOneOfAttributeSets[] |
Podobnie jak
Ogranicza wyszukiwanie tylko do pojazdów ze wszystkimi atrybutami |
orderBy |
To pole jest wymagane. Określa żądane kryterium kolejności wyników. |
includeBackToBack |
Określa, czy pojazdy z jedną aktywną podróżą kwalifikują się do tego wyszukiwania. To pole jest używane tylko wtedy, gdy pole Wartością domyślną jest |
tripId |
Wskazuje podróż związaną z: |
currentTripsPresent |
Określa, czy pojazdy z aktywnymi podróżami kwalifikują się do tego wyszukiwania. Jeśli pole |
filter |
Opcjonalnie. Zapytanie filtra do zastosowania podczas wyszukiwania pojazdów. Przykłady składni filtra znajdziesz na stronie http://aip.dev/160. To pole zastępuje pola Ten filtr działa jak klauzula ORAZ z innymi ograniczeniami, takimi jak Pamiętaj, że obsługiwane są tylko zapytania dotyczące atrybutów pojazdu (np. Poza tym wszystkie atrybuty są przechowywane jako ciągi znaków, więc jedynymi obsługiwanymi porównaniami z atrybutami są porównania ciągów znaków. Aby można było porównać wartości z liczbami lub wartościami logicznymi, muszą one być umieszczone w cudzysłowie i traktowane jako ciągi znaków (np. |
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SearchVehiclesResponse
.