Geocoding API सेट अप करना

इस दस्तावेज़ में, Geocoding API का इस्तेमाल शुरू करने के लिए ज़रूरी चरणों के बारे में बताया गया है.

Google Maps Platform के प्रॉडक्ट के लिए, एपीआई कॉल में एपीआई पासकोड या OAuth टोकन शामिल करना ज़रूरी है. इससे, बिना अनुमति के इस्तेमाल को रोका जा सकता है. आपके पास सेटअप करने की वह प्रक्रिया चुनने का विकल्प है जो आपके डिप्लॉयमेंट एनवायरमेंट से मेल खाती हो.

एपीआई पासकोड OAuth टोकन

OAuth टोकन बनाना

Geocoding API, पुष्टि करने के लिए OAuth 2.0 का इस्तेमाल करता है. Google, OAuth 2.0 के सामान्य मामलों के साथ काम करता है. जैसे, वेब सर्वर के मामले.

इस दस्तावेज़ में, आपके डेवलपमेंट एनवायरमेंट में Geocoding API कॉल को OAuth टोकन पास करने का तरीका बताया गया है. प्रोडक्शन एनवायरमेंट में OAuth का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, Google पर पुष्टि करने के तरीके देखें.

सर्वर को एपीआई अनुरोध भेजकर, Google Maps API को सीधे कॉल किया जा सकता है. इसके अलावा, अपने कोड को आसान बनाने के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल किया जा सकता है. Google Maps, Go, Java, Node.js, और Python के लिए क्लाइंट लाइब्रेरी उपलब्ध कराता है. ज़्यादा जानकारी के लिए, Geocoding API की क्लाइंट लाइब्रेरी देखें.

OAuth के बारे में खास जानकारी

डिप्लॉयमेंट एनवायरमेंट के आधार पर, OAuth की मदद से ऐक्सेस टोकन बनाने और उन्हें मैनेज करने के कई तरीके हैं.

अपने ऐप्लिकेशन और Google की किसी सेवा के बीच सर्वर-टू-सर्वर इंटरैक्शन के लिए, OAuth 2.0 का इस्तेमाल किया जा सकता है. इस मामले में, आपको किसी उपयोगकर्ता के बजाय, अपने ऐप्लिकेशन से जुड़े सेवा खाते का इस्तेमाल करना होगा. सेवा खाते का इस्तेमाल करके, उपयोगकर्ताओं को सीधे तौर पर शामिल किए बिना एपीआई अनुरोध किए जा सकते हैं. पुष्टि करने के तरीकों के बारे में ज़्यादा जानने के लिए, Google पर पुष्टि करने के तरीके लेख पढ़ें.

इसके अलावा, Geocoding API को Android या iOS मोबाइल ऐप्लिकेशन में इंटिग्रेट किया जा सकता है. डिप्लॉयमेंट के अलग-अलग एनवायरमेंट के लिए, OAuth का इस्तेमाल करने और ऐक्सेस टोकन मैनेज करने के बारे में ज़्यादा जानने के लिए, Google API को ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना लेख पढ़ें.

OAuth के दायरे

Geocoding API के साथ OAuth का इस्तेमाल करने के लिए, आपको OAuth टोकन को सही दायरा असाइन करना होगा. Geocoding API के लिए, ये स्कोप इस्तेमाल किए जा सकते हैं:

• https://www.googleapis.com/auth/maps-platform.geocode—Geocoding API के सभी तरीकों के साथ इस्तेमाल करें.
• https://www.googleapis.com/auth/maps-platform.destinations—मंज़िल और पहुंचने से जुड़ी क्वेरी के लिए, सिर्फ़ SearchDestinations के साथ इस्तेमाल करें.
• https://www.googleapis.com/auth/maps-platform.geocode.address—फ़ॉरवर्ड जियोकोडिंग के लिए, सिर्फ़ GeocodeAddress के साथ इस्तेमाल करें.
• https://www.googleapis.com/auth/maps-platform.geocode.location—रिवर्स जियोकोडिंग के लिए, सिर्फ़ GeocodeLocation के साथ इस्तेमाल करें.
• https://www.googleapis.com/auth/maps-platform.geocode.place—जगह की जियोकोडिंग के लिए, सिर्फ़ GeocodePlace के साथ इस्तेमाल करें.

