Method: providers.vehicles.search

Zwraca listę pojazdów zgodnych z opcjami żądania.

Żądanie HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagany. Musi mieć format providers/{provider}. Dostawca musi być identyfikatorem projektu (np. sample-cloud-project) projektu Google Cloud, do którego należy konto usługi wywołujące to połączenie.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
Pola
header

object (RequestHeader)

Standardowy nagłówek żądania Fleet Engine.

pickupPoint

object (TerminalLocation)

Wymagany. Punkt odbioru w pobliżu miejsca wyszukiwania.

dropoffPoint

object (TerminalLocation)

Zamierzona lokalizacja dostawy klienta. To pole jest wymagane, jeśli tripTypes zawiera TripType.SHARED.

pickupRadiusMeters

integer

Wymagany. Określa promień wyszukiwania pojazdu w pobliżu punktu odbioru. Zwracane będą tylko pojazdy znajdujące się w promieniu wyszukiwania. Wartość musi znajdować się w zakresie od 400 do 10 000 metrów (włącznie).

count

integer

Wymagany. Określa maksymalną liczbę pojazdów, które mają zostać zwrócone. Wartość musi znajdować się w zakresie od 1 do 50 (włącznie).

minimumCapacity

integer

Wymagany. Określa liczbę pasażerów rozważających podróż. Wartość nie może być mniejsza niż 1. Operator nie jest brany pod uwagę jako wartość pojemności.

tripTypes[]

enum (TripType)

Wymagany. Wskazuje typ proponowanej podróży. Obsługiwane pojazdy to takie, które obsługują co najmniej jeden z typów podróży.

Wartości EXCLUSIVE i SHARED mogą nie być uwzględnione razem. Pole SHARED nie jest obsługiwane, gdy currentTripsPresent ma wartość CURRENT_TRIPS_PRESENT_UNSPECIFIED. UNKNOWN_TRIP_TYPE jest niedozwolone.

maximumStaleness

string (Duration format)

Ogranicza wyszukiwanie tylko do tych pojazdów, które w określonym czasie wysłały informacje o lokalizacji do Fleet Engine. Stacjonarne pojazdy przesyłające dalej lokalizacje nie są uważane za nieaktualne. Jeśli to pole nie zostanie ustawione, wartość domyślna to 5 minut.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, który kończy się na „s”. Przykład: "3.5s".

vehicleTypes[]

object (VehicleType)

Wymagany. Ogranicza wyszukiwanie do pojazdów z jednym z określonych typów. Musisz określić co najmniej 1 typ pojazdu. Typy pojazdów z kategorii UNKNOWN są niedozwolone.

requiredAttributes[]

object (VehicleAttribute)

Wywołanie może tworzyć złożone operacje logiczne za pomocą dowolnej kombinacji pól requiredAttributes, requiredOneOfAttributes i requiredOneOfAttributeSets.

requiredAttributes to lista. requiredOneOfAttributes używa wiadomości, która umożliwia utworzenie listy. Te 2 pola umożliwiają utworzenie 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 wyszukiwanie tylko do tych pojazdów, które mają określone atrybuty. To pole jest spójnikiem ORAZ. Maksymalna dozwolona liczba atrybutów to 50. Jest to maksymalna dozwolona liczba atrybutów pojazdu.

requiredOneOfAttributes[]

object (VehicleAttributeList)

Ogranicza wyszukiwanie tylko do tych pojazdów, które mają co najmniej 1 z określonych atrybutów w każdym elemencie VehicleAttributeList. W przypadku każdej listy pojazd musi pasować do co najmniej jednego z atrybutów. To pole jest łączeniem operacji LUB LUB w każdej VehicleAttributeList i spójnikiem ORAZ ORAZ w ramach kolekcji VehicleAttributeList.

requiredOneOfAttributeSets[]

object (VehicleAttributeList)

requiredOneOfAttributeSets oferuje dodatkowe funkcje.

Podobnie jak requiredOneOfAttributes, requiredOneOfAttributeSets używa wiadomości, która umożliwia utworzenie listy umożliwiającej korzystanie z wyrażeń takich 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 wyszukiwanie tylko do tych pojazdów, które mają wszystkie atrybuty w elemencie VehicleAttributeList. W przypadku każdej listy pojazd musi pasować do wszystkich atrybutów. To pole jest operacją spójną/ORAZ w każdej funkcji VehicleAttributeList i łączeniem operacji LUB LUB w ramach kolekcji VehicleAttributeList.

orderBy

enum (VehicleMatchOrder)

Wymagany. Określa odpowiednie kryterium sortowania wyników.

includeBackToBack

boolean

Wskazuje, czy pojazd z jedną aktywną podróżą kwalifikuje się do innego dopasowania. Jeśli wybierzesz opcję false, pojazdy z przypisanymi podróżami zostaną wykluczone z wyników wyszukiwania. Jeśli true, w wynikach wyszukiwania pojawiają się pojazdy z TripStatus z ENROUTE_TO_DROPOFF.

To pole jest uwzględniane tylko wtedy, gdy określono tylko tripType z EXCLUSIVE.

Wartością domyślną jest false.

tripId

string

Wskazuje podróż powiązaną z tym elementem (SearchVehicleRequest).

currentTripsPresent

enum (CurrentTripsPresent)

Ogranicza wyświetlanie pojazdów w wynikach wyszukiwania na podstawie ich aktualnych podróży.

Gdy wartość obecnaTripspresent to NONE lub ANY, tripTypes może mieć wartość EXCLUSIVE lub SHARED, ale nie oba jednocześnie.

filter

string

Opcjonalnie. Zapytanie filtra, które ma być stosowane podczas wyszukiwania pojazdów. Przykłady składni filtra znajdziesz na http://aip.dev/160.

To pole zostało zaprojektowane w celu zastąpienia pól requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets. Jeśli podana tu wartość nie jest pusta, te pola muszą być puste: requiredAttributes, requiredOneOfAttributes i required_one_of_attributes_sets.

Ten filtr działa jako klauzula AND z innymi ograniczeniami, takimi jak minimumCapacity czy vehicleTypes.

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ń w zapytaniu filtra wynosi 50.

Wszystkie atrybuty są przechowywane jako ciągi znaków, więc jedynymi obsługiwanymi porównaniami atrybutów są porównania ciągów znaków. Aby porównać wartości liczbowe lub logiczne, musisz je jednoznacznie cytować, aby były traktowane jako ciągi znaków (np. attributes.<key> = "10" lub attributes.<key> = "true").

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SearchVehiclesResponse.