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

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

संसाधन-ओरिएंटेड डिज़ाइन

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

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

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

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

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

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