Struktur dasar (ShipmentModel, Shipment, dan Vehicle)

ShipmentModel memiliki satu objek `shipments` dengan jenis pesan `Shipment` dan satu objek `vehicles` dengan jenis pesan `Vehicle`.

Tujuan Route Optimization API adalah merencanakan rute untuk sekumpulan kendaraan agar mengunjungi serangkaian lokasi. Objek OptimizeToursRequest menjelaskan properti kendaraan dan lokasi ini serta merupakan struktur utama isi permintaan setiap endpoint.

Struktur dasar objek OptimizeToursRequest adalah sebagai berikut:

Dokumen ini menjelaskan jenis pesan berikut:

  • ShipmentModel: Berisi daftar pengiriman, kendaraan yang tersedia, dan objek lain yang menjelaskan hubungannya.
  • Shipment: Mendeskripsikan lokasi yang akan dikunjungi oleh kendaraan. Objek ini dapat mewakili paket sebenarnya yang harus diambil dan dikirimkan atau tempat pengemudi kendaraan melakukan layanan.
  • Vehicle: Menjelaskan sarana transportasi antara lokasi pengiriman. Setiap kendaraan sesuai dengan kendaraan sebenarnya atau orang yang bergerak dengan berjalan kaki.

ShipmentModel

ShipmentModel menyimpan elemen masalah pengoptimalan rute. Objek ini berisi serangkaian pengiriman yang dapat dilakukan oleh serangkaian kendaraan, dengan mempertimbangkan batasan dan meminimalkan biaya keseluruhan.

Tabel di bawah menjelaskan beberapa properti ShipmentModel yang relevan:

Properti Deskripsi
shipments dan vehicles Objek wajib yang berisi detail satu atau banyak pengiriman dan kendaraan.
globalStartTime dan globalEndTime Menunjukkan awal dan akhir jangka waktu saat semua kendaraan harus menyelesaikan semua pengiriman. Meskipun properti ini tidak wajib, sebaiknya sertakan properti ini karena pengoptimal berfungsi paling baik saat mematuhi batasan waktu.

Lihat dokumentasi referensi untuk mengetahui daftar lengkap properti di ShipmentModel.

Contoh ShipmentModel

Dalam contoh ini, Anda memiliki layanan penitipan dan mulai membuat permintaan. Anda akan menentukan pengiriman dan kendaraan nanti, tetapi Anda ingin memulai dengan menetapkan jam buka dan biaya operasional per jam.

Untuk contoh ini, nilai properti ShipmentModel dalam permintaan Anda adalah sebagai berikut:

Properti Nilai Deskripsi
globalStartTime 2024-02-13T00:00:00.000Z Tanggal dan waktu mulai jam buka.
globalEndTime 2024-02-14T06:00:00.000Z Tanggal dan waktu berakhir jam buka.

Berikut adalah contoh kode pesan ShipmentModel yang menggabungkan nilai skenario contoh.

{
  "model": {
    "shipments": [
      ...
    ],
    "vehicles": [
      ...
    ],
   "globalStartTime": "2024-02-13T00:00:00.000Z",
   "globalEndTime": "2024-02-14T06:00:00.000Z"
  }
}

Shipment

Jenis pesan Shipment menentukan struktur properti pengiriman yang dapat dikirim atau layanan yang dapat dilakukan di rute.

Pengiriman di kehidupan nyata sama dengan satu pesan `Shipment`, yang terdapat dalam objek `shipments`

Seperti yang diilustrasikan dalam diagram:

Pesan Shipment memerlukan setidaknya satu objek pickups atau deliveries. Definisi objek ini adalah sebagai berikut:

Tabel berikut menjelaskan berbagai skenario berdasarkan konfigurasi pickups dan deliveries dalam pesan Shipment.

Skenario Deskripsi
pickups saja Diasumsikan Anda hanya mengumpulkan kiriman.
deliveries saja Diasumsikan Anda telah memuat pengiriman sebelumnya atau sedang memberikan layanan.
pickups dan deliveries Kendaraan yang ditugaskan harus menyelesaikan pengambilan terlebih dahulu, lalu pengiriman. Hanya kendaraan yang melakukan pengambilan yang dapat melakukan pengiriman.
Beberapa pickups atau deliveries Jika pengiriman mencantumkan beberapa kemungkinan untuk pickups atau deliveries, pengoptimal memilih satu opsi pengambilan dan satu opsi pengiriman untuk digunakan, berdasarkan minimisasi biaya dan pemenuhan batasan.

Lihat dokumentasi referensi untuk mengetahui daftar lengkap properti di Shipment.

Contoh Shipment

