Package maps.fleetengine.delivery.v1

Indeks

DeliveryService

Usługa dostawy ostatniej mili.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Tworzy i zwraca partię nowych obiektów Task.

CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Tworzy i zwraca nowy obiekt DeliveryVehicle.

CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Tworzy i zwraca nowy obiekt Task.

GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Zwraca określoną instancję DeliveryVehicle.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Pobiera informacje o Task.

GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Zwraca podaną instancję TaskTrackingInfo.

ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Pobiera wszystkie DeliveryVehicle, które spełniają określone kryteria filtrowania.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Pobiera wszystkie Task, które spełniają określone kryteria filtrowania.

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Zapisuje zaktualizowane dane DeliveryVehicle w Fleet Engine i przypisuje Tasks do DeliveryVehicle. Nie możesz zaktualizować nazwy DeliveryVehicle. Możesz zaktualizować zasób remaining_vehicle_journey_segments, ale musi on zawierać wszystkie VehicleJourneySegment, aby zachować je w DeliveryVehicle. Elementy typu task_id są pobierane z elementu remaining_vehicle_journey_segments, a odpowiadające im Tasks są przypisywane do elementu DeliveryVehicle, jeśli nie zostały jeszcze przypisane.

UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Aktualizuje dane Task.

BatchCreateTasksRequest

wiadomość z prośbą BatchCreateTask,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API; Uwaga: jeśli ustawisz to pole, pole nagłówka w wiadomościach CreateTaskRequest musi być puste lub zgodne z tym polem.

parent

string

Wymagane. Zasób nadrzędny udostępniany przez wszystkie zadania. Ta wartość musi mieć format providers/{provider}. Wartość provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project. Pole nadrzędne w wiadomościach CreateTaskRequest musi być puste lub pasować do tego pola.

requests[]

CreateTaskRequest

Wymagane. Komunikat z prośbą o utworzenie zasobów. Uwaga: możesz utworzyć maksymalnie 500 zadań w ramach jednego zbiorczego zadania.

BatchCreateTasksResponse

wiadomość BatchCreateTask z odpowiedzią,

Pola
tasks[]

Task

utworzone zadania.

CreateDeliveryVehicleRequest

wiadomość z prośbą CreateDeliveryVehicle,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

parent

string

Wymagane. Musi mieć format providers/{provider}. Dostawcą musi być identyfikator projektu Google Cloud. Na przykład: sample-cloud-project.

delivery_vehicle_id

string

Wymagane. Identyfikator pojazdu dostarczanego na potrzeby dostawy musi być niepowtarzalny i podlega tym ograniczeniom:

  • Musi to być prawidłowy ciąg znaków Unicode.
  • Może mieć maksymalnie 64 znaki.
  • znormalizowany zgodnie z formą normalizacji C standardu Unicode.
  • Nie może zawierać tych znaków ASCII: '/', ':', '?', ',' ani '#'.
delivery_vehicle

DeliveryVehicle

Wymagane. Element DeliveryVehicle do utworzenia. Podczas tworzenia nowego pojazdu dostawczego możesz wypełnić te pola opcjonalne:

  • typ
  • last_location
  • atrybuty

Uwaga: pole name w przypadku dostawy pojazdu jest ignorowane. Wszystkie pozostałe pola DeliveryVehicle nie mogą być ustawione, w przeciwnym razie zwracany jest błąd.

CreateTaskRequest

wiadomość z prośbą CreateTask,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

parent

string

Wymagane. Musi mieć format providers/{provider}. Wartość provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

task_id

string

Wymagane. Identyfikator zadania musi być unikalny, ale nie powinien być identyfikatorem śledzenia przesyłki. Aby zapisać identyfikator śledzenia przesyłki, użyj pola tracking_id. Pamiętaj, że ta sama wartość tracking_id może występować w przypadku wielu zadań. Identyfikatory zadań podlegają tym ograniczeniom:

  • Musi być prawidłowym ciągiem znaków Unicode.
  • Może mieć maksymalnie 64 znaki.
  • znormalizowany zgodnie z formą normalizacji C standardu Unicode.
  • Nie może zawierać tych znaków ASCII: '/', ':', '?', ',' ani '#'.
task

Task

Wymagane. Encja Zadania do utworzenia. Podczas tworzenia zadania wymagane są te pola:

  • type
  • state (musi mieć wartość OPEN)
  • tracking_id (nie musi być ustawiony w przypadku zadań UNAVAILABLE ani SCHEDULED_STOP, ale jest wymagany w przypadku wszystkich innych typów zadań)
  • planned_location (opcjonalny w przypadku UNAVAILABLE zadań)
  • task_duration

Uwaga: pole name w zadaniu jest ignorowane. Wszystkie pozostałe pola zadania nie mogą być ustawione, w przeciwnym razie zwracany jest błąd.

DeliveryRequestHeader

Nagłówek RequestHeader zawiera pola wspólne dla wszystkich żądań RPC dostawy.

Pola
language_code

string

Kod języka BCP-47, np. pl-PL lub sr-Latn. Więcej informacji znajdziesz na stronie http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Jeśli nie podasz żadnej wartości, odpowiedź może być w dowolnym języku, a preferowany jest język angielski, o ile taka nazwa istnieje. Przykład wartości pola: en-US.

region_code

string

Wymagane. Kod regionu CLDR, z którego pochodzi żądanie. Przykład wartości pola: US.

