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