REST Resource: providers.deliveryVehicles

Zasób: DeliveryVehicle

Wiadomość DeliveryVehicle. Pojazd dostawczy transportuje przesyłki z magazynu do miejsca dostawy oraz z miejsca odbioru do magazynu. W niektórych przypadkach pojazdy kurierskie transportują przesyłki bezpośrednio z miejsca odbioru do miejsca dostawy.

Uwaga: w interfejsach API gRPC i REST stosowane są różne konwencje nazewnictwa pól. Na przykład pole DeliveryVehicle.current_route_segment w interfejsie API gRPC i pole DeliveryVehicle.currentRouteSegment w interfejsie API REST odwołują 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

Unikalna 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ą zaleca nawigacja do następnego punktu na trasie. Aplikacja kierowcy aktualizuje te dane po dotarciu do przystanku lub po jego upływie, a także po zmianie trasy. Te LatLng są zwracane w funkcji Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) lub Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) w przypadku wszystkich aktywnych zadań przypisanych do pojazdu.

W niektórych przypadkach to pole może nie być używane do wypełniania właściwości Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) lub Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

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

  • Aplikacja sterownika nie zaktualizował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 nieaktualny i wskazuje poprzedni przystanek.

W takich przypadkach Fleet Engine wypełnia to pole trasą z ostatniego zaliczonego przejazdu VehicleStop do zbliżającego się VehicleStop, aby upewnić się, że klient korzystający z tego pola ma dostęp do aktualnych informacji o bieżącej trasie pojazdu dostarczającego.

Ciąg zakodowany w formacie base64.

currentRouteSegmentEndPoint

object (LatLng)

Lokalizacja, w której kończy się fragment currentRouteSegment. Te dane nie są obecnie wypełniane przez aplikację kierowcy, ale możesz je podać podczas połączeń z operatorem deliveryVehicles.patch. To LatLng z nadchodzącego przystanku lub LatLng currentRouteSegment. Fleet Engine postara się wtedy interpolować do rzeczywistego VehicleStop.

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

remainingDistanceMeters

integer

Pozostała odległość dojazdu samochodem z lotniska currentRouteSegment. Zazwyczaj to pole znajduje się w aplikacji Driver, ale w pewnych okolicznościach Fleet Engine zastąpi wartość przesłaną przez aplikację. Aby dowiedzieć się więcej, zobacz DeliveryVehicle.current_route_segment. To pole jest zwracane w funkcji Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) lub Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) w przypadku wszystkich aktywnych elementów 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 samochodem: currentRouteSegment. Zazwyczaj to pole znajduje się w aplikacji Driver, ale w pewnych okolicznościach Fleet Engine zastąpi wartość przesłaną przez aplikację. Aby dowiedzieć się więcej, zobacz DeliveryVehicle.current_route_segment. To pole jest zwracane w funkcji 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 currentRouteSegment jest puste.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „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 deliveryVehicles.list.

attributes[]

object (DeliveryVehicleAttribute)

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

type

enum (DeliveryVehicleType)

Typ pojazdu dostawczego. Jeśli zasada jest nieskonfigurowana, wartość domyślna 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 szczegółowa nawigacja zakręt po zakręcie, a nawigacja w aplikacji kierowcy włączyła tryb GUIDED_NAV.
OFF_ROUTE Pojazd zjechał z sugerowanej trasy.
ARRIVED_AT_DESTINATION Pojazd znajduje się w promieniu około 50 m od miejsca docelowego.

DeliveryVehicleAttribute

Opisuje atrybut pojazdu jako parę klucz-wartość. Długość ciągu „klucz:wartość” 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 sumy 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 wpisana na podstawie ciągu znaków.

Uwaga: ta wartość jest taka sama jak wartość pola value, które zostanie w końcu wycofane. W przypadku metod tworzenia lub aktualizacji można użyć dowolnego z tych pól, ale zdecydowanie zalecamy używanie pola stringValue. Jeśli ustawiono zarówno stringValue, jak i value, muszą one być identyczne. W przeciwnym razie zostanie zgłoszony błąd. Oba pola są wypełniane w odpowiedziach.

boolValue

boolean

Wartość atrybutu o typie wartości logicznej.

numberValue

number

Wartość atrybutu z podwójnym wpisanym.

DeliveryVehicleType

Typ pojazdu dostawczego.

Wartości w polu enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Wartość nie jest używana.
AUTO Samochód.
TWO_WHEELER Motocykl, motorower lub inny pojazd dwukołowy
BICYCLE Transport oparty na ludziach.
PEDESTRIAN Transporter, zwykle idący lub biegnący, poruszający się po chodnikach.

Metody

create

Tworzy i zwraca nowy obiekt DeliveryVehicle.

get

Zwraca określoną instancję DeliveryVehicle.

list

Pobiera wszystkie encje DeliveryVehicle spełniające określone kryteria filtrowania.

patch

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