Indeks
DeliveryService
(interfejs)BatchCreateTasksRequest
(komunikat)BatchCreateTasksResponse
(komunikat)CreateDeliveryVehicleRequest
(komunikat)CreateTaskRequest
(komunikat)DeleteDeliveryVehicleRequest
(komunikat)DeleteTaskRequest
(komunikat)DeliveryRequestHeader
(komunikat)DeliveryRequestHeader.Platform
(wyliczenie)DeliveryRequestHeader.SdkType
(wyliczenie)DeliveryVehicle
(komunikat)DeliveryVehicle.DeliveryVehicleType
(wyliczenie)DeliveryVehicleAttribute
(komunikat)DeliveryVehicleLocation
(komunikat)DeliveryVehicleLocationSensor
(wyliczenie)DeliveryVehicleNavigationStatus
(wyliczenie)GetDeliveryVehicleRequest
(komunikat)GetTaskRequest
(komunikat)GetTaskTrackingInfoRequest
(komunikat)ListDeliveryVehiclesRequest
(komunikat)ListDeliveryVehiclesResponse
(komunikat)ListTasksRequest
(komunikat)ListTasksResponse
(komunikat)LocationInfo
(komunikat)LocationInfo.PointSource
(wyliczenie)Task
(komunikat)Task.JourneySharingInfo
(komunikat)Task.State
(wyliczenie)Task.TaskOutcome
(wyliczenie)Task.TaskOutcomeLocationSource
(wyliczenie)Task.Type
(wyliczenie)TaskAttribute
(komunikat)TaskTrackingInfo
(komunikat)TaskTrackingViewConfig
(komunikat)TaskTrackingViewConfig.VisibilityOption
(komunikat)TimeWindow
(komunikat)UpdateDeliveryVehicleRequest
(komunikat)UpdateTaskRequest
(komunikat)VehicleJourneySegment
(komunikat)VehicleStop
(komunikat)VehicleStop.State
(wyliczenie)VehicleStop.TaskInfo
(komunikat)
DeliveryService
usługi dostawy ostatniej mili,
BatchCreateTasks |
---|
Tworzy i zwraca partię nowych obiektów |
CreateDeliveryVehicle |
---|
Tworzy i zwraca nowy obiekt |
CreateTask |
---|
Tworzy i zwraca nowy obiekt |
DeleteDeliveryVehicle |
---|
Usuwa pojazd dostawczy z Fleet Engine. Zwraca wartość FAILED_PRECONDITION, jeśli do pojazdu dostawczego przypisane są zadania w stanie OPEN. |
DeleteTask |
---|
Usuwa pojedyncze zadanie. Zwraca wartość FAILED_PRECONDITION, jeśli zadanie ma stan OPEN i jest przypisane do pojazdu dostawczego. |
GetDeliveryVehicle |
---|
Zwraca określoną instancję |
GetTask |
---|
Pobiera informacje o |
GetTaskTrackingInfo |
---|
Zwraca określoną instancję |
ListDeliveryVehicles |
---|
Pobiera wszystkie zakresy |
ListTasks |
---|
Pobiera wszystkie zakresy |
UpdateDeliveryVehicle |
---|
Zapisuje zaktualizowane dane |
UpdateTask |
---|
Aktualizuje dane |
BatchCreateTasksRequest
Wiadomość z prośbą o BatchCreateTask
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. Uwaga: jeśli ustawisz to pole, pole nagłówka w wiadomościach |
parent |
Wymagany. Zasób nadrzędny udostępniany wszystkim zadaniom. Wartość musi być w formacie |
requests[] |
Wymagany. Wiadomość z żądaniem, która określa zasoby do utworzenia. Uwaga: w jednej partii możesz utworzyć maksymalnie 500 zadań. |
BatchCreateTasksResponse
BatchCreateTask
wiadomość z odpowiedzią;
Pola | |
---|---|
tasks[] |
utworzone zadania. |
CreateDeliveryVehicleRequest
Wiadomość z prośbą o CreateDeliveryVehicle
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
parent |
Wymagany. Musi mieć format |
delivery_vehicle_id |
Wymagany. Identyfikator pojazdu dostawczego musi być unikalny i podlegać tym ograniczeniom:
|
delivery_vehicle |
Wymagany.
Uwaga: pole |
CreateTaskRequest
Wiadomość z prośbą o CreateTask
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
parent |
Wymagany. Musi mieć format |
task_id |
Wymagany. Identyfikator zadania musi być unikalny, ale nie powinien być identyfikatorem śledzenia przesyłki. Aby zapisać identyfikator śledzenia przesyłki, użyj pola
|
task |
Wymagany. Encja zadania do utworzenia. Podczas tworzenia zadania wymagane są te pola:
Możesz opcjonalnie ustawić te pola:
Uwaga: pole |
DeleteDeliveryVehicleRequest
Komunikat żądania DeleteDeliveryVehicle.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
name |
Wymagany. Musi mieć format |
DeleteTaskRequest
Wiadomość z prośbą DeleteTask.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
name |
Wymagany. Musi mieć format |
DeliveryRequestHeader
RequestHeader zawiera pola wspólne dla wszystkich żądań RPC dostarczania.
Pola | |
---|---|
language_code |
Kod języka w formacie BCP-47, np. en-US lub sr-Latn. Więcej informacji znajdziesz na stronie http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Jeśli nie określono żadnego języka, odpowiedź może być w dowolnym języku, ale jeśli istnieje nazwa w języku angielskim, będzie ona preferowana. Przykład wartości pola: |
region_code |
Wymagany. Kod regionu CLDR, z którego pochodzi żądanie. Przykład wartości pola: |
sdk_version |
Wersja pakietu SDK do połączeń (w stosownych przypadkach). Format wersji to „główna.pomniejsza.poprawka”, np. |
os_version |
Wersja systemu operacyjnego, na którym działa wywołujący pakiet SDK. Przykłady wartości pola: |
device_model |
Model urządzenia, na którym działa wywołujący pakiet SDK. Przykłady wartości pola: |
sdk_type |
Typ pakietu SDK, który wysłał żądanie. |
maps_sdk_version |
Wersja pakietu MapSDK, od której zależy wywołujący pakiet SDK (w odpowiednich przypadkach). Format wersji to „główna.pomniejsza.poprawka”, np. |
nav_sdk_version |
Wersja pakietu NavSDK, od której zależy wywołujący pakiet SDK (w odpowiednich przypadkach). Format wersji to „główna.pomniejsza.poprawka”, np. |
platform |
Platforma wywołującego pakietu SDK. |
manufacturer |
Producent urządzenia z Androidem, z którego wywoływany jest pakiet SDK. Dotyczy to tylko pakietów SDK na Androida. Przykład wartości pola: |
android_api_level |
Poziom interfejsu Android API wywołującego pakietu SDK. Dotyczy tylko pakietów SDK na Androida. Przykład wartości pola: |
trace_id |
Opcjonalny identyfikator, który można podać na potrzeby rejestrowania, aby zidentyfikować żądanie. |
Platforma
Platforma wywołującego pakietu SDK.
Wartości w polu enum | |
---|---|
PLATFORM_UNSPECIFIED |
Wartość domyślna. Ta wartość jest używana, jeśli platforma jest pominięta. |
ANDROID |
Żądanie pochodzi z Androida. |
IOS |
Żądanie pochodzi z iOS. |
WEB |
Żądanie pochodzi z internetu. |
SdkType
Możliwe typy pakietu SDK.
Wartości w polu enum | |
---|---|
SDK_TYPE_UNSPECIFIED |
Wartość domyślna. Ta wartość jest używana, jeśli pominięto element sdk_type . |
CONSUMER |
Wywołujący pakiet SDK to Consumer. |
DRIVER |
Wywołujący pakiet SDK to Driver. |
JAVASCRIPT |
Wywołujący pakiet SDK to JavaScript. |
DeliveryVehicle
Wiadomość DeliveryVehicle
. Pojazd dostawczy przewozi przesyłki z magazynu do miejsca dostawy i z miejsca odbioru do magazynu. W niektórych przypadkach pojazdy dostawcze transportują przesyłki bezpośrednio z miejsca odbioru do miejsca dostawy.
Uwaga: interfejsy gRPC i REST API używają różnych konwencji nazewnictwa pól. Na przykład pole DeliveryVehicle.current_route_segment
w interfejsie gRPC API i pole DeliveryVehicle.currentRouteSegment
w interfejsie REST API odnoszą się do tego samego pola.
Pola | |
---|---|
name |
Unikalna nazwa pojazdu dostawczego. Format to |
last_location |
Ostatnia zgłoszona lokalizacja pojazdu dostawczego. |
past_locations[] |
Tylko dane wejściowe. Lokalizacje, w których w przeszłości znajdował się ten pojazd dostawczy, ale nie zostały jeszcze zgłoszone do Fleet Engine. Jest on używany w |
navigation_status |
Stan nawigacji pojazdu dostawczego. |
current_route_segment |
Zakodowana linia łamana określająca trasę, którą nawigacja zaleca dojazdu do następnego punktu pośredniego. Aplikacja dla kierowców aktualizuje tę informację, gdy dotrzesz do przystanku lub go miniesz oraz gdy nawigacja zmieni trasę. Te W kilku przypadkach to pole może nie być używane do wypełniania pól
W takich przypadkach Fleet Engine wypełnia to pole trasą od ostatniego przystanku pojazdu do następnego przystanku, aby odbiorca tych informacji miał jak najlepsze dane o bieżącej trasie pojazdu dostawczego. |
current_route_segment_end_point |
Miejsce, w którym kończy się To pole jest ignorowane w wywołaniach |
remaining_distance_meters |
Pozostała odległość do przejechania w przypadku Fleet Engine ignoruje to pole w |
remaining_duration |
Pozostały czas jazdy w przypadku Fleet Engine ignoruje to pole w |
remaining_vehicle_journey_segments[] |
Odcinki podróży przypisane do tego pojazdu dostawczego, począwszy od ostatnio zgłoszonej lokalizacji pojazdu. To pole nie będzie wypełnione w odpowiedzi |
attributes[] |
Lista niestandardowych atrybutów pojazdu dostawczego. Pojazd dostawczy może mieć maksymalnie 100 atrybutów, a każdy atrybut musi mieć unikalny klucz. |
type |
Typ pojazdu dostawczego. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość |
DeliveryVehicleType
Rodzaj pojazdu dostawczego.
Wartości w polu enum | |
---|---|
DELIVERY_VEHICLE_TYPE_UNSPECIFIED |
Wartość jest nieużywana. |
AUTO |
samochód, |
TWO_WHEELER |
motocykl, skuter lub inny pojazd dwukołowy; |
BICYCLE |
transport napędzany siłą ludzkich mięśni, |
PEDESTRIAN |
Osoba transportująca, zwykle pieszo lub biegiem, poruszająca się po ścieżkach dla pieszych. |
DeliveryVehicleAttribute
Opisuje atrybut pojazdu jako parę klucz-wartość. Długość ciągu znaków „klucz:wartość” nie może przekraczać 256 znaków.
Pola | |
---|---|
key |
Klucz atrybutu. |
value |
Wartość atrybutu. |
Pole unii delivery_vehicle_attribute_value . Wartość atrybutu może być ciągiem znaków, wartością logiczną lub liczbą zmiennoprzecinkową. delivery_vehicle_attribute_value może mieć tylko jedną z tych wartości: |
|
string_value |
Wartość atrybutu typu ciąg znaków. Uwaga: to pole jest identyczne z polem |
bool_value |
Wartość atrybutu typu logicznego. |
number_value |
Wartość atrybutu typu double. |
DeliveryVehicleLocation
Lokalizacja, prędkość i kierunek pojazdu w danym momencie.
Pola | |
---|---|
location |
Lokalizacja pojazdu. Gdy jest wysyłana do Fleet Engine, lokalizacja pojazdu jest lokalizacją GPS. Gdy otrzymasz ją w odpowiedzi, lokalizacja pojazdu może być lokalizacją GPS, lokalizacją dodatkową lub inną lokalizacją szacunkową. Źródło jest określone w |
horizontal_accuracy |
Wycofana: zamiast niej używaj zasady |
latlng_accuracy |
Dokładność |
heading |
Kierunek, w którym porusza się pojazd, w stopniach. 0 oznacza północ. Prawidłowy zakres to [0,360). |
bearing_accuracy |
Wycofana: zamiast niej używaj zasady |
heading_accuracy |
Dokładność |
altitude |
Wysokość w metrach nad poziomem WGS84. |
vertical_accuracy |
Wycofana: zamiast niej używaj zasady |
altitude_accuracy |
Dokładność |
speed_kmph |
Prędkość pojazdu w kilometrach na godzinę. Wycofana: zamiast niej używaj zasady |
speed |
Prędkość pojazdu w metrach na sekundę |
speed_accuracy |
Dokładność |
update_time |
Czas, w którym czujnik zgłosił wartość |
server_time |
Tylko dane wyjściowe. Czas, w którym serwer otrzymał informacje o lokalizacji. |
location_sensor |
Dostawca danych o lokalizacji (np. |
is_road_snapped |
Określa, czy ikona |
is_gps_sensor_enabled |
Tylko dane wejściowe. Określa, czy na urządzeniu mobilnym jest włączony czujnik GPS. |
time_since_update |
Tylko dane wejściowe. Czas (w sekundach) od momentu, gdy ta lokalizacja została po raz pierwszy wysłana na serwer. W przypadku pierwszej aktualizacji będzie to zero. Jeśli czas jest nieznany (np. po ponownym uruchomieniu aplikacji), ta wartość jest resetowana do zera. |
num_stale_updates |
Tylko dane wejściowe. Wycofano: do określania, czy lokalizacja jest nieaktualna, używane są teraz inne sygnały. |
raw_location |
Surowa lokalizacja pojazdu (nieprzetworzona przez funkcję przyciągania do drogi). |
raw_location_time |
Sygnatura czasowa powiązana z nieprzetworzoną lokalizacją. |
raw_location_sensor |
Źródło nieprzetworzonej lokalizacji. Domyślna wartość to |
raw_location_accuracy |
Dokładność |
flp_location |
Lokalizacja z usługi lokalizacyjnej Androida. |
flp_update_time |
Aktualizacja sygnatury czasowej |
flp_latlng_accuracy_meters |
Dokładność |
flp_heading_degrees |
Kierunek, w którym porusza się pojazd, w stopniach, określony przez dostawcę połączonej lokalizacji. 0 oznacza północ. Prawidłowy zakres to [0,360). |
supplemental_location |
Dodatkowa lokalizacja podana przez aplikację integrującą. |
supplemental_location_time |
Sygnatura czasowa powiązana z dodatkową lokalizacją. |
supplemental_location_sensor |
Źródło dodatkowej lokalizacji. Domyślna wartość to |
supplemental_location_accuracy |
Dokładność |
road_snapped |
Wycofana: zamiast niej używaj zasady |
DeliveryVehicleLocationSensor
Czujnik lub metodologia użyte do określenia lokalizacji.
Wartości w polu enum | |
---|---|
UNKNOWN_SENSOR |
Czujnik jest nieokreślony lub nieznany. |
GPS |
GPS lub wspomagany GPS. |
NETWORK |
GPS wspomagany, identyfikator stacji bazowej lub punkt dostępu Wi-Fi. |
PASSIVE |
Identyfikator stacji bazowej lub punktu dostępu Wi-Fi. |
ROAD_SNAPPED_LOCATION_PROVIDER |
Lokalizacja określona przez urządzenie mobilne jako najbardziej prawdopodobne położenie na drodze. |
CUSTOMER_SUPPLIED_LOCATION |
Lokalizacja podana przez klienta z niezależnego źródła. Zwykle ta wartość jest używana w przypadku lokalizacji pochodzącej ze źródeł innych niż urządzenie mobilne, na którym działa pakiet Driver SDK. Jeśli pierwotne źródło jest opisane przez jedną z innych wartości wyliczeniowych, użyj tej wartości. Lokalizacje oznaczone jako CUSTOMER_SUPPLIED_LOCATION są zwykle podawane za pomocą parametru last_location.supplemental_location_sensor obiektu DeliveryVehicle. |
FLEET_ENGINE_LOCATION |
Lokalizacja obliczona przez Fleet Engine na podstawie dostępnych sygnałów. Tylko dane wyjściowe. Jeśli ta wartość zostanie przesłana w żądaniu, zostanie odrzucona. |
FUSED_LOCATION_PROVIDER |
Dostawca uśrednionej lokalizacji na Androidzie. |
CORE_LOCATION |
Dostawca lokalizacji w systemach operacyjnych Apple. |
GetDeliveryVehicleRequest
Wiadomość z prośbą o GetDeliveryVehicle
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
name |
Wymagany. Musi mieć format |
GetTaskRequest
Wiadomość z prośbą o GetTask
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
name |
Wymagany. Musi mieć format |
GetTaskTrackingInfoRequest
Wiadomość z prośbą o GetTaskTrackingInfoRequest
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
name |
Wymagany. Musi mieć format |
ListDeliveryVehiclesRequest
Wiadomość z prośbą o ListDeliveryVehicles
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
parent |
Wymagany. Musi mieć format |
page_size |
Opcjonalnie. Maksymalna liczba pojazdów do zwrócenia. Usługa może zwrócić mniejszą liczbę wyników. Jeśli nie podasz tej liczby, serwer określi liczbę wyników do zwrócenia. |
page_token |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania Podczas paginacji wszystkie inne parametry przekazane do funkcji |
filter |
Opcjonalnie. Zapytanie filtra do zastosowania podczas wyświetlania listy pojazdów dostawczych. Przykłady składni filtra znajdziesz na stronie http://aip.dev/160. Jeśli nie podasz wartości lub podasz pusty ciąg znaków jako filtr, zostaną zwrócone wszystkie pojazdy dostawcze. Pamiętaj, że w przypadku atrybutu Maksymalna liczba ograniczeń dozwolonych w zapytaniu filtra to 50. Ograniczenie to część zapytania w formie |
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. |
ListDeliveryVehiclesResponse
ListDeliveryVehicles
wiadomość z odpowiedzią;
Pola | |
---|---|
delivery_vehicles[] |
Zestaw pojazdów dostawczych spełniających kryteria filtrowania. Jeśli nie określisz filtra, żądanie zwróci wszystkie pojazdy dostawcze. Odpowiedź informująca o powodzeniu może być też pusta. Pusta odpowiedź oznacza, że nie znaleziono pojazdów dostawczych spełniających kryteria filtra. |
next_page_token |
Możesz przekazać ten token w parametrze |
total_size |
Łączna liczba pojazdów dostawczych spełniających kryteria żądania na wszystkich stronach. |
ListTasksRequest
Wiadomość z prośbą o ListTasks
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
parent |
Wymagany. Musi mieć format |
page_size |
Opcjonalnie. Maksymalna liczba zadań do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podasz tej wartości, serwer określi liczbę wyników do zwrócenia. |
page_token |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania Podczas paginacji wszystkie inne parametry przekazane do funkcji |
filter |
Opcjonalnie. Zapytanie filtra do zastosowania podczas wyświetlania listy zadań. Przykłady składni filtra znajdziesz na stronie http://aip.dev/160. Jeśli nie określisz wartości lub zastosujesz filtr do pustego ciągu znaków, zostaną zwrócone wszystkie zadania. Informacje o właściwościach zadań, według których możesz filtrować, znajdziesz w artykule Wyświetlanie listy zadań. |
ListTasksResponse
Odpowiedź ListTasks
zawierająca zestaw zadań spełniających kryteria filtra w ListTasksRequest
.
Pola | |
---|---|
tasks[] |
Zbiór zadań spełniających kryteria filtrowania. Jeśli nie podasz filtra, żądanie zwróci wszystkie zadania. Odpowiedź informująca o powodzeniu może być też pusta. Pusta odpowiedź oznacza, że nie znaleziono żadnych zadań spełniających kryteria filtra. |
next_page_token |
Przekaż ten token w parametrze |
total_size |
Łączna liczba zadań spełniających kryteria żądania na wszystkich stronach. |
LocationInfo
Lokalizacja z dodatkowymi identyfikatorami.
Pola | |
---|---|
point |
Współrzędne lokalizacji. Jako dane wejściowe należy podać wartość |
place |
Nazwa zasobu miejsca, które reprezentuje tę lokalizację. Format to To funkcja eksperymentalna. |
point_location_source |
Tylko dane wyjściowe. Źródło pola |
PointSource
Wskazuje źródło LatLng
.
Wartości w polu enum | |
---|---|
POINT_SOURCE_UNSPECIFIED |
Nieokreślone źródło punktowe. |
POINT_SOURCE_DEVELOPER_PROVIDED |
LatLng zostało wyraźnie podane przez dewelopera. |
POINT_SOURCE_CALCULATED_FROM_PLACE |
Wartość LatLng została obliczona na podstawie podanego miejsca. |
Zadanie
Zadanie w interfejsie Delivery API reprezentuje pojedynczą czynność do śledzenia. Ogólnie rzecz biorąc, istnieje rozróżnienie między zadaniami związanymi z przesyłką a przerwami. Z jedną przesyłką może być powiązanych wiele zadań. Na przykład może być jedno zadanie odbioru i jedno zadanie dostawy lub przekazania. Różne zadania w przypadku danej przesyłki mogą być realizowane przez różne pojazdy. Na przykład jeden pojazd może odebrać przesyłkę i dowieźć ją do centrum, a inny pojazd może przewieźć tę samą przesyłkę z centrum do miejsca docelowego.
Uwaga: interfejsy gRPC i REST API używają różnych konwencji nazewnictwa pól. Na przykład pole Task.journey_sharing_info
w interfejsie gRPC API i pole Task.journeySharingInfo
w interfejsie REST API odnoszą się do tego samego pola.
Pola | |
---|---|
name |
Musi mieć format |
type |
Wymagany. Niezmienne. Określa typ zadania. Może to być na przykład przerwa lub wysyłka. |
state |
Wymagany. Bieżący stan wykonania zadania. |
task_outcome |
Wynik zadania. |
task_outcome_time |
Sygnatura czasowa wskazująca, kiedy dostawca ustawił wynik |
task_outcome_location |
Lokalizacja, w której ustawiono wynik |
task_outcome_location_source |
Wskazuje, skąd pochodzi wartość |
tracking_id |
Niezmienne. To pole ułatwia przechowywanie identyfikatora, dzięki czemu nie musisz używać skomplikowanego mapowania. Nie możesz ustawić
|
delivery_vehicle_id |
Tylko dane wyjściowe. Identyfikator pojazdu, który wykonuje to zadanie. Identyfikatory pojazdów dostawczych podlegają tym ograniczeniom:
|
planned_location |
Niezmienne. Lokalizacja, w której zostanie wykonane zadanie. Opcjonalny w przypadku |
task_duration |
Wymagany. Niezmienne. Czas potrzebny na wykonanie zadania w tej lokalizacji. |
target_time_window |
Przedział czasu, w którym należy wykonać zadanie. |
journey_sharing_info |
Tylko dane wyjściowe. Pola dotyczące udostępniania podróży. Nie jest wypełniane, gdy stan to |
task_tracking_view_config |
Konfiguracja śledzenia zadań, która określa, które elementy danych są widoczne dla użytkowników końcowych i w jakich okolicznościach. |
attributes[] |
Lista niestandardowych atrybutów zadania. Każdy atrybut musi mieć unikalny klucz. |
JourneySharingInfo
Pola dotyczące udostępniania podróży.
Pola | |
---|---|
remaining_vehicle_journey_segments[] |
Informacje o śledzeniu przystanków, które przypisany pojazd wykona przed zakończeniem tego zadania. Pamiętaj, że ta lista może zawierać przystanki z innych zadań. Pierwszy segment, |
last_location |
Wskazuje ostatnią zgłoszoną lokalizację przypisanego pojazdu. |
last_location_snappable |
Wskazuje, czy ostatnia lokalizacja pojazdu może być przyciągana do |
Stan
Stan zadania. Wskazuje postęp zadania.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Domyślny: Używany w przypadku nieokreślonego lub nierozpoznanego stanu zadania. |
OPEN |
Zadanie nie zostało jeszcze przypisane do pojazdu dostawczego lub pojazd dostawczy nie dotarł jeszcze do przypisanego mu punktu odbioru Task . |
CLOSED |
Gdy pojazd minie przystanek dla tego zadania. |
TaskOutcome
Wynik próby wykonania zadania. Gdy TaskState
zostanie zamknięty, TaskOutcome
wskazuje, czy udało się go ukończyć.
Wartości w polu enum | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
Wynik zadania przed ustawieniem jego wartości. |
SUCCEEDED |
Zadanie zostało wykonane. |
FAILED |
Nie udało się wykonać zadania lub zostało ono anulowane. |
TaskOutcomeLocationSource
Tożsamość źródła, które wypełniło pole task_outcome_location
.
Wartości w polu enum | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
Wynik zadania przed jego ustawieniem. |
PROVIDER |
Dostawca określił task_outcome_location . |
LAST_VEHICLE_LOCATION |
Dostawca nie określił task_outcome_location , więc Fleet Engine użył ostatniej znanej lokalizacji pojazdu. |
Typ
Typ zadania.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Domyślnie typ zadania jest nieznany. |
PICKUP |
Zadanie odbioru to działanie polegające na odebraniu przesyłki od klienta. W przypadku odbioru w depocie lub pojazdem dowozowym należy użyć typu SCHEDULED_STOP . |
DELIVERY |
Zadanie dostawy to działanie podejmowane w celu dostarczenia przesyłki do klienta końcowego. W przypadku dostaw z magazynu lub pojazdu dostawczego należy użyć typu SCHEDULED_STOP . |
SCHEDULED_STOP |
Zaplanowane zadanie zatrzymania jest używane do celów planowania. Może to być na przykład odbiór lub dostawa przesyłek z pojazdów pomocniczych lub magazynów. Nie należy go używać w przypadku przesyłek odbieranych lub dostarczanych do klienta końcowego. |
UNAVAILABLE |
Zadanie oznaczające, że pojazd jest niedostępny. Może się tak zdarzyć, gdy kierowca robi przerwę lub gdy pojazd jest tankowany. |
TaskAttribute
Opisuje atrybut zadania jako parę klucz-wartość. Długość ciągu znaków „klucz:wartość” nie może przekraczać 256 znaków.
Pola | |
---|---|
key |
Klucz atrybutu. Klucze nie mogą zawierać dwukropka (:). |
Pole unii task_attribute_value . Wartość atrybutu może być ciągiem znaków, wartością logiczną lub liczbą zmiennoprzecinkową. Jeśli żadna z nich nie jest ustawiona, wartość string_value elementu TaskAttribute będzie przechowywana jako pusty ciąg znaków „”. task_attribute_value może mieć tylko jedną z tych wartości: |
|
string_value |
Wartość atrybutu typu ciąg znaków. |
bool_value |
Wartość atrybutu typu logicznego. |
number_value |
Wartość atrybutu typu double. |
TaskTrackingInfo
Wiadomość TaskTrackingInfo
. Wiadomość zawiera informacje o śledzeniu zadań, które będą używane do wyświetlania. Jeśli identyfikator śledzenia jest powiązany z kilkoma zadaniami, Fleet Engine używa heurystyki, aby zdecydować, które informacje TaskTrackingInfo zadania wybrać.
Pola | |
---|---|
name |
Musi mieć format |
tracking_id |
Niezmienne. Identyfikator śledzenia zadania. * Musi to być prawidłowy ciąg znaków Unicode. * Maksymalna długość to 64 znaki. * Znormalizowane zgodnie z Unicode Normalization Form C. * Nie może zawierać żadnego z tych znaków ASCII: „/”, „:”, „?”, „,” ani „#”. |
vehicle_location |
Ostatnia lokalizacja pojazdu. |
route_polyline_points[] |
Lista punktów, które po połączeniu tworzą linię łamaną przedstawiającą oczekiwaną trasę pojazdu do miejsca wykonania tego zadania. |
remaining_stop_count |
Wskazuje liczbę przystanków pozostałych do osiągnięcia przystanku zadania, w tym przystanku zadania. Jeśli na przykład następnym przystankiem pojazdu jest przystanek zadania, wartość będzie wynosić 1. |
remaining_driving_distance_meters |
Całkowita pozostała odległość w metrach do |
estimated_arrival_time |
Sygnatura czasowa wskazująca szacowany czas dotarcia do lokalizacji przystanku. |
estimated_task_completion_time |
Sygnatura czasowa wskazująca szacowany czas ukończenia zadania. |
state |
Bieżący stan wykonania zadania. |
task_outcome |
Wynik próby wykonania zadania. |
task_outcome_time |
Sygnatura czasowa wskazująca, kiedy dostawca ustawił wynik zadania. |
planned_location |
Niezmienne. Lokalizacja, w której zostanie wykonane zadanie. |
target_time_window |
Przedział czasu, w którym należy wykonać zadanie. |
attributes[] |
Atrybuty niestandardowe ustawione w przypadku zadania. |
TaskTrackingViewConfig
Komunikat konfiguracyjny, który określa, kiedy element danych zadania powinien być widoczny dla użytkowników.
Pola | |
---|---|
route_polyline_points_visibility |
Pole określające, kiedy punkty linii łamanej trasy mogą być widoczne. Jeśli to pole nie zostanie określone, używana będzie domyślna konfiguracja widoczności na poziomie projektu dla tych danych. |
estimated_arrival_time_visibility |
Pole, które określa, kiedy może być widoczny szacowany czas przyjazdu. Jeśli to pole nie zostanie określone, używana będzie domyślna konfiguracja widoczności na poziomie projektu dla tych danych. |
estimated_task_completion_time_visibility |
Pole, które określa, kiedy może być widoczny szacowany czas ukończenia zadania. Jeśli to pole nie zostanie określone, używana będzie domyślna konfiguracja widoczności na poziomie projektu dla tych danych. |
remaining_driving_distance_visibility |
Pole określające, kiedy może być widoczna pozostała odległość do przejechania. Jeśli to pole nie zostanie określone, używana będzie domyślna konfiguracja widoczności na poziomie projektu dla tych danych. |
remaining_stop_count_visibility |
Pole określające, kiedy może być widoczna pozostała liczba przystanków. Jeśli to pole nie zostanie określone, używana będzie domyślna konfiguracja widoczności na poziomie projektu dla tych danych. |
vehicle_location_visibility |
Pole określające, kiedy lokalizacja pojazdu może być widoczna. Jeśli to pole nie zostanie określone, używana będzie domyślna konfiguracja widoczności na poziomie projektu dla tych danych. |
VisibilityOption
Komunikat opcji, który określa, kiedy element danych powinien być widoczny dla użytkowników.
Pola | |
---|---|
Pole unii visibility_option . Wybrana opcja widoczności. visibility_option może mieć tylko jedną z tych wartości: |
|
remaining_stop_count_threshold |
Ten element danych jest widoczny dla użytkowników, jeśli pozostała liczba przystanków <= remaining_stop_count_threshold. |
duration_until_estimated_arrival_time_threshold |
Ten element danych jest widoczny dla użytkowników, jeśli szacowany czas dotarcia do przystanku <= duration_until_estimated_arrival_time_threshold. |
remaining_driving_distance_meters_threshold |
Ten element danych jest widoczny dla użytkowników, jeśli pozostała odległość dojazdu w metrach <= remaining_driving_distance_meters_threshold. |
always |
Jeśli ta opcja jest ustawiona na wartość „true”, ten element danych jest zawsze widoczny dla użytkowników bez progów. Nie można ustawić wartości tego pola na false. |
never |
Jeśli ma wartość Prawda, ten element danych jest zawsze ukryty przed użytkownikami bez progów. Nie można ustawić wartości tego pola na false. |
TimeWindow
zakres czasu,
Pola | |
---|---|
start_time |
Wymagany. Godzina rozpoczęcia przedziału czasu (włącznie z tym dniem). |
end_time |
Wymagany. Godzina zakończenia przedziału czasu (włącznie z tą godziną). |
UpdateDeliveryVehicleRequest
Wiadomość z prośbą o UpdateDeliveryVehicle
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
delivery_vehicle |
Wymagany. Aktualizacja encji |
update_mask |
Wymagany. Maska pola, która wskazuje, które pola Jest to lista w pełni kwalifikowanych nazw pól rozdzielonych przecinkami. Przykład: |
UpdateTaskRequest
Wiadomość z prośbą o UpdateTask
.
Pola | |
---|---|
header |
Opcjonalnie. Standardowy nagłówek żądania do interfejsu Delivery API. |
task |
Wymagany. Zadanie powiązane z aktualizacją. Te pola są obsługiwane przez Fleet Engine. Nie aktualizuj ich za pomocą ikony
Uwaga: po ustawieniu wartości Jeśli zadanie zostało przypisane do pojazdu dostawczego, nie ustawiaj stanu zadania na ZAMKNIĘTE za pomocą |
update_mask |
Wymagany. Maska pola, która wskazuje, które pola zadania mają zostać zaktualizowane. Uwaga: element Jest to lista w pełni kwalifikowanych nazw pól rozdzielonych przecinkami. Przykład: |
VehicleJourneySegment
Reprezentuje odcinek podróży pojazdu – od poprzedniego do bieżącego przystanku. Jeśli jest to pierwszy aktywny przystanek, trasa prowadzi od bieżącej lokalizacji pojazdu do tego przystanku.
Pola | |
---|---|
stop |
Określa lokalizację przystanku wraz z powiązanymi z nim |
driving_distance_meters |
Tylko dane wyjściowe. Odległość podróży od poprzedniego do tego przystanku. Jeśli bieżący przystanek jest pierwszym przystankiem na liście odcinków podróży, punktem początkowym jest lokalizacja pojazdu zarejestrowana w momencie dodania tego przystanku do listy. To pole może nie być widoczne, jeśli ten segment ścieżki jest częścią |
driving_duration |
Tylko dane wyjściowe. Czas podróży od poprzedniego przystanku do tego przystanku. Jeśli bieżący przystanek jest pierwszym przystankiem na liście segmentów podróży, punktem początkowym jest lokalizacja pojazdu zarejestrowana w momencie dodania tego przystanku do listy. Jeśli to pole jest zdefiniowane w ścieżce |
path[] |
Tylko dane wyjściowe. Ścieżka od poprzedniego do tego przystanku. Jeśli bieżący przystanek jest pierwszym przystankiem na liście odcinków podróży, jest to ścieżka od bieżącej lokalizacji pojazdu do tego przystanku w momencie dodania go do listy. To pole może nie być widoczne, jeśli ten segment ścieżki jest częścią Jeśli to pole jest zdefiniowane w ścieżce |
VehicleStop
Opisuje punkt, w którym pojazd zatrzymuje się, aby wykonać co najmniej 1 Task
.
Pola | |
---|---|
planned_location |
Wymagany. Lokalizacja przystanku. Pamiętaj, że lokalizacje w |
tasks[] |
Lista |
state |
Stan elementu |
Stan
Bieżący stan VehicleStop
.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Nieznany. |
NEW |
Utworzono, ale nie jest aktywnie kierowany. |
ENROUTE |
Przypisane i aktywnie kierowane. |
ARRIVED |
Dotarliśmy na przystanek. Zakłada, że gdy pojazd jedzie do następnego przystanku, wszystkie poprzednie przystanki zostały już obsłużone. |
TaskInfo
Dodatkowe informacje o zadaniu wykonanym na tym przystanku.
Pola | |
---|---|
task_id |
Identyfikator zadania. To pole nie będzie wypełnione w odpowiedzi na wywołanie
|
task_duration |
Tylko dane wyjściowe. czas potrzebny na wykonanie zadania; |
target_time_window |
Tylko dane wyjściowe. Przedział czasu, w którym należy wykonać zadanie. Jest ona ustawiana tylko w odpowiedzi na żądanie |