sdk_version

string

Wersja pakietu SDK wywołującego (jeśli dotyczy). Format wersji to „major.minor.patch”, np. 1.1.2.

os_version

string

Wersja systemu operacyjnego, w którym działa pakiet SDK wywołujący. Przykłady wartości pola: 4.4.1, 12.1.

device_model

string

Model urządzenia, na którym działa pakiet SDK wywołujący. Przykłady wartości pola: iPhone12,1, SM-G920F.

sdk_type

SdkType

Typ pakietu SDK, który wysyła żądanie.

maps_sdk_version

string

Wersja MapSDK, z której korzysta wywoływany pakiet SDK (w odpowiednich przypadkach). Format wersji to „major.minor.patch”, np. 5.2.1.

nav_sdk_version

string

Wersja pakietu NavSDK, od której zależy wywoływany pakiet SDK (w odpowiednich przypadkach). Format wersji to „major.minor.patch”, np. 2.1.0.

platform

Platform

Platforma pakietu SDK wywołującego.

manufacturer

string

Producent urządzenia z Androidem wywołującego pakiet SDK (dotyczy tylko pakietów SDK na Androida). Przykład wartości pola: Samsung.

android_api_level

int32

Poziom interfejsu Android API wywołującego pakietu SDK, dotyczy tylko pakietów SDK Androida. Przykład wartości pola: 23.

trace_id

string

Opcjonalny identyfikator, który można podać w celu 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 Prośba pochodzi z sieci.

SdkType

Możliwe typy pakietu SDK.

Wartości w polu enum
SDK_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość jest używana, jeśli element sdk_type jest pominięty.
CONSUMER Pakiet SDK wywołujący to Consumer.
DRIVER Pakiet SDK wywołujący to Driver.
JAVASCRIPT Wywoływanie SDK to JavaScript.

DeliveryVehicle

Wiadomość DeliveryVehicle. Pojazd dostawczy transportuje przesyłki z depotu do miejsca dostawy i z miejsca odbioru do depozytu. W niektórych przypadkach pojazdy dostawcze transportują też przesyłki bezpośrednio z miejsca odbioru do miejsca dostawy.

Uwaga: interfejsy gRPC i REST 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

string

Niepowtarzalna nazwa tego pojazdu dostawczego. Format to providers/{provider}/deliveryVehicles/{vehicle}.

last_location

DeliveryVehicleLocation

Ostatnia zgłoszona lokalizacja pojazdu dostawczego.

navigation_status

DeliveryVehicleNavigationStatus

Stan nawigacji pojazdu dostawczego.

current_route_segment

bytes

Zaszyfrowana linia łamana określająca trasę, którą nawigacja zaleca przejechać do następnego punktu orientacyjnego. Aplikacja kierowcy aktualizuje te informacje, gdy kierowca dotrze do przystanku lub minie go, a także gdy nawigacja zmieni trasę. Te LatLng są zwracane w Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) lub Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) dla wszystkich aktywnych zadań przypisanych do pojazdu.

W kilku przypadkach tego pola nie można użyć do wypełnienia pola Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ani pola Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • Punkt końcowy current_route_segment nie pasuje do DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) ani DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • Aplikacja kierowcy nie zaktualizowała ostatnio lokalizacji, więc ostatnia zaktualizowana wartość tego pola może być nieaktualna.

  • Aplikacja kierowcy niedawno zaktualizowała swoją lokalizację, ale current_route_segment jest nieaktualna i wskazuje na poprzedni przystanek pojazdu.

W takich przypadkach Fleet Engine wypełnia to pole trasą z ostatniego przekazanego VehicleStop do następnego elementu VehicleStop, aby mieć pewność, że klient z tego pola ma najdokładniejsze dostępne informacje o bieżącej ścieżce pojazdu dostarczanego.

current_route_segment_end_point

LatLng

Lokalizacja, w której kończy się current_route_segment. Obecnie aplikacja kierowcy nie wypełnia tego pola, ale możesz podać je podczas połączenia UpdateDeliveryVehicle. Jest to LatLng z najbliższego przystanku pojazdu lub ostatni LatLngcurrent_route_segment. Fleet Engine zrobi wszystko, co w jego mocy, aby interpolować rzeczywistą wartość VehicleStop.

To pole jest ignorowane w wywołaniach UpdateDeliveryVehicle, jeśli pole current_route_segment jest puste.

remaining_distance_meters

Int32Value

Pozostała odległość do przejechania w przypadku current_route_segment. To pole jest zwykle dostępne w aplikacji Kierowca, ale w niektórych okolicznościach silnik Fleet Engine może zastąpić wartość przesłaną przez aplikację. Więcej informacji znajdziesz w artykule DeliveryVehicle.current_route_segment. To pole jest zwracane w Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) lub Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) w przypadku wszystkich aktywnych Task przypisanych do pojazdu dostawczego.

Silnik floty ignoruje to pole w elementach UpdateDeliveryVehicleRequest, jeśli pole current_route_segment jest puste.

remaining_duration

Duration

Pozostały czas jazdy w przypadku current_route_segment. To pole jest zwykle dostępne w aplikacji Kierowca, ale w niektórych okolicznościach silnik Fleet Engine może zastąpić wartość przesłaną przez aplikację. Więcej informacji znajdziesz w artykule DeliveryVehicle.current_route_segment. To pole jest zwracane w Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) lub Task.remainingVehicleJourneySegments[0].drivingDuration (REST) w przypadku wszystkich aktywnych zadań przypisanych do pojazdu dostawczego.

