Google APIs खोजें और उन्हें चुनें

1. शुरू करने से पहले

इस कोडलैब में, Google API खोजने और चुनने के साथ-साथ एपीआई मेट्रिक देखने का तरीका बताया गया है.

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

  • Google Cloud Console पर नेविगेट करने की सुविधा.

आपको क्या सीखने को मिलेगा

  • Google Cloud API लाइब्रेरी और OAuth 2.0 Playground का इस्तेमाल करके, एपीआई कैसे खोजें और चुनें.
  • Metrics Explorer और Cloud APIs & Services की मदद से, एपीआई मेट्रिक देखने का तरीका.

आपको किन चीज़ों की ज़रूरत होगी

2. Cloud Console से एपीआई ऐक्सेस करना

  1. Cloud Console में, 5854836f11d5d97b.png नेविगेशन मेन्यू > एपीआई और सेवाएं > चालू किए गए एपीआई और सेवाएं को चुनें.

Cloud Console में नेविगेशन मेन्यू की इमेज

  1. एपीआई और सेवाएं डैशबोर्ड में, उपलब्ध एपीआई देखने के लिए + एपीआई और सेवाएं चालू करें पर क्लिक करें.

एपीआई और सेवाएं डैशबोर्ड में, एपीआई और सेवाएं चालू करें विकल्प दिखाया गया है.

एपीआई और सेवाएं पेज पर, एपीआई खोजने के कई तरीके हैं. अगर आपको एपीआई का नाम पता है, तो उसे पेज पर सबसे ऊपर मौजूद एपीआई और सेवाएं खोजें फ़ील्ड में डालें. पेज के किनारे मौजूद फ़िल्टर का इस्तेमाल करके, कैटगरी के हिसाब से भी एपीआई फ़िल्टर किए जा सकते हैं.

एपीआई और सेवाएं ढूंढें फ़ील्ड में खोज करने पर मिले एपीआई की सूची.

  1. कैटगरी मेन्यू में, मशीन लर्निंग को चुनें, ताकि आपको सिर्फ़ मशीन लर्निंग एपीआई दिखें.

सिर्फ़ मशीन लर्निंग वाले एपीआई दिखाने के लिए, एपीआई को CATEGORY के हिसाब से फ़िल्टर किया गया है.

  1. मशीन लर्निंग एपीआई में जाकर, Cloud Natural Language API को चुनें. इससे आपको इस एपीआई के बारे में जानकारी मिलेगी.
  2. सही प्रोजेक्ट में इस एपीआई को चालू करने के लिए, चालू करें पर क्लिक करें.

Cloud Natural Language API का पैनल, जिसमें 'चालू करें' और 'इस एपीआई को आज़माएं' बटन दिख रहे हैं.

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

चुने गए एपीआई का खास जानकारी देने वाला पेज, जिसमें एपीआई के लिए मेट्रिक दिखाई गई हैं.

आने वाले समय में, क्रेडेंशियल बनाने के तरीके के बारे में ज़्यादा जानकारी दी जाएगी. हालांकि, अगर आपको अभी इसके बारे में जानना है, तो क्रेडेंशियल बनाएं पर क्लिक करें. इसके बाद, पूछे गए सवालों के जवाब दें.

  1. पिछले चरण में खास जानकारी पर वापस जाने के लिए, मैनेज करें पर क्लिक करें.

Cloud Natural Language API के बारे में खास जानकारी देने वाला पेज.

  1. एपीआई को आज़माने के लिए, इस एपीआई को आज़माएं पर क्लिक करें. ऐसा एपीआई को चालू करने से पहले भी किया जा सकता है.

इससे आम तौर पर, आपको एपीआई के दस्तावेज़ वाले पेज पर ले जाया जाता है. हालांकि, कुछ एपीआई के लिए, एपीआई को तुरंत आज़माने का कोई तरीका नहीं है, क्योंकि इसमें कई अलग-अलग तरीके होते हैं. Cloud Natural Language API के लिए ऐसा ही होता है.

Cloud Natural Language API का रेफ़रंस पेज.

  1. analyzeEntitites तरीका चुनें.

आपको एपीआई के तरीकों के बारे में जानकारी देने वाला एक वेब पेज दिखेगा. साथ ही, यह एपीआई आज़माएं पैनल दिखेगा.

