- Zasób: zadanie
- Typ
- TaskOutcomeLocationSource
- JourneySharingInfo
- TaskTrackingViewConfig
- VisibilityOption
- Metody
Zasób: zadanie
Task API w interfejsie Delivery API reprezentuje jedno działanie do śledzenia. Ogólnie istnieje rozróżnienie między zadaniami związanymi z dostawą i zadaniami dotyczącymi awarii. Z przesyłką może być powiązanych wiele zadań. Może to być na przykład jedno zadanie dotyczące odbioru i jednego zadania polegającego na odesłaniu lub przesiadce. Różne pojazdy mogą być też obsługiwane przez różne zadania dla danej przesyłki. Jeden pojazd może na przykład obsługiwać odbiór i przewieźć przesyłkę do centrum, a inny – z centrum do odbioru.
Uwaga: w interfejsach API gRPC i REST stosowane są różne konwencje nazewnictwa pól. Na przykład pole Task.journey_sharing_info
w interfejsie gRPC API i pole Task.journeySharingInfo
w interfejsie API REST odwołują się do tego samego pola.
Zapis JSON |
---|
{ "name": string, "type": enum ( |
Pola | |
---|---|
name |
Musi mieć format |
type |
Wymagane. Stałe. Określa typ zadania. Może to być na przykład przerwa lub wysyłka. |
state |
Wymagane. Bieżący stan wykonania zadania. |
taskOutcome |
Rezultat wykonania zadania. |
taskOutcomeTime |
Sygnatura czasowa wskazująca, kiedy dostawca Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
taskOutcomeLocation |
Lokalizacja, w której ustawiono wynik działania funkcji |
taskOutcomeLocationSource |
Wskazuje, skąd pochodzi wartość parametru |
trackingId |
Stałe. To pole ułatwia przechowywanie dokumentu tożsamości, dzięki czemu można uniknąć używania skomplikowanego mapowania. Nie można ustawić
|
deliveryVehicleId |
Tylko dane wyjściowe. Identyfikator pojazdu, który wykonuje to zadanie. Identyfikatory pojazdów dostawczych podlegają następującym ograniczeniom:
|
plannedLocation |
Stałe. Lokalizacja, w której zostanie wykonane zadanie. Opcjonalny w przypadku |
taskDuration |
Wymagane. Stałe. Czas potrzebny na wykonanie zadania w tej lokalizacji. Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „ |
targetTimeWindow |
Przedział czasu, w którym należy wykonać zadanie. |
journeySharingInfo |
Tylko dane wyjściowe. Pola dotyczące udostępniania serii czynności. Brak wypełnienia, gdy stan to |
taskTrackingViewConfig |
Konfiguracja śledzenia zadań, która określa, które elementy danych są widoczne dla użytkowników w jakich okolicznościach. |
attributes[] |
Lista niestandardowych atrybutów zadania. Każdy atrybut musi mieć unikalny klucz. |
Typ
Typ zadania.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Domyślnie typ zadania jest nieznany. |
PICKUP |
Zadanie odbioru to działanie podjęte w celu odebrania przesyłki od klienta. W przypadku odbioru pojazdów z łazienki lub podajnika należy używać typu SCHEDULED_STOP . |
DELIVERY |
Zadanie dostawy to działanie podjęte w celu dostarczenia przesyłki do klienta końcowego. W przypadku pojazdów do obsługi pojazdów lub dostawczych należy używać typu SCHEDULED_STOP . |
SCHEDULED_STOP |
Zadanie zaplanowanego zatrzymania jest używane do planowania. Może to być na przykład odbieranie lub odbieranie przesyłek z pojazdów dostarczających lub magazynów. Nie należy go używać w przypadku przesyłek, które zostały odebrane lub dostarczone przez klienta końcowego. |
UNAVAILABLE |
Zadanie, które oznacza, że pojazd nie jest dostępny do naprawy. Może się tak na przykład zdarzyć, gdy kierowca robi sobie przerwę lub gdy pojazd jest tankowany. |
TaskOutcomeLocationSource
Tożsamość źródła, które wypełniło pole taskOutcomeLocation
.
Wartości w polu enum | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
Wynik zadania przed jego ustawieniem. |
PROVIDER |
Dostawca określił wartość taskOutcomeLocation . |
LAST_VEHICLE_LOCATION |
Dostawca nie podał taskOutcomeLocation , więc Fleet Engine użyło ostatniej znanej lokalizacji pojazdu. |
JourneySharingInfo
Określone pola dotyczące udostępniania serii czynności.
Zapis JSON |
---|
{ "remainingVehicleJourneySegments": [ { object ( |
Pola | |
---|---|
remainingVehicleJourneySegments[] |
Informacje o przystankach, które zatrzyma przydzielony pojazd przed zakończeniem tego zadania. Pamiętaj, że ta lista może zawierać przystanki z innych zadań. Pierwszy segment, |
lastLocation |
Wskazuje ostatnią zarejestrowaną lokalizację przypisanego pojazdu. |
lastLocationSnappable |
Wskazuje, czy parametr lastLocation pojazdu może być przyciągnięty do obiektu |
TaskTrackingViewConfig
Komunikat konfiguracji, który określa, kiedy element danych zadania powinien być widoczny dla użytkowników.
Zapis JSON |
---|
{ "routePolylinePointsVisibility": { object ( |
Pola | |
---|---|
routePolylinePointsVisibility |
Pole, które określa, kiedy punkty linii łamanej na trasie mogą być widoczne. Jeśli to pole nie zostanie określone, dla tych danych będzie używana domyślna konfiguracja widoczności na poziomie projektu. |
estimatedArrivalTimeVisibility |
Pole, które określa, kiedy może być widoczny szacowany czas przyjazdu. Jeśli to pole nie zostanie określone, dla tych danych będzie używana domyślna konfiguracja widoczności na poziomie projektu. |
estimatedTaskCompletionTimeVisibility |
Pole, które określa, kiedy może być widoczny szacowany czas ukończenia zadania. Jeśli to pole nie zostanie określone, dla tych danych będzie używana domyślna konfiguracja widoczności na poziomie projektu. |
remainingDrivingDistanceVisibility |
Pole, które określa pozostały dystans jazdy, może być widoczne. Jeśli to pole nie zostanie określone, dla tych danych będzie używana domyślna konfiguracja widoczności na poziomie projektu. |
remainingStopCountVisibility |
Pole, które określa, kiedy pozostaje liczba przystanków, może być widoczne. Jeśli to pole nie zostanie określone, dla tych danych będzie używana domyślna konfiguracja widoczności na poziomie projektu. |
vehicleLocationVisibility |
Pole, które określa, kiedy lokalizacja pojazdu może być widoczna. Jeśli to pole nie zostanie określone, dla tych danych będzie używana domyślna konfiguracja widoczności na poziomie projektu. |
VisibilityOption
Komunikat dotyczący opcji, który określa, kiedy element danych ma być widoczny dla użytkowników.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy visibility_option . Wybrana opcja widoczności. visibility_option może być tylko jedną z tych wartości: |
|
remainingStopCountThreshold |
Ten element danych jest widoczny dla użytkowników, jeśli liczba pozostałych przystanków jest <= pozostałaStopCountThreshold. |
durationUntilEstimatedArrivalTimeThreshold |
Ten element danych jest widoczny dla użytkowników, jeśli szacowany czas dotarcia na miejsce do zatrzymania jest <= durationUntilScheduleArrivalTimeThreshold. Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „ |
remainingDrivingDistanceMetersThreshold |
Ten element danych jest widoczny dla użytkowników, jeśli pozostały dystans przejazdu w metrach <= przejechany kilometry. |
always |
Jeśli ma wartość Prawda, ten element danych jest zawsze widoczny dla użytkowników bez żadnych progów. Tego pola nie można ustawić na wartość Fałsz. |
never |
Jeśli zasada ma wartość Prawda, ten element danych jest zawsze ukryty przed użytkownikami bez progów. Tego pola nie można ustawić na wartość Fałsz. |
Metody |
|
---|---|
|
Tworzy i zwraca grupę nowych obiektów Task . |
|
Tworzy i zwraca nowy obiekt Task . |
|
Pobiera informacje o: Task . |
|
Pobiera wszystkie obiekty Task , które spełniają określone kryteria filtrowania. |
|
Aktualizuje dane: Task . |