Fleet Engine ignoruje to pole w UpdateDeliveryVehicleRequest, jeśli pole current_route_segment jest puste.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

Odcinki trasy przypisane do tego pojazdu dostawczego, zaczynając od ostatnio zgłoszonej lokalizacji pojazdu. To pole nie będzie wypełniane w odpowiedzi na ListDeliveryVehicles.

attributes[]

DeliveryVehicleAttribute

Lista niestandardowych atrybutów pojazdu dostawczego. Pojazd dostawczy może mieć maksymalnie 100 atrybutów, a każdy z nich musi mieć unikalny klucz.

type

DeliveryVehicleType

Typ pojazdu dostawczego. Jeśli nie są ustawione, Google przyjmuje domyślnie AUTO.

DeliveryVehicleType

Typ pojazdu dostawczego.

Wartości w polu enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Wartość nie jest używana.
AUTO Samochód.
TWO_WHEELER motocykl, skuter lub inny pojazd dwukołowy;
BICYCLE Transport napędzany przez człowieka.
PEDESTRIAN Osoba poruszająca się pieszo lub biegnąca po chodniku.

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

string

Klucz atrybutu.

value

string

Wartość atrybutu.

Pole unii delivery_vehicle_attribute_value. Wartość atrybutu może być typu string, bool lub double. delivery_vehicle_attribute_value może mieć tylko jedną z tych wartości:
string_value

string

Wartość atrybutu typu ciąg znaków.

Uwaga: działa tak samo jak pole value, które z czasem zostanie wycofane. W przypadku metod tworzenia lub aktualizowania możesz użyć dowolnego pola, ale zdecydowanie zalecamy użycie pola string_value. Jeśli opcje string_valuevalue są ustawione, muszą być identyczne, w przeciwnym razie wystąpi błąd. Oba pola są wypełniane w odpowiedziach.

bool_value

bool

Wartość atrybutu typu logicznego.

number_value

double

Wartość atrybutu typu podwójnego.

DeliveryVehicleLocation

lokalizacja, prędkość i kierunek pojazdu w określonym czasie;

Pola
location

LatLng

Lokalizacja pojazdu. Gdy jest wysyłany do Fleet Engine, lokalizacja pojazdu to lokalizacja GPS. Po otrzymaniu odpowiedzi możesz określić lokalizację pojazdu na podstawie GPS-u, dodatkową lokalizację lub inną orientacyjną lokalizację. Źródło jest określone w polu location_sensor.

horizontal_accuracy
(deprecated)

DoubleValue

Wycofane: użyj w zastępstwie zasady latlng_accuracy.

latlng_accuracy

DoubleValue

Dokładność location m w promieniach.

heading

Int32Value

Kierunek, w którym pojazd porusza się w stopniach. 0 oznacza kierunek północny. Prawidłowy zakres to [0,360).

bearing_accuracy
(deprecated)

DoubleValue

Wycofane: użyj atrybutu heading_accuracy.

heading_accuracy

DoubleValue

Dokładność: heading w stopniach.

altitude

DoubleValue

Wysokość w metrach nad WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Wycofane: użyj w zastępstwie zasady altitude_accuracy.

altitude_accuracy

DoubleValue

Dokładność altitude w metrach.

speed_kmph
(deprecated)

Int32Value

Prędkość pojazdu w kilometrach na godzinę. Wycofane: użyj atrybutu speed.

speed

DoubleValue

Prędkość pojazdu w metrach/s

speed_accuracy

DoubleValue

Dokładność speed w metrach na sekundę.

update_time

Timestamp

Czas, w którym czujnik location został zgłoszony przez czujnik zgodnie z zegarem czujnika.

server_time

Timestamp

Tylko dane wyjściowe. Czas, w którym serwer otrzymał informacje o lokalizacji.

location_sensor

DeliveryVehicleLocationSensor

Dostawca danych o lokalizacji (np. GPS).

is_road_snapped

BoolValue

Określa, czy location jest dopasowane do drogi.

is_gps_sensor_enabled

BoolValue

Tylko dane wejściowe. Wskazuje, czy czujnik GPS jest włączony na urządzeniu mobilnym.

time_since_update

Int32Value

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 wartość 0. Jeśli czas jest nieznany (np. po ponownym uruchomieniu aplikacji), wartość zostaje wyzerowana.

num_stale_updates
(deprecated)

Int32Value

Tylko dane wejściowe. Wycofane: do określenia, czy lokalizacja jest nieaktualna, używane są teraz inne sygnały.

raw_location

LatLng

Surowa lokalizacja pojazdu (nieprzetworzona przez road-snapper).

raw_location_time

Timestamp

Sygnatura czasowa powiązana z nieprzetworzoną lokalizacją.

raw_location_sensor

DeliveryVehicleLocationSensor

Źródło nieprzetworzonej lokalizacji. Domyślna wartość to GPS.

raw_location_accuracy

DoubleValue

Dokładność raw_location jako promień w metrach.

supplemental_location

LatLng

Dodatkowa lokalizacja dostarczona przez aplikację integrującą.

supplemental_location_time

Timestamp

Sygnatura czasowa powiązana z dodatkową lokalizacją.

supplemental_location_sensor

DeliveryVehicleLocationSensor

