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 क्या नतीजों में, मिटाई गई कैलेंडर सूची की प्रविष्टियां शामिल करनी हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'फ़ॉल्स' पर सेट होती है.
showHidden boolean क्या छिपी हुई प्रविष्टियां दिखानी हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'फ़ॉल्स' पर सेट होती है.
showOwnOrganizationOnly boolean क्या सिर्फ़ संगठन के कैलेंडर की प्रविष्टियां दिखानी हैं. यह पैरामीटर, सिर्फ़ Google Workspace के उपयोगकर्ताओं के लिए लागू होता है. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'फ़ॉल्स' पर सेट होती है.
syncToken string यह टोकन, सूची के पिछले अनुरोध के नतीजों के आखिरी पेज पर दिखाए गए nextSyncToken फ़ील्ड से मिलता है. इससे, सूची के इस अनुरोध के नतीजों में सिर्फ़ वे प्रविष्टियां शामिल होती हैं जिनमें तब से बदलाव हुआ है. अगर सिर्फ़ रीड-ओनली फ़ील्ड में बदलाव हुआ है, जैसे कि कैलेंडर की प्रॉपर्टी या एसीएल, तो प्रविष्टि नहीं दिखाई जाएगी. सूची के पिछले अनुरोध के बाद से मिटाई गई और छिपी हुई सभी प्रविष्टियां, नतीजों के सेट में हमेशा शामिल रहेंगी. साथ ही, showDeleted और showHidden को 'फ़ॉल्स' पर सेट नहीं किया जा सकता.
क्लाइंट की स्थिति में एकरूपता बनाए रखने के लिए, minAccessRole और showOwnOrganizationOnly क्वेरी पैरामीटर को 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 दिया जाता है.

इसे आज़माएं!

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