REST Resource: providers.deliveryVehicles

Resource: DeliveryVehicle

Pesan DeliveryVehicle. Kendaraan pengiriman mengangkut paket dari depot ke lokasi pengiriman, dan dari lokasi pengambilan ke depot. Dalam beberapa kasus, kendaraan pengiriman juga mengangkut kiriman langsung dari lokasi pengambilan ke lokasi pengiriman.

Catatan: gRPC dan REST API menggunakan konvensi penamaan kolom yang berbeda. Misalnya, kolom DeliveryVehicle.current_route_segment di gRPC API dan kolom DeliveryVehicle.currentRouteSegment di REST API merujuk ke kolom yang sama.

Representasi 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)
}
Kolom
name

string

Nama unik Kendaraan Pengiriman ini. Formatnya adalah providers/{provider}/deliveryVehicles/{vehicle}.

lastLocation

object (DeliveryVehicleLocation)

Lokasi terakhir yang dilaporkan dari Kendaraan Pengiriman.

navigationStatus

enum (DeliveryVehicleNavigationStatus)

Status navigasi Kendaraan Pengiriman.

currentRouteSegment

string (bytes format)

Polyline yang dienkode yang menentukan rute yang direkomendasikan navigasi untuk diambil ke titik jalan berikutnya. Aplikasi pengemudi Anda akan memperbarui informasi ini saat perhentian dicapai atau dilewati, dan saat navigasi mengubah rute. LatLng ini ditampilkan di Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) untuk semua Tugas aktif yang ditetapkan ke Kendaraan.

Ada beberapa kasus ketika kolom ini mungkin tidak digunakan untuk mengisi Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • Endpoint currentRouteSegment tidak cocok dengan DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) atau DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • Aplikasi pengemudi belum memperbarui lokasinya baru-baru ini, sehingga nilai yang terakhir diperbarui untuk kolom ini mungkin sudah tidak berlaku.

  • Aplikasi pengemudi baru-baru ini memperbarui lokasinya, tetapi currentRouteSegment sudah tidak berlaku, dan mengarah ke perhentian kendaraan sebelumnya.

Dalam hal ini, Fleet Engine mengisi kolom ini dengan rute dari VehicleStop yang baru saja dilewati ke VehicleStop berikutnya untuk memastikan bahwa konsumen kolom ini memiliki informasi terbaik yang tersedia di jalur Kendaraan Pengiriman saat ini.

String berenkode base64.

currentRouteSegmentEndPoint

object (LatLng)

Lokasi tempat currentRouteSegment berakhir. Saat ini kolom ini tidak diisi oleh aplikasi driver, tetapi Anda dapat menyediakannya pada panggilan deliveryVehicles.patch. Ini adalah LatLng dari perhentian kendaraan mendatang, atau LatLng terakhir dari currentRouteSegment. Fleet Engine kemudian akan melakukan yang terbaik untuk berinterpolasi ke VehicleStop yang sebenarnya.

Kolom ini diabaikan dalam panggilan deliveryVehicles.patch jika kolom currentRouteSegment kosong.

remainingDistanceMeters

integer

Jarak mengemudi yang tersisa untuk currentRouteSegment. Aplikasi Pengemudi biasanya menyediakan kolom ini, tetapi ada beberapa situasi saat Fleet Engine akan mengganti nilai yang dikirim oleh aplikasi. Untuk informasi selengkapnya, lihat DeliveryVehicle.current_route_segment. Kolom ini ditampilkan di Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) atau Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) untuk semua Task aktif yang ditetapkan ke Kendaraan Pengiriman.

Fleet Engine mengabaikan kolom ini di UpdateDeliveryVehicleRequest jika kolom currentRouteSegment kosong.

remainingDuration

string (Duration format)

Sisa waktu mengemudi untuk currentRouteSegment. Aplikasi Pengemudi biasanya menyediakan kolom ini, tetapi ada beberapa situasi saat Fleet Engine akan mengganti nilai yang dikirim oleh aplikasi. Untuk informasi selengkapnya, lihat DeliveryVehicle.current_route_segment. Kolom ini ditampilkan di Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) atau Task.remainingVehicleJourneySegments[0].drivingDuration (REST) untuk semua tugas aktif yang ditetapkan ke Kendaraan Pengiriman.

Fleet Engine mengabaikan kolom ini di UpdateDeliveryVehicleRequest jika kolom currentRouteSegment kosong.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Segmen perjalanan yang ditetapkan ke Kendaraan Pengiriman ini, mulai dari lokasi Kendaraan yang terakhir dilaporkan. Kolom ini tidak akan diisi dalam respons deliveryVehicles.list.

attributes[]

object (DeliveryVehicleAttribute)

Daftar atribut Kendaraan Pengiriman kustom. Kendaraan Pengiriman dapat memiliki maksimal 100 atribut, dan setiap atribut harus memiliki kunci unik.

type

enum (DeliveryVehicleType)

Jenis kendaraan pengiriman ini. Jika tidak ditetapkan, setelan defaultnya adalah AUTO.

DeliveryVehicleNavigationStatus

Status navigasi kendaraan.

Enum
UNKNOWN_NAVIGATION_STATUS Status navigasi tidak ditentukan.
NO_GUIDANCE Navigasi aplikasi Pengemudi dalam mode FREE_NAV.
ENROUTE_TO_DESTINATION Navigasi belokan demi belokan tersedia dan navigasi aplikasi Pengemudi telah memasuki mode GUIDED_NAV.
OFF_ROUTE Kendaraan keluar dari rute yang disarankan.
ARRIVED_AT_DESTINATION Kendaraan berada dalam jarak sekitar 50 m dari tujuan.

DeliveryVehicleAttribute

Menjelaskan atribut kendaraan sebagai pasangan nilai kunci. Panjang string "key:value" tidak boleh melebihi 256 karakter.

Representasi 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.
}
Kolom
key

string

Kunci atribut.

value

string

Nilai atribut.

Kolom union delivery_vehicle_attribute_value. Nilai atribut, dapat berupa jenis string, bool, atau double. delivery_vehicle_attribute_value hanya dapat berupa salah satu dari berikut:
stringValue

string

Nilai atribut berjenis string.

Catatan: Ini sama dengan kolom value yang pada akhirnya tidak akan digunakan lagi. Untuk metode pembuatan atau pembaruan, kedua kolom dapat digunakan, tetapi sangat direkomendasikan untuk menggunakan stringValue. Jika stringValue dan value ditetapkan, keduanya harus identik atau error akan ditampilkan. Kedua kolom diisi dalam respons.

boolValue

boolean

Nilai atribut berjenis boolean.

numberValue

number

Nilai atribut berjenis ganda.

DeliveryVehicleType

Jenis kendaraan pengiriman.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Nilai tidak digunakan.
AUTO Mobil.
TWO_WHEELER Sepeda motor, moped, atau kendaraan roda dua lainnya
BICYCLE Transportasi yang digerakkan manusia.
PEDESTRIAN Pengangkut manusia, biasanya berjalan atau berlari, yang melintasi jalur pejalan kaki.

Metode

create

Membuat dan menampilkan DeliveryVehicle baru.

get

Menampilkan instance DeliveryVehicle yang ditentukan.

list

Mendapatkan semua DeliveryVehicle yang memenuhi kriteria pemfilteran yang ditentukan.

patch

Menulis data DeliveryVehicle yang diperbarui ke Fleet Engine, dan menetapkan Tasks ke DeliveryVehicle.