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

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

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

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

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

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

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 फ़ॉर्मैट में होती है.