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

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 zwrotu. Wartość domyślna: 100.

pageToken

string

Wartość pola nextPageToken podana w poprzednim wywołaniu funkcji vehicles.list, która umożliwia podział na strony w grupach pojazdów. Wartość jest nieokreślona, jeśli kryteria filtrowania w żądaniu nie są takie same jak kryteria filtrowania poprzedniego wywołania funkcji vehicles.list.

minimumCapacity

integer

Określa wymaganą minimalną pojemność pojazdu. W przypadku wszystkich zwróconych pojazdów wartość maximumCapacity będzie większa lub równa tej wartości. Jeśli jest ustawiona, musi być równa 0 lub większa.

tripTypes[]

enum (TripType)

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

maximumStaleness

string (Duration format)

Ogranicza odpowiedź do pojazdów, które w określonym czasie wysłały aktualizacje lokalizacji do Fleet Engine. Stacjonarne pojazdy, które nadal przesyłają swoje lokalizacje, nie są uznawane za nieaktualne. Jeśli występuje, musi mieć prawidłową wartość dodatnią.

Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku i kończący się „s”. Przykład: "3.5s".

vehicleTypeCategories[]

enum (Category)

Wymagane. Ogranicza odpowiedź do pojazdów z jedną z określonych kategorii typów. 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 jest listą; requiredOneOfAttributes używa wiadomości, która zezwala na listę list. Te 2 pola umożliwiają kompozycję 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 jest spójnikiem/operacją ORAZ. Dozwolonych jest maksymalnie 50 wymaganych atrybutów. Ta wartość jest zgodna z maksymalną liczbą atrybutów dozwolonych w pojeździe. Każdy powtarzany ciąg znaków powinien mieć format „klucz:wartość”.

requiredOneOfAttributes[]

string

Ogranicza odpowiedź do pojazdów, które mają co najmniej 1 z określonych atrybutów w każdym elemencie VehicleAttributeList. Pojazd musi pasować do co najmniej jednego atrybutu na każdej liście. To pole zawiera operator rozdzielający/LUB w każdym elemencie VehicleAttributeList oraz operacja spójności/ORAZ w zbiorze funkcji 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 w zasadzie requiredOneOfAttributes, requiredOneOfAttributeSets używa komunikatu, który umożliwia listę list, umożliwiając użycie takich wyrażeń:

(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 spełniają wszystkie atrybuty określone w atrybucie VehicleAttributeList. Pojazd musi spełniać warunki wszystkich atrybutów na każdej liście. To pole stanowi operację spójności/I w każdym elemencie VehicleAttributeList oraz operacji obejmującej funkcję rozdzielenia/LUB w zbiorze VehicleAttributeList. Każdy powtórzony ciąg powinien mieć format „klucz1:wartość1|klucz2:wartość2|klucz3:wartość3”.

vehicleState

enum (VehicleState)

Ogranicza odpowiedź do pojazdów w tym stanie.

onTripOnly

boolean

Zwracaj tylko te pojazdy, które są obecnie dostępne.

filter

string

Opcjonalnie: Zapytanie filtra, które ma być stosowane przy wyświetlaniu listy pojazdów. Przykłady składni filtrów znajdziesz na stronie http://aip.dev/160.

To pole zastępuje pola requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets. Jeśli podasz tu 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 (na przykład attributes.<key> = <value> lub attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Maksymalna dozwolona liczba ograniczeń w zapytaniu filtra to 50.

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").

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

vehicles.list odpowiedź.

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 zapytania. 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)

Wymagane. Łączna liczba pojazdów 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.