Bagikan melalui

Route - Post Route Matrix Sync

  • Referensi
Layanan:
Maps
Versi API:
1.0

Gunakan untuk mendapatkan matriks rute yang menunjukkan waktu dan jarak perjalanan untuk semua pasangan yang mungkin dalam daftar asal dan tujuan, menggunakan permintaan sinkron.

API Post Route Matrix Sync adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan satu permintaan sinkron (sinkronisasi). Untuk membuat permintaan asinkron (asinkron), lihat Post Route Matrix. Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API.

Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API.

Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan).

Kirim Permintaan Matriks Rute Sinkron

Jika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Matriks Rute Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi).

Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti.

Unduh Hasil Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

HTTP 202 Accepted - Permintaan Matriks diterima tetapi masih diproses. Silakan coba lagi dalam beberapa waktu.

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0
Dengan parameter opsional: 
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
format
 path True

JsonFormat

Format respons yang diinginkan. Hanya format json yang didukung.
api-version
 query True

string

Nomor versi Azure Maps API.
arriveAt
 query

string

date-time

Tanggal dan waktu kedatangan di titik tujuan yang diformat sebagai nilai dateTime seperti yang didefinisikan dalam RFC 3339, bagian 5,6, dengan offset zona waktu opsional. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik tujuan.

Contoh:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Parameter arriveAt tidak dapat digunakan bersama dengan departAt, minDeviationDistance atau minDeviationTime.
avoid
 query

RouteAvoidType[]

Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan Rentang Rute, nilai sudahUsedRoads tidak boleh digunakan.
computeTravelTimeFor
 query

ComputeTravelTime

Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default.
departAt
 query

string

date-time

Tanggal dan waktu keberangkatan dari titik asal yang diformat sebagai nilai dateTime seperti yang didefinisikan dalam RFC 3339, bagian 5,6, dengan offset zona waktu opsional. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik asal.

  • Nilai default: sekarang
  • Nilai lain: dateTime

Contoh:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Parameter departAt tidak dapat digunakan bersama dengan arriveAt.
hilliness
 query

InclineLevel

Tingkat perbukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.
routeType
 query

RouteType

Jenis rute yang diminta.
sectionType
 query

SectionType[]

Menentukan jenis bagian mana yang dilaporkan dalam respons rute.

Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Bagian defaultType mengacu pada input travelMode. Secara default travelMode diatur ke mobil
traffic
 query

boolean

Nilai yang mungkin:

  • true - Pertimbangkan semua informasi lalu lintas yang tersedia selama perutean
  • false - Abaikan data lalu lintas saat ini selama perutean. Perhatikan bahwa meskipun data lalu lintas saat ini diabaikan selama perutean, efek lalu lintas historis pada kecepatan jalan yang efektif masih dimasukkan.
travelMode
 query

TravelMode

Mode perjalanan untuk rute yang diminta. Jika tidak ditentukan, defaultnya adalah 'mobil'. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi "lainnya". Perhatikan bahwa bus mode perjalanan, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area.
vehicleAxleWeight
 query

integer

Berat per sumbu kendaraan dalam kg. Nilai 0 berarti bahwa pembatasan berat per sumbu tidak dipertimbangkan.
vehicleHeight
 query

number

double

Tinggi kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan tinggi tidak dipertimbangkan.
vehicleLength
 query

number

double

Panjang kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan panjang tidak dipertimbangkan.
vehicleLoadType
 query

VehicleLoadType

Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara/wilayah lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara/wilayah lainnya. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck.
vehicleMaxSpeed
 query

integer

Kecepatan maksimum kendaraan dalam km/jam. Kecepatan maksimum di profil kendaraan digunakan untuk memeriksa apakah kendaraan diizinkan di jalan raya.

  • Nilai 0 berarti bahwa nilai yang sesuai untuk kendaraan akan ditentukan dan diterapkan selama perencanaan rute.

  • Nilai bukan nol dapat ditimpa selama perencanaan rute. Misalnya, arus lalu lintas saat ini adalah 60 km/jam. Jika kecepatan maksimum kendaraan diatur ke 50 km/jam, mesin perutean akan mempertimbangkan 60 km/jam karena ini adalah situasi saat ini. Jika kecepatan maksimum kendaraan disediakan sebagai 80 km/jam tetapi arus lalu lintas saat ini adalah 60 km/jam, maka mesin perutean akan kembali menggunakan 60 km/jam.
vehicleWeight
 query

integer

