रेफ़रंस गाइड

यह दस्तावेज़ 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, इन वैकल्पिक पैरामीटर की अनुमति देता है. ये पैरामीटर, कॉन्टेंट फ़ीड का इस्तेमाल करके GET अनुरोध जारी करते हैं:

पैरामीटर ब्यौरा टाइप ज़रूरी जानकारी
ancestor सिर्फ़ उन एंट्री के लिए अनुरोध किया जाता है जिनमें पहले से सेट किया गया पैरामीटर है. स्ट्रिंग पसंदीदा ऐन्सेस्टर एंट्री का आईडी दें. उदाहरण के लिए: 0123456789. वे सभी एंट्री दिखाता है जिनमें पैरंट के तौर पर, माता-पिता के तौर पर बताया गया पूर्वज, वगैरह होता है.
include-deleted तय करता है कि मिटाई गई एंट्री शामिल करनी है या नहीं. boolean संभावित वैल्यू true या false हो सकती हैं. डिफ़ॉल्ट वैल्यू false है.
include-draft तय करता है कि ड्राफ़्ट एंट्री शामिल करनी हैं या नहीं. boolean संभावित वैल्यू 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 डोमेन में उपयोगकर्ता कम से कम देख सकता है. boolean यह पैरामीटर सिर्फ़ तब लागू होता है, जब G Suite डोमेन के लिए साइटों को लिस्ट किया जाता है. इसकी वैल्यू true या false हो सकती हैं. डिफ़ॉल्ट वैल्यू false है.
with-mappings इसमें किसी साइट एंट्री में वेब पते की मैपिंग शामिल होती हैं. boolean संभावित वैल्यू true या false हो सकती हैं. डिफ़ॉल्ट वैल्यू false है.

ACL फ़ीड

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 (पूरे टेक्स्ट से जुड़ी क्वेरी)

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

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