रेफ़रंस गाइड

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

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

ऑडियंस

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

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

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

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

गतिविधि फ़ीड

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

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

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

domainName "site" या G Suite डोमेन है.

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

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

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

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

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

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

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

domainName "site" या G Suite डोमेन है.

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

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

इन अनुरोध टाइप का इस्तेमाल किया जा सकता है: GET, POST, PUT, DELETE

Sites Data API, स्टैंडर्ड Data API के क्वेरी पैरामीटर के अलावा, इन वैकल्पिक पैरामीटर का इस्तेमाल करने की अनुमति देता है. इसके लिए, Content feed का इस्तेमाल करके 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 "site" या G Suite डोमेन है.

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

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

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

साइट फ़ीड

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

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

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

domainName "site" या G Suite डोमेन है.

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

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

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

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

ऐसीएल फ़ीड

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

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

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

domainName "site" या G Suite डोमेन है.

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

इन अनुरोध टाइप का इस्तेमाल किया जा सकता है: GET, POST, PUT, DELETE

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

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

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

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

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