Method: computeRoutes

Menampilkan rute utama beserta rute alternatif opsional, dengan menetapkan titik jalan terminal dan perantara.

CATATAN: Metode ini mengharuskan Anda menentukan mask kolom respons dalam input. Anda dapat memberikan mask kolom respons menggunakan parameter URL $fields atau fields, atau menggunakan header HTTP/gRPC X-Goog-FieldMask (lihat parameter dan header URL yang tersedia. Nilainya adalah daftar jalur kolom yang dipisahkan koma. Lihat dokumentasi mendetail tentang cara membuat jalur kolom.

Misalnya, dalam metode ini:

  • Mask kolom untuk semua kolom yang tersedia (untuk pemeriksaan manual): X-Goog-FieldMask: *
  • Mask kolom untuk durasi tingkat Rute, jarak, dan polyline (contoh penyiapan produksi): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google tidak menyarankan penggunaan mask kolom respons karakter pengganti (*), atau menetapkan mask kolom di tingkat atas (routes), karena:

  • Memilih hanya kolom yang Anda perlukan akan membantu server kami menghemat siklus komputasi, sehingga kami dapat menampilkan hasilnya kepada Anda dengan latensi yang lebih rendah.
  • Memilih hanya kolom yang Anda perlukan dalam tugas produksi akan memastikan performa latensi yang stabil. Kami mungkin menambahkan lebih banyak kolom respons di masa mendatang, dan kolom baru tersebut mungkin memerlukan waktu komputasi tambahan. Jika Anda memilih semua kolom, atau jika memilih semua kolom di tingkat teratas, Anda mungkin akan mengalami penurunan performa karena kolom baru yang kami tambahkan akan otomatis disertakan dalam respons.
  • Memilih hanya kolom yang Anda perlukan akan menghasilkan ukuran respons yang lebih kecil, sehingga throughput jaringan lebih tinggi.

Permintaan HTTP

POST https://routespreferred.googleapis.com/v1alpha:computeRoutes

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean
}
Kolom
origin

object (Waypoint)

Wajib. Titik jalan asal.
destination

object (Waypoint)

Wajib. Titik jalan tujuan.
intermediates[]

object (Waypoint)

Opsional. Kumpulan titik jalan di sepanjang rute (tidak termasuk titik terminal), untuk berhenti di atau lewat. Hingga 25 titik jalan perantara didukung.
travelMode

enum (RouteTravelMode)

Opsional. Menentukan moda transportasi.
routingPreference

enum (RoutingPreference)

Opsional. Menentukan cara menghitung rute. Server mencoba menggunakan preferensi pemilihan rute yang dipilih untuk menghitung rute. Jika preferensi pemilihan rute menghasilkan error atau latensi yang sangat lama, error akan ditampilkan. Anda hanya dapat menentukan opsi ini jika travelMode adalah DRIVE atau TWO_WHEELER. Jika tidak, permintaan akan gagal.
polylineQuality

enum (PolylineQuality)

Opsional. Menentukan preferensi Anda untuk kualitas polyline.
polylineEncoding

enum (PolylineEncoding)

Opsional. Menentukan encoding yang lebih disukai untuk polyline.
departureTime

string (Timestamp format)

Opsional. Waktu keberangkatan. Jika Anda tidak menetapkan nilai ini, nilai ini akan ditetapkan secara default ke waktu saat Anda membuat permintaan. Jika Anda menetapkan nilai ini ke waktu yang telah terjadi, permintaan akan gagal.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
computeAlternativeRoutes

boolean

Opsional. Menentukan apakah akan menghitung rute alternatif selain rute. Tidak ada rute alternatif yang ditampilkan untuk permintaan yang memiliki titik jalan perantara.
routeModifiers

object (RouteModifiers)

Opsional. Kumpulan kondisi yang harus dipenuhi yang memengaruhi cara penghitungan rute.
languageCode

string

Opsional. Kode bahasa BCP-47, seperti "en-US" atau "sr-Latn". Untuk mengetahui informasi selengkapnya, lihat ID Lokal Unicode. Lihat Dukungan Bahasa untuk melihat daftar bahasa yang didukung. Jika Anda tidak memberikan nilai ini, bahasa tampilan akan disimpulkan dari lokasi permintaan rute.
units

enum (Units)

Opsional. Menentukan satuan ukuran untuk kolom tampilan. Hal ini mencakup kolom instruction di NavigationInstruction. Satuan ukuran yang digunakan untuk rute, segmen, jarak langkah, dan durasi tidak terpengaruh oleh nilai ini. Jika Anda tidak memberikan nilai ini, unit tampilan akan disimpulkan dari lokasi permintaan.
optimizeWaypointOrder

boolean

Jika OptimizeWaypointOrder disetel ke true, upaya dilakukan untuk mengurutkan ulang titik jalan perantara yang ditentukan untuk meminimalkan biaya keseluruhan rute. Jika salah satu titik jalan perantara adalah melalui titik jalan, permintaan akan gagal. Gunakan ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index untuk menemukan urutan baru. Jika routes.optimized_intermediate_waypoint_index tidak diminta di header X-Goog-FieldMask, permintaan akan gagal. Jika optimizeWaypointOrder disetel ke salah (false), ComputeRoutesResponse.optimized_intermediate_waypoint_index akan kosong.

Isi respons

Jika berhasil, isi respons memuat instance ComputeRoutesResponse.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/maps-platform.routespreferred

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.