analyzeEntities तरीके के लिए पेज, जिसमें तरीके की जानकारी और 'यह एपीआई आज़माएं' पैनल दिखाया गया है.

  1. सैंपल क्वेरी आज़माने के लिए, इन पैरामीटर के साथ अनुरोध के मुख्य हिस्से फ़ील्ड में document ऑब्जेक्ट जोड़ें. फ़ील्ड के विकल्पों को बड़ा करने के लिए, + आइकॉन पर क्लिक करें.
  2. content: फ़ील्ड में, वह टेक्स्ट डालें जिसका विश्लेषण करना है.

इस उदाहरण में Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'. का इस्तेमाल किया गया है

  1. type: फ़ील्ड में, PLAIN_TEXT चुनें.

अनुरोध का मुख्य हिस्सा ऐसा दिखना चाहिए:

अनुरोध के मुख्य हिस्से का पैरामीटर दिखाने वाला अनुरोध के मुख्य हिस्से का पैनल.

हर पैरामीटर के बारे में ज़्यादा जानने के लिए, दस्तावेज़ देखें.

  1. Google OAuth 2.0 वाले चेकबॉक्स से सही का निशान हटाएं. इसके बाद, इकाइयों के बारे में जानकारी वाला जवाब पाने के लिए, लागू करें पर क्लिक करें.

इकाइयों के बारे में जानकारी देने वाला 200 रिस्पॉन्स.

  1. एपीआई कुंजी चेकबॉक्स से सही का निशान हटाएं. इसके बाद, लागू करें पर फिर से क्लिक करें.

इस बार क्वेरी चलाने पर, आपको इस तरह की गड़बड़ी का मैसेज मिलता है. ऐसा इसलिए होता है, क्योंकि एपीआई को चलाने के लिए क्रेडेंशियल की ज़रूरत होती है.

अनुरोध में क्रेडेंशियल मौजूद न होने पर, 403 रिस्पॉन्स मिलता है.

  1. Google OAuth 2.0 चेकबॉक्स को चुनें. इसके बाद, Execute पर फिर से क्लिक करें.

OAuth 2.0, आपके खाते पर एपीआई की अनुमतियां देता है और आपको चेतावनी दिखाता है.

OAuth 2.0 की चेतावनी, जिसमें बताया गया है कि Google APIs Explorer को आपके Google खाते का ऐक्सेस चाहिए.

ऐक्सेस की अनुमति देने पर, आपको वही जवाब मिलेगा जो एपीआई पासकोड के साथ मिलता था. अगर आपको किसी ऐप्लिकेशन में एपीआई का इस्तेमाल करना है और आपको उन लोगों को ऐक्सेस देना है जिनके पास अपने क्रेडेंशियल की जानकारी है, तो आपको OAuth 2.0 का इस्तेमाल करना होगा. अगर ऐप्लिकेशन को उपयोगकर्ता के लिए एपीआई ऐक्सेस करने की अनुमति देनी है, तो एपीआई कुंजियों का इस्तेमाल किया जा सकता है.

3. मेट्रिक एक्सप्लोरर की मदद से, एपीआई की मेट्रिक देखना

किसी भी एपीआई के लिए किए गए कॉल का इतिहास देखने के लिए, एपीआई की खास जानकारी वाले पेज पर जाएं. यह पेज, Cloud Console से एपीआई ऐक्सेस करने के छठे चरण में दिखाया गया है. हालांकि, एपीआई के सभी इस्तेमाल के लिए ज़्यादा मेट्रिक देखने के लिए, मेट्रिक एक्सप्लोरर का इस्तेमाल करें.

  1. f6b6844bf5688982.png नेविगेशन मेन्यू के कार्रवाइयां सेक्शन में, निगरानी > मेट्रिक एक्सप्लोरर पर क्लिक करें.

नेविगेशन मेन्यू के 'कार्रवाइयां' सेक्शन में, मॉनिटरिंग और मेट्रिक एक्सप्लोरर के चुने गए विकल्प दिख रहे हैं.

  1. संसाधन का टाइप मेन्यू में, मेट्रिक के टाइप के तौर पर इस्तेमाल किया गया एपीआई चुनें. (अगर आपको यह नहीं दिखता है, तो सिर्फ़ चालू कैंपेन दिखाएं चेकबॉक्स से सही का निशान हटाएं.)

ca850c4295ef4ec9.png

  1. मेट्रिक मेन्यू में, एपीआई के लिए कोई एक मेट्रिक चुनें. जैसे, अनुरोध की संख्या. इससे यह पता चलेगा कि दी गई अवधि में कितने एपीआई कॉल किए गए.

