Method: providers.deliveryVehicles.list

Pobiera wszystkie encje DeliveryVehicle spełniające 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

To pole jest wymagane. Musi mieć format providers/{provider}. Element 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 zwrócenia. Usługa może zwrócić mniej niż ten numer. Jeśli nie określisz tej liczby, serwer określa liczbę wyników do zwrócenia.
pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania deliveryVehicles.list. Musisz go podać w celu pobrania kolejnej strony.

Podczas podziału na strony wszystkie pozostałe parametry przekazywane w metodzie deliveryVehicles.list muszą odpowiadać wywołaniu, które przekazało token strony.
filter

string

Opcjonalnie. Zapytanie filtra, które będzie stosowane podczas wyświetlania informacji o pojazdach dostawczych. Przykłady składni filtra znajdziesz na stronie http://aip.dev/160. Jeśli nie określisz wartości lub określisz pusty ciąg w filtrze, zwrócone zostaną wszystkie pojazdy dostawcze.

Pamiętaj, że w przypadku atrybutu deliveryVehicles.list obsługiwane są tylko zapytania dotyczące atrybutów pojazdu (np. attributes.<key> = <value> lub attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Wszystkie atrybuty są przechowywane w postaci ciągów 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. attributes.<key> = "10" lub attributes.<key> = "true").

Maksymalna dozwolona liczba ograniczeń w zapytaniu filtra to 50. Ograniczenie jest częścią zapytania w formie 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 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ą określone kryteria filtrowania. Jeśli nie określisz filtra, żądanie zwróci wszystkie pojazdy dostawcze. Pomyślna odpowiedź też może być pusta. Pusta odpowiedź oznacza, że nie znaleziono żadnych pojazdów dostawczych spełniających podane kryteria filtra.
nextPageToken

string

Możesz przekazać ten token w ListDeliveryVehiclesRequest, aby kontynuować wyświetlanie wyników. Po zwróceniu wszystkich wyników to pole nie pojawi się w odpowiedzi lub będzie pustym ciągiem znaków.
totalSize

string (int64 format)

Łączna liczba pojazdów dostawczych 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 i high.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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Pola
low

object (LatLng)

To pole jest wymagane. Najniższy punkt widocznego obszaru.
high

object (LatLng)

To pole jest wymagane. Najwyższy punkt widocznego obszaru.