Method: projects.optimizeTours

Mengirim OptimizeToursRequest yang berisi ShipmentModel dan menampilkan OptimizeToursResponse yang berisi ShipmentRoute, yang merupakan kumpulan rute yang akan dilakukan dengan kendaraan yang meminimalkan biaya keseluruhan.

Model ShipmentModel sebagian besar terdiri dari Shipment yang perlu dilakukan dan Vehicle yang dapat digunakan untuk memindahkan Shipment. ShipmentRoute menetapkan Shipment ke Vehicle. Lebih khusus lagi, mereka menetapkan serangkaian Visit untuk setiap kendaraan, dengan Visit sesuai dengan VisitRequest, yang merupakan layanan pengambilan atau pengiriman untuk Shipment.

Tujuannya adalah untuk memberikan penetapan ShipmentRoute ke Vehicle yang meminimalkan total biaya ketika biaya memiliki banyak komponen yang ditentukan di ShipmentModel.

Permintaan HTTP

POST https://routeoptimization.googleapis.com/v1/{parent=projects/*}:optimizeTours

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Targetkan project atau lokasi untuk melakukan panggilan.

Format: * projects/{project-id} * projects/{project-id}/locations/{location-id}

Jika tidak ada lokasi yang ditentukan, wilayah akan dipilih secara otomatis.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "timeout": string,
  "model": {
    object (ShipmentModel)
  },
  "solvingMode": enum (SolvingMode),
  "searchMode": enum (SearchMode),
  "injectedFirstSolutionRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "injectedSolutionConstraint": {
    object (InjectedSolutionConstraint)
  },
  "refreshDetailsRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "interpretInjectedSolutionsUsingLabels": boolean,
  "considerRoadTraffic": boolean,
  "populatePolylines": boolean,
  "populateTransitionPolylines": boolean,
  "allowLargeDeadlineDespiteInterruptionRisk": boolean,
  "useGeodesicDistances": boolean,
  "label": string,
  "geodesicMetersPerSecond": number,
  "maxValidationErrors": integer
}
Kolom
timeout

string (Duration format)

Jika waktu tunggu ini disetel, server akan menampilkan respons sebelum periode waktu tunggu berlalu atau batas waktu server untuk permintaan sinkron tercapai, mana saja yang lebih cepat.

Untuk permintaan asinkron, server akan membuat solusi (jika memungkinkan) sebelum waktu tunggu berlalu.

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

model

object (ShipmentModel)

Model pengiriman yang harus diselesaikan.

solvingMode

enum (SolvingMode)

Secara default, mode penyelesaiannya adalah DEFAULT_SOLVE (0).

searchMode

enum (SearchMode)

Mode penelusuran yang digunakan untuk menyelesaikan permintaan.

injectedFirstSolutionRoutes[]

object (ShipmentRoute)

Memandu algoritma pengoptimalan dalam menemukan solusi pertama yang mirip dengan solusi sebelumnya.

Model dibatasi saat solusi pertama dibuat. Setiap pengiriman yang tidak dilakukan di suatu rute secara implisit dilewati pada solusi pertama, tetapi pengiriman tersebut dapat dilakukan secara berturut-turut.

Solusi ini harus memenuhi beberapa asumsi validitas dasar:

  • untuk semua rute, vehicleIndex harus berada dalam jangkauan dan tidak diduplikasi.
  • untuk semua kunjungan, shipmentIndex dan visitRequestIndex harus berada dalam rentang.
  • pengiriman hanya dapat dirujuk pada satu rute.
  • pengambilan dengan pengiriman dengan pengantaran harus dilakukan sebelum pengantaran.
  • tidak lebih dari satu alternatif pengambilan atau alternatif pengiriman yang dapat dilakukan.
  • untuk semua rute, waktu akan bertambah (misalnya, vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime).
  • pengiriman hanya dapat dilakukan dengan kendaraan yang diizinkan. Kendaraan diizinkan jika Shipment.allowed_vehicle_indices kosong atau vehicleIndex miliknya disertakan dalam Shipment.allowed_vehicle_indices.

Jika solusi yang dimasukkan tidak memungkinkan, error validasi belum tentu ditampilkan dan error yang menunjukkan ketidaklayakan dapat ditampilkan.

injectedSolutionConstraint

object (InjectedSolutionConstraint)

Membatasi algoritma pengoptimalan untuk menemukan solusi akhir yang mirip dengan solusi sebelumnya. Misalnya, perintah ini dapat digunakan untuk membekukan bagian rute yang telah selesai atau yang harus diselesaikan tetapi tidak boleh diubah.

Jika solusi yang dimasukkan tidak memungkinkan, error validasi belum tentu ditampilkan dan error yang menunjukkan ketidaklayakan dapat ditampilkan.

refreshDetailsRoutes[]

object (ShipmentRoute)