अनुरोधों की संख्या के लिए, इस्तेमाल किए गए एपीआई की मेट्रिक दिखाने वाला मेट्रिक एक्सप्लोरर.

  1. आउटपुट को और ज़्यादा पसंद के मुताबिक बनाने के लिए, एग्रीगेटर सेट करें और समय अवधि में बदलाव करें. इस इमेज में, मेट्रिक एक्सप्लोरर दिखाया गया है. इसमें, इस्तेमाल किए गए एपीआई की मेट्रिक दिखाई गई हैं. साथ ही, अनुरोधों की संख्या के लिए एग्रीगेटर और समयावधि भी तय की गई है.

4. एपीआई आज़माने के लिए, OAuth 2.0 Playground का इस्तेमाल करना

Google APIs को आज़माने के लिए, OAuth 2.0 Playground का इस्तेमाल भी किया जा सकता है. OAuth 2.0 Playground की मदद से, कोई एपीआई चुना जा सकता है. इसके बाद, उसे अनुमति दी जा सकती है. इसके बाद, अनुरोध भेजे जा सकते हैं और OAuth 2.0 Playground की कंसोल विंडो में जवाब देखे जा सकते हैं.

  1. OAuth 2.0 Playground खोलें.

OAuth 2.0 Playground में, उन एपीआई की सूची दिखाई गई है जिन्हें आज़माया जा सकता है.

  1. Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Authorize APIs पर क्लिक करें.

OAuth 2.0 Playground में, चुने गए Cloud Natural Language API दिखाए गए हैं.

  1. अगर ज़रूरी हो, तो अपने Google खाते में साइन इन करें. इसके बाद, अनुमति देने वाला कोड पाने के लिए अनुमति दें पर क्लिक करें.
  2. टोकन के लिए ऑथराइज़ेशन कोड बदलें पर क्लिक करें.

'टोकन के लिए ऑथराइज़ेशन कोड बदलें' पैनल में जाकर, 'टोकन के लिए ऑथराइज़ेशन कोड बदलें' पर क्लिक करें.

अब एपीआई का अनुरोध किया जा सकता है.

  1. सभी संभावित एपीआई कॉल की जांच करने के लिए, संभावित कार्रवाइयां दिखाएं पर क्लिक करें.

आपने पहले Natural Language API analyzeEntities दस्तावेज़ का जानकारी वाला पेज खोला था. इसलिए, आपको दिख सकता है कि एचटीटीपी अनुरोध का यूआरएल यह है:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

यह एक POST अनुरोध है.

'एपीआई से अनुरोध करें' पैनल को कॉन्फ़िगर करें. यहां से एचटीटीपी तरीका चुना जा सकता है, अनुरोध यूआरआई रजिस्टर किया जा सकता है, अनुरोध का मुख्य हिस्सा डाला जा सकता है, और अनुरोध भेजा जा सकता है.

  1. अनुरोध यूआरआई की जानकारी डालें और अनुरोध का मुख्य हिस्सा जोड़ें.

एपीआई एक्सप्लोरर में इस्तेमाल किए गए कोड का इस्तेमाल यहां भी किया जा सकता है.

अनुरोध के मुख्य हिस्से वाला पैनल.

  1. बंद करें > अनुरोध भेजें पर क्लिक करें.

आपको इस इमेज में दिखाए गए नतीजों जैसे नतीजे मिलने चाहिए:

अनुरोध पोस्ट करने के बाद, OAuth 2.0 अनुरोध/जवाब वाला पैनल.

OAuth 2.0 Playground में, अन्य एपीआई आज़माएं.

5. व्यवस्थित करें

प्रोजेक्ट के लिए, बिना किसी पाबंदी वाला एपीआई पासकोड इस्तेमाल करना सही तरीका नहीं है. अगर किसी व्यक्ति को इसका ऐक्सेस मिल जाता है, तो वह इसका इस्तेमाल बिना किसी और पुष्टि के कर सकता है.

इस एपीआई पासकोड को मिटाने के लिए:

  1. f6b6844bf5688982.png नेविगेशन मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर क्लिक करें.
  2. एपीआई पासकोड में जाकर, मिटाने के लिए पासकोड चुनें. इसके बाद, 247adf2e1d1eae4b.png पर क्लिक करें.
  3. इसी तरह, सेवा खाते की निजी कुंजी के सुरक्षित न होने की चिंता करने के बजाय, सेवा खाते में जाकर, मिटाने के लिए सेवा खाता चुनें. इसके बाद, 247adf2e1d1eae4b.png पर क्लिक करें.

6. बधाई हो

बधाई हो! आपने Google APIs को खोजने और चुनने का तरीका सीखा. साथ ही, उनकी मेट्रिक देखने का तरीका भी सीखा.