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