Źródło dodatkowej lokalizacji. Domyślna wartość to CUSTOMER_SUPPLIED_LOCATION.

supplemental_location_accuracy

DoubleValue

Dokładność supplemental_location jako promień w metrach.

road_snapped
(deprecated)

bool

Wycofane: użyj w zastępstwie zasady is_road_snapped.

DeliveryVehicleLocationSensor

Czujnik lub metodologia używana do określenia lokalizacji.

Wartości w polu enum
UNKNOWN_SENSOR Czujnik jest nieokreślony lub nieznany.
GPS GPS lub wspomagany GPS.
NETWORK wspomagany GPS, 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 prawdopodobna pozycja na drodze.
CUSTOMER_SUPPLIED_LOCATION Lokalizacja podana przez klienta z niezależnego źródła. Zwykle ta wartość jest używana do lokalizacji pochodzącej ze źródeł innych niż urządzenie mobilne z pakietem Driver SDK. Jeśli pierwotne źródło jest opisane za pomocą innej wartości z enumeracji, użyj tej wartości. Lokalizacje oznaczone jako CUSTOMER_SUPPLIED_LOCATION są zwykle podawane za pomocą DeliveryVehicle last_location.supplemental_location_sensor.
FLEET_ENGINE_LOCATION Lokalizacja obliczona przez Fleet Engine na podstawie dostępnych sygnałów. Tylko dane wyjściowe. Ta wartość zostanie odrzucona, jeśli zostanie otrzymana w żądaniu.
FUSED_LOCATION_PROVIDER Dostawca uśrednionej lokalizacji w Androidzie.
CORE_LOCATION Dostawca danych o lokalizacji w systemach operacyjnych Apple.

DeliveryVehicleNavigationStatus

Stan nawigacji pojazdu.

Wartości w polu enum
UNKNOWN_NAVIGATION_STATUS Nieokreślony stan nawigacji.
NO_GUIDANCE Nawigacja w aplikacji Kierowca jest w trybie FREE_NAV.
ENROUTE_TO_DESTINATION Dostępna jest szczegółowa nawigacja, a nawigacja w aplikacji Kierowca została przełączona w tryb GUIDED_NAV.
OFF_ROUTE Pojazd zjechał z zalecanej trasy.
ARRIVED_AT_DESTINATION Pojazd znajduje się w odległości około 50 m od miejsca docelowego.

GetDeliveryVehicleRequest

wiadomość z prośbą GetDeliveryVehicle,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

name

string

Wymagane. Musi mieć format providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

GetTaskRequest

Wiadomość z prośbą GetTask.

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

name

string

Wymagane. Musi mieć format providers/{provider}/tasks/{task}. Wartość provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

GetTaskTrackingInfoRequest

Wiadomość z prośbą GetTaskTrackingInfoRequest.

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

name

string

Wymagane. Musi mieć format providers/{provider}/taskTrackingInfo/{tracking_id}. Wartość provider musi być identyfikatorem projektu Google Cloud, a wartość tracking_id – identyfikatorem śledzenia powiązanym z tym zadaniem. Przykładową nazwą może być providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

Wiadomość z prośbą ListDeliveryVehicles.

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

parent

string

Wymagane. Musi mieć format providers/{provider}. Wartość provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

page_size

int32

Opcjonalnie: Maksymalna liczba pojazdów do zwrócenia. Usługa może zwrócić mniej niż ta liczba. Jeśli nie określisz tej liczby, serwer sam ją ustali.

page_token

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji ListDeliveryVehicles. Musisz podać ten token, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu ListDeliveryVehicles muszą być zgodne z wywołaniem, które dostarczyło token strony.

filter

string

Opcjonalnie: Zapytanie filtra, które ma być stosowane przy wyświetlaniu listy pojazdów dostawy. Przykłady składni filtra znajdziesz na stronie http://aip.dev/160. Jeśli nie określisz wartości lub podasz pusty ciąg znaków jako filtr, zwrócone zostaną wszystkie środki przekazu.