Berat kendaraan dalam kilogram.
vehicleWidth
 query

number

double

Lebar kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan lebar tidak dipertimbangkan.
waitForResults
 query

boolean

Boolean untuk menunjukkan apakah akan menjalankan permintaan secara sinkron. Jika diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik. Jika tidak, pengguna akan segera mendapatkan respons 202. Lihat deskripsi API untuk detail selengkapnya tentang respons 202. Didukung hanya untuk permintaan asinkron.
windingness
 query

WindingnessLevel

Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-id

string

Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun sarana manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.

Isi Permintaan

Nama Jenis Deskripsi
destinations

GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.
origins

GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.

Respons

Nama Jenis Deskripsi
200 OK

RouteMatrixResult

Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.
Other Status Codes

ErrorResponse

Waktu habis: Permintaan membutuhkan waktu lebih lama untuk diselesaikan daripada jumlah waktu maksimum yang ditentukan dalam api.
Other Status Codes

ErrorResponse

Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Microsoft Entra OAuth 2.0 Flows. Saat dipasangkan dengan akses berbasis peran Azure kontrol dapat digunakan untuk mengontrol akses ke REST API Azure Maps. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya Atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin ke REST API Azure Maps.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi . Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

  • Definisi keamanan ini mengharuskan penggunaan header x-ms-client-id untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi ID Microsoft Entra. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

  • Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft .

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Microsoft Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses REST API Azure Maps sehingga kunci Anda dapat disimpan dengan aman.

Jenis: apiKey
Dalam: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol butir halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun peta untuk membatasi penyalahgunaan penyajian dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

Successfully retrieve a route matrix request result synchronously

Permintaan sampel

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Respon sampel

Kode status:
200 
{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}
Kode status:
408 
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definisi

Nama Deskripsi
ComputeTravelTime

Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default.
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan
GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.
InclineLevel

Tingkat perbukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.
JsonFormat

Format respons yang diinginkan. Hanya format json yang didukung.
RouteAvoidType

Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan Rentang Rute, nilai sudahUsedRoads tidak boleh digunakan.
RouteLegSummary

Objek ringkasan untuk bagian rute.
RouteMatrix

Objek hasil matriks
RouteMatrixQuery

Objek dengan matriks koordinat.
RouteMatrixResult

Objek ini dikembalikan dari panggilan Route Matrix yang berhasil. Misalnya, jika 2 asal dan 3 tujuan disediakan, akan ada 2 array dengan masing-masing 3 elemen. Konten setiap elemen bergantung pada opsi yang disediakan dalam kueri.
RouteMatrixResultResponse

Objek respons sel saat ini dalam matriks input.
RouteMatrixSummary

Objek ringkasan
RouteType

Jenis rute yang diminta.
SectionType

Menentukan jenis bagian mana yang dilaporkan dalam respons rute.

Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Bagian defaultType mengacu pada input travelMode. Secara default travelMode diatur ke mobil
TravelMode

Mode perjalanan untuk rute yang diminta. Jika tidak ditentukan, defaultnya adalah 'mobil'. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi "lainnya". Perhatikan bahwa bus mode perjalanan, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area.
VehicleLoadType

Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara/wilayah lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara/wilayah lainnya. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck.
WindingnessLevel

Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.

ComputeTravelTime

Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta waktu perjalanan perkiraan terbaik default.

Nama Jenis Deskripsi
all

string

Menghitung waktu perjalanan untuk semua jenis informasi lalu lintas dan menentukan semua hasil di bidang noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds dan liveTrafficIncidentsTravelTimeInSeconds yang disertakan dalam ringkasan dalam respons rute.
none

string

Tidak menghitung waktu perjalanan tambahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.
type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Detail kesalahan.
message

string

Pesan kesalahan.
target

string

Target kesalahan.

ErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat untuk geometri GeoJson MultiPoint.
type string:

MultiPoint

Menentukan jenis GeoJSON. Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

InclineLevel

Tingkat perbukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.

Nama Jenis Deskripsi
high

string

tinggi
low

string

rendah
normal

string

biasa

JsonFormat

Format respons yang diinginkan. Hanya format json yang didukung.

Nama Jenis Deskripsi
json

string

Format Pertukaran Data Notasi Objek JavaScript

RouteAvoidType

Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan Rentang Rute, nilai sudahUsedRoads tidak boleh digunakan.

Nama Jenis Deskripsi
alreadyUsedRoads

string

Menghindari penggunaan jalan yang sama beberapa kali. Paling berguna bersama dengan routeType=mendebarkan.
borderCrossings

string

Menghindari persimpangan batas dalam perhitungan rute.
carpools

string

Menghindari rute yang memerlukan penggunaan jalur carpool (HOV/High Occupancy Vehicle).
ferries

string

Menghindari feri
motorways

string

Menghindari jalan raya
tollRoads

string

Menghindari jalan tol.
unpavedRoads

string

Menghindari jalan yang belum diaspal

RouteLegSummary

Objek ringkasan untuk bagian rute.

Nama Jenis Deskripsi
arrivalTime

string

Perkiraan waktu kedatangan untuk rute atau kaki. Waktu dalam UTC.
batteryConsumptionInkWh

number

Perkiraan konsumsi energi listrik dalam jam kilowatt (kWh) menggunakan Model Konsumsi Listrik. Disertakan jika vehicleEngineType diatur ke listrik dan konstantaSpeedConsumptionInkWhPerHundredkm ditentukan. Nilai bateraiConsumptionInkWh mencakup energi listrik yang disembuhkan dan karenanya bisa negatif (yang menunjukkan mendapatkan energi). Jika maxChargeInkWh dan currentChargeInkWh ditentukan, pemulihan akan dibatasi untuk memastikan bahwa tingkat pengisian daya baterai tidak pernah melebihi maxChargeInkWh. Jika maxChargeInkWh atau currentChargeInkWh tidak ditentukan, pemulihan yang tidak dibatasi diasumsikan dalam perhitungan konsumsi.
departureTime

string

Perkiraan waktu keberangkatan untuk rute atau kaki. Waktu dalam UTC.
fuelConsumptionInLiters

number

Perkiraan konsumsi bahan bakar dalam liter menggunakan Model Konsumsi Pembakaran. Disertakan jika vehicleEngineType diatur ke pembakaran dan constantSpeedConsumptionInLitersPerHundredkm ditentukan. Nilainya akan non-negatif.
historicTrafficTravelTimeInSeconds

integer

Perkiraan waktu perjalanan dihitung menggunakan data lalu lintas historis yang bergantung pada waktu. Disertakan hanya jika computeTravelTimeFor = semua digunakan dalam kueri.
lengthInMeters

integer

Properti Panjang Dalam Meter
liveTrafficIncidentsTravelTimeInSeconds

integer

Estimasi waktu perjalanan dihitung menggunakan data kecepatan real time. Disertakan hanya jika computeTravelTimeFor = semua digunakan dalam kueri.
noTrafficTravelTimeInSeconds

integer

Perkiraan waktu perjalanan dihitung seolah-olah tidak ada keterlambatan pada rute karena kondisi lalu lintas (misalnya kemacetan). Disertakan hanya jika computeTravelTimeFor = semua digunakan dalam kueri.
trafficDelayInSeconds

integer

Estimasi keterlambatan dalam detik yang disebabkan oleh insiden real-time sesuai dengan informasi lalu lintas. Untuk rute yang direncanakan dengan waktu keberangkatan di masa mendatang, penundaan selalu 0. Untuk mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas, parameter computeTravelTimeFor=all perlu ditambahkan.
travelTimeInSeconds

integer

Perkiraan waktu perjalanan dalam detik properti yang mencakup keterlambatan karena lalu lintas real time. Perhatikan bahwa bahkan ketika traffic=false travelTimeInSeconds masih menyertakan penundaan karena lalu lintas. Jika DepartAt di masa mendatang, waktu perjalanan dihitung menggunakan data lalu lintas historis yang bergantung pada waktu.

RouteMatrix

Objek hasil matriks

Nama Jenis Deskripsi
response

RouteMatrixResultResponse

Objek respons sel saat ini dalam matriks input.
statusCode

integer

Properti StatusCode untuk sel saat ini dalam matriks input.

RouteMatrixQuery

Objek dengan matriks koordinat.

Nama Jenis Deskripsi
destinations

GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.
origins

GeoJsonMultiPoint

Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.

RouteMatrixResult

Objek ini dikembalikan dari panggilan Route Matrix yang berhasil. Misalnya, jika 2 asal dan 3 tujuan disediakan, akan ada 2 array dengan masing-masing 3 elemen. Konten setiap elemen bergantung pada opsi yang disediakan dalam kueri.

Nama Jenis Deskripsi
formatVersion

string

Properti Format Versi
matrix

RouteMatrix[]

Hasil sebagai array 2 dimensi ringkasan rute.
summary

RouteMatrixSummary

Objek ringkasan

RouteMatrixResultResponse

Objek respons sel saat ini dalam matriks input.

Nama Jenis Deskripsi
routeSummary

RouteLegSummary

Objek ringkasan untuk bagian rute.

RouteMatrixSummary

Objek ringkasan

Nama Jenis Deskripsi
successfulRoutes

integer

Jumlah rute yang berhasil dalam respons.
totalRoutes

integer

Jumlah total rute yang diminta. Jumlah sel dalam matriks input.

RouteType

Jenis rute yang diminta.

Nama Jenis Deskripsi
eco

string

Rute yang diseimbangkan oleh ekonomi dan kecepatan.
fastest

string

Rute tercepat.
shortest

string

Rute terpendek berdasarkan jarak.
thrilling

string

Termasuk jalan yang menarik atau menantang dan menggunakan jalan raya sesedi mungkin. Anda dapat memilih tingkat belokan yang disertakan dan juga tingkat kebukitan. Lihat parameter hilliness dan windingness untuk cara mengatur ini. Ada batas 900 km pada rute yang direncanakan dengan routeType=mendebarkan

SectionType

Menentukan jenis bagian mana yang dilaporkan dalam respons rute.

Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Bagian defaultType mengacu pada input travelMode. Secara default travelMode diatur ke mobil

Nama Jenis Deskripsi
carTrain

string

Bagian dari rute yang merupakan mobil atau kereta api.
carpool

string

Bagian dari rute yang memerlukan penggunaan jalur carpool (HOV/High Occupancy Vehicle).
country

string

Bagian yang menunjukkan negara/wilayah mana rute berada.
ferry

string

Bagian dari rute yang merupakan feri.
motorway

string

Bagian dari rute yang merupakan jalan raya.
pedestrian

string

Bagian dari rute yang hanya cocok untuk pejalan kaki.
tollRoad

string

Bagian dari rute yang mengharuskan tol dibayar.
tollVignette

string

Bagian dari rute yang memerlukan vignette tol untuk hadir.
traffic

string

Bagian rute yang berisi informasi lalu lintas.
travelMode

string

Bagian dalam kaitannya dengan parameter permintaan travelMode.
tunnel

string

Bagian dari rute yang merupakan terowongan.
urban

string

Bagian dari rute yang terletak di daerah perkotaan.

TravelMode

Mode perjalanan untuk rute yang diminta. Jika tidak ditentukan, defaultnya adalah 'mobil'. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi "lainnya". Perhatikan bahwa bus mode perjalanan, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area.

Nama Jenis Deskripsi
bicycle

string

Rute yang dikembalikan dioptimalkan untuk sepeda, termasuk penggunaan jalur sepeda.
bus

string

Rute yang dikembalikan dioptimalkan untuk bus, termasuk penggunaan jalur bus saja. Fungsionalitas BETA.
car

string

Rute yang dikembalikan dioptimalkan untuk mobil.
motorcycle

string

Rute yang dikembalikan dioptimalkan untuk sepeda motor. Fungsionalitas BETA.
pedestrian

string

Rute yang dikembalikan dioptimalkan untuk pejalan kaki, termasuk penggunaan trotoar.
taxi

string

Rute yang dikembalikan dioptimalkan untuk taksi. Fungsionalitas BETA.
truck

string

Rute yang dikembalikan dioptimalkan untuk kendaraan komersial, seperti untuk truk.
van

string

Rute yang dikembalikan dioptimalkan untuk van. Fungsionalitas BETA.

VehicleLoadType

Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara/wilayah lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara/wilayah lainnya. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck.

Nama Jenis Deskripsi
USHazmatClass1

string

Bahan peledak
USHazmatClass2

string

Gas terkompresi
USHazmatClass3

string

Cairan mudah terbakar
USHazmatClass4

string

Padatan yang mudah terbakar
USHazmatClass5

string

Pengoksidasi
USHazmatClass6

string

Racun
USHazmatClass7

string

Radioaktif
USHazmatClass8

string

Korelif
USHazmatClass9

string

Miscellaneous
otherHazmatExplosive

string

Bahan peledak
otherHazmatGeneral

string

Miscellaneous
otherHazmatHarmfulToWater

string

Berbahaya bagi air

WindingnessLevel

Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling.

Nama Jenis Deskripsi
high

string

tinggi
low

string

rendah
normal

string

biasa