Method: providers.vehicles.list

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

string

To pole jest wymagane. Musi mieć format providers/{provider}. Dostawca musi być identyfikatorem projektu (np. sample-cloud-project) projektu Google Cloud, którego członkiem jest konto usługi wywołujące to wywołanie.

Parametry zapytania

Parametry
header

object (RequestHeader)

Standardowy nagłówek żądania Fleet Engine.

pageSize

integer

Maksymalna liczba pojazdów do zwrócenia. Wartość domyślna: 100.

pageToken

string

Wartość parametru nextPageToken podana przez poprzednie wywołanie metody vehicles.list umożliwia podział grup pojazdów na strony. Wartość jest nieokreślona, jeśli kryteria filtrowania w żądaniu nie są takie same jak kryteria filtrowania w poprzednim wywołaniu funkcji vehicles.list.

minimumCapacity

integer

Określa wymaganą minimalną pojemność pojazdu. Wszystkie zwrócone pojazdy będą miały parametr maximumCapacity większy lub równy tej wartości. Jeśli jest ustawiony, musi być większy lub równy 0.

tripTypes[]

enum (TripType)

Ogranicza odpowiedź do pojazdów, które obsługują co najmniej jeden z określonych typów podróży.

maximumStaleness

string (Duration format)

Ogranicza odpowiedzi do pojazdów, które wysłały aktualizacje lokalizacji do Fleet Engine w określonym czasie. Nieruchome pojazdy przesyłające swoją lokalizację nie są uznawane za nieaktualne. Jeśli ten parametr występuje, musi mieć prawidłową wartość dodatnią.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „s”. Przykład: "3.5s".

vehicleTypeCategories[]

enum (Category)

To pole jest wymagane. Ogranicza odpowiedź do pojazdów z jednej ze wskazanych kategorii. UNKNOWN – to jest niedozwolone.

requiredAttributes[]

string

Wywołujący mogą tworzyć złożone operacje logiczne, korzystając z dowolnej kombinacji pól requiredAttributes, requiredOneOfAttributes i requiredOneOfAttributeSets.

requiredAttributes to lista, requiredOneOfAttributes używa komunikatu, który może zawierać listę list. Te 2 pola łącznie umożliwiają tworzenie tego wyrażenia:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

Ogranicza odpowiedź do pojazdów o określonych atrybutach. To pole to operacja koniunkcji/ORAZ. Dozwolonych jest maksymalnie 50 atrybutów wymaganych. Ta wartość odpowiada maksymalnej liczbie atrybutów dozwolonych w pojeździe. Każdy powtórzony ciąg powinien mieć format „klucz:wartość”.

requiredOneOfAttributes[]

string

Ogranicza odpowiedź do pojazdów z co najmniej 1 z określonych atrybutów w każdym elemencie VehicleAttributeList. Na każdej liście pojazd musi pasować do co najmniej jednego z atrybutów. To pole zawiera operację rozdzielenia/LUB w każdym elemencie VehicleAttributeList oraz spójnik/ORAZ w zbiorze danych VehicleAttributeList. Każdy powtórzony ciąg powinien mieć format „klucz1:wartość1|klucz2:wartość2|klucz3:wartość3”.

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets udostępnia dodatkowe funkcje.

Podobnie jak requiredOneOfAttributes, requiredOneOfAttributeSets używa komunikatu, który zezwala na listę list, co pozwala na wyrażenia takie jak ta:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Ogranicza odpowiedź do pojazdów, które pasują do wszystkich atrybutów w VehicleAttributeList. Pojazd musi pasować do wszystkich atrybutów na każdej liście. To pole jest operacją spójności/ORAZ w każdym elemencie VehicleAttributeList i uwzględniającą łączenie/LUB w zbiorze danych VehicleAttributeList. Każdy powtórzony ciąg powinien mieć format „klucz1:wartość1|klucz2:wartość2|klucz3:wartość3”.

vehicleState

enum (VehicleState)

Ogranicza odpowiedzi do pojazdów z tym stanem pojazdu.

onTripOnly

boolean

Zwracaj tylko pojazdy, w których obecnie odbyto się podróż.

filter

string

Opcjonalnie. Zapytanie filtra, które będzie stosowane przy wyświetlaniu informacji o pojazdach. Przykłady składni filtra znajdziesz na stronie http://aip.dev/160.

To pole zastępuje pola requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets. Jeśli podasz wartość, która nie jest pusta, te pola muszą być puste: requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets.

Ten filtr działa jak klauzula ORAZ z innymi ograniczeniami, takimi jak vehicleState lub onTripOnly.

Pamiętaj, że obsługiwane są tylko zapytania dotyczące atrybutów pojazdu (np. attributes.<key> = <value> lub attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Maksymalna liczba ograniczeń dozwolona w zapytaniu filtra to 50.

Poza tym wszystkie atrybuty są przechowywane jako ciągi 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").

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

vehicles.list wiadomość z odpowiedzią.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Pola
vehicles[]

object (Vehicle)

Pojazdy spełniające kryteria w żądaniu. Maksymalna liczba zwróconych pojazdów jest określana przez pole pageSize w żądaniu.

nextPageToken

string

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

string (int64 format)

To pole jest wymagane. Łączna liczba pojazdów 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.