REST Resource: providers.tasks

Resource: Task

Tugas di Delivery API mewakili satu tindakan yang akan dilacak. Secara umum, ada perbedaan antara Tugas terkait pengiriman dan Tugas istirahat. Pengiriman dapat memiliki beberapa Tugas yang terkait dengannya. Misalnya, mungkin ada satu Tugas untuk pengambilan, dan satu lagi untuk pengantaran atau transfer. Selain itu, Tugas yang berbeda untuk pengiriman tertentu dapat ditangani oleh kendaraan yang berbeda. Misalnya, satu kendaraan dapat menangani pengambilan, yang mengangkut paket ke hub, sementara kendaraan lain mengangkut paket yang sama dari hub ke lokasi pengantaran.

Catatan: gRPC dan REST API menggunakan konvensi penamaan kolom yang berbeda. Misalnya, kolom Task.journey_sharing_info di gRPC API dan kolom Task.journeySharingInfo di REST API merujuk ke kolom yang sama.

Representasi JSON 
{
  "name": string,
  "type": enum (Type),
  "state": enum (State),
  "taskOutcome": enum (TaskOutcome),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfo)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSource),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfo)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindow)
  },
  "journeySharingInfo": {
    object (JourneySharingInfo)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfig)
  },
  "attributes": [
    {
      object (TaskAttribute)
    }
  ]
}
Kolom
name

string

Harus dalam format providers/{provider}/tasks/{task}.
type

enum (Type)

Wajib. Tidak dapat diubah. Menentukan jenis Tugas. Misalnya, istirahat atau pengiriman.
state

enum (State)

Wajib. Status eksekusi Tugas saat ini.
taskOutcome

enum (TaskOutcome)

Hasil Tugas.
taskOutcomeTime

string (Timestamp format)

Stempel waktu yang menunjukkan kapan hasil Task ditetapkan oleh penyedia.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
taskOutcomeLocation

object (LocationInfo)

Lokasi tempat hasil Task ditetapkan. Nilai ini diperbarui sebagai bagian dari tasks.patch. Jika nilai ini tidak diperbarui secara eksplisit oleh penyedia, Fleet Engine akan mengisinya secara default dengan lokasi kendaraan terakhir yang diketahui (lokasi mentah).
taskOutcomeLocationSource

enum (TaskOutcomeLocationSource)

Menunjukkan sumber nilai taskOutcomeLocation.
trackingId

string

Tidak dapat diubah. Kolom ini memfasilitasi penyimpanan ID sehingga Anda dapat menghindari penggunaan pemetaan yang rumit. Anda tidak dapat menetapkan trackingId untuk Tugas berjenis UNAVAILABLE dan SCHEDULED_STOP. ID ini tunduk pada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga maksimum 64 karakter.
  • Dinormalisasi sesuai dengan Unicode Normalization Form C.
  • Tidak boleh berisi salah satu karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
deliveryVehicleId

string

Hanya output. ID kendaraan yang menjalankan Tugas ini. ID Kendaraan Pengiriman tunduk pada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga maksimum 64 karakter.
  • Dinormalisasi sesuai dengan Unicode Normalization Form C.
  • Tidak boleh berisi salah satu karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
plannedLocation

object (LocationInfo)

Tidak dapat diubah. Lokasi tempat Tugas akan diselesaikan. Opsional untuk Tugas UNAVAILABLE, tetapi wajib untuk semua Tugas lainnya.
taskDuration

string (Duration format)

Wajib. Tidak dapat diubah. Waktu yang diperlukan untuk menjalankan Tugas di lokasi ini.

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

object (TimeWindow)

Periode waktu selama tugas harus diselesaikan.
journeySharingInfo

object (JourneySharingInfo)

Hanya output. Kolom khusus berbagi perjalanan. Tidak diisi jika statusnya CLOSED.
taskTrackingViewConfig

object (TaskTrackingViewConfig)

Konfigurasi untuk pelacakan tugas yang menentukan elemen data mana yang terlihat oleh pengguna akhir dalam situasi apa.
attributes[]

object (TaskAttribute)

Daftar atribut Tugas kustom. Setiap atribut harus memiliki kunci unik.

Jenis

Jenis Tugas.

Enum
TYPE_UNSPECIFIED Secara default, jenis Tugas tidak diketahui.
PICKUP Tugas pengambilan adalah tindakan yang dilakukan untuk mengambil paket dari pelanggan. Pengambilan kendaraan feeder atau depot harus menggunakan jenis SCHEDULED_STOP.
DELIVERY Tugas pengiriman adalah tindakan yang dilakukan untuk mengirimkan paket kepada pelanggan akhir. Penurunan kendaraan feeder atau depot harus menggunakan jenis SCHEDULED_STOP.
SCHEDULED_STOP Tugas perhentian terjadwal digunakan untuk tujuan perencanaan. Misalnya, ini dapat mewakili pengambilan atau pengantaran pengiriman dari kendaraan atau depot feeder. Kode ini tidak boleh digunakan untuk pengiriman apa pun yang diambil atau diantar dari pelanggan akhir.
UNAVAILABLE Tugas yang berarti Kendaraan tidak tersedia untuk diservis. Misalnya, hal ini dapat terjadi saat pengemudi beristirahat, atau saat kendaraan mengisi bahan bakar.