Geocoding API के सभी तरीकों के लिए, सामान्य https://www.googleapis.com/auth/cloud-platform स्कोप का भी इस्तेमाल किया जा सकता है. यह स्कोप, डेवलपमेंट के दौरान काम आता है. इसकी वजह यह है कि gcloud सीएलआई की मदद से टोकन बनाते समय, यह डिफ़ॉल्ट स्कोप होता है.

उदाहरण: अपने लोकल डेवलपमेंट एनवायरमेंट में REST API कॉल आज़माना

अगर आपके पास टोकन जनरेट करने वाला एनवायरमेंट नहीं है और आपको OAuth टोकन के साथ Geocoding API को आज़माना है, तो इस सेक्शन में दी गई प्रोसेस का इस्तेमाल करें.

इस उदाहरण में, कॉल करने के लिए ऐप्लिकेशन डिफ़ॉल्ट क्रेडेंशियल (एडीसी) से मिले OAuth टोकन का इस्तेमाल करने का तरीका बताया गया है. क्लाइंट लाइब्रेरी की मदद से Google API को कॉल करने के लिए, एडीसी का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल करके पुष्टि करना लेख पढ़ें.

यहां दी गई REST प्रोसेस का इस्तेमाल सिर्फ़ डेवलपमेंट या टेस्टिंग के लिए करें, प्रोडक्शन के लिए नहीं.

ज़रूरी शर्तें

एडीसी का इस्तेमाल करके REST अनुरोध करने से पहले, एडीसी को क्रेडेंशियल देने के लिए gcloud सीएलआई का इस्तेमाल करें:

1. gcloud सीएलआई को इंस्टॉल करें और उसे शुरू करें. ज़्यादा जानकारी के लिए, gcloud सीएलआई इंस्टॉल करें लेख पढ़ें.

2. gcloud सीएलआई की मदद से पुष्टि करें:

   gcloud auth application-default login

3. एडीसी की इस्तेमाल की जाने वाली लोकल क्रेडेंशियल फ़ाइल में अपने क्रेडेंशियल सेव करने के लिए, साइन इन करने की प्रोसेस पूरी करें.

ज़्यादा जानकारी के लिए, लोकल डेवलपमेंट एनवायरमेंट के लिए एडीसी सेट अप करना लेख पढ़ें.

REST अनुरोध करना

इस उदाहरण में, आप दो अनुरोध का हेडर पास करते हैं:

• टोकन जनरेट करने के लिए, इस कमांड का इस्तेमाल करके Authorization हेडर में OAuth टोकन पास करें:

  gcloud auth application-default print-access-token

  वापस किए गए टोकन का दायरा https://www.googleapis.com/auth/cloud-platform है.

• अपने उस Google Cloud प्रोजेक्ट का आईडी या नाम पास करें जिसके लिए X-Goog-User-Project हेडर में बिलिंग की सुविधा चालू है.

OAuth टोकन का इस्तेमाल करके Geocoding API को कॉल करने के लिए, यह तरीका अपनाएं:

1. यहां दिए गए कोड सैंपल में, PROJECT_ID की जगह अपना Google Cloud प्रोजेक्ट आईडी डालें:

   curl -X GET -H 'Content-Type: application/json' \
   -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   -H "X-Goog-User-Project: PROJECT_ID" \
   "https://geocode.googleapis.com/v4/geocode/address/1600+Amphitheatre+Parkway,+Mountain+View,+CA"
   

2. curl कमांड को कॉपी करने के लिए, कोड सैंपल में कॉपी करें पर क्लिक करें.

3. कमांड को टर्मिनल विंडो में चिपकाएं और फिर उसे चलाएं.

समस्या का हल

अगर आपके अनुरोध पर गड़बड़ी का यह मैसेज मिलता है कि यह एपीआई असली उपयोगकर्ता के क्रेडेंशियल के साथ काम नहीं करता, तो एडीसी सेटअप से जुड़ी समस्या हल करना लेख पढ़ें.