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 zwrócenia. Wartość domyślna: 100.
pageToken

string

Wartość nextPageToken z poprzedniego wywołania funkcji vehicles.list, która umożliwia przewijanie grup 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 minimalną wymaganą pojemność pojazdu. Wszystkie zwrócone pojazdy będą miały wartość maximumCapacity większą lub równą tej wartości. Jeśli jest ustawiona, musi być większa od lub równa 0.
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 wysłały do Fleet Engine aktualizacje lokalizacji w określonym czasie. 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 dziewięciu cyfr po przecinku i kończący się „s”. Przykład: "3.5s".
vehicleTypeCategories[]

enum (Category)

Wymagane. Ogranicza odpowiedź do pojazdów należących do jednej z podanych kategorii typu. 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 wiadomości, która umożliwia utworzenie listy list. Połączenie tych 2 pol pozwala stworzyć to wyrażenie:

(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 VehicleAttributeList. Pojazd musi pasować do co najmniej jednego atrybutu na każdej liście. To pole zawiera rozdzielność/operator LUB w każdym elemencie VehicleAttributeList oraz operację 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 zapewnia dodatkowe funkcje.

Podobnie jak w przypadku requiredOneOfAttributes, requiredOneOfAttributeSets używa wiadomości, która umożliwia utworzenie listy list, co pozwala na wyrażenia takie jak to:

(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 znaków 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 filtra znajdziesz na stronie http://aip.dev/160.

To pole zastępuje pola requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets. Jeśli tutaj zostanie podana niepusta wartość, pola requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets muszą być puste.

Ten filtr działa jak klauzula I w połączeniu 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 liczba ograniczeń dozwolonych 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ó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").
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

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 zapytania. Maksymalna liczba zwracanych 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. 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.

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 widok zawiera w pełni 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.