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