Method: providers.deliveryVehicles.list

Pobiera wszystkie 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}. Wartość provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

Parametry zapytania

Parametry
header

object (DeliveryRequestHeader)

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;
pageSize

integer

Opcjonalnie: Maksymalna liczba pojazdów do zwrotu. Usługa może zwrócić mniej niż tę liczbę. 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 podziału na strony wszystkie inne parametry przekazane do funkcji deliveryVehicles.list muszą być zgodne z wywołaniem, które dostarczyło token strony.
filter

string

Opcjonalnie: Zapytanie filtra stosowane podczas wyświetlania pojazdów dostawczych. 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 jako filtr, zwrócone zostaną wszystkie środki przekazu.

Pamiętaj, że jedyne zapytania obsługiwane w przypadku atrybutu deliveryVehicles.list to te dotyczące atrybutów pojazdu (na przykład attributes.<key> = <value> lub attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Ponadto wszystkie atrybuty są przechowywane jako ciągi znaków, więc jedyne obsługiwane porównania atrybutów to porównania ciągów znaków. Aby można było porównywać je z wartościami liczbowymi lub logicznymi, muszą być one wyraźnie umieszczone w cudzysłowie (np. attributes.<key> = "10" lub attributes.<key> = "true").

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

object (Viewport)

Opcjonalnie: Filtr, który ogranicza zwracane pojazdy do tych, których ostatnia znana lokalizacja znajdowała się w prostokątnym obszarze zdefiniowanym przez widoczny obszar.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

wiadomość deliveryVehicles.list z odpowiedzią,

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 środków dostawy, które spełniają określone kryteria filtrowania. Jeśli nie zostanie określony żaden filtr, żądanie zwróci wszystkie środki dostawy. Pomyślna odpowiedź może być pusta. Pusty tekst oznacza, że nie znaleziono żadnych pojazdów dostawczych spełniających żądane kryteria filtra.
nextPageToken

string

Aby przejść do wyświetlania wyników, możesz przekazać ten token w ListDeliveryVehiclesRequest. Gdy zwracane są wszystkie wyniki, to pole nie występuje w odpowiedzi lub jest puste.
totalSize

string (int64 format)

Łączna liczba nośników, które spełniają kryteria żądania, na wszystkich stronach.

Widoczny obszar

Strefa widoczna współrzędnych szerokości i długości geograficznej, reprezentowana przez 2 punkty low i high, leżące na przekątnej w przeciwnych kierunkach. Widok jest uważany za zamknięty obszar, czyli obejmuje swoją granicę. Granice szerokości geograficznej muszą mieścić się w zakresie od -90 do 90 stopni, a granice długości geograficznej – od -180 do 180 stopni. Przykładowe etui:

  • 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°).

  • 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.

Wartości low i high muszą być wypełnione, a pole reprezentowane przez te wartości nie może być puste (zgodnie z definicjami podanymi 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 w obszarze widoku.