Dalam contoh ini, Anda memiliki layanan penitipan di mana Anda menjemput dari rumahnya dan mengantarkannya ke tempat penitipan Anda. Anda ingin menetapkan lokasi pengambilan dua, dan menetapkan lokasi pengiriman ke bisnis Anda:

  • Rumah pertama berada di Coit Tower, San Francisco. Koordinat ke lokasi ini adalah lintang 37.8024 dan bujur -122.4058.
  • Rumah kedua berada di South Sunset Playground Park, San Francisco. Koordinat lokasi ini adalah lintang 37.7359 dan bujur -122.5011.
  • Penitipan Anda berada di Mission Dolores Park, San Francisco. Koordinat ke lokasi ini adalah lintang 37.759773 dan bujur -122.427063.

Berikut adalah contoh kode pesan Shipment, dengan objek shipments berisi dua jenis pesan Shipment dengan contoh koordinat.

{
  "model": {
    "shipments": [
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.8024,
              "longitude": -122.4058
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      },
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.7359,
              "longitude": -122.5011
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      }
    ],
    "vehicles": [
    ...
    ]
  }
}

Vehicle

Jenis pesan Vehicle menentukan struktur properti kendaraan yang dapat melakukan pengiriman dalam rute.

Kendaraan di dunia nyata sama dengan satu pesan `Vehicle`, yang terdapat dalam objek `vehicles`

Seperti yang diilustrasikan dalam diagram:

Tabel berikut menjelaskan beberapa properti yang relevan dari Vehicle.

Properti Deskripsi
startLocation dan endLocation Lokasi awal dan akhir kendaraan, yang merupakan bagian dari rute akhir yang dioptimalkan. Jika tidak ditentukan, lokasi ini akan ditetapkan secara default ke lokasi pengambilan pengiriman pertama dan pengiriman terakhir.
costPerHour, costPerKilometer, costPerTraveledHour Parameter biaya khusus kendaraan. Sebaiknya Anda memiliki setidaknya satu parameter biaya dalam permintaan agar API menampilkan rute yang dioptimalkan. Lihat konsep utama Model biaya untuk mempelajari biaya lebih lanjut.
startTimeWindows dan endTimeWindows Tentukan periode waktu saat kendaraan dapat beroperasi di rute. Waktu ini harus berada dalam periode waktu globalStartTime dan globalEndTime yang ditetapkan di ShipmentModel. Meskipun properti ini tidak wajib, sebaiknya sertakan properti ini karena pengoptimal berfungsi paling baik saat mematuhi batasan waktu.

Contoh Vehicle

Dalam contoh ini, Anda memiliki layanan penitipan dan ingin menentukan lokasi kendaraan Anda di awal dan akhir hari serta jumlah bahan bakar yang digunakan. Anda tidak perlu menentukan jam kerja kendaraan karena cocok dengan jam yang Anda tentukan di properti globalStartTime dan globalEndTime dalam objek ShipmentModel.

Untuk contoh ini, nilai properti Vehicle dalam permintaan Anda adalah sebagai berikut:

Properti Nilai Deskripsi
startLocation latitude: 37,759773, longitude: -122,427063 Koordinat awal rute untuk kendaraan Anda. Lokasi ini cocok dengan lokasi penitipan Anda yang berada di Mission Dolores Park, San Francisco.
endLocation latitude: 37,759773, longitude: -122,427063 Koordinat akhir rute untuk kendaraan Anda. Lokasi ini cocok dengan lokasi penitipan Anda yang berada di Mission Dolores Park, San Francisco.
costPerHour 27 Jumlah yang Anda bayar kepada pengemudi untuk mengemudikan kendaraan penitipan Anda. Anda membayar pengemudi 27 dolar per jam.

Berikut adalah contoh kode pesan Vehicle yang menggabungkan nilai skenario contoh.

{
  "model": {
    "shipments": [
    ...
    ],
    "vehicles": [
      {
        "startLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "endLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "costPerHour": 27
      }
    ]
  }
}

Lihat dokumentasi referensi untuk mengetahui daftar lengkap properti di Vehicle.

Contoh permintaan lengkap

Contoh kode berikut memberikan contoh permintaan lengkap, yang menggabungkan contoh ShipmentModel, Shipment, dan Vehicle yang ditampilkan dalam dokumen ini.

{
  "model": {
    "shipments": [
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.8024,
              "longitude": -122.4058
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      },
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.7359,
              "longitude": -122.5011
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      }
    ],
    "vehicles": [
      {
        "startLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "endLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "costPerHour": 27
      }
    ],
    "globalStartTime": "2024-02-13T00:00:00.000Z",
    "globalEndTime": "2024-02-14T06:00:00.000Z"
  }
}