Pamiętaj, że jedyne zapytania obsługiwane w przypadku atrybutu ListDeliveryVehicles to te dotyczące atrybutów pojazdu (na przykład attributes.<key> = <value> lub attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Ponadto wszystkie atrybuty są przechowywane jako ciągi znaków, więc jedyne obsługiwane porównania atrybutów to porównania ciągów znaków. Aby można było porównywać je z wartościami liczbowymi lub logicznymi, muszą być one wyraźnie umieszczone w cudzysłowie (np. attributes.<key> = "10" lub attributes.<key> = "true").

Maksymalna liczba ograniczeń dozwolonych w zapytaniu filtra to 50. Ograniczenie jest częścią zapytania o postaci attribute.<KEY> <COMPARATOR> <VALUE>, np. attributes.foo = bar to 1 ograniczenie.

viewport

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

wiadomość ListDeliveryVehicles z odpowiedzią,

Pola
delivery_vehicles[]

DeliveryVehicle

Zestaw środków dostawy, które spełniają określone kryteria filtrowania. Jeśli nie zostanie określony żaden filtr, żądanie zwróci wszystkie środki dostawy. Odpowiedź informująca o pomyślnym zakończeniu może też być pusta. Pusty tekst oznacza, że nie znaleziono żadnych pojazdów dostawczych spełniających żądane kryteria filtra.

next_page_token

string

Aby wyświetlić listę wyników, możesz przekazać ten token w polu ListDeliveryVehiclesRequest. Gdy zwracane są wszystkie wyniki, to pole nie występuje w odpowiedzi lub jest puste.

total_size

int64

Łączna liczba pojazdów dostawy spełniających kryteria żądania na wszystkich stronach.

ListTasksRequest

wiadomość z prośbą ListTasks,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

parent

string

Wymagane. Musi mieć format providers/{provider}. Wartość provider musi być identyfikatorem projektu Google Cloud. Na przykład: sample-cloud-project.

page_size

int32

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ę zwracanych wyników.

page_token

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji ListTasks. Dzięki temu można pobierać kolejne strony.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji ListTasks muszą być zgodne z wywołaniem, które dostarczyło token strony.

filter

string

Opcjonalnie: Zapytanie filtra stosowane podczas wyświetlania zadań. Przykłady składni filtrów znajdziesz na stronie http://aip.dev/160. Jeśli nie określisz wartości lub zastosujesz filtrowanie za pomocą pustego ciągu, zwrócone zostaną wszystkie zadania. Informacje o właściwościach Listy zadań, według których można filtrować, znajdziesz w sekcji Wyświetlanie listy zadań.

ListTasksResponse

Odpowiedź ListTasks zawierająca zestaw zadań, które spełniają kryteria filtrowania w ListTasksRequest.

Pola
tasks[]

Task

Zbiór zadań, które spełniają określone kryteria filtrowania. Jeśli nie podasz żadnego filtra, żądanie zwróci wszystkie zadania. Odpowiedź informująca o pomyślnym zakończeniu może też być pusta. Pusta odpowiedź oznacza, że nie znaleziono Listy zadań spełniającej żądane kryteria filtrowania.

next_page_token

string

Przekaż ten token w parametrze ListTasksRequest, aby wyświetlić wyniki. Jeśli zwrócono wszystkie wyniki, to pole jest pustym ciągiem znaków lub nie pojawia się w odpowiedzi.

total_size

int64

Łączna liczba zadań, które spełniają kryteria żądania, na wszystkich stronach.

LocationInfo

Lokalizacja z dodatkowymi identyfikatorami.

Pola
point

LatLng

współrzędne lokalizacji;

Zadanie

Zadanie w Delivery API reprezentuje pojedyncze działanie do śledzenia. Ogólnie rzecz biorąc, rozróżnia się zadania związane z dostawą i przerwy. Z wysyłką może być powiązanych wiele zadań. Możesz na przykład mieć jedno zadanie dotyczące odbioru i jedno dotyczące dostarczenia lub przeniesienia. Różne zadania związane z danym zleceniem mogą być realizowane przez różne pojazdy. Na przykład jeden pojazd może odbierać przesyłkę i przewozić ją do huba, a inny przewozić tę samą przesyłkę z huba do miejsca dostawy.

Uwaga: interfejsy gRPC i REST 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

string

Musi mieć format providers/{provider}/tasks/{task}.

type

Type

Wymagane. Stały. Określa typ zadania. Może to być na przykład przerwa lub wysyłka.

state

State

Wymagane. Bieżący stan wykonywania zadania.

task_outcome

TaskOutcome

Wynik zadania.

task_outcome_time

Timestamp

Sygnatura czasowa wskazująca, kiedy wynik Task został ustawiony przez dostawcę.

task_outcome_location

LocationInfo

Lokalizacja, w której ustawiono wynik Task. Ta wartość jest aktualizowana w ramach UpdateTask. Jeśli ta wartość nie jest aktualizowana bezpośrednio przez dostawcę, Fleet Engine wypełnia ją domyślnie ostatnią znaną lokalizacją pojazdu (lokalizacja nieprzetworzona).

task_outcome_location_source

TaskOutcomeLocationSource

Wskazuje, skąd pochodzi wartość task_outcome_location.

tracking_id

string

Stały. To pole ułatwia przechowywanie identyfikatora, dzięki czemu można uniknąć korzystania ze skomplikowanego mapowania. Nie możesz ustawić wartości tracking_id dla zadań typu UNAVAILABLESCHEDULED_STOP. Te identyfikatory podlegają tym ograniczeniom:

  • Musi być prawidłowym ciągiem znaków Unicode.
  • Może mieć maksymalnie 64 znaki.
  • znormalizowany zgodnie z formą normalizacji C standardu Unicode.
  • Nie może zawierać następujących znaków ASCII: „/”, „:”, „?”, „,” ani „#”.
delivery_vehicle_id

string

Tylko dane wyjściowe. Identyfikator pojazdu, który wykonuje to zadanie. Identyfikatory środków transportu podlegają tym ograniczeniom:

  • Musi to być prawidłowy ciąg znaków Unicode.
  • Może mieć maksymalnie 64 znaki.
  • znormalizowany zgodnie z formą normalizacji C standardu Unicode.
  • Nie może zawierać tych znaków ASCII: '/', ':', '?', ',' ani '#'.
planned_location

LocationInfo

Niezmienna. Lokalizacja, w której zadanie zostanie wykonane. Opcjonalny w przypadku zadań UNAVAILABLE, ale wymagany w przypadku wszystkich innych zadań.

task_duration

Duration

Wymagane. Niezmienna. Czas potrzebny do wykonania zadania w danej lokalizacji.

target_time_window

TimeWindow

Okno czasowe, w którym należy wykonać zadanie.

journey_sharing_info

JourneySharingInfo

Tylko dane wyjściowe. Pola dotyczące udostępniania podróży. Niewypełniane, gdy stan ma wartość CLOSED.

task_tracking_view_config

TaskTrackingViewConfig

Konfiguracja śledzenia zadań określająca, które elementy danych są widoczne dla użytkowników w konkretnych okolicznościach.

attributes[]

TaskAttribute

Lista niestandardowych atrybutów zadania. Każdy atrybut musi mieć unikalny klucz.

JourneySharingInfo

Udostępnianie konkretnych pól w podróży

Pola
remaining_vehicle_journey_segments[]

VehicleJourneySegment

informacje śledzące przystanki, które wykona przypisany pojazd, zanim zakończy to zadanie; Pamiętaj, że ta lista może zawierać przystanki z innych zadań.

Pierwszy segment, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) lub Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), zawiera informacje o trasie od ostatniej znanej lokalizacji kierowcy do najbliższego VehicleStop. Informacje o bieżącej trasie pochodzą zwykle z aplikacji kierowcy, z wyjątkiem niektórych przypadków opisanych w dokumentacji DeliveryVehicle.current_route_segment. Pozostałe segmenty w Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) lub Task.journeySharingInfo.remainingVehicleJourneySegments (REST) są wypełniane przez Fleet Engine. Zawierają informacje o trasie między pozostałymi VehicleStops.

