इस पेज पर, यह मान लिया गया है कि आपको संसाधन के हिसाब से डिज़ाइन किए गए एपीआई और संसाधन के नाम के बारे में डेवलपर गाइड की जानकारी है. साथ ही, इसमें Google Ads API को लागू करने के बारे में खास जानकारी दी गई है.
संसाधन के हिसाब से डिज़ाइन करना
आम तौर पर, 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 इंटरफ़ेस एंडपॉइंट तय करने के लिए, इनका एक साथ इस्तेमाल कैसे किया जाता है.