इस दस्तावेज़ में बताया गया है कि अपना पहला क्लाइंट ऐप्लिकेशन लिखने से पहले आपको क्या करना चाहिए.
कोई Google खाता प्राप्त करें
इस एपीआई का इस्तेमाल करने के लिए, आपके पास एक Google खाता होना चाहिए. अपने खाते में किसी प्रॉपर्टी को Search Console की अनुमति देने के लिए, उस प्रॉपर्टी पर Search Console की अनुमति होनी ज़रूरी है. उदाहरण के लिए, searchAnalytics.query चलाने के लिए, आपके पास उस प्रॉपर्टी पर पढ़ने की अनुमतियां होनी चाहिए.
Google Search Console आज़माएं
एपीआई के इस दस्तावेज़ के लिए यह मान लिया जाता है कि आपने Google Search Console का इस्तेमाल किया है. साथ ही, आपको वेब प्रोग्रामिंग के सिद्धांतों और वेब डेटा फ़ॉर्मैट के बारे में जानकारी है.
अगर आपने Google Search Console का इस्तेमाल नहीं किया है, तो कोड शुरू करने से पहले, यूज़र इंटरफ़ेस आज़माएं. हर एपीआई, Search Console में किसी रिपोर्ट के फ़ंक्शन को दिखाता है. आपको जो डेटा मिलता है उसे समझने के लिए, एपीआई का इस्तेमाल करने से पहले, आपको उस जैसी रिपोर्ट के लिए यह दस्तावेज़ पढ़ना चाहिए.
अपने क्लाइंट के लिए प्रोजेक्ट और क्रेडेंशियल बनाना
Google Search Console को अनुरोध भेजने से पहले, आपको Google को अपने क्लाइंट के बारे में बताना होगा और एपीआई का ऐक्सेस चालू करना होगा. ऐसा करने के लिए Google API (एपीआई) कंसोल का इस्तेमाल करके एक प्रोजेक्ट बनाएं. यह सेटिंग और एपीआई ऐक्सेस की जानकारी का कलेक्शन होता है और इसमें आपका ऐप्लिकेशन रजिस्टर किया जाता है.
टेस्टिंग टूल एपीआई के अलावा, सभी Search Console एपीआई को OAuth2 क्रेडेंशियल की ज़रूरत होती है. Python और Java की क्विकस्टार्ट गाइड, प्रोजेक्ट बनाने और अपने क्लाइंट के क्रेडेंशियल पाने के तरीके के बारे में जानकारी देती हैं.
REST की बुनियादी बातों को समझें
एपीआई को शुरू करने के दो तरीके हैं:
- एचटीटीपी अनुरोध भेजना और जवाब पार्स करना.
- क्लाइंट लाइब्रेरी का इस्तेमाल करके.
अगर आप क्लाइंट लाइब्रेरी इस्तेमाल नहीं करने का फ़ैसला लेते हैं, तो आपको REST की बुनियादी बातों को समझना होगा.
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 देखें.