Jika tidak kosong, rute yang ditentukan akan diperbarui, tanpa mengubah urutan kunjungan atau waktu perjalanan yang mendasarinya: hanya detail lain yang akan diperbarui. Ini tidak menyelesaikan model.

Mulai 2020/11, kode ini hanya mengisi polyline rute yang tidak kosong dan mengharuskan populatePolylines bernilai benar (true).

Kolom routePolyline dari rute yang diteruskan mungkin tidak konsisten dengan rute transitions.

Kolom ini tidak boleh digunakan bersama dengan injectedFirstSolutionRoutes atau injectedSolutionConstraint.

Shipment.ignore dan Vehicle.ignore tidak berpengaruh pada perilaku tersebut. Polyline masih diisi di antara semua kunjungan di semua rute yang tidak kosong, terlepas dari apakah pengiriman atau kendaraan terkait diabaikan.

interpretInjectedSolutionsUsingLabels

boolean

Jika true (benar):

Penafsiran ini berlaku untuk kolom injectedFirstSolutionRoutes, injectedSolutionConstraint, dan refreshDetailsRoutes. Solusi ini dapat digunakan jika indeks pengiriman atau kendaraan dalam permintaan telah berubah sejak solusi dibuat, mungkin karena pengiriman atau kendaraan telah dihapus dari atau ditambahkan ke permintaan.

Jika benar, label dalam kategori berikut harus muncul paling banyak sekali dalam kategorinya:

Jika vehicleLabel dalam solusi yang dimasukkan tidak sesuai dengan kendaraan permintaan, rute yang sesuai akan dihapus dari solusi bersama dengan kunjungannya. Jika shipmentLabel dalam solusi yang dimasukkan tidak sesuai dengan pengiriman permintaan, kunjungan yang sesuai akan dihapus dari solusi. Jika SkippedShipment.label dalam solusi yang dimasukkan tidak sesuai dengan pengiriman permintaan, SkippedShipment akan dihapus dari solusi.

Menghapus kunjungan rute atau seluruh rute dari solusi yang dimasukkan dapat berpengaruh pada batasan tersirat, yang dapat menyebabkan perubahan pada solusi, error validasi, atau ketidaklayakan.

CATATAN: Pemanggil harus memastikan bahwa setiap Vehicle.label (respons Shipment.label) secara unik mengidentifikasi entity kendaraan (pengiriman responsif) yang digunakan di dua permintaan yang relevan: permintaan sebelumnya yang menghasilkan OptimizeToursResponse yang digunakan dalam solusi yang dimasukkan dan permintaan saat ini yang menyertakan solusi yang dimasukkan. Pemeriksaan keunikan yang dijelaskan di atas tidak cukup untuk menjamin persyaratan ini.

considerRoadTraffic

boolean

Pertimbangkan estimasi lalu lintas saat menghitung kolom ShipmentRoute Transition.travel_duration, Visit.start_time, dan vehicleEndTime; saat menetapkan kolom ShipmentRoute.has_traffic_infeasibilities, serta saat menghitung kolom OptimizeToursResponse.total_cost.

populatePolylines

boolean

Jika true (benar), polyline akan diisi dalam ShipmentRoute respons.

populateTransitionPolylines

boolean

Jika true (benar), polyline akan diisi dalam ShipmentRoute.transitions respons.

allowLargeDeadlineDespiteInterruptionRisk

boolean

Jika kebijakan ini disetel, permintaan dapat memiliki batas waktu (lihat https://grpc.io/blog/deadlines) hingga 60 menit. Jika tidak, batas waktu maksimum hanya 30 menit. Perlu diketahui bahwa permintaan yang telah berlangsung lama memiliki risiko gangguan yang lebih besar (tetapi masih kecil) secara signifikan.

useGeodesicDistances

boolean

Jika benar, jarak perjalanan akan dihitung menggunakan jarak geodesi, bukan jarak Google Maps, dan waktu perjalanan akan dihitung menggunakan jarak geodesi dengan kecepatan yang ditentukan oleh geodesicMetersPerSecond.

label

string

Label yang dapat digunakan untuk mengidentifikasi permintaan ini, dilaporkan kembali di OptimizeToursResponse.request_label.

geodesicMetersPerSecond

number

Jika useGeodesicDistances bernilai benar (true), kolom ini harus ditetapkan dan menentukan kecepatan yang diterapkan untuk menghitung waktu perjalanan. Nilainya harus setidaknya 1,0 meter/detik.

maxValidationErrors

integer

Memotong jumlah error validasi yang ditampilkan. Error ini biasanya dilampirkan ke payload error INVALID_ARGUMENT sebagai detail error BadRequest (https://cloud.google.com/apis/design/errors#error_details), kecuali jika solvingMode=VALIDATE_ONLY: lihat kolom OptimizeToursResponse.validation_errors. Nilai defaultnya adalah 100 dan dibatasi hingga 10.000.

Isi respons

Jika berhasil, isi respons akan berisi instance OptimizeToursResponse.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/cloud-platform