Zwraca podzieloną na strony listę pojazdów powiązanych z dostawcą, które pasują do opcji żądania.
Żądanie HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
To pole jest wymagane. Musi mieć format |
Parametry zapytania
Parametry | |
---|---|
header |
Standardowy nagłówek żądania Fleet Engine. |
pageSize |
Maksymalna liczba pojazdów do zwrócenia. Wartość domyślna: 100. |
pageToken |
Wartość parametru |
minimumCapacity |
Określa wymaganą minimalną pojemność pojazdu. Wszystkie zwrócone pojazdy będą miały parametr |
tripTypes[] |
Ogranicza odpowiedź do pojazdów, które obsługują co najmniej jeden z określonych typów podróży. |
maximumStaleness |
Ogranicza odpowiedzi do pojazdów, które wysłały aktualizacje lokalizacji do Fleet Engine w określonym czasie. Nieruchome pojazdy przesyłające swoją lokalizację nie są uznawane za nieaktualne. Jeśli ten parametr występuje, musi mieć prawidłową wartość dodatnią. Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „ |
vehicleTypeCategories[] |
To pole jest wymagane. Ogranicza odpowiedź do pojazdów z jednej ze wskazanych kategorii. |
requiredAttributes[] |
Wywołujący mogą tworzyć złożone operacje logiczne, korzystając z dowolnej kombinacji pól
Ogranicza odpowiedź 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. Każdy powtórzony ciąg powinien mieć format „klucz:wartość”. |
requiredOneOfAttributes[] |
Ogranicza odpowiedź do pojazdów z co najmniej 1 z określonych atrybutów w każdym elemencie |
requiredOneOfAttributeSets[] |
Podobnie jak
Ogranicza odpowiedź do pojazdów, które pasują do wszystkich atrybutów w |
vehicleState |
Ogranicza odpowiedzi do pojazdów z tym stanem pojazdu. |
onTripOnly |
Zwracaj tylko pojazdy, w których obecnie odbyto się podróż. |
filter |
Opcjonalnie. Zapytanie filtra, które będzie stosowane przy wyświetlaniu informacji o pojazdach. 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. |
viewport |
Opcjonalnie. Filtr, który ogranicza zwracane pojazdy do tych, których ostatnia znana lokalizacja znajdowała się w prostokątnym obszarze zdefiniowanym w widocznym obszarze. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
vehicles.list
wiadomość z odpowiedzią.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"vehicles": [
{
object ( |
Pola | |
---|---|
vehicles[] |
Pojazdy spełniające kryteria w żądaniu. Maksymalna liczba zwróconych pojazdów jest określana przez pole |
nextPageToken |
Token umożliwiający pobranie następnej strony pojazdów lub pusty, jeśli nie ma więcej pojazdów spełniających kryteria żądania. |
totalSize |
To pole jest wymagane. Łączna liczba pojazdów spełniających kryteria żądania na wszystkich stronach. |
Widoczny obszar
Widok obejmujący szerokość i długość geograficzną (2 punkty po przekątnej low
i high
). Widoczny obszar jest uważany za obszar zamknięty, czyli obejmujący swoje granice. Granice szerokości geograficznej muszą się mieścić w przedziale od -90 do 90 stopni włącznie, a długość geograficzna – z zakresu od -180 do 180 stopni włącznie. Oto niektóre z nich:
Jeśli
low
=high
, widoczny obszar składa się z tego pojedynczego punktu.Jeśli
low.longitude
>high.longitude
, zakres długości geograficznej zostaje odwrócony (widoczny obszar przekracza linię długości 180 stopni).Jeśli
low.longitude
= -180 stopni ihigh.longitude
= 180 stopni, widoczny obszar uwzględnia wszystkie długości.Jeśli
low.longitude
= 180 stopni,high.longitude
= -180 stopni, zakres długości geograficznej jest pusty.Jeśli
low.latitude
>high.latitude
, zakres szerokości geograficznej jest pusty.
Musisz wypełnić zarówno pole low
, jak i high
, a reprezentowane pole nie może być puste (zgodnie z definicjami powyżej). Pusty widoczny obszar spowoduje błąd.
Na przykład ten widoczny obszar w całości obejmuje Nowy Jork:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
Zapis JSON |
---|
{ "low": { object ( |
Pola | |
---|---|
low |
To pole jest wymagane. Najniższy punkt widocznego obszaru. |
high |
To pole jest wymagane. Najwyższy punkt widocznego obszaru. |