Method: providers.deliveryVehicles.list

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

string

Wymagane. Musi mieć format providers/{provider}. provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

Parametry zapytania

Parametry
header

object (DeliveryRequestHeader)

Opcjonalnie: Standardowy nagłówek żądania do interfejsu Delivery API.
pageSize

integer

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

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji deliveryVehicles.list. Musisz go podać, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu deliveryVehicles.list muszą być zgodne z wywołaniem, które dostarczyło token strony.
filter

string

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 deliveryVehicles.list obsługiwane są tylko zapytania dotyczące atrybutów pojazdu (np. attributes.<key> = <value> lub attributes.<key1> = <value1> AND attributes.<key2> = <value2>). 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. attributes.<key> = "10" lub attributes.<key> = "true").

Maksymalna dozwolona liczba ograniczeń w zapytaniu filtra to 50. Ograniczenie jest częścią zapytania w formularzu attribute.<KEY> <COMPARATOR> <VALUE>, np. attributes.foo = bar to 1 ograniczenie.
viewport

object (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 (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Pola
deliveryVehicles[]

object (DeliveryVehicle)

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

string

Aby przejść do wyświetlania wyników, możesz przekazać ten token w ListDeliveryVehiclesRequest. Gdy zostaną zwrócone wszystkie wyniki, to pole nie będzie zawarte w odpowiedzi lub będzie pustym ciągiem znaków.
totalSize

string (int64 format)

Łą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ą się mieścić w zakresie 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, a high.longitude = 180 stopni, widoczny obszar obejmuje wszystkie długości geograficzne.

  • Jeśli low.longitude = 180 stopni, a 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ć 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Pola
low

object (LatLng)

Wymagane. Najniższy punkt widocznego obszaru.
high

object (LatLng)

Wymagane. Najwyższy punkt widocznego obszaru.