रेफ़रंस गाइड

इस दस्तावेज़ में Google Sites Data API के रॉ प्रोटोकॉल (एक्सएमएल और एचटीटीपी) के बारे में ज़्यादा जानकारी दी गई है.

इस दस्तावेज़ में, प्रोग्रामिंग भाषा की क्लाइंट लाइब्रेरी के बारे में जानकारी नहीं है. क्लाइंट-लाइब्रेरी की रेफ़रंस जानकारी के लिए, डेवलपर की गाइड में प्रोग्रामिंग भाषा के हिसाब से बने सेक्शन में दिए गए लिंक देखें.

ऑडियंस

यह दस्तावेज़ उन प्रोग्रामर के लिए है जो Google Sites के साथ इंटरैक्ट करने वाले क्लाइंट ऐप्लिकेशन लिखना चाहते हैं.

यह एक रेफ़रंस दस्तावेज़ है. इसमें यह माना गया है कि आपको प्रोटोकॉल गाइड में बताए गए कॉन्सेप्ट और Google Data API प्रोटोकॉल के पीछे के सामान्य आइडिया के बारे में पता है.

Google Sites के फ़ीड टाइप

Google Sites Data API, इस तरह के फ़ीड उपलब्ध कराता है:

गतिविधि फ़ीड

गतिविधि फ़ीड एक ऐसा फ़ीड होता है जिसमें किसी साइट पर की गई सभी गतिविधियों की जानकारी होती है.

किसी खास डोमेन में मौजूद साइट के लिए, इस फ़ीड का GET यूआरआई यह है:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName, "साइट" या G Suite डोमेन है.

siteName साइट का नाम है, जो साइट के लैंडिंग पेज यूआरएल में दिखता है: http://sites.google.com/a/domainName/siteName/.

इस फ़ीड के लिए किए गए सभी अनुरोधों की पुष्टि की जानी चाहिए.

इस तरह के अनुरोध किए जा सकते हैं: GET

कॉन्टेंट फ़ीड

कॉन्टेंट फ़ीड एक ऐसा फ़ीड होता है जिसमें साइट का मौजूदा कॉन्टेंट होता है और उसमें बदलाव किया जा सकता है.

किसी खास डोमेन में मौजूद साइट के लिए, इस फ़ीड का GET यूआरआई यह है:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName, "साइट" या G Suite डोमेन है.

siteName, साइट का वही नाम है जो साइट के लैंडिंग पेज यूआरएल में दिखता है: http://sites.google.com/a/domainName/siteName.

साइट की (पब्लिश की गई) सेटिंग के आधार पर, इस फ़ीड के लिए किए गए अनुरोधों के लिए पुष्टि करने की ज़रूरत हो भी सकती है और नहीं भी.

इन तरह के अनुरोध किए जा सकते हैं: GET, POST, PUT, DELETE

Data API के स्टैंडर्ड क्वेरी पैरामीटर के अलावा, Sites Data API में Content फ़ीड का इस्तेमाल करके GET अनुरोध जारी करने के लिए, ये वैकल्पिक पैरामीटर इस्तेमाल किए जा सकते हैं:

पैरामीटर ब्यौरा टाइप नोट
ancestor सिर्फ़ उन एंट्री का अनुरोध करता है जिनमें बताए गए पूर्वज हैं. स्ट्रिंग मनचाहे एंसेस्टर एंट्री का आईडी दें. उदाहरण के लिए: 0123456789. वे सभी एंट्री लौटाता है जिनमें पैरंट, पैरंट के पैरंट के रूप में खास एंसेस्टर वगैरह होता है.
include-deleted यह बताता है कि मिटाई गई एंट्री शामिल करनी हैं या नहीं. बूलियन संभावित वैल्यू true या false हैं. डिफ़ॉल्ट रूप से false होता है.
include-draft तय करता है कि ड्राफ़्ट एंट्री को शामिल करना है या नहीं. बूलियन true या false को वैल्यू के तौर पर इस्तेमाल किया जा सकता है. डिफ़ॉल्ट रूप से false होता है. ड्राफ़्ट देखने के लिए, आपके पास उसका मालिकाना हक या लेखक का ऐक्सेस होना चाहिए.
kind यह बताता है कि किस तरह की कॉन्टेंट एंट्री दिखानी हैं. ये Google Sites में मौजूद पेज के टाइप के हिसाब से होते हैं. कॉमा से अलग की गई स्ट्रिंग की सूची संभावित वैल्यू ये हैं: announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent सिर्फ़ उन एंट्री का अनुरोध करता है जिनमें तय किया गया पैरंट है. स्ट्रिंग पैरंट एंट्री का आईडी दें. उदाहरण के लिए: 0123456789.
path किसी खास पेज के क्रम में कॉन्टेंट के लिए अनुरोध करना स्ट्रिंग किसी साइट के उस सबपेज का पाथ जिसका कॉन्टेंट फ़ेच करना है. उदाहरण के लिए: path=/path/to/page.