TaskOutcomeLocationSource

Identitas sumber yang mengisi taskOutcomeLocation.

Enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Hasil tugas sebelum ditetapkan.
PROVIDER Penyedia menentukan taskOutcomeLocation.
LAST_VEHICLE_LOCATION Penyedia tidak menentukan taskOutcomeLocation, sehingga Fleet Engine menggunakan lokasi kendaraan terakhir yang diketahui.

JourneySharingInfo

Perjalanan membagikan kolom tertentu.

Representasi JSON 
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}
Kolom
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Melacak informasi untuk perhentian yang akan dilakukan kendaraan yang ditetapkan sebelum menyelesaikan Tugas ini. Perhatikan bahwa daftar ini dapat berisi perhentian dari tugas lain.

Segmen pertama, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), berisi informasi rute dari lokasi terakhir yang diketahui pengemudi ke VehicleStop mendatang. Informasi rute saat ini biasanya berasal dari aplikasi pengemudi, kecuali untuk beberapa kasus yang disebutkan dalam dokumentasi untuk DeliveryVehicle.current_route_segment. Segmen lain di Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments (REST) diisi oleh Fleet Engine. Informasi ini memberikan informasi rute antara VehicleStops yang tersisa.
lastLocation

object (DeliveryVehicleLocation)

Menunjukkan lokasi terakhir yang dilaporkan kendaraan yang ditetapkan.
lastLocationSnappable

boolean

Menunjukkan apakah lastLocation kendaraan dapat disambungkan ke currentRouteSegment. Nilai ini adalah Salah jika lastLocation atau currentRouteSegment tidak ada. Nilai ini dihitung oleh Fleet Engine. Pembaruan dari klien akan diabaikan.

TaskTrackingViewConfig

Pesan konfigurasi yang menentukan kapan elemen data Tugas harus terlihat oleh pengguna akhir.

Representasi JSON 
{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}
Kolom
routePolylinePointsVisibility

object (VisibilityOption)

Kolom yang menentukan kapan titik polyline rute dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default tingkat project untuk data ini akan digunakan.
estimatedArrivalTimeVisibility

object (VisibilityOption)

Kolom yang menentukan kapan perkiraan waktu tiba dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default tingkat project untuk data ini akan digunakan.
estimatedTaskCompletionTimeVisibility

object (VisibilityOption)

Kolom yang menentukan kapan perkiraan waktu penyelesaian tugas dapat dilihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default tingkat project untuk data ini akan digunakan.
remainingDrivingDistanceVisibility

object (VisibilityOption)

Kolom yang menentukan kapan jarak mengemudi yang tersisa dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default tingkat project untuk data ini akan digunakan.
remainingStopCountVisibility

object (VisibilityOption)

Kolom yang menentukan kapan jumlah perhentian yang tersisa dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default tingkat project untuk data ini akan digunakan.
vehicleLocationVisibility

object (VisibilityOption)

Kolom yang menentukan kapan lokasi kendaraan dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default tingkat project untuk data ini akan digunakan.

VisibilityOption

Pesan opsi yang menentukan kapan elemen data harus terlihat oleh pengguna akhir.

Representasi JSON 
{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}
Kolom
Kolom union visibility_option. Opsi visibilitas tertentu yang dipilih. visibility_option hanya dapat berupa salah satu dari berikut:
remainingStopCountThreshold

integer

Elemen data ini dapat dilihat oleh pengguna akhir jika jumlah perhentian yang tersisa <= remainingStopCountThreshold.
durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

Elemen data ini dapat dilihat oleh pengguna akhir jika perkiraan waktu tiba ke perhentian <= durationUntilEstimatedArrivalTimeThreshold.

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

integer

Elemen data ini dapat dilihat oleh pengguna akhir jika sisa jarak mengemudi dalam meter <= remainingDrivingDistanceMetersThreshold.
always

boolean

Jika disetel ke benar (true), elemen data ini akan selalu terlihat oleh pengguna akhir tanpa nilai minimum. Kolom ini tidak dapat ditetapkan ke salah (false).
never

boolean

Jika disetel ke benar (true), elemen data ini selalu disembunyikan dari pengguna akhir tanpa nilai minimum. Kolom ini tidak dapat ditetapkan ke salah (false).

Metode

batchCreate

 Membuat dan menampilkan batch objek Task baru.

create

 Membuat dan menampilkan objek Task baru.

delete

 Menghapus satu Tugas.

get

 Mendapatkan informasi tentang Task.

list

 Mendapatkan semua Task yang memenuhi kriteria pemfilteran yang ditentukan.

patch

 Memperbarui data Task.