Method: providers.vehicles.search

Zwraca listę pojazdów pasujących do opcji w żądaniu.

Żą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

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.

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)

To pole jest wymagane. Miejsce odbioru, które chcesz wyszukać.

dropoffPoint

object (TerminalLocation)

Planowane miejsce docelowe klienta. Pole jest wymagane, jeśli tripTypes zawiera TripType.SHARED.

pickupRadiusMeters

integer

To pole jest wymagane. Określa promień wyszukiwania pojazdów wokół punktu odbioru. Zwrócone zostaną tylko pojazdy znajdujące się w promieniu wyszukiwania. Wartość musi mieścić się w przedziale od 400 do 10 000 metrów (włącznie).

count

integer

To pole jest wymagane. Określa maksymalną liczbę pojazdów do zwrócenia. Wartość musi mieścić się w zakresie od 1 do 50 (włącznie).

minimumCapacity

integer

To pole jest wymagane. Określa liczbę pasażerów uwzględnianych podczas podróży. Wartość nie może być mniejsza niż 1. Kierowca nie jest uwzględniany w wartości pojemności.

tripTypes[]

enum (TripType)

To pole jest wymagane. Reprezentuje typ proponowanej podróży. Musi zawierać dokładnie 1 typ. UNKNOWN_TRIP_TYPE – to jest niedozwolone. Ogranicza wyszukiwanie tylko do tych pojazdów, które obsługują dany typ podróży.

maximumStaleness

string (Duration format)

Ogranicza wyszukiwanie tylko do tych pojazdów, które w określonym czasie wysłały aktualizacje lokalizacji do Fleet Engine. Nieruchome pojazdy przesyłające swoją lokalizację nie są uznawane za nieaktualne. Jeśli to pole nie jest skonfigurowane, serwer użyje wartości domyślnej 5 minut.

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

vehicleTypes[]

object (VehicleType)

To pole jest wymagane. Ogranicza wyszukiwanie do pojazdów jednego z określonych typów. Musisz określić co najmniej jeden typ pojazdu. Pojazdy typu VehicleType z kategorii UNKNOWN są niedozwolone.

requiredAttributes[]

object (VehicleAttribute)

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 wyszukiwanie tylko 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.

requiredOneOfAttributes[]

object (VehicleAttributeList)

Ogranicza wyszukiwanie tylko do pojazdów, w których każdy element VehicleAttributeList ma co najmniej jeden z określonych atrybutów. 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.

requiredOneOfAttributeSets[]

object (VehicleAttributeList)

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 wyszukiwanie tylko do pojazdów ze wszystkimi atrybutami 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.

orderBy

enum (VehicleMatchOrder)

To pole jest wymagane. Określa żądane kryterium kolejności wyników.

includeBackToBack

boolean

Określa, czy pojazdy z jedną aktywną podróżą kwalifikują się do tego wyszukiwania. To pole jest używane tylko wtedy, gdy pole currentTripsPresent jest nieokreślone. Gdy pole currentTripsPresent nie jest określone, a pole ma wartość false, pojazdy z przypisanymi podróżami są wykluczone z wyników wyszukiwania. Gdy pole currentTripsPresent nie jest określone, a pole ma wartość true, wyniki wyszukiwania mogą zawierać pojazdy z jedną aktywną podróżą o stanie ENROUTE_TO_DROPOFF. Jeśli określono currentTripsPresent, to pole nie może mieć wartości prawda.

Wartością domyślną jest false.

tripId

string

Wskazuje podróż związaną z: SearchVehicleRequest.

currentTripsPresent

enum (CurrentTripsPresent)

Określa, czy pojazdy z aktywnymi podróżami kwalifikują się do tego wyszukiwania. Jeśli pole tripType zawiera ciąg SHARED, należy ustawić wartość inną niż CURRENT_TRIPS_PRESENT_UNSPECIFIED.

filter

string

Opcjonalnie. Zapytanie filtra do zastosowania podczas wyszukiwania 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 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 minimumCapacity lub vehicleTypes.

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

Treść odpowiedzi

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