इस दस्तावेज़ में यह बताया गया है कि पहला क्लाइंट ऐप्लिकेशन लिखने से पहले आपको क्या करना चाहिए.
कोई Google खाता प्राप्त करें
इस एपीआई का इस्तेमाल करने के लिए, आपके पास Google खाता होना ज़रूरी है. आपके खाते के पास किसी प्रॉपर्टी पर उस तरीके को लागू करने के लिए, Search Console की ज़रूरी अनुमति होनी चाहिए. उदाहरण के लिए, searchAnalytics.query चलाने के लिए, आपके पास उस प्रॉपर्टी के लिए पढ़ने की अनुमतियां होनी चाहिए.
Google Search Console आज़माएं
इस एपीआई दस्तावेज़ में यह माना गया है कि आपने Google Search Console का इस्तेमाल किया है और आपको वेब प्रोग्रामिंग के सिद्धांतों और वेब डेटा फ़ॉर्मैट के बारे में जानकारी है.
अगर आपने Google Search Console का इस्तेमाल नहीं किया है, तो कोड बनाने से पहले यूज़र इंटरफ़ेस आज़माएं. हर एपीआई, Search Console में किसी रिपोर्ट के काम करने के तरीके को दिखाता है. एपीआई का इस्तेमाल करने से पहले, आपको मिलने वाले डेटा को समझने के लिए उस रिपोर्ट से जुड़े दस्तावेज़ पढ़ें.
अपने क्लाइंट के लिए प्रोजेक्ट और क्रेडेंशियल बनाएं
Google Search Console को अनुरोध भेजने से पहले, आपको Google को अपने क्लाइंट के बारे में बताना होगा. साथ ही, एपीआई का ऐक्सेस चालू करना होगा. ऐसा करने के लिए, आपको Google API Console का इस्तेमाल करके प्रोजेक्ट बनाना होगा. प्रोजेक्ट, सेटिंग और एपीआई के ऐक्सेस की जानकारी का नाम वाला कलेक्शन होता है. इसके बाद, अपना ऐप्लिकेशन रजिस्टर किया जाता है.
टेस्टिंग टूल एपीआई को छोड़कर, Search Console के सभी एपीआई के लिए OAuth2 क्रेडेंशियल ज़रूरी हैं. Python और Java की क्विकस्टार्ट गाइड में, प्रोजेक्ट बनाने और अपने क्लाइंट के लिए क्रेडेंशियल पाने के बारे में जानकारी दी गई है.
REST से जुड़ी बुनियादी बातें समझना
एपीआई को शुरू करने के दो तरीके हैं:
- एचटीटीपी अनुरोध भेजना और जवाब पार्स करना.
- क्लाइंट लाइब्रेरी का इस्तेमाल करना.
अगर आपने क्लाइंट लाइब्रेरी का इस्तेमाल न करने का फ़ैसला किया है, तो आपको आरईएसटी की बुनियादी बातें जाननी होंगी.
आराम से जुड़ी बुनियादी बातें
REST, सॉफ़्टवेयर आर्किटेक्चर की एक स्टाइल है. यह डेटा का अनुरोध करने और उसमें बदलाव करने के लिए, आसान और एक जैसा तरीका उपलब्ध कराती है.
REST शब्द "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र" का छोटा रूप है. Google API के संदर्भ में, यह Google के सेव किए गए डेटा को दिखाने और उसमें बदलाव करने के लिए एचटीटीपी क्रियाओं का इस्तेमाल करता है.
RESTful सिस्टम में, संसाधनों को डेटा स्टोर में सेव किया जाता है. वहीं, क्लाइंट एक अनुरोध भेजता है कि सर्वर किसी खास काम (जैसे, संसाधन बनाना, वापस पाना, अपडेट करना या मिटाना) करता है. इसके बाद, सर्वर कार्रवाई करता है और जवाब देता है. आम तौर पर, यह अनुरोध, बताए गए संसाधन के तौर पर किया जाता है.
Google के RESTful एपीआई में, क्लाइंट एचटीटीपी कार्रवाई के बारे में बताता है, जैसे कि POST, GET, PUT या DELETE. यह ऐसे संसाधन के बारे में बताता है जो नीचे दिए गए फ़ॉर्म के दुनिया भर में मौजूद यूनीक यूआरआई की मदद से बनाया जाता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों में, एचटीटीपी से ऐक्सेस किए जा सकने वाले यूनीक यूआरआई होते हैं. इसलिए, REST डेटा कैश करने की सुविधा को चालू करती है. साथ ही, उसे वेब के डिस्ट्रिब्यूटेड इन्फ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
आपको एचटीटीपी 1.1 स्टैंडर्ड वाले दस्तावेज़ में तरीका की परिभाषाएं लग सकती हैं. इनमें GET, POST, PUT, और DELETE के लिए खास जानकारी शामिल होती है.
Google Search Console API में REST का निशान
Google Search Console API की कार्रवाइयां, सीधे REST एचटीटीपी कार्रवाइयों पर मैप होती हैं.
ज़्यादातर Google Search Console API यूआरआई का फ़ॉर्मैट कुछ इस तरह का होता है:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
हर तरीके के लिए इस्तेमाल किए गए यूआरआई और क्रिया का पूरा सेट Google Search Console API का संदर्भ की खास जानकारी में दिया गया है.
JSON से जुड़ी बुनियादी बातें समझना
Google Search Console API, JSON फ़ॉर्मैट में डेटा दिखाता है.
JSON (JavaScript ऑब्जेक्ट नोटेशन), आम तौर पर भाषा पर आधारित डेटा फ़ॉर्मैट है. यह आर्बिट्रेरी डेटा स्ट्रक्चर को टेक्स्ट में आसान तरीके से दिखाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.