Respons dan permintaan elevasi

Permintaan elevasi

Permintaan Elevation API dibuat sebagai string URL. API ini menampilkan data elevasi untuk lokasi di bumi. Anda menentukan data lokasi dengan salah satu dari dua cara:

• Sebagai kumpulan satu atau beberapa locations.
• Sebagai serangkaian titik yang terhubung di sepanjang path.

Kedua pendekatan ini menggunakan koordinat garis lintang/bujur untuk mengidentifikasi lokasi atau verteks jalur. Dokumen ini menjelaskan format URL Elevation API yang diperlukan dan parameter yang tersedia.

Elevation API menampilkan data untuk kueri satu titik dengan akurasi setinggi mungkin. Kueri batch yang melibatkan beberapa lokasi dapat menampilkan data dengan akurasi yang lebih rendah, terutama jika lokasi tersebut tersebar, karena beberapa penghalusan data terjadi.

Permintaan Elevation API menggunakan format berikut:

https://maps.googleapis.com/maps/api/elevation/outputFormat?parameters

dengan outputFormat dapat berupa salah satu nilai berikut:

• json (direkomendasikan), menunjukkan output dalam JavaScript Object Notation (JSON); atau
• xml, menunjukkan output dalam XML, yang di-wrap dalam node <ElevationResponse>.

Catatan: URL harus dienkode dengan benar agar valid dan dibatasi hingga 16.384 karakter untuk semua layanan web. Perhatikan batas ini saat membuat URL. Perhatikan bahwa browser, proxy, dan server yang berbeda mungkin memiliki batas karakter URL yang berbeda juga.

HTTPS diperlukan untuk permintaan yang menggunakan kunci API.

Parameter permintaan

Permintaan ke Elevation API menggunakan parameter yang berbeda berdasarkan apakah permintaan ditujukan untuk lokasi terpisah atau untuk jalur yang berurutan. Untuk lokasi terpisah, permintaan elevasi menampilkan data tentang lokasi tertentu yang diteruskan dalam permintaan; untuk jalur, permintaan elevasi diambil sampelnya di sepanjang jalur yang diberikan.

Seperti standar di semua URL, parameter dipisahkan menggunakan karakter ampersand (&). Daftar parameter dan kemungkinan nilainya ditunjukkan di bawah.

Semua permintaan

• key -- (wajib) Kunci API aplikasi Anda. Kunci ini mengidentifikasi aplikasi Anda untuk tujuan pengelolaan kuota. Pelajari cara mendapatkan kunci.

Permintaan posisi

• locations (wajib) menentukan lokasi di atas bumi yang menjadi titik ditampilkannya data elevasi. Parameter ini menggunakan satu lokasi sebagai pasangan {latitude,longitude} yang dipisahkan koma (misalnya, "40.714728,-73.998672") atau beberapa pasangan lintang/bujur yang diteruskan sebagai array atau sebagai polyline yang dienkode. Ada batas 512 titik untuk parameter tertentu ini. Untuk mengetahui informasi selengkapnya, lihat Menentukan Lokasi di bawah.

Permintaan jalur sampel

• path (wajib) menentukan jalur di atas bumi yang data elevasinya akan ditampilkan. Parameter ini menentukan kumpulan dua atau lebih pasangan {latitude,longitude} yang diurutkan yang menentukan jalur di sepanjang permukaan bumi. Parameter ini harus digunakan bersama dengan parameter samples yang dijelaskan di bawah. Ada batas 512 titik untuk parameter tertentu ini. Untuk mengetahui informasi selengkapnya, lihat bagian Menentukan Jalur di bawah.
• samples (wajib) menentukan jumlah titik sampel di sepanjang jalur yang data elevasinya akan ditampilkan. Parameter samples membagi path yang diberikan ke dalam kumpulan titik yang berjarak sama secara berurutan di sepanjang jalur.

Menentukan lokasi

Permintaan posisi ditunjukkan melalui penggunaan parameter locations, yang menunjukkan permintaan elevasi untuk lokasi tertentu yang diteruskan sebagai nilai garis lintang/bujur.

Parameter locations dapat menggunakan argumen berikut:

• Satu koordinat: locations=40.714728,-73.998672
• Array koordinat yang dipisahkan menggunakan karakter pipa ('|'): locations=40.714728,-73.998672|-34.397,150.644
• Kumpulan koordinat yang dienkode menggunakan Algoritma Polyline yang Dienkodekan: locations=enc:gfo}EtohhU

String koordinat lintang dan bujur ditentukan menggunakan angka dalam string teks yang dipisahkan koma. Misalnya, "40.714728,-73.998672" adalah nilai locations yang valid. Nilai lintang dan bujur harus sesuai dengan lokasi yang valid di permukaan bumi. Lintang dapat mengambil nilai apa pun antara -90 dan 90, sedangkan nilai bujur dapat mengambil nilai apa pun antara -180 dan 180. Jika Anda menentukan nilai lintang atau bujur yang tidak valid, permintaan Anda akan ditolak sebagai permintaan yang buruk.

