इस एपीआई का सीधे तौर पर या SDK टूल के ज़रिए इस्तेमाल करने से पहले, आपको Google Cloud Search API का ऐक्सेस कॉन्फ़िगर करना होगा. इस दस्तावेज़ में, Google Cloud Search API REST API का इस्तेमाल करने के लिए ज़रूरी चरणों के बारे में बताया गया है.
1. एपीआई प्रोजेक्ट बनाना
एपीआई को चालू करने के लिए, आपको पहले Google Cloud प्रोजेक्ट बनाना होगा. यह प्रोजेक्ट, Google Cloud की सभी सेवाएं बनाने, चालू करने, और उनका इस्तेमाल करने का आधार बनाता है. इनमें एपीआई मैनेज करना, बिलिंग चालू करना, सहयोगियों को जोड़ना और हटाना, और अनुमतियां मैनेज करना शामिल है.
Google Cloud Console खोलें.
पेज पर सबसे ऊपर, "Google Cloud Console" के दाईं ओर मौजूद
पर क्लिक करें. आपको मौजूदा प्रोजेक्ट की सूची वाला डायलॉग दिखेगा.नया प्रोजेक्ट पर क्लिक करें. "नया प्रोजेक्ट" स्क्रीन दिखेगी.
प्रोजेक्ट का नाम फ़ील्ड में, प्रोजेक्ट का नाम डालें.
(ज़रूरी नहीं) प्रोजेक्ट आईडी में बदलाव करने के लिए, बदलाव करें पर क्लिक करें. प्रोजेक्ट बनाने के बाद, उसका आईडी नहीं बदला जा सकता. इसलिए, ऐसा आईडी चुनें जो प्रोजेक्ट के पूरे जीवनकाल के लिए आपकी ज़रूरतों को पूरा करता हो.
प्रोजेक्ट के लिए जगहें ब्राउज़ करने के लिए, ब्राउज़ करें पर क्लिक करें.
अपने प्रोजेक्ट के लिए किसी जगह पर क्लिक करें और चुनें पर क्लिक करें.
बनाएं पर क्लिक करें. ऐसा करने पर, कंसोल डैशबोर्ड पेज पर पहुंच जाता है. प्रोजेक्ट कुछ ही मिनटों में बन जाता है.
प्रोजेक्ट बनाने और मैनेज करने के बारे में ज़्यादा जानने के लिए, प्रोजेक्ट बनाना और मैनेज करना लेख पढ़ें.
2. एपीआई चालू करना
क्रेडेंशियल पाने के लिए, आपको Google Cloud Search API चालू करना होगा और एक सेवा खाता बनाना होगा.
- यह पक्का करने के लिए कि आपने नया प्रोजेक्ट बनाया है, Google Cloud Console के बैनर के दाईं ओर मौजूद आइकॉन पर क्लिक करें. इसके बाद, अपना नया प्रोजेक्ट चुनें.
- एपीआई और सेवाएं चालू करें पर क्लिक करें. "एपीआई लाइब्रेरी में आपका स्वागत है" पेज दिखता है.
- Google Cloud Search API पर जाएं.
- चालू करें पर क्लिक करें. "खास जानकारी" पेज दिखेगा.
एपीआई को चालू और बंद करने के बारे में ज़्यादा जानने के लिए, Google Cloud Console में एपीआई मैनेज करना लेख पढ़ें
3. सेवा खाते के क्रेडेंशियल बनाना
- Google Cloud Console में, बाईं ओर मौजूद नेविगेशन में क्रेडेंशियल पर क्लिक करें. क्रेडेंशियल पेज दिखेगा.
- क्रेडेंशियल बनाएं ड्रॉप-डाउन सूची से, सेवा खाता चुनें. "सेवा खाता बनाएं" पेज दिखेगा.
- सेवा खाते का नाम फ़ील्ड में कोई नाम डालें.
- (ज़रूरी नहीं) सेवा खाते के आईडी में बदलाव करें.
- बनाएं पर क्लिक करें. "सेवा खाते की अनुमतियां" स्क्रीन दिखेगी.
- जारी रखें पर क्लिक करें. "उपयोगकर्ताओं को इस सेवा खाते का ऐक्सेस दें" स्क्रीन दिखेगी.
- कुंजी बनाएं पर क्लिक करें. इसके बाद, हो गया पर क्लिक करें. "आपके कंप्यूटर पर सेव की गई निजी कुंजी" डायलॉग दिखता है. साथ ही, निजी कुंजी की एक कॉपी आपके कंप्यूटर पर डाउनलोड हो जाती है.
- Close पर क्लिक करें.
सेवा खातों के बारे में ज़्यादा जानकारी के लिए, सेवा खाते, वेब ऐप्लिकेशन, और इंस्टॉल किए गए ऐप्लिकेशन लेख पढ़ें
4. ईमेल पते की पहचान करना
- Google Cloud Console में, पेज पर सबसे ऊपर मौजूद वह प्रोजेक्ट चुनें जिसे आपने बनाया है.
- Google Cloud Console के बैनर की बाईं ओर मौजूद नेविगेशन मेन्यू पर क्लिक करें.
- IAM और एडमिन > सेवा खाते पर क्लिक करें.
- सूची में, "सेवा खाते का आईडी" में जाकर, जनरेट किए गए उस ईमेल पते को नोट करें जिससे आपके कॉन्फ़िगर किए गए सेवा खाते की पहचान होती है. Cloud Search में डेटा सोर्स जोड़ते समय, इस ईमेल पते का इस्तेमाल किया जाता है.
5. तीसरे पक्ष की सहायता शुरू करना
Cloud Search के किसी भी अन्य एपीआई को कॉल करने से पहले, आपको Google Cloud Search के लिए तीसरे पक्ष की सहायता शुरू करनी होगी.
Cloud Search के लिए तीसरे पक्ष की सहायता शुरू करने के लिए:
आपके Cloud Search Platform प्रोजेक्ट में सेवा खाते के क्रेडेंशियल मौजूद हैं. हालांकि, तीसरे पक्ष की सहायता शुरू करने के लिए, आपको वेब ऐप्लिकेशन के क्रेडेंशियल बनाने होंगे. वेब ऐप्लिकेशन के क्रेडेंशियल बनाने का तरीका जानने के लिए, क्रेडेंशियल बनाएं लेख पढ़ें. यह चरण पूरा करने के बाद, आपके पास क्लाइंट आईडी और क्लाइंट सीक्रेट फ़ाइल होनी चाहिए.
ऐक्सेस टोकन पाने के लिए, Google के OAuth 2 प्लेलैंड का इस्तेमाल करें:
- सेटिंग पर क्लिक करें और अपने पुष्टि करने वाले क्रेडेंशियल इस्तेमाल करें को चुनें.
- पहले चरण में दिए गए क्लाइंट आईडी और क्लाइंट सीक्रेट डालें.
- Close पर क्लिक करें.
- दायरों वाले फ़ील्ड में,
https://www.googleapis.com/auth/cloud_search.settings
लिखें और अनुमति दें पर क्लिक करें. OAuth 2 प्लैटफ़ॉर्म, ऑथराइज़ेशन कोड दिखाता है. - टोकन के लिए ऑथराइज़ेशन कोड बदलें पर क्लिक करें. एक टोकन दिखाया जाता है.
Cloud Search के लिए तीसरे पक्ष की सहायता शुरू करने के लिए, यहां दिए गए curl कमांड का इस्तेमाल करें.
[YOUR_ACCESS_TOKEN]
की जगह, दूसरे चरण में मिले टोकन का इस्तेमाल करें.curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
कामयाब रहने पर, जवाब के मुख्य हिस्से में
operation
का एक इंस्टेंस शामिल किया जाता है. उदाहरण के लिए:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
अगर ऐसा नहीं होता है, तो Cloud Search की सहायता टीम से संपर्क करें.
तीसरे पक्ष की सहायता शुरू की गई है या नहीं, इसकी पुष्टि करने के लिए operations.get का इस्तेमाल करें:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
तीसरे पक्ष का इंनिशियलाइज़ेशन पूरा होने के बाद, इसमें
done
फ़ील्डtrue
पर सेट होता है. उदाहरण के लिए:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
अगले चरण
यहां कुछ अगले चरण बताए गए हैं:
अगर आपको Google Cloud Search का इस्तेमाल, Google के अलावा किसी दूसरे डेटा रिपॉज़िटरी के साथ करना है, जैसे कि Microsoft® SharePoint®, तो आपको डेटा सोर्स बनाना होगा. डेटा सोर्स जोड़ने के निर्देशों के लिए, खोज के लिए डेटा सोर्स जोड़ना लेख पढ़ें.
डेटा सोर्स सेट अप करने के बाद, स्कीमा बनाएं और रजिस्टर करें. इससे यह पता चलता है कि Google Cloud Search को डेटा को रिपॉज़िटरी में कैसे दिखाना चाहिए.