Pobiera wszystkie elementy typu DeliveryVehicle
, które spełniają określone kryteria filtrowania.
Żądanie HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
Wymagane. Musi mieć format |
Parametry zapytania
Parametry | |
---|---|
header |
Opcjonalnie: Standardowy nagłówek żądania do interfejsu Delivery API. |
pageSize |
Opcjonalnie: Maksymalna liczba pojazdów do zwrotu. Usługa może zwrócić mniej niż ta liczba. Jeśli liczba ta nie zostanie określona, serwer określi liczbę wyników do zwrócenia. |
pageToken |
Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu |
filter |
Opcjonalnie: Zapytanie filtra, które ma być stosowane przy wyświetlaniu listy pojazdów dostawy. Przykłady składni filtrów znajdziesz na stronie http://aip.dev/160. Jeśli nie określisz wartości lub podasz pusty ciąg znaków, zwracane będą wszystkie pojazdy dostawcze. Pamiętaj, że w przypadku Maksymalna dozwolona liczba ograniczeń w zapytaniu filtra to 50. Ograniczenie jest częścią zapytania w formularzu |
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
Komunikat z odpowiedzią deliveryVehicles.list
.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"deliveryVehicles": [
{
object ( |
Pola | |
---|---|
deliveryVehicles[] |
Zestaw pojazdów dostawczych, które spełniają żądane kryteria filtrowania. Jeśli nie określisz filtra, żądanie zwróci wszystkie pojazdy dostawcze. Pomyślna odpowiedź może być pusta. Pusta odpowiedź oznacza, że nie znaleziono żadnych pojazdów dostawczych spełniających żądane kryteria filtrowania. |
nextPageToken |
Aby przejść do wyświetlania wyników, możesz przekazać ten token w |
totalSize |
Łączna liczba pojazdów dostawy spełniających kryteria żądania 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. |