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 |
Wymagane. Musi mieć format |
Parametry zapytania
Parametry | |
---|---|
header |
Standardowy nagłówek żądania Fleet Engine. |
pageSize |
Maksymalna liczba pojazdów do zwrotu. Wartość domyślna: 100. |
pageToken |
Wartość pola |
minimumCapacity |
Określa wymaganą minimalną pojemność pojazdu. W przypadku wszystkich zwróconych pojazdów wartość |
tripTypes[] |
Ogranicza odpowiedź do pojazdów, które obsługują co najmniej jeden z podanych typów podróży. |
maximumStaleness |
Ogranicza odpowiedź do pojazdów, które w określonym czasie wysłały aktualizacje lokalizacji do Fleet Engine. Stacjonarne pojazdy, które nadal przesyłają swoje lokalizacje, nie są uznawane za nieaktualne. Jeśli występuje, musi mieć prawidłową wartość dodatnią. Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „ |
vehicleTypeCategories[] |
Wymagane. Ogranicza odpowiedź do pojazdów z jedną z określonych kategorii typów. |
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 jest spójnikiem/operacją ORAZ. Dozwolonych jest maksymalnie 50 wymaganych atrybutów. Ta wartość jest zgodna z maksymalną liczbą atrybutów dozwolonych w pojeździe. Każdy powtarzany ciąg znaków powinien mieć format „klucz:wartość”. |
requiredOneOfAttributes[] |
Ogranicza odpowiedź do pojazdów, które mają co najmniej 1 z określonych atrybutów w każdym |
requiredOneOfAttributeSets[] |
Podobnie jak w zasadzie
Ogranicza odpowiedź do pojazdów pasujących do wszystkich atrybutów w atrybucie |
vehicleState |
Ogranicza odpowiedź do pojazdów w tym stanie. |
onTripOnly |
Zwracaj tylko te pojazdy, które są obecnie dostępne. |
filter |
Opcjonalnie: Zapytanie filtra, które ma być stosowane przy wyświetlaniu listy pojazdów. Przykłady składni filtrów 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 (na przykład Poza tym wszystkie atrybuty są przechowywane jako ciągi znaków, więc jedynym obsługiwanym porównaniam z atrybutami są porównania ciągów znaków. Aby można było porównać wartości z wartościami liczbowymi lub logicznymi, wartości muszą być jawnie ujęte w cudzysłów, aby były traktowane jako ciągi znaków (np. |
viewport |
Opcjonalnie: Filtr ograniczający liczbę pojazdów zwracanych 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
odpowiedź.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"vehicles": [
{
object ( |
Pola | |
---|---|
vehicles[] |
Pojazdy spełniające kryteria zapytania. 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 |
Wymagane. Łączna liczba pojazdów spełniających kryteria zapytania na wszystkich stronach. |
Widoczny obszar
Widoczny obszar o długości i szerokości geograficznej reprezentowany jako dwa przeciwstawne punkty: low
i high
po przekątnej. Widoczny obszar jest uważany za obszar zamknięty, czyli obejmujący swoją granicę. Granice szerokości geograficznej muszą mieścić się w przedziale od -90 do 90 stopni włącznie, a długość geograficzna musi się mieścić w przedziale od -180 do 180 stopni włącznie. Różne przypadki:
Jeśli
low
=high
, widoczny obszar składa się z tego pojedynczego punktu.Jeśli
low.longitude
>high.longitude
, zakres długości geograficznej jest odwrócony (widoczny obszar przecina linię długości geograficznej 180 stopni).Jeśli
low.longitude
= -180 stopni, ahigh.longitude
= 180 stopni, widoczny obszar obejmuje wszystkie długości geograficzne.Jeśli
low.longitude
= 180 stopni, ahigh.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ć pola low
i high
, a reprezentowane pole nie może być puste (zgodnie z definicjami powyżej). Pusty obszar spowoduje wystąpienie błędu.
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 |
Wymagane. Najniższy punkt widocznego obszaru. |
high |
Wymagane. Najwyższy punkt widocznego obszaru. |