ऊंचाई के अनुरोध
एलिवेशन एपीआई अनुरोध यूआरएल स्ट्रिंग के तौर पर बनाए जाते हैं. एपीआई, पृथ्वी की जगहों की ऊंचाई से जुड़ा डेटा दिखाता है. जगह की जानकारी का डेटा, इन दो में से किसी एक तरीके से चुना जाता है:
- एक या उससे ज़्यादा
locations
के सेट के तौर पर. path
पर कनेक्टेड पॉइंट की सीरीज़ के तौर पर.
इनमें से किसी भी तरीके से जगहों या रास्ते के कोने की पहचान करने के लिए अक्षांश/देशांतर निर्देशांक का इस्तेमाल किया जाता है. इस दस्तावेज़ में, एलिवेशन एपीआई यूआरएल के ज़रूरी फ़ॉर्मैट और उपलब्ध पैरामीटर के बारे में बताया गया है.
एलिवेशन एपीआई, सबसे सटीक सटीक नतीजे वाली सिंगल पॉइंट क्वेरी के लिए डेटा दिखाता है. एक से ज़्यादा जगहों की जानकारी वाली एक साथ की गई कई क्वेरी से, कम सटीक डेटा मिल सकता है. ऐसा तब होता है, जब जगहें एक-दूसरे से दूर हों. इसकी वजह यह है कि डेटा में कुछ बदलाव होता है.
Elevation API का अनुरोध इस तरह का होता है:
https://maps.googleapis.com/maps/api/elevation/outputFormat?parameters
जहां outputFormat
इनमें से कोई एक वैल्यू हो सकती है:
json
(सुझाया गया), JavaScript ऑब्जेक्ट नोटेशन (JSON) में आउटपुट दिखाता है याxml
, एक्सएमएल में आउटपुट दिखाता है, जो<ElevationResponse>
नोड में रैप किया जाता है.
ध्यान दें: यूआरएल मान्य होने के लिए, उन्हें सही तरीके से कोड में बदला treba होना चाहिए. साथ ही, सभी वेब सेवाओं के लिए यूआरएल में 16,384 से ज़्यादा वर्ण नहीं होने चाहिए. अपने यूआरएल बनाते समय इस सीमा का ध्यान रखें. ध्यान रखें कि अलग-अलग ब्राउज़र, प्रॉक्सी, और सर्वर की यूआरएल में वर्ण सीमाएं भी अलग हो सकती हैं.
एपीआई पासकोड का इस्तेमाल करने वाले अनुरोधों के लिए, एचटीटीपीएस ज़रूरी है.
अनुरोध पैरामीटर
एलिवेशन एपीआई के अनुरोध अलग-अलग पैरामीटर का इस्तेमाल करते हैं. ये इस बात पर निर्भर करते हैं कि अनुरोध अलग-अलग जगहों के लिए है या ऑर्डर वाले पाथ के लिए. अलग-अलग जगहों के लिए, अनुरोध में पास की गई खास जगहों की ऊंचाई के डेटा के अनुरोधों का डेटा, पाथ के लिए सैंपल के तौर पर भेजा जाता है.
जैसा कि सभी यूआरएल में स्टैंडर्ड होता है, पैरामीटर को ऐंपरसेंड (&
) वर्ण का इस्तेमाल करके अलग किया जाता है. पैरामीटर और उनकी संभावित वैल्यू की सूची नीचे दी गई है.
सभी अनुरोध
key
— (ज़रूरी है) आपके ऐप्लिकेशन का एपीआई पासकोड. यह कुंजी कोटा प्रबंधन के उद्देश्यों के लिए आपके ऐप्लिकेशन की पहचान करती है. कुंजी पाने का तरीका जानें.
पोज़िशन के लिए किए गए अनुरोध
locations
(ज़रूरी है) पृथ्वी की उन जगहों के बारे में बताता है जहां से ऊंचाई का डेटा दिखाना है. यह पैरामीटर, कॉमा लगाकर अलग की गई {latitude,longitude} जोड़ी के तौर पर एक जगह या कई जगहों की जानकारी लेता है. उदाहरण के लिए, "40.714728,-73.998672". इसके अलावा, यह पैरामीटर ऐरे या कोड में बदली गई पॉलीलाइन के तौर पर भी कई जगहों की जानकारी लेता है. इस खास पैरामीटर के लिए 512 पॉइंट की सीमा है. ज़्यादा जानकारी के लिए, नीचे जगहों के बारे में बताना देखें.
सैंपल के तौर पर पाथ के अनुरोध
path
(ज़रूरी है) से पृथ्वी पर एक पाथ तय होता है, जिसके लिए ऊंचाई का डेटा दिखाया जाता है. यह पैरामीटर, पृथ्वी की सतह के साथ पाथ की जानकारी देने वाले दो या ज़्यादा क्रम वाले {अक्षांश,देशांतर} जोड़े के सेट के बारे में बताता है. इस पैरामीटर का इस्तेमाल, नीचे दिए गएsamples
पैरामीटर के साथ करना ज़रूरी है. इस खास पैरामीटर के लिए 512 पॉइंट की सीमा है. ज़्यादा जानकारी के लिए, नीचे पाथ तय करना देखें.samples
(ज़रूरी है) से पता चलता है कि किसी पाथ पर, ऊंचाई का डेटा दिखाने के लिए सैंपल पॉइंट की संख्या कितनी होनी चाहिए.samples
पैरामीटर, दिए गएpath
को पाथ पर समान दूरी के पॉइंट के ऑर्डर किए गए सेट में बांटता है.
जगह बताना
पोज़िशन के लिए बने अनुरोध, locations
पैरामीटर का इस्तेमाल करके दिखाए जाते हैं. इससे, अक्षांश/देशांतर वैल्यू के तौर पर पास की गई खास जगहों के लिए, ऊंचाई के अनुरोधों के बारे में पता चलता है.
locations
पैरामीटर में ये आर्ग्युमेंट इस्तेमाल किए जा सकते हैं:
- एक निर्देशांक:
locations=40.714728,-73.998672
- पाइप ('
|
') वर्ण का इस्तेमाल करके अलग किए गए निर्देशांकों का कलेक्शन:locations=40.714728,-73.998672|-34.397,150.644
- एन्कोड किए गए
पॉलीलाइन एल्गोरिदम का इस्तेमाल करके, कोड में बदले गए कोऑर्डिनेट का सेट:
locations=enc:gfo}EtohhU
अक्षांश और देशांतर कोऑर्डिनेट स्ट्रिंग को कॉमा लगाकर अलग की गई टेक्स्ट स्ट्रिंग में अंकों का इस्तेमाल करके तय किया जाता है. उदाहरण के लिए, "40.714728,-73.998672" एक मान्य locations
वैल्यू है. अक्षांश और देशांतर की वैल्यू, धरती पर किसी मान्य जगह से मेल खानी चाहिए. अक्षांश की वैल्यू -90
से 90
के बीच हो सकती है, जबकि देशांतर की वैल्यू -180
से 180
के बीच हो सकती है. अगर अक्षांश या देशांतर की अमान्य वैल्यू दी जाती है, तो आपके अनुरोध को अमान्य अनुरोध के तौर पर अस्वीकार कर दिया जाएगा.
एक मान्य यूआरएल बनाते समय भी, किसी अरे या कोड में बदली गई पॉलीलाइन में 512 निर्देशांक तक पास किए जा सकते हैं.
ध्यान दें कि एक से ज़्यादा निर्देशांक पास करने पर, मिलने वाले डेटा की सटीक जानकारी, एक निर्देशांक के लिए डेटा का अनुरोध करने के मुकाबले कम हो सकती है.
'जगहें' या 'पाथ' पैरामीटर में 512 पॉइंट या निर्देशांक से ज़्यादा होने पर, INVALID_REQUEST
जवाब मिलता है.
पाथ तय करना
सैंपल किए गए पाथ के अनुरोधों के बारे में path
और samples
पैरामीटर का इस्तेमाल करके बताया जाता है. इससे, तय किए गए इंटरवल पर पाथ के साथ-साथ ऊंचाई के डेटा का अनुरोध करने की जानकारी मिलती है. locations
पैरामीटर का इस्तेमाल करके किए गए जगह की जानकारी वाले अनुरोधों की तरह ही, path
पैरामीटर से अक्षांश और देशांतर की वैल्यू का एक सेट तय होता है. हालांकि, पोज़िशन के अनुरोध के उलट,
path
वर्टिक्स के क्रम में लगाए गए सेट की जानकारी देता है. सिर्फ़ वर्टिसेस पर ऊंचाई का डेटा दिखाने के बजाय, पाथ के अनुरोधों को पाथ की लंबाई के साथ सैंपल किया जाता है. यह सैंपलिंग, एंडपॉइंट के साथ-साथ तय किए गए samples
की संख्या के आधार पर की जाती है.
path
पैरामीटर में से, इनमें से कोई एक तर्क हो सकता है:
- कॉमा लगाकर अलग की गई दो या उससे ज़्यादा निर्देशांक टेक्स्ट स्ट्रिंग का कलेक्शन,
पाइप ('
|
') वर्ण का इस्तेमाल करके अलग किया गया है:path=40.714728,-73.998672|-34.397,150.644
- कोड में बदले गए निर्देशांक, कोड में बदला गया पॉलीलाइन एल्गोरिदम का इस्तेमाल करके बनाए गए हैं:
path=enc:gfo}EtohhUxD@bAxJmGF
अक्षांश और देशांतर कोऑर्डिनेट स्ट्रिंग को कॉमा लगाकर अलग की गई टेक्स्ट स्ट्रिंग में अंकों का इस्तेमाल करके तय किया जाता है. उदाहरण के लिए, "40.714728,-73.998672|-34.397, 150.644", path
की मान्य वैल्यू है. अक्षांश और देशांतर की वैल्यू, धरती पर किसी मान्य जगह से मेल खानी चाहिए. अक्षांश -90
और 90
के बीच का कोई भी मान ले सकते हैं, जबकि देशांतर के मान -180
और 180
के बीच का कोई भी मान ले सकते हैं. अगर अक्षांश या देशांतर की वैल्यू अमान्य है, तो आपके अनुरोध को गलत अनुरोध के तौर पर अस्वीकार कर दिया जाएगा.
एक मान्य यूआरएल बनाते समय भी, किसी अरे या कोड में बदली गई पॉलीलाइन में 512 निर्देशांक तक पास किए जा सकते हैं. ध्यान दें कि कई कोऑर्डिनेट पास करते समय, दिखाए गए किसी भी डेटा के सटीक होने की संभावना, एक कोऑर्डिनेट के लिए डेटा का अनुरोध करने की तुलना में कम रिज़ॉल्यूशन हो सकती है. 'जगहें' या 'पाथ' पैरामीटर में 512 पॉइंट या निर्देशांक से ज़्यादा, INVALID_REQUEST
रिस्पॉन्स दिखाता है.
एलिवेशन रिस्पॉन्स
हर मान्य अनुरोध के लिए, एलिवेशन सेवा, अनुरोध यूआरएल में बताए गए फ़ॉर्मैट में एलिवेशन रिस्पॉन्स देगी.
ElevationResponse
Field | Required | Type | Description |
---|---|---|---|
| required | Array<ElevationResult> | See ElevationResult for more information. |
| required | ElevationStatus | See ElevationStatus for more information. |
| optional | string |
When the service returns a status code other than |
ElevationStatus
Status codes returned by service.
OK
indicating the API request was successful.DATA_NOT_AVAILABLE
indicating that there's no available data for the input locations.INVALID_REQUEST
indicating the API request was malformed.OVER_DAILY_LIMIT
indicating any of the following:- The API key is missing or invalid.
- Billing has not been enabled on your account.
- A self-imposed usage cap has been exceeded.
- The provided method of payment is no longer valid (for example, a credit card has expired).
OVER_QUERY_LIMIT
indicating the requestor has exceeded quota.REQUEST_DENIED
indicating the API did not complete the request.UNKNOWN_ERROR
indicating an unknown error.
अगर स्टेटस कोड OK
के अलावा कोई दूसरा है, तो एलिवेशन रिस्पॉन्स ऑब्जेक्ट में error_message
फ़ील्ड भी हो सकता है. इस फ़ील्ड में, दिए गए स्टेटस कोड की वजहों के बारे में ज़्यादा जानकारी होती है.
रिस्पॉन्स में इन एलिमेंट के साथ एक results
कलेक्शन शामिल होता है:
ElevationResult
Field | Required | Type | Description |
---|---|---|---|
| required | number | The elevation of the location in meters. |
| required | LatLngLiteral | A location element of the position for which elevation data is being computed. Note that for path requests, the set of location elements will contain the sampled points along the path. See LatLngLiteral for more information. |
| optional | number | The value indicating the maximum distance between data points from which the elevation was interpolated, in meters. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger resolution values) when multiple points are passed. To obtain the most accurate elevation value for a point, it should be queried independently. |
location
ऑब्जेक्ट में ये एलिमेंट हैं:
LatLngLiteral
An object describing a specific location with Latitude and Longitude in decimal degrees.
Field | Required | Type | Description |
---|---|---|---|
| required | number | Latitude in decimal degrees |
| required | number | Longitude in decimal degrees |
पोज़िशन की ऊंचाई के उदाहरण
नीचे दिए गए उदाहरण में, JSON फ़ॉर्मैट में डेनवर, कोलोराडो, "माइल हाई सिटी" के लिए एलिवेशन का अनुरोध किया गया है:
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>
यहां दिए गए उदाहरण में, एक से ज़्यादा जवाब दिखाए गए हैं. जैसे, डेनवर, कोलोरैडो और डेथ वैली, कैलिफ़ोर्निया के लिए.
इस अनुरोध में, JSON output
फ़्लैग का इस्तेमाल करने का तरीका बताया गया है:
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'
इस अनुरोध में, एक्सएमएल output
फ़्लैग का इस्तेमाल करने का तरीका बताया गया है:
https://maps.googleapis.com/maps/api/elevation/xml?locations=39.7391536,-104.9847034|36.455556,-116.866667&key=YOUR_API_KEY
JSON और एक्सएमएल के जवाबों के सैंपल देखने के लिए, नीचे दिए गए टैब चुनें.
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>
नीचे दिए गए उदाहरणों में एक सीधी रेखा के साथ, ऊंचाई के डेटा का अनुरोध किया गया है
path
जो माउंट व्हिटनी, कैलिफ़ोर्निया से बैडवाटर, सीए तक है, जो अमेरिका के महाद्वीप के सबसे ऊंचे और सबसे निचले बिंदु हैं. हम तीन samples
मांगते हैं, ताकि दो एंडपॉइंट और हाफ़वे पॉइंट शामिल हों.
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>