REST Resource: providers.deliveryVehicles

Zasób: DeliveryVehicle

Wiadomość DeliveryVehicle. Pojazd transportowy służy do transportu przesyłek z zajmu do miejsca dostawy oraz z miejsca odbioru do magazynu. W niektórych przypadkach pojazdy dostawcze transportują też przesyłki bezpośrednio z miejsca odbioru do miejsca dostawy.

Uwaga: interfejsy API 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 API REST odnoszą się do tego samego pola.

Zapis JSON 
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
Pola
name

string

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

object (DeliveryVehicleLocation)

Ostatnia zgłoszona lokalizacja pojazdu dostawczego.
navigationStatus

enum (DeliveryVehicleNavigationStatus)

Stan nawigacji pojazdu dostawy.
currentRouteSegment

string (bytes format)

Zakodowana linia łamana określająca trasę, którą według nawigacji zaleca przejście do następnego punktu pośredniego. Aplikacja kierowcy aktualizuje te informacje, gdy dotrzesz na miejsce lub je pominiesz oraz 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 instancji currentRouteSegment nie pasuje do typu DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) ani DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

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

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

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

Ciąg znaków zakodowany w formacie Base64.
currentRouteSegmentEndPoint

object (LatLng)

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

To pole jest ignorowane w wywołaniach deliveryVehicles.patch, jeśli pole currentRouteSegment jest puste.
remainingDistanceMeters

integer

Pozostały dystans jazdy samochodem przez currentRouteSegment. To pole jest zwykle dostępne w aplikacji Kierowca, ale w niektórych okolicznościach 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 zasadzie Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) lub Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) w przypadku wszystkich aktywnych zasobów typu Task przypisanych do pojazdu dostawczego.

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

string (Duration format)

Pozostały czas jazdy w przypadku currentRouteSegment. To pole jest zwykle dostępne w aplikacji Kierowca, ale w niektórych okolicznościach 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 metodzie 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 elementach UpdateDeliveryVehicleRequest, jeśli pole currentRouteSegment jest puste.

Czas w sekundach z maksymalnie 9 miejscami po przecinku, zakończony literą „s”. Przykład: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Segmenty podróży przypisane do tego pojazdu dostawczego, zaczynając od ostatnio zgłoszonej lokalizacji pojazdu. To pole nie zostanie wypełnione w odpowiedzi na żądanie deliveryVehicles.list.
attributes[]

object (DeliveryVehicleAttribute)

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

enum (DeliveryVehicleType)

Typ tego pojazdu dostawy. Jeśli nie są ustawione, domyślna wartość to AUTO.

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 nawigacja zakręt po zakrętem, a nawigacja w aplikacji Kierowca przeszła w tryb GUIDED_NAV.
OFF_ROUTE Pojazd zjechał z sugerowanej trasy.
ARRIVED_AT_DESTINATION Pojazd znajduje się w odległości około 50 m od miejsca docelowego.

DeliveryVehicleAttribute

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

Zapis JSON 
{
  "key": string,
  "value": string,

  // Union field delivery_vehicle_attribute_value can be only one of the
  // following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field
  // delivery_vehicle_attribute_value.
}
Pola
key

string

Klucz atrybutu.
value

string

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:
stringValue

string

Wartość atrybutu z ciągiem znaków.

Uwaga: działa tak samo jak pole value, które z czasem zostanie wycofane. Do tworzenia i aktualizacji danych możesz użyć dowolnego z tych pól, ale zdecydowanie zalecamy użycie stringValue. Jeśli opcje stringValue i value są ustawione, muszą być identyczne, w przeciwnym razie wystąpi błąd. Oba pola są wypełniane w odpowiedziach.
boolValue

boolean

Wartość atrybutu z wartością logiczną.
numberValue

number

Wartość atrybutu typu podwójnego.

DeliveryVehicleType

Typ pojazdu dostawy.

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 siłą ludzkich mięśni.
PEDESTRIAN Osobisty środek transportu, zwykle pieszo lub biegnący po ścieżkach.

Metody

create

 Tworzy i zwraca nowy obiekt DeliveryVehicle.

get

 Zwraca podaną instancję DeliveryVehicle.

list

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

patch

 Zapisuje zaktualizowane dane DeliveryVehicle w Fleet Engine i przypisuje Tasks do DeliveryVehicle.