REST इंटरफ़ेस डिज़ाइन

इस पेज पर, यह मान लिया गया है कि आपको संसाधन के हिसाब से डिज़ाइन और संसाधन के नाम वाली डेवलपर गाइड के बारे में जानकारी है. साथ ही, इसमें Google Ads API को लागू करने के बारे में खास जानकारी दी गई है.

अहम जानकारी: इस गाइड में दिए गए सभी उदाहरणों में, एपीआई को कॉल करने का तरीका दिखाने के लिए एचटीटीपी प्रोटोकॉल का इस्तेमाल किया गया है. curl कमांड लाइन यूटिलिटी का इस्तेमाल करके, इसी तरह के एपीआई कॉल करने का तरीका जानने के लिए, उदाहरण पेज देखें.

संसाधन के हिसाब से डिज़ाइन करना

आम तौर पर, Google Ads API में संसाधन-आधारित डिज़ाइन का इस्तेमाल किया जाता है. इसे अलग-अलग पते वाले संसाधनों के संग्रह (एपीआई के संज्ञा) के तौर पर मॉडल किया जाता है. रिसॉर्स को उनके रिसॉर्स के नामों से रेफ़र किया जाता है. साथ ही, तरीकों के छोटे सेट का इस्तेमाल करके उनमें बदलाव किया जाता है. इन्हें क्रियाएं या कार्रवाइयां भी कहा जाता है.

ये संसाधन के नाम और तरीके, किसी एपीआई वर्शन के प्रीफ़िक्स के साथ मिलकर, REST इंटरफ़ेस के यूआरएल बनाते हैं. उदाहरण के लिए, यहां दिए गए यूआरएल को अलग-अलग कॉम्पोनेंट में बांटा जा सकता है. इसके बारे में यहां दी गई टेबल में बताया गया है:

https://googleads.googleapis.com/v21/customers/1234567890:mutate

एपीआई वर्शन का प्रीफ़िक्स	संसाधन का नाम (रिलेटिव)	तरीका
https://googleads.googleapis.com/v21	customers/1234567890	mutate

एपीआई के किसी वर्शन के लिए सभी REST यूआरएल (जैसे, v21) एक ही एपीआई वर्शन प्रीफ़िक्स शेयर करें. संसाधन का नाम और तरीका, दोनों मिलकर यह तय करते हैं कि किस एपीआई सेवा को कॉल किया जा रहा है.

Google Ads API, ज़्यादातर कस्टम तरीकों का इस्तेमाल करता है. वहीं, ज़्यादातर पारंपरिक REST API, स्टैंडर्ड REST तरीकों का इस्तेमाल करते हैं. जैसे, list, get, create, update, और delete. Google Ads API में कस्टम तरीकों के उदाहरणों में search, searchStream, और mutate शामिल हैं.

यहां दिए गए पेजों पर, Google Ads API के संसाधन के नामों, सेवा के तरीकों, और JSON के नाम रखने के नियमों के बारे में ज़्यादा जानकारी दी गई है. इससे यह समझने में मदद मिलती है कि REST इंटरफ़ेस एंडपॉइंट तय करने के लिए, इनका एक साथ इस्तेमाल कैसे किया जाता है.

डिस्कवरी दस्तावेज़

Google Ads API में उपलब्ध तरीकों को आसानी से खोजने और उन्हें अपने-आप लागू करने के लिए, हर वर्शन के लिए पब्लिश किए गए खोज से जुड़े दस्तावेज़ का इस्तेमाल किया जा सकता है.

यह https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION> पर उपलब्ध है. इसलिए, उदाहरण के लिए, यह Google Ads API के सबसे नए वर्शन का डिस्कवरी दस्तावेज़ है.

डिस्कवरी दस्तावेज़ में, Google Ads API में इस्तेमाल की जाने वाली सभी सेवाओं, तरीकों, संसाधनों, और इकाइयों के बारे में जानकारी होती है. जैसे, रेफ़रंस दस्तावेज़. हालांकि, यह जानकारी मशीन से पढ़े जा सकने वाले JSON फ़ॉर्मैट में होती है.