बदलाव वाला फ़ीड

बदलाव वाले फ़ीड में, साइट के कॉन्टेंट में किए गए पुराने बदलाव शामिल होते हैं.

किसी खास डोमेन में मौजूद साइट के लिए, इस फ़ीड का GET यूआरआई यह है:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName, "साइट" या G Suite डोमेन है.

siteName, साइट का नाम है. यह साइट के लैंडिंग पेज के यूआरएल में दिखता है: http://sites.google.com/a/domainName/siteName.

इस फ़ीड के लिए किए गए सभी अनुरोधों की पुष्टि की जानी चाहिए.

इस तरह के अनुरोध किए जा सकते हैं: GET

साइट फ़ीड

साइट फ़ीड का इस्तेमाल, उन Google साइटों की सूची बनाने के लिए किया जा सकता है जिनका मालिकाना हक उपयोगकर्ता के पास है या जिन पर उसे देखने की अनुमतियां हैं. इसका इस्तेमाल, नई साइटें बनाने, किसी साइट को कॉपी करने या किसी मौजूदा साइट के नाम में बदलाव करने के लिए भी किया जा सकता है.

साइट की लिस्टिंग के लिए फ़ीड का यूआरआई:

https://sites.google.com/feeds/site/domainName/[siteName]

domainName, "साइट" या G Suite डोमेन है.

इस फ़ीड के लिए किए गए सभी अनुरोधों की पुष्टि की जानी चाहिए.

इन तरह के अनुरोध किए जा सकते हैं: GET, POST, PUT

साइटों की लिस्टिंग के लिए GET का अनुरोध जारी करते समय, साइट फ़ीड इन पैरामीटर के साथ काम करता है. हालांकि, ऐसा करना ज़रूरी नहीं है:

पैरामीटर ब्यौरा टाइप नोट
include-all-sites उन सभी साइटों की सूची बनाएं जिन्हें उपयोगकर्ता, G Suite डोमेन में कम से कम देख सकता है. बूलियन यह पैरामीटर सिर्फ़ G Suite डोमेन के लिए साइटें लिस्ट करते समय लागू होता है. संभावित वैल्यू, true या false हैं. डिफ़ॉल्ट वैल्यू false है.
with-mappings यह किसी साइट एंट्री में वेब पते की मैपिंग शामिल करता है. बूलियन संभावित वैल्यू true या false हैं. डिफ़ॉल्ट रूप से false होता है.

एसीएल फ़ीड

ACL फ़ीड का इस्तेमाल किसी Google साइट की शेयर करने की अनुमतियों (ACL) को सूचीबद्ध और/या उनमें बदलाव करने के लिए किया जा सकता है.

साइट की लिस्टिंग के लिए फ़ीड का यूआरआई:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName, "साइट" या G Suite डोमेन है.

इस फ़ीड के लिए किए गए सभी अनुरोधों की पुष्टि की जानी चाहिए.

इन तरह के अनुरोध किए जा सकते हैं: GET, POST, PUT, DELETE

Google Sites के क्वेरी पैरामीटर का रेफ़रंस

Google Data API प्रोटोकॉल के साथ काम करने वाले क्वेरी पैरामीटर:

  • max-results
  • published-max (सिर्फ़ कॉन्टेंट फ़ीड)
  • published-min (सिर्फ़ कॉन्टेंट फ़ीड)
  • start-index
  • updated-max
  • updated-min
  • q (पूरे टेक्स्ट वाली क्वेरी)

उस फ़ीड के लिए खास पैरामीटर की सूची देखने के लिए, ऊपर हर फ़ीड देखें.

वापस सबसे ऊपर जाएं