- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Punkt pośredni
- VehicleMatchType
Zwraca listę pojazdów, które pasują do opcji żą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 |
Wymagane. Musi mieć format |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "header": { object ( |
Pola | |
---|---|
header |
Standardowy nagłówek żądania Fleet Engine. |
pickupPoint |
Wymagane. Punkt odbioru w pobliżu. |
dropoffPoint |
Zamierzone miejsce zwrotu produktu przez klienta. Pole jest wymagane, jeśli |
pickupRadiusMeters |
Wymagane. Określa promień wyszukiwania pojazdu 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 |
Wymagane. Określa maksymalną liczbę pojazdów do zwrotu. Wartość musi znajdować się w zakresie od 1 do 50 (włącznie). |
minimumCapacity |
Wymagane. Określa liczbę pasażerów uwzględnianych w podróży. Wartość nie może być mniejsza niż 1. Kierowca nie jest uwzględniany w wartości pojemności. |
tripTypes[] |
Wymagane. Reprezentuje typ proponowanej podróży. Musi zawierać dokładnie 1 typ. |
maximumStaleness |
Ogranicza wyszukiwanie tylko do tych 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 to pole nie jest skonfigurowane, serwer ustawia domyślną wartość z pięciu minut. Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „ |
vehicleTypes[] |
Wymagane. Ogranicza wyszukiwanie do pojazdów jednego z określonych typów. Należy określić co najmniej jeden typ pojazdu. Typy pojazdów o kategorii |
requiredAttributes[] |
Wywołujący mogą tworzyć złożone operacje logiczne, korzystając z dowolnej kombinacji pól
Ogranicza wyszukiwanie 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. |
requiredOneOfAttributes[] |
Ogranicza wyszukiwanie tylko do tych pojazdów, które mają co najmniej 1 z określonych atrybutów w każdym |
requiredOneOfAttributeSets[] |
Podobnie jak w zasadzie
Ogranicza wyszukiwanie tylko do pojazdów mających wszystkie atrybuty w atrybucie |
orderBy |
Wymagane. Określa żądane kryterium kolejności wyników. |
includeBackToBack |
Wskazuje, czy do tego wyszukiwania kwalifikują się pojazdy z pojedynczą aktywną podróżą. To pole jest używane tylko wtedy, gdy pole Wartością domyślną jest |
tripId |
Wskazuje podróż powiązaną z tym obiektem: |
currentTripsPresent |
Wskazuje, czy do tego wyszukiwania kwalifikują się pojazdy, które aktywnie podróżują. Jeśli parametr |
filter |
Opcjonalnie: Zapytanie filtra, które ma być stosowane przy wyszukiwaniu pojazdów. Przykłady składni filtrów znajdziesz na stronie http://aip.dev/160. To pole zastępuje pola Ten filtr działa jak klauzula ORAZ z innymi ograniczeniami, takimi jak Pamiętaj, że obsługiwane są tylko zapytania dotyczące atrybutów pojazdu (na przykład 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. |
Treść odpowiedzi
vehicles.search
odpowiedź.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"matches": [
{
object ( |
Pola | |
---|---|
matches[] |
Lista pojazdów spełniających kryteria |
VehicleAttributeList
Typ danych listy list dla atrybutów pojazdów.
Zapis JSON |
---|
{
"attributes": [
{
object ( |
Pola | |
---|---|
attributes[] |
Lista atrybutów w tej kolekcji. |
VehicleMatchOrder
Określa kolejność dopasowań pojazdów w odpowiedzi.
Wartości w polu enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Domyślnie używana w przypadku nieokreślonego lub nierozpoznanego dopasowania pojazdu. |
PICKUP_POINT_ETA |
Rosnąco według czasu przejazdu pojazdu do punktu odbioru. |
PICKUP_POINT_DISTANCE |
Rosnąco według odległości pojazdu do punktu odbioru. |
DROPOFF_POINT_ETA |
Kolejność rosnąca według czasu przejazdu pojazdu do punktu nadania. Tego zamówienia można użyć tylko wtedy, gdy punkt zwrotu jest określony w żądaniu. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Kolejność rosnąca według bezpośredniej odległości od ostatniej zgłoszonej lokalizacji pojazdu do punktu odbioru. |
COST |
Kolejność rosnąca według skonfigurowanego kosztu dopasowania. Koszt dopasowania to obliczenie ważone między długością linii prostej a szacowanym czasem dotarcia na miejsce. Wagi są ustawiane na wartości domyślne i można je modyfikować dla poszczególnych klientów. Jeśli musisz zmodyfikować te wagi na potrzeby projektu, skontaktuj się z zespołem pomocy Google. |
CurrentTripsPresent
Określa rodzaje ograniczeń dotyczących bieżącej trasy pojazdu.
Wartości w polu enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
Dostępność pojazdów z możliwością podróży jest określana w polu includeBackToBack . |
NONE |
Pojazdy, które nie będą przejazdami, mogą pojawiać się w wynikach wyszukiwania. W przypadku użycia tej wartości dyrektywa includeBackToBack nie może być ustawiona jako true . |
ANY |
W wynikach wyszukiwania uwzględniane są pojazdy, z którymi aktualnie pokonuje się maks. 5 tras i 10 punktów pośrednich. W przypadku użycia tej wartości dyrektywa includeBackToBack nie może być ustawiona jako true . |
VehicleMatch
Zawiera pojazd i powiązane z nim dane szacunkowe dotyczące pojazdu pasujące do punktów aktywnych przejazdów pojazdu SearchVehiclesRequest
.
Zapis JSON |
---|
{ "vehicle": { object ( |
Pola | |
---|---|
vehicle |
Wymagane. Pojazd zgodny z żądaniem. |
vehiclePickupEta |
Szacowany czas dotarcia pojazdu na miejsce do punktu odbioru określonego w żądaniu. Pusta wartość oznacza błąd w obliczaniu szacowanego czasu dotarcia na miejsce. Jeśli Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
vehiclePickupDistanceMeters |
Odległość od bieżącej lokalizacji pojazdu do punktu odbioru określonego w żądaniu, z uwzględnieniem wszelkich pośrednich punktów odbioru i zwrotu w przypadku dotychczasowych podróży. Na tę odległość składają się obliczona odległość dojazdu (trasa) oraz odległość w linii prostej między punktem końcowym nawigacji a żądanym punktem odbioru. (Odległość między punktem końcowym nawigacji a żądanym punktem odbioru jest zwykle niewielka). Pusta wartość oznacza błąd podczas obliczania odległości. |
vehiclePickupStraightLineDistanceMeters |
Wymagane. Długość linii prostej między pojazdem a punktem odbioru określonej w żądaniu. |
vehicleDropoffEta |
Szacowany czas dotarcia na miejsce z całego pojazdu do punktu postoju wskazanego w żądaniu. Szacowany czas dotarcia na miejsce obejmuje zatrzymanie w dowolnym punkcie pośrednim przed Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
vehiclePickupToDropoffDistanceMeters |
Odległość pojazdu (w metrach) od punktu odbioru do miejsca nadania określonego w żądaniu. Odległość jest ograniczona tylko do tych 2 punktów i nie obejmuje lokalizacji pojazdu ani żadnych innych punktów, które należy odwiedzić, zanim pojazd dotrze do punktu odbioru lub punktu nadania. Wartość zostanie wypełniona tylko wtedy, gdy w żądaniu określisz atrybut |
tripType |
Wymagane. Rodzaj podróży użyty w żądaniu, który został użyty do obliczenia szacowanego czasu dotarcia do punktu odbioru. |
vehicleTripsWaypoints[] |
Uporządkowana lista punktów na trasie używanych do obliczania szacowanego czasu dotarcia na miejsce. Lista zawiera lokalizację pojazdu, punkty odbioru aktywnych podróży i punkty odbioru podane w prośbie. Pusta lista oznacza błąd w obliczaniu szacowanego czasu dotarcia na miejsce. |
vehicleMatchType |
Typ dopasowania pojazdu. |
requestedOrderedBy |
Zażądano kolejności sortowania zgodnych pojazdów. |
orderedBy |
Rzeczywiste zamówienie użyte w przypadku tego pojazdu. Normalnie pasuje do parametru „orderBy” z żądania; jednak w pewnych okolicznościach, takich jak wewnętrzny błąd serwera, można użyć innej metody (takiej jak |
Punkt pośredni
Opisuje punkty pośrednie na trasie przejazdu przez: VehicleMatch
w: SearchVehiclesResponse
. Ta koncepcja jest reprezentowana jako TripWaypoint
we wszystkich innych punktach końcowych.
Zapis JSON |
---|
{
"latLng": {
object ( |
Pola | |
---|---|
latLng |
Lokalizacja tego punktu na trasie. |
eta |
Szacowana godzina, o której pojazd dotrze do tego punktu pośredniego. Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
VehicleMatchType
Typ dopasowania pojazdu.
Wartości w polu enum | |
---|---|
UNKNOWN |
Nieznany typ dopasowania pojazdu |
EXCLUSIVE |
Pojazd nie ma obecnie przypisanej podróży i może dotrzeć do punktu odbioru. |
BACK_TO_BACK |
Pojazd jest obecnie przypisany do podróży, ale po zakończeniu trwającej podróży może przejść do punktu odbioru. Przy obliczaniu szacowanego czasu dotarcia na miejsce i dystansu brana jest pod uwagę dotychczasowa podróż. |
CARPOOL |
Pojazd ma wystarczającą pojemność do wspólnego przejazdu. |
CARPOOL_BACK_TO_BACK |
Pojazd zakończy bieżącą, aktywną podróż, zanim dotrze do punktu odbioru. Przy obliczaniu szacowanego czasu dotarcia na miejsce i dystansu brana jest pod uwagę dotychczasowa podróż. |