इस पेज पर, रिसॉर्स ओरिएंटेड डिज़ाइन और रिसॉर्स के नामों के बारे में बताने वाली डेवलपर गाइड के बारे में जानकारी दी गई है. साथ ही, इसमें Google Ads API को लागू करने के बारे में खास जानकारी भी दी गई है.
रिसॉर्स ओरिएंटेड डिज़ाइन
आम तौर पर, Google Ads API, रिसॉर्स ओरिएंटेड डिज़ाइन को फ़ॉलो करता है. इसे अलग-अलग पतों वाले रिसॉर्स के कलेक्शन के तौर पर मॉडल किया जाता है. ये संज्ञाएं एपीआई की होती हैं. रिसॉर्स के नामों से, रिसॉर्स के रेफ़रंस दिए जाते हैं. साथ ही, तरीकों के छोटे सेट का इस्तेमाल करके, उन्हें मैनेज किया जाता है. इन्हें क्रियाएं या ऑपरेशन भी कहा जाता है. REST इंटरफ़ेस के यूआरएल में, इन रिसॉर्स के नाम और तरीके के साथ-साथ एपीआई वर्शन का प्रीफ़िक्स भी शामिल होता है. उदाहरण के लिए, इस उदाहरण के यूआरएल को, यहां दी गई टेबल के मुताबिक अलग-अलग कॉम्पोनेंट में बांटा जा सकता है:
https://googleads.googleapis.com/v25/customers/1234567890:mutate
| एपीआई वर्शन का प्रीफ़िक्स | रिसॉर्स का नाम (रिलेटिव) | तरीका |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
एपीआई के किसी खास वर्शन (जैसे, v25) के सभी REST यूआरएल में, एपीआई वर्शन का एक ही प्रीफ़िक्स होता है. रिसॉर्स का नाम और तरीका, दोनों मिलकर यह बताते हैं कि एपीआई की किस सेवा को कॉल किया जा रहा है.
Google Ads API में, कस्टम तरीकों का ज़्यादा इस्तेमाल किया जाता है. जबकि ज़्यादातर
REST API में, list, get,
create, update, और delete जैसे स्टैंडर्ड REST तरीकों का इस्तेमाल किया जाता है. 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 फ़ॉर्मैट में होता है.