CalendarList: list

यह तरीका, उपयोगकर्ता की कैलेंडर सूची में मौजूद कैलेंडर दिखाता है. इसे अभी आज़माएं.

अनुरोध

एचटीटीपी अनुरोध

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

पैरामीटर

पैरामीटर का नाम मान ब्यौरा
वैकल्पिक क्वेरी पैरामीटर
maxResults integer नतीजे वाले एक पेज पर ज़्यादा से ज़्यादा एंट्री दिखाई जाती हैं. डिफ़ॉल्ट रूप से, वैल्यू 100 एंट्री होती है. पेज का साइज़, 250 एंट्री से ज़्यादा नहीं हो सकता. ज़रूरी नहीं.
minAccessRole string जवाब में दी गई एंट्री में, उपयोगकर्ता के लिए ऐक्सेस की कम से कम भूमिका. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, कोई पाबंदी नहीं होती.

इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "freeBusyReader": उपयोगकर्ता, खाली/व्यस्त होने की जानकारी पढ़ सकता है.
  • "owner": उपयोगकर्ता, इवेंट को पढ़ सकता है और उनमें बदलाव कर सकता है. साथ ही, ऐक्सेस कंट्रोल लिस्ट को ऐक्सेस कर सकता है.
  • "reader": उपयोगकर्ता, उन इवेंट को पढ़ सकता है जिन्हें निजी के तौर पर मार्क नहीं किया गया है.
  • "writer": उपयोगकर्ता इवेंट पढ़ सकता है और उनमें बदलाव कर सकता है.
  • "writerWithoutPrivateAccess": उपयोगकर्ता इवेंट पढ़ सकता है और उनमें बदलाव कर सकता है. हालांकि, वह निजी इवेंट ऐक्सेस नहीं कर सकता.
pageToken string यह टोकन बताता है कि नतीजों का कौनसा पेज दिखाना है. ज़रूरी नहीं.
showDeleted boolean मिटाई गई कैलेंडर सूची की एंट्री को नतीजे में शामिल करना है या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
showHidden boolean छिपाई गई एंट्री दिखानी हैं या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
syncToken string यह टोकन, सूची बनाने के पिछले अनुरोध के नतीजों के आखिरी पेज पर दिखाए गए nextSyncToken फ़ील्ड से मिलता है. इससे, सूची के लिए किए गए अनुरोध के नतीजे में सिर्फ़ वे एंट्री शामिल होती हैं जिनमें तब से बदलाव हुआ है. अगर सिर्फ़ पढ़ने के लिए उपलब्ध फ़ील्ड में बदलाव किया गया है, जैसे कि कैलेंडर प्रॉपर्टी या एसीएल, तो एंट्री नहीं दिखाई जाएगी. पिछली सूची के अनुरोध के बाद से मिटाई गई और छिपाई गई सभी एंट्री, नतीजे के सेट में हमेशा मौजूद रहेंगी. साथ ही, showDeleted और showHidden को False पर सेट करने की अनुमति नहीं है.
क्लाइंट की स्थिति में एकरूपता बनाए रखने के लिए, minAccessRole क्वेरी पैरामीटर को nextSyncToken के साथ एक साथ तय नहीं किया जा सकता.
अगर syncToken की समयसीमा खत्म हो जाती है, तो सर्वर 410 GONE रिस्पॉन्स कोड के साथ जवाब देगा. साथ ही, क्लाइंट को अपना स्टोरेज मिटा देना चाहिए और बिना किसी syncToken के पूरा सिंक्रनाइज़ेशन करना चाहिए.
इंक्रीमेंटल सिंक्रनाइज़ेशन के बारे में ज़्यादा जानें.
ज़रूरी नहीं. डिफ़ॉल्ट रूप से, सभी एंट्री दिखाई जाती हैं.

अनुमति देना

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है:

दायरा
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

ज़्यादा जानकारी के लिए, पुष्टि और अनुमति पेज देखें.

अनुरोध का मुख्य भाग

इस तरीके से अनुरोध करते समय, अनुरोध का मुख्य हिस्सा न दें.

जवाब

अगर अनुरोध सही से काम करता है, तो यह तरीका जवाब के मुख्य हिस्से में नीचे दिया गया स्ट्रक्चर दिखाता है:

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
प्रॉपर्टी का नाम मान ब्यौरा नोट
kind string कलेक्शन का टाइप ("calendar#calendarList").
etag etag कलेक्शन का ETag.
nextPageToken string इस टोकन का इस्तेमाल, नतीजे के अगले पेज को ऐक्सेस करने के लिए किया जाता है. अगर कोई और नतीजा उपलब्ध नहीं है, तो इसे शामिल नहीं किया जाता. ऐसे मामले में, nextSyncToken दिया जाता है.
items[] list ऐसे कैलेंडर जो उपयोगकर्ता के कैलेंडर की सूची में मौजूद हैं.
nextSyncToken string इस टोकन का इस्तेमाल बाद में सिर्फ़ उन एंट्री को वापस पाने के लिए किया जाता है जिनमें इस नतीजे के वापस आने के बाद से बदलाव हुआ है. अगर ज़्यादा नतीजे उपलब्ध हैं, तो इसे हटा दिया जाता है. ऐसे मामले में nextPageToken दिया जाता है.

इसे आज़माएं!

लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, यहां दिए गए APIs explorer का इस्तेमाल करें.