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

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

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

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

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

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

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

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

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