Anda dapat meneruskan hingga 512 koordinat dalam array atau polyline yang dienkode, sambil tetap membuat URL yang valid. Perhatikan, saat meneruskan beberapa koordinat, akurasi data yang ditampilkan mungkin memiliki resolusi lebih rendah daripada saat meminta data untuk satu koordinat. Melebihi 512 titik atau koordinat dalam parameter 'locations' atau 'path' akan menampilkan respons INVALID_REQUEST.

Menentukan jalur

Permintaan jalur yang disampel ditunjukkan melalui penggunaan parameter path dan samples, yang menunjukkan permintaan data elevasi di sepanjang jalur pada interval tertentu. Seperti permintaan posisi yang menggunakan parameter locations, parameter path menentukan sekumpulan nilai garis lintang dan garis bujur. Namun, tidak seperti permintaan posisi, path menentukan sekumpulan verteks yang diurutkan. Daripada menampilkan data elevasi hanya di verteks, sampel permintaan jalur diambil di sepanjang jalur, berdasarkan jumlah samples yang ditentukan (termasuk endpoint).

Parameter path dapat menggunakan salah satu argumen berikut:

• Array dari dua atau lebih string teks koordinat yang dipisahkan koma dan dipisahkan menggunakan karakter pipa ('|'): path=40.714728,-73.998672|-34.397,150.644
• Koordinat yang dienkode menggunakan Algoritma Polyline yang Dienkodekan: path=enc:gfo}EtohhUxD@bAxJmGF

String koordinat lintang dan bujur ditentukan menggunakan angka dalam string teks yang dipisahkan koma. Misalnya, "40.714728,-73.998672|-34.397, 150.644" adalah nilai path yang valid. Nilai garis lintang dan garis bujur harus sesuai dengan lokasi yang valid di permukaan bumi. Lintang dapat mengambil nilai apa pun antara -90 dan 90, sedangkan nilai bujur dapat mengambil nilai apa pun antara -180 dan 180. Jika Anda menentukan nilai lintang atau bujur yang tidak valid, permintaan Anda akan ditolak sebagai permintaan yang buruk.

Anda dapat meneruskan hingga 512 koordinat dalam array atau polyline yang dienkode, sambil tetap membuat URL yang valid. Perhatikan, saat meneruskan beberapa koordinat, akurasi data yang ditampilkan mungkin memiliki resolusi lebih rendah daripada saat meminta data untuk satu koordinat. Melebihi 512 titik atau koordinat dalam parameter 'locations' atau 'path' akan menampilkan respons INVALID_REQUEST.

Respons elevasi

• Array dari dua atau lebih string teks koordinat yang dipisahkan koma dan dipisahkan menggunakan karakter pipa ('|'): path=40.714728,-73.998672|-34.397,150.644
• Koordinat yang dienkode menggunakan Algoritma Polyline yang Dienkodekan: path=enc:gfo}EtohhUxD@bAxJmGF

String koordinat lintang dan bujur ditentukan menggunakan angka dalam string teks yang dipisahkan koma. Misalnya, "40.714728,-73.998672|-34.397, 150.644" adalah nilai path yang valid. Nilai garis lintang dan garis bujur harus sesuai dengan lokasi yang valid di permukaan bumi. Lintang dapat mengambil nilai apa pun antara -90 dan 90, sedangkan nilai bujur dapat mengambil nilai apa pun antara -180 dan -180. Jika Anda menentukan nilai lintang atau bujur yang tidak valid, permintaan Anda akan ditolak sebagai permintaan yang buruk.

Anda dapat meneruskan hingga 512 koordinat dalam array atau polyline yang dienkode, sambil tetap membuat URL yang valid. Perhatikan, saat meneruskan beberapa koordinat, akurasi data yang ditampilkan mungkin memiliki resolusi lebih rendah daripada saat meminta data untuk satu koordinat. Melebihi 512 titik atau koordinat dalam parameter 'locations' atau 'path' akan menampilkan respons INVALID_REQUEST.

Respons elevasi

Untuk setiap permintaan yang valid, layanan Elevation akan menampilkan respons Elevation dalam format yang ditunjukkan dalam URL permintaan.

ElevationResponse

ElevationStatus

Kode status yang ditampilkan oleh layanan.

• OK yang menunjukkan bahwa permintaan API berhasil.
• DATA_NOT_AVAILABLE yang menunjukkan bahwa tidak ada data yang tersedia untuk lokasi input.
• INVALID_REQUEST yang menunjukkan bahwa format permintaan API salah.
• OVER_DAILY_LIMIT yang menunjukkan salah satu dari berikut ini:
  • Kunci API tidak ada atau tidak valid.
  • Penagihan belum diaktifkan di akun Anda.
  • Batas penggunaan yang ditentukan sendiri telah terlampaui.
  • Metode pembayaran yang diberikan sudah tidak valid (misalnya, kartu kredit sudah tidak berlaku).
• OVER_QUERY_LIMIT yang menunjukkan bahwa pemohon telah melampaui kuota.
• REQUEST_DENIED yang menunjukkan bahwa API tidak menyelesaikan permintaan.
• UNKNOWN_ERROR menunjukkan error yang tidak diketahui.

Jika kode statusnya selain OK, mungkin ada kolom error_message tambahan dalam objek respons Ketinggian. Kolom ini berisi informasi yang lebih mendetail tentang alasan di balik kode status yang diberikan.

Respons berisi array results dengan elemen berikut:

ElevationResult

LatLngLiteral

Objek yang menjelaskan lokasi tertentu dengan Lintang dan Bujur dalam derajat desimal.

Contoh elevasi posisi

Contoh berikut meminta elevasi untuk Denver, Colorado, "Mile High City":

https://maps.googleapis.com/maps/api/elevation/json
    ?locations=39.7391536%2C-104.9847034
    &key=YOUR_API_KEY
      

curl -L -X GET 'https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536%2C-104.9847034&key=YOUR_API_KEY'
      

        
{
  "results":
    [
      {
        "elevation": 1608.637939453125,
        "location": { "lat": 39.7391536, "lng": -104.9847034 },
        "resolution": 4.771975994110107,
      },
    ],
  "status": "OK",
}
        
        

        
<ElevationResponse>
 <status>OK</status>
 <result>
  <location>
   <lat>39.7391536</lat>
   <lng>-104.9847034</lng>
  </location>
  <elevation>1608.6379395</elevation>
  <resolution>4.7719760</resolution>
 </result>
</ElevationResponse>
        
        

Contoh berikut menunjukkan beberapa respons (untuk Denver, CO dan untuk Death Valley, CA).

Permintaan ini menunjukkan penggunaan flag JSON output:

https://maps.googleapis.com/maps/api/elevation/json
    ?locations=39.7391536%2C-104.9847034%7C36.455556%2C-116.866667
    &key=YOUR_API_KEY
      

curl -L -X GET 'https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536%2C-104.9847034%7C36.455556%2C-116.866667&key=YOUR_API_KEY'
      

Permintaan ini menunjukkan penggunaan flag XML output:

https://maps.googleapis.com/maps/api/elevation/xml?locations=39.7391536,-104.9847034|36.455556,-116.866667&key=YOUR_API_KEY

Pilih tab di bawah untuk melihat contoh respons JSON dan XML.

      
{
  "results":
    [
      {
        "elevation": 1608.637939453125,
        "location": { "lat": 39.7391536, "lng": -104.9847034 },
        "resolution": 4.771975994110107,
      },
      {
        "elevation": -52.79492568969727,
        "location": { "lat": 36.455556, "lng": -116.866667 },
        "resolution": 19.08790397644043,
      },
    ],
  "status": "OK",
}
      
      

      
<ElevationResponse>
 <status>OK</status>
 <result>
  <location>
   <lat>39.7391536</lat>
   <lng>-104.9847034</lng>
  </location>
  <elevation>1608.6379395</elevation>
  <resolution>4.7719760</resolution>
 </result>
 <result>
  <location>
   <lat>36.4555560</lat>
   <lng>-116.8666670</lng>
  </location>
  <elevation>-52.7949257</elevation>
  <resolution>19.0879040</resolution>
 </result>
</ElevationResponse>
      
      

Contoh berikut meminta data elevasi di sepanjang garis lurus path dari Mt. Whitney, CA ke Badwater, CA, titik tertinggi dan terendah di Amerika Serikat. Kita meminta tiga samples, sehingga akan mencakup dua endpoint dan titik tengah.

https://maps.googleapis.com/maps/api/elevation/json
  ?path=36.578581%2C-118.291994%7C36.23998%2C-116.83171
  &samples=3
  &key=YOUR_API_KEY
    

curl -L -X GET 'https://maps.googleapis.com/maps/api/elevation/json?path=36.578581%2C-118.291994%7C36.23998%2C-116.83171&samples=3&key=YOUR_API_KEY'
    

      
{
  "results":
    [
      {
        "elevation": 4411.94189453125,
        "location": { "lat": 36.578581, "lng": -118.291994 },
        "resolution": 19.08790397644043,
      },
      {
        "elevation": 1372.8359375,
        "location": { "lat": 36.41150289067028, "lng": -117.5602607523847 },
        "resolution": 9.543951988220215,
      },
      {
        "elevation": -84.51690673828125,
        "location": { "lat": 36.23998, "lng": -116.83171 },
        "resolution": 9.543951988220215,
      },
    ],
  "status": "OK",
}
      
      

      
<ElevationResponse>
 <status>OK</status>
 <result>
  <location>
   <lat>36.5785810</lat>
   <lng>-118.2919940</lng>
  </location>
  <elevation>4411.9418945</elevation>
  <resolution>19.0879040</resolution>
 </result>
 <result>
  <location>
   <lat>36.4115029</lat>
   <lng>-117.5602608</lng>
  </location>
  <elevation>1372.8359375</elevation>
  <resolution>9.5439520</resolution>
 </result>
 <result>
  <location>
   <lat>36.2399800</lat>
   <lng>-116.8317100</lng>
  </location>
  <elevation>-84.5169067</elevation>
  <resolution>9.5439520</resolution>
 </result>
</ElevationResponse>