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.

Salah satu pendekatan ini menggunakan koordinat 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 tertinggi yang memungkinkan. Kueri batch yang melibatkan beberapa lokasi dapat menampilkan data dengan akurasi yang lebih rendah, terutama jika lokasi tersebut tersebar, karena beberapa data akan dihaluskan.

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 dienkapsulasi dalam node <ElevationResponse>.

Catatan: URL harus dienkode dengan benar agar valid dan dibatasi hingga 16384 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 tersebut untuk lokasi terpisah atau untuk jalur yang diurutkan. Untuk lokasi terpisah, permintaan elevasi menampilkan data di lokasi tertentu yang diteruskan dalam permintaan; untuk jalur, permintaan elevasi akan diambil sampelnya di sepanjang jalur yang diberikan.

Sesuai dengan standar di semua URL, parameter dipisahkan menggunakan karakter ampersand (&amp;). 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 yang diambil sampelnya

  • path (wajib) menentukan jalur di atas bumi yang data elevasinya akan ditampilkan. Parameter ini menentukan kumpulan dua atau beberapa pasangan {latitude,longitude} yang diurutkan yang menentukan jalur di sepanjang permukaan bumi. Parameter ini harus digunakan bersama parameter samples yang dijelaskan di bawah. Ada batas 512 titik untuk parameter tertentu ini. Untuk mengetahui informasi selengkapnya, lihat Menentukan Jalur di bawah.
  • samples (wajib) menentukan jumlah titik sampel di sepanjang jalur yang data elevasinya akan tampilkan. 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 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 Dienkode: 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 menggunakan nilai apa pun antara -90 dan 90, sedangkan nilai bujur dapat menggunakan nilai apa pun antara -180 dan 180. Jika Anda menentukan nilai lintang atau bujur yang tidak valid, permintaan Anda akan ditolak sebagai permintaan yang salah format.

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 diambil sampelnya ditunjukkan melalui penggunaan parameter path dan samples, yang menunjukkan permintaan data elevasi di sepanjang jalur pada interval tertentu. Sebagaimana permintaan posisi 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 beberapa string teks koordinat yang dipisahkan koma yang dipisahkan menggunakan karakter pipa ('|'): path=40.714728,-73.998672|-34.397,150.644
  • Koordinat yang dienkode menggunakan Polyline yang Dienkode Algoritma: 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 lintang dan bujur harus sesuai dengan lokasi yang valid di permukaan bumi. Lintang dapat menggunakan nilai apa pun antara -90 dan 90, sedangkan nilai bujur dapat menggunakan nilai apa pun antara -180 dan 180. Jika Anda menentukan nilai lintang atau bujur yang tidak valid, permintaan Anda akan ditolak sebagai permintaan yang salah format.

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 beberapa string teks koordinat yang dipisahkan koma yang dipisahkan menggunakan karakter pipa ('|'): path=40.714728,-73.998672|-34.397,150.644
  • Koordinat yang dienkode menggunakan Polyline yang Dienkode Algoritma: 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 lintang dan bujur harus sesuai dengan lokasi yang valid di permukaan bumi. Lintang dapat menggunakan nilai apa pun antara -90 dan 90, sedangkan nilai bujur dapat menggunakan nilai apa pun antara -180 dan -180. Jika Anda menentukan nilai lintang atau bujur yang tidak valid, permintaan Anda akan ditolak sebagai permintaan yang salah format.

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 Elevasi dalam format yang ditunjukkan dalam URL permintaan.

ElevationResponse

Kolom Wajib Jenis Deskripsi
wajib ada Array<ElevationResult> Lihat ElevationResult untuk mengetahui informasi selengkapnya.
wajib ada ElevationStatus Lihat ElevationStatus untuk mengetahui informasi selengkapnya.
opsional string

Jika layanan menampilkan kode status selain OK, mungkin ada kolom error_message tambahan dalam objek respons. Kolom ini berisi informasi yang lebih mendetail tentang alasan di balik kode status yang diberikan. Kolom ini tidak selalu ditampilkan, dan kontennya dapat berubah.

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 permintaan API salah format.
  • OVER_DAILY_LIMIT yang menunjukkan salah satu hal berikut:
    • 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 yang sudah tidak berlaku).
  • OVER_QUERY_LIMIT yang menunjukkan bahwa pemohon telah melampaui kuota.
  • REQUEST_DENIED yang menunjukkan bahwa API tidak menyelesaikan permintaan.
  • UNKNOWN_ERROR yang menunjukkan error yang tidak dikenal.

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

Respons berisi array results dengan elemen berikut:

ElevationResult

Kolom Wajib Jenis Deskripsi
wajib ada angka

Elevasi lokasi dalam meter.

wajib ada LatLngLiteral

Elemen lokasi dari posisi penghitungan data elevasi. Perhatikan bahwa untuk permintaan jalur, kumpulan elemen lokasi akan berisi titik sampel di sepanjang jalur.

Lihat LatLngLiteral untuk mengetahui informasi selengkapnya.

opsional angka

Nilai yang menunjukkan jarak maksimum antara titik data yang digunakan untuk interpolasi elevasi, dalam meter. Properti ini tidak akan ada jika resolusi tidak diketahui. Perhatikan bahwa data elevasi akan menjadi kurang akurat (nilai resolusi lebih besar) jika beberapa titik diteruskan. Guna memperoleh nilai elevasi yang paling akurat untuk sebuah titik, kueri terpisah harus dibuat.

LatLngLiteral

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

Kolom Wajib Jenis Deskripsi
wajib ada angka

Lintang dalam derajat desimal

wajib ada angka

Bujur dalam derajat desimal

Contoh elevasi posisi

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

URL

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

cURL

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

JSON

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

XML

        
<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 output JSON:

URL

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

cURL

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 output XML:

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.

JSON

      
{
  "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",
}
      
      

XML

      
<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 path garis lurus dari Mt. Whitney, CA ke Badwater, CA, titik tertinggi dan terendah di Amerika Serikat. Kami meminta tiga samples, sehingga akan menyertakan dua endpoint dan titik tengah.

URL

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

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'
    

JSON

      
{
  "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",
}
      
      

XML

      
<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>