ऊंचाई के अनुरोध
एलिवेशन एपीआई के अनुरोध, यूआरएल स्ट्रिंग के तौर पर बनाए जाते हैं. एपीआई पृथ्वी पर जगहों के लिए ऊंचाई डेटा दिखाता है. जगह की जानकारी का डेटा, दो में से किसी एक तरीके से बताया जाता है:
- एक या ज़्यादा
locations
के सेट के तौर पर. path
पर कनेक्ट किए गए पॉइंट की सीरीज़ के तौर पर.
जगहों या पाथ के शीर्ष की पहचान करने के लिए, इनमें से कोई भी तरीका अक्षांश/देशांतर निर्देशांक का इस्तेमाल करता है. इस दस्तावेज़ में, Elevation API यूआरएल के ज़रूरी फ़ॉर्मैट और उपलब्ध पैरामीटर की जानकारी दी गई है.
Elevation API, सबसे ज़्यादा सटीक जानकारी वाली सिंगल पॉइंट क्वेरी के लिए डेटा दिखाता है. कई जगहों से जुड़ी बैच क्वेरी, कम सटीक तरीके से डेटा दिखा सकती हैं. खास तौर पर, अगर जगहों को अलग-अलग दिखाया जाता है, क्योंकि डेटा को बेहतर तरीके से दिखाया जाता है.
एलिवेशन एपीआई अनुरोध इस तरह से किया जाता है:
https://maps.googleapis.com/maps/api/elevation/outputFormat?parameters
जहां outputFormat
, इनमें से कोई भी वैल्यू हो सकती है:
json
(सुझाया गया), JavaScript ऑब्जेक्ट नोटेशन (JSON) में आउटपुट दिखाता है; याxml
, आउटपुट को एक्सएमएल में दिखाता है और यह<ElevationResponse>
नोड में रैप होता है.
ध्यान दें: मान्य यूआरएल बनाने के लिए, उन्हें सही तरीके से कोड में बदला जाना चाहिए. साथ ही, सभी वेब सेवाओं के लिए ज़्यादा से ज़्यादा 16,384 वर्ण इस्तेमाल किए जा सकते हैं. अपने यूआरएल बनाते समय इस सीमा का ध्यान रखें. ध्यान रखें कि अलग-अलग ब्राउज़र, प्रॉक्सी, और सर्वर की यूआरएल की वर्ण सीमाएं भी अलग-अलग हो सकती हैं.
एपीआई पासकोड का इस्तेमाल करने वाले अनुरोधों के लिए, एचटीटीपीएस ज़रूरी है.
अनुरोध के पैरामीटर
Elevation API को किए जाने वाले अनुरोध, अलग-अलग पैरामीटर का इस्तेमाल करते हैं. यह इस बात पर निर्भर करता है कि अनुरोध अलग-अलग जगहों के लिए है या क्रम वाले पाथ के लिए. अलग-अलग जगहों के लिए, ऊंचाई के अनुरोध से अनुरोध में पास की गई खास जगहों का डेटा मिलता है. इसके बजाय, पाथ के लिए, ऊंचाई के अनुरोधों का डेटा दिए गए पाथ पर सैंपल होता है.
जैसा कि सभी यूआरएल में मानक होता है, पैरामीटर को एंपरसैंड (&
) वर्ण का इस्तेमाल करके अलग किया जाता है. पैरामीटर की सूची और उनकी संभावित वैल्यू नीचे दी गई हैं.
सभी अनुरोध
key
— (ज़रूरी है) आपके ऐप्लिकेशन की एपीआई कुंजी. यह कुंजी कोटा प्रबंधन के लिए आपके ऐप्लिकेशन की पहचान करती है. कुंजी पाने का तरीका जानें.
पोज़िशन के हिसाब से किए गए अनुरोध
locations
(ज़रूरी है) से पृथ्वी पर उस जगह(जगहों) के बारे में पता चलता है जहां से ऊंचाई का डेटा दिखाया जाता है. यह पैरामीटर या तो किसी एक जगह को, कॉमा लगाकर अलग किए गए {अक्षांश,देशांतर} के जोड़े (जैसे, "40.714728,-73.998672") या कई अक्षांश/देशांतर के जोड़े के तौर पर या ऐरे या एन्कोड किए गए पॉलीलाइन के रूप में पास करता है. इस पैरामीटर के लिए 512 पॉइंट की सीमा तय है. ज़्यादा जानकारी के लिए, नीचे जगह तय करना देखें.
सैंपल पाथ के अनुरोध
path
(ज़रूरी है) पृथ्वी पर वह पाथ तय करता है जिसके लिए ऊंचाई का डेटा दिखाया जाता है. यह पैरामीटर दो या दो से ज़्यादा क्रमित {latitude,longitude} जोड़े के एक सेट को परिभाषित करता है. यह पृथ्वी की सतह पर पाथ की जानकारी देता है. इस पैरामीटर का इस्तेमाल, नीचे बताए गए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 फ़ॉर्मैट में, डेनवर, कोलोराडो, "मील हाई सिटी" की ऊंचाई का अनुरोध किया गया है:
यूआरएल
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
फ़्लैग के इस्तेमाल की जानकारी देता है:
यूआरएल
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
के लिए कहते हैं, इसलिए इसमें दो एंडपॉइंट और हाफ़वे पॉइंट शामिल होंगे.
यूआरएल
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>