last_location

DeliveryVehicleLocation

Wskazuje ostatnią zgłoszoną lokalizację przypisanego pojazdu.

last_location_snappable

bool

Wskazuje, czy ostatnia znana lokalizacja pojazdu może być dopasowana do current_route_segment. Jeśli last_location lub current_route_segment nie istnieją, ta wartość to False. Ta wartość jest obliczana przez Fleet Engine. Aktualizacje od klientów są ignorowane.

Stan

Stan zadania. Wskazuje postępy w realizacji zadań.

Wartości w polu enum
STATE_UNSPECIFIED Domyślny: Używana w przypadku nieokreślonego lub nierozpoznanego stanu zadania.
OPEN Zadanie nie zostało jeszcze przypisane do pojazdu dostawczego lub pojazd dostawczy nie przejechał jeszcze przez przystanek przypisany do Task.
CLOSED Gdy pojazd minie zatrzyma się w ramach tego zadania.

TaskOutcome

Wynik próby wykonania zadania. Gdy zasada TaskState jest zamknięta, TaskOutcome wskazuje, czy udało się wykonać tę czynność.

Wartości w polu enum
TASK_OUTCOME_UNSPECIFIED Wynik zadania przed ustawieniem jego wartości.
SUCCEEDED Zadanie zostało wykonane.
FAILED albo nie udało się ukończyć zadania, albo zostało ono anulowane.

TaskOutcomeLocationSource

Tożsamość źródła, które wypełniło element task_outcome_location.

Wartości w polu enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Wynik zadania przed jego ustawieniem.
PROVIDER Dostawca określił wartość task_outcome_location.
LAST_VEHICLE_LOCATION Dostawca nie podał: task_outcome_location, więc Fleet Engine użyła 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 odbiorze przesyłki od klienta. Odbiór z depotu lub z pojazdu zasilającego powinien używać typu SCHEDULED_STOP.
DELIVERY Zadanie dostawy to działanie polegające na dostarczeniu przesyłki do klienta końcowego. Punkty wyładunku w depot lub na pojazdach podwożących powinny używać typu SCHEDULED_STOP.
SCHEDULED_STOP Zaplanowane zatrzymanie zadania służy do planowania. Może to być na przykład odbiór lub dostarczenie przesyłek z pojazdów pomocniczych lub z depozytów. Nie należy go używać w przypadku żadnych przesyłek odbieranych lub dostarczanych przez klienta końcowego.
UNAVAILABLE Zadanie, które oznacza, że pojazd nie jest dostępny do serwisowania. Może się tak zdarzyć, gdy kierowca robi sobie przerwę lub tankuje pojazd.

TaskAttribute

Opisuje atrybut zadania jako parę klucz-wartość. Długość ciągu „klucz:wartość” nie może przekraczać 256 znaków.

Pola
key

string

Klucz atrybutu. Klucze nie mogą zawierać dwukropka (:).

Pole sumy task_attribute_value. Wartość atrybutu może być typu string, bool lub double. Jeśli nie ustawisz żadnej z nich, wartość string_value atrybutu TaskAttribute zostanie zapisana jako pusty ciąg znaków „”. Wartość task_attribute_value może być tylko jedną z tych:
string_value

string

Wartość atrybutu typu ciąg znaków.

bool_value

bool

Wartość atrybutu typu logicznego.

number_value

double

Wartość atrybutu została wpisana dwukrotnie.

TaskTrackingInfo

Wiadomość TaskTrackingInfo. Komunikat zawiera informacje o śledzeniu zadań, które będą wyświetlane. Jeśli identyfikator śledzenia jest powiązany z większą liczbą zadań, usługa Fleet Engine używa heurystyki, aby wybrać TaskTrackingInfo, którego ma użyć.

Pola
name

string

Musi mieć format providers/{provider}/taskTrackingInfo/{tracking}, gdzie tracking oznacza identyfikator śledzenia.

tracking_id

string

Niezmienna. Identyfikator śledzenia zadania. * Musi być prawidłowym ciągiem znaków Unicode. * Maksymalna długość to 64 znaki. * Znormalizowane zgodnie z formularzem normalizacji Unicode C. * Nie może zawierać tych znaków ASCII: '/', ':', '?', ',' ani '#'.

vehicle_location

DeliveryVehicleLocation

Ostatnia lokalizacja pojazdu.

route_polyline_points[]

LatLng

Lista punktów, które po połączeniu tworzą linię wielokąta oczekiwanej trasy pojazdu do lokalizacji tego zadania.

remaining_stop_count

Int32Value

Wskazuje liczbę przystanków, które pojazd ma jeszcze do wykonania, zanim dotrze do przystanku zadania, w tym przystanek zadania. Jeśli na przykład następny przystanek pojazdu to przystanek związany z wykonywaniem zadania, wartość będzie wynosić 1.

remaining_driving_distance_meters

Int32Value

Całkowita pozostała odległość (w metrach) do interesującego Cię obszaru (VehicleStop).

estimated_arrival_time

Timestamp

Sygnatura czasowa, która wskazuje szacowany czas przybycia do lokalizacji przystanku.

estimated_task_completion_time

Timestamp

Sygnatura czasowa wskazująca szacowany czas ukończenia zadania.

state

State

Bieżący stan wykonania zadania.

task_outcome

TaskOutcome

Wynik próby wykonania zadania.

task_outcome_time

Timestamp

Sygnatura czasowa wskazująca, kiedy wynik zadania został ustawiony przez dostawcę.

planned_location

LocationInfo

Niezmienna. Lokalizacja, w której zadanie zostanie wykonane.

target_time_window

TimeWindow

Okno czasowe, w którym należy wykonać zadanie.

attributes[]

TaskAttribute

Atrybuty niestandardowe ustawione w zadaniu.

TaskTrackingViewConfig

Komunikat konfiguracji określający, kiedy element danych zadania powinien być widoczny dla użytkowników.

Pola
route_polyline_points_visibility

VisibilityOption

Pole określające, kiedy punkty ścieżki polilinii mogą być widoczne. Jeśli to pole nie zostanie określone, zostanie użyta domyślna konfiguracja widoczności tych danych na poziomie projektu.

estimated_arrival_time_visibility

VisibilityOption

Pole określające, kiedy szacowany czas przyjazdu może być widoczny. Jeśli to pole nie zostanie określone, zostanie użyta domyślna konfiguracja widoczności tych danych na poziomie projektu.

estimated_task_completion_time_visibility

VisibilityOption

Pole określające, kiedy może być widoczny szacowany czas ukończenia zadania. Jeśli to pole nie zostanie określone, zostanie użyta domyślna konfiguracja widoczności tych danych na poziomie projektu.

remaining_driving_distance_visibility

VisibilityOption

Pole określające, kiedy pozostała odległość jazdy może być widoczna. Jeśli to pole nie zostanie określone, zostanie użyta domyślna konfiguracja widoczności tych danych na poziomie projektu.

remaining_stop_count_visibility

VisibilityOption

Pole określające, kiedy widoczny może być pozostały przystanek. Jeśli to pole nie zostanie określone, zostanie użyta domyślna konfiguracja widoczności tych danych na poziomie projektu.

vehicle_location_visibility

VisibilityOption

Pole, które określa, kiedy lokalizacja pojazdu może być widoczna. Jeśli to pole nie zostanie określone, zostanie użyta domyślna konfiguracja widoczności tych danych na poziomie projektu.

VisibilityOption

Komunikat opcji określający, kiedy element danych powinien być widoczny dla użytkowników.

Pola
Pole sumy visibility_option. Wybrana opcja widoczności. visibility_option może być tylko jednym z tych elementów:
remaining_stop_count_threshold

int32

Ten element danych jest widoczny dla użytkowników, jeśli liczba pozostałych przystanków <= remaining_stop_count_threshold.

duration_until_estimated_arrival_time_threshold

Duration

Ten element danych jest widoczny dla użytkowników, jeśli szacowany czas przybycia na przystanek <= wartość_progi_czasu_do_planowanego_przybycia.

remaining_driving_distance_meters_threshold

int32

Ten element danych jest widoczny dla użytkowników, jeśli pozostała odległość przejechana w metrach wynosi <= remaining_driving_distance_meters_threshold.

always

bool

Jeśli ma wartość Prawda, ten element danych jest zawsze widoczny dla użytkowników bez żadnych progów. To pole nie może być ustawione na „false”.

never

bool

Jeśli ma wartość prawda, ten element danych jest zawsze ukryty przed użytkownikami i nie ma dla niego żadnych progów. To pole nie może być ustawione na „false”.

TimeWindow

Zakres czasowy.

Pola
start_time

Timestamp

Wymagane. Godzina rozpoczęcia przedziału czasu (włącznie).

end_time

Timestamp

Wymagane. Godzina zakończenia przedziału czasowego (włącznie).

UpdateDeliveryVehicleRequest

wiadomość z prośbą UpdateDeliveryVehicle,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

delivery_vehicle

DeliveryVehicle

Wymagane. Aktualizacja elementu DeliveryVehicle, która ma zostać zastosowana. Uwaga: nie możesz zmienić nazwy DeliveryVehicle.

update_mask

FieldMask

Wymagane. Maska pola, która wskazuje, które pola DeliveryVehicle mają zostać zaktualizowane. Pamiętaj, że pole update_mask musi zawierać co najmniej 1 pole.

Jest to lista pełnych nazw pól rozdzielona przecinkami. Przykład: "remaining_vehicle_journey_segments".

UpdateTaskRequest

wiadomość z prośbą UpdateTask,

Pola
header

DeliveryRequestHeader

Opcjonalnie: standardowy nagłówek żądania interfejsu Delivery API;

task

Task

Wymagane. Zadanie powiązane z aktualizacją. Te pola są obsługiwane przez silnik floty. Nie aktualizuj ich za pomocą funkcji Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Uwaga: po ustawieniu wartości task_outcome nie można jej zmienić.

Jeśli zadanie zostało przypisane do pojazdu dostawczego, nie zmieniaj jego stanu na ZAMKNIĘTE za pomocą opcji Task.update. Zamiast tego usuń VehicleStop zawierający zadanie z pojazdu dostawczego, co spowoduje automatyczne ustawienie stanu zadania na „Zamknięte”.

update_mask

FieldMask

Wymagane. Maska pól określająca, które pola zadania mają zostać zaktualizowane. Uwaga: pole update_mask musi zawierać co najmniej 1 pole.

Jest to lista pełnych nazw pól rozdzielona przecinkami. Przykład: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Reprezentuje segment podróży pojazdu – od poprzedniego do bieżącego przystanku. Jeśli jest to pierwsze aktywne zatrzymanie, to oznacza przejazd z obecnej lokalizacji pojazdu do tego przystanku.

Pola
stop

VehicleStop

Określa lokalizację przystanku oraz powiązane z nim Task. Niektóre pola obiektu VehicleStop mogą nie być dostępne, jeśli ten segment podróży należy do: JourneySharingInfo.

driving_distance_meters

Int32Value

Tylko dane wyjściowe. Odległość przebyta od poprzedniego przystanku do tego przystanku. Jeśli bieżący przystanek jest pierwszym na liście segmentó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 podróży jest częścią JourneySharingInfo.

driving_duration

Duration

Tylko dane wyjściowe. Czas podróży z poprzedniego przystanku do tego przystanku. Jeśli bieżący przystanek jest pierwszym 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 na ścieżce Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) lub Task.remainingVehicleJourneySegments[0].drivingDuration (REST), może być wypełnione wartością z DeliveryVehicle.remaining_duration (gRPC) lub DeliveryVehicle.remainingDuration (REST). Podaje pozostały czas jazdy z ostatniej znanej lokalizacji aplikacji kierowcy zamiast czasu jazdy z poprzedniego przystanku.

path[]

LatLng

Tylko dane wyjściowe. Ścieżka z poprzedniego przystanku do tego przystanku. Jeśli bieżący przystanek jest pierwszym na liście odcinków podróży, to jest to droga 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 podróży jest częścią JourneySharingInfo.

Jeśli to pole jest zdefiniowane na ścieżce Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) lub Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), może być wypełnione wartościami LatLng zdekodowanymi z DeliveryVehicle.current_route_segment (gRPC) lub DeliveryVehicle.currentRouteSegment (REST). Dzięki temu ścieżka przejazdu będzie prowadzić z ostatniej znanej lokalizacji aplikacji kierowcy, a nie z poprzedniego przystanku.

VehicleStop

Opisuje punkt, w którym pojazd zatrzymuje się, aby wykonać co najmniej 1 Task.

Pola
planned_location

LocationInfo

Wymagane. Lokalizacja przystanku. Pamiętaj, że lokalizacje w plikach Task mogą nie odpowiadać dokładnie tej lokalizacji, ale będą znajdować się w jej pobliżu. To pole nie będzie wypełniane w odpowiedzi na wywołanie GetTask.

tasks[]

TaskInfo

Lista Task, które mają być wykonane na tym przystanku. To pole nie będzie wypełniane w odpowiedzi na wywołanie GetTask.

state

State

Stan VehicleStop. To pole nie będzie wypełniane w odpowiedzi na wywołanie GetTask.

Stan

Bieżący stan VehicleStop.

Wartości w polu enum
STATE_UNSPECIFIED Nieznany.
NEW Utworzone, ale nie aktywnie kierujące ruchem.
ENROUTE Przypisany i aktywnie kierujący ruchem.
ARRIVED Przybycie na przystanek. Zakłada się, że gdy Pojazd jedzie do następnego przystanku, wszystkie poprzednie przystanki zostały już zrealizowane.

TaskInfo

Dodatkowe informacje o wykonywanym na tym przystanku zadaniu.

Pola
task_id

string

Identyfikator zadania. To pole nie będzie wypełniane w odpowiedzi na wywołanie GetTask. Identyfikatory zadań podlegają tym ograniczeniom:

  • Musi być prawidłowym ciągiem znaków Unicode.
  • Maksymalna długość to 64 znaki.
  • Znormalizowane zgodnie z formularzem normalizacji Unicode C.
  • Nie może zawierać tych znaków ASCII: '/', ':', '?', ',' ani '#'.
task_duration

Duration

Tylko dane wyjściowe. Czas potrzebny do wykonania zadania.

target_time_window

TimeWindow

Tylko dane wyjściowe. Okno czasowe, w którym należy wykonać zadanie. Jest on ustawiany tylko w odpowiedzi na GetDeliveryVehicle.