- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Punkt pośredni
- VehicleMatchType
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 |
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 |
Wymagane. Położony w pobliżu punkt odbioru, który chcesz wyszukać. |
dropoffPoint |
Zamierzone miejsce docelowe zwrotu klienta. Pole jest wymagane, jeśli |
pickupRadiusMeters |
Wymagane. Określa promień wyszukiwania pojazdu wokół punktu odbioru. Zwrócone zostaną tylko pojazdy znajdujące się w określonym promieniu wyszukiwania. Wartość musi mieścić się w przedziale od 400 do 10 000 metrów (włącznie). |
count |
Wymagane. Określa maksymalną liczbę pojazdów do zwrócenia. Wartość musi mieścić się w przedziale od 1 do 50 (włącznie). |
minimumCapacity |
Wymagane. Określa liczbę pasażerów uwzględnianych podczas podróży. Wartość nie może być mniejsza niż 1. W zakresie pojemności nie brany jest pod uwagę kierowca. |
tripTypes[] |
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 do Fleet Engine aktualizacje lokalizacji. Nieruchome pojazdy przesyłające swoją lokalizację nie są uznawane za nieaktualne. Jeśli to pole nie jest skonfigurowane, serwer używa wartości domyślnej 5 minut. Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „ |
vehicleTypes[] |
Wymagane. Ogranicza wyszukiwanie do pojazdów jednego z określonych typów. Musisz określić co najmniej jeden typ pojazdu. Typy pojazdów 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 jest łączeniem/ORAZ. Dozwolonych jest maksymalnie 50 atrybutów wymaganych. Ta wartość jest zgodna z maksymalną liczbą atrybutów dozwolonych w pojeździe. |
requiredOneOfAttributes[] |
Ogranicza wyszukiwanie tylko do tych pojazdów, które mają co najmniej jeden z określonych atrybutów w każdym atrybucie |
requiredOneOfAttributeSets[] |
Podobnie jak
Ogranicza wyszukiwanie tylko do tych pojazdów ze wszystkimi atrybutami marki |
orderBy |
Wymagane. Określa żądane kryterium kolejności wyników. |
includeBackToBack |
Ta wartość określa, czy pojazdy z 1 aktywną podróżą kwalifikują się do tego wyszukiwania. To pole jest używane tylko wtedy, gdy pole Wartością domyślną jest |
tripId |
Wskazuje podróż powiązaną z obiektem |
currentTripsPresent |
Ta wartość określa, czy pojazdy z aktywnymi podróżami kwalifikują się do tego wyszukiwania. Jeśli zasada |
filter |
Opcjonalnie. Zapytanie filtra, które ma być stosowane przy wyszukiwaniu pojazdów. Przykłady składni filtra znajdziesz na 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 w postaci ciągów znaków. Aby można było porównać wartości z liczbami lub wartościami logicznymi, muszą one być ujęte w cudzysłów, aby były traktowane jako ciągi znaków (np. |
Treść odpowiedzi
vehicles.search
odpowiedź.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"matches": [
{
object ( |
Pola | |
---|---|
matches[] |
Lista pojazdów, które spełniają kryteria |
VehicleAttributeList
Typ danych „lista list” dla atrybutów pojazdu.
Zapis JSON |
---|
{
"attributes": [
{
object ( |
Pola | |
---|---|
attributes[] |
Lista atrybutów w tej kolekcji. |
VehicleMatchOrder
Określa kolejność pojazdów w odpowiedzi.
Wartości w polu enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Domyślnie używana w przypadku nieokreślonego lub nierozpoznanego dopasowania pojazdu do zamówienia. |
PICKUP_POINT_ETA |
Rosnąco według czasu jazdy pojazdu do punktu odbioru. |
PICKUP_POINT_DISTANCE |
Rosnąco według odległości jazdy pojazdem do punktu odbioru. |
DROPOFF_POINT_ETA |
Rosnąco według czasu jazdy pojazdem do miejsca docelowego. Tego zamówienia można użyć tylko wtedy, gdy w prośbie podano punkt zwrotu. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Rosnąco według odległości w linii prostej od ostatniej zarejestrowanej lokalizacji pojazdu do punktu odbioru. |
COST |
W kolejności rosnącej według skonfigurowanego kosztu dopasowania. Koszt dopasowania jest obliczony jako obliczenie ważone między odległością w linii prostej a szacowanym czasem dotarcia na miejsce. Wagi są ustalane z wartościami domyślnymi i można je modyfikować w zależności od klienta. Jeśli chcesz zmienić te wagi w projekcie, skontaktuj się z zespołem pomocy Google. |
CurrentTripsPresent
Określa rodzaje ograniczeń obowiązujących w bieżącej trasie pojazdu.
Wartości w polu enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
Dostępność pojazdów, w których dostępne są podróże, jest określana w polu includeBackToBack . |
NONE |
Pojazdy bez podróży mogą się wyświetlać w wynikach wyszukiwania. Gdy jest używana ta wartość, includeBackToBack nie może mieć wartości true . |
ANY |
W wynikach wyszukiwania uwzględniane są pojazdy z maksymalnie 5 aktualnymi trasami i 10 punktami pośrednimi. Gdy jest używana ta wartość, includeBackToBack nie może mieć wartości true . |
VehicleMatch
Zawiera dane dotyczące pojazdu i powiązane z nim dane szacunkowe pasujące do punktów aktywnych przejazdów pojazdem SearchVehiclesRequest
.
Zapis JSON |
---|
{ "vehicle": { object ( |
Pola | |
---|---|
vehicle |
Wymagane. Pojazd pasujący do żądania. |
vehiclePickupEta |
Szacowany czas dotarcia pojazdu do miejsca odbioru wskazanego w żądaniu. Pusta wartość oznacza błąd w obliczaniu szacowanego czasu dotarcia na miejsce. Jeśli Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
vehiclePickupDistanceMeters |
Odległość od bieżącej lokalizacji pojazdu do punktu odbioru określonego w żądaniu, z uwzględnieniem wszystkich pośrednich punktów odbioru lub miejsca zwrotu w przypadku dotychczasowych podróży. Ta odległość obejmuje obliczoną odległość (trasę) oraz odległość w linii prostej między punktem końcowym nawigacji a żądanym punktem odbioru. (Odległość między punktem końcowym nawigacji a żądanym punktem odbioru jest zwykle mała). Pusta wartość oznacza błąd przy obliczaniu odległości. |
vehiclePickupStraightLineDistanceMeters |
Wymagane. W linii prostej między pojazdem a punktem odbioru określonym w żądaniu. |
vehicleDropoffEta |
Pełny szacowany czas dotarcia na miejsce w ramach przejazdu pojazdu do miejsca zwrotu określonego w żądaniu. Szacowany czas dotarcia na miejsce obejmuje postój na każdym punkcie na trasie przed obiektem Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
vehiclePickupToDropoffDistanceMeters |
Odległość pojazdu (w metrach) od punktu odbioru do miejsca docelowego podanego w żądaniu. Odległość jest wyrażona wyłącznie między tymi dwoma punktami i nie obejmuje lokalizacji pojazdu ani żadnych innych punktów, które trzeba odwiedzić, zanim pojazd odwiedzi punkt odbioru lub punkt zwrotu. Ta wartość zostanie wypełniona tylko wtedy, gdy w żądaniu określisz |
tripType |
Wymagane. Typ podróży dla żądania, które zostało użyte do obliczenia szacowanego czasu dotarcia do punktu odbioru. |
vehicleTripsWaypoints[] |
Uporządkowana lista punktów na trasie używanych do obliczania szacowanego czasu dotarcia na miejsce. Lista obejmuje lokalizację pojazdu, punkty odbioru aktywnych podróży oraz punkty odbioru podane w prośbie. Pusta lista oznacza, że nie udało się obliczyć szacowanego czasu dotarcia na miejsce. |
vehicleMatchType |
Typ dopasowania pojazdu. |
requestedOrderedBy |
Żądana kolejność sortowania pojazdów. |
orderedBy |
Rzeczywiste zamówienie użyte w przypadku tego pojazdu. Zwykle jest ona zgodna z polem „orderBy” w żądaniu, ale w pewnych okolicznościach, takich jak wewnętrzny błąd serwera, można użyć innej metody (np. |
Punkt pośredni
Opisuje punkty pośrednie na trasie w obrębie rzeki VehicleMatch
w regionie SearchVehiclesResponse
. Ten element jest przedstawiany jako TripWaypoint
we wszystkich pozostałych punktach końcowych.
Zapis JSON |
---|
{
"latLng": {
object ( |
Pola | |
---|---|
latLng |
Lokalizacja tego punktu na trasie. |
eta |
Szacowany czas dotarcia pojazdu do tego punktu pośredniego. Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
VehicleMatchType
Typ dopasowania pojazdu.
Wartości w polu enum | |
---|---|
UNKNOWN |
Nieznany typ dopasowania pojazdu |
EXCLUSIVE |
Pojazd nie ma obecnie przypisanej podróży i może udać się do punktu odbioru. |
BACK_TO_BACK |
Pojazd jest obecnie przypisany do podróży, ale może przejść do punktu odbioru po zakończeniu trwającej podróży. Przy obliczaniu czasu dotarcia i dystansu uwzględnia się istniejącą trasę. |
CARPOOL |
Pojazd ma wystarczającą pojemność na wspólne przejazdy. |
CARPOOL_BACK_TO_BACK |
Pojazd zakończy swoją bieżącą, aktywną podróż, zanim dotrzesz do punktu odbioru. Przy obliczaniu czasu dotarcia i dystansu uwzględnia się istniejącą trasę. |