CalendarList

उपयोगकर्ता के कैलेंडर की सूची में मौजूद कैलेंडर का कलेक्शन. यह भी देखें Calendars vs CalendarList.

इस संसाधन के लिए तरीकों की सूची देखने के लिए, इस पेज के आखिर में जाएं.

संसाधन के बारे में जानकारी

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
प्रॉपर्टी का नाम मान ब्यौरा नोट
accessRole string इससे पता चलता है कि पुष्टि किए गए उपयोगकर्ता के पास कैलेंडर को ऐक्सेस करने की कौनसी भूमिका है. सिर्फ़ पढ़ने के लिए. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "freeBusyReader" - इससे, व्यस्त/उपलब्ध होने की जानकारी को पढ़ने का ऐक्सेस मिलता है.
  • "reader" - इससे कैलेंडर को पढ़ने का ऐक्सेस मिलता है. निजी इवेंट, पढ़ने का ऐक्सेस रखने वाले उपयोगकर्ताओं को दिखेंगे. हालांकि, इवेंट की जानकारी छिपी रहेगी.
  • "writer" - इससे कैलेंडर को पढ़ने और उसमें बदलाव करने का ऐक्सेस मिलता है. निजी इवेंट, लेखक के तौर पर ऐक्सेस रखने वाले उपयोगकर्ताओं को दिखेंगे. साथ ही, उन्हें इवेंट की जानकारी भी दिखेगी.
  • "owner" - इससे कैलेंडर का ऐक्सेस मैनेजर को मिलता है. इस भूमिका में, लेखक की भूमिका वाली सभी अनुमतियां होती हैं. साथ ही, इसमें अन्य उपयोगकर्ताओं के ऐक्सेस लेवल को देखने और उनमें बदलाव करने की सुविधा भी होती है.

backgroundColor string कैलेंडर का मुख्य रंग, हेक्साडेसिमल फ़ॉर्मैट "#0088aa" में होता है. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट या बदलने के लिए, आपको insert, update, और patch तरीकों के पैरामीटर में colorRgbFormat=true को तय करना होगा. ज़रूरी नहीं. लिखा जा सकता है
colorId string कैलेंडर का रंग. यह एक आईडी है. यह आईडी, रंगों की परिभाषा के calendar सेक्शन में मौजूद किसी एंट्री को दिखाता है. इसके बारे में जानने के लिए, colors एंडपॉइंट देखें. इस प्रॉपर्टी की जगह backgroundColor और foregroundColor प्रॉपर्टी का इस्तेमाल किया जाता है. इन प्रॉपर्टी का इस्तेमाल करते समय, इस प्रॉपर्टी को अनदेखा किया जा सकता है. ज़रूरी नहीं. लिखा जा सकता है
conferenceProperties nested object इस कैलेंडर के लिए कॉन्फ़्रेंसिंग प्रॉपर्टी. उदाहरण के लिए, किस तरह की कॉन्फ़्रेंस की अनुमति है.
conferenceProperties.allowedConferenceSolutionTypes[] list इस कैलेंडर के लिए, कॉन्फ़्रेंस के लिए इस्तेमाल किए जा सकने वाले समाधानों के टाइप.

इन वैल्यू का इस्तेमाल किया जा सकता है:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
ज़रूरी नहीं.
dataOwner string कैलेंडर के मालिक का ईमेल पता. इसे सिर्फ़ सेकंडरी कैलेंडर के लिए सेट किया जाता है. सिर्फ़ पढ़ने के लिए.
defaultReminders[] list इस कैलेंडर के लिए, पुष्टि किए गए उपयोगकर्ता को डिफ़ॉल्ट रूप से भेजे जाने वाले रिमाइंडर. लिखा जा सकता है
defaultReminders[].method string इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "email" - रिमाइंडर ईमेल से भेजे जाते हैं.
  • "popup" - रिमाइंडर, यूज़र इंटरफ़ेस (यूआई) के पॉप-अप के ज़रिए भेजे जाते हैं.

रिमाइंडर जोड़ने के लिए यह जानकारी देना ज़रूरी है.

 लिखा जा सकता है
defaultReminders[].minutes integer इवेंट शुरू होने से कितने मिनट पहले रिमाइंडर ट्रिगर होना चाहिए. मान्य वैल्यू 0 से 40320 (चार हफ़्ते में मिनट) के बीच होती हैं.

रिमाइंडर जोड़ने के लिए यह जानकारी देना ज़रूरी है.

 लिखा जा सकता है
deleted boolean यह कैलेंडर सूची की एंट्री, कैलेंडर सूची से मिटाई गई है या नहीं. सिर्फ़ पढ़ने के लिए. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
description string कैलेंडर के बारे में जानकारी. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.
etag etag संसाधन का ETag.
foregroundColor string कैलेंडर के फ़ोरग्राउंड का रंग, हेक्साडेसिमल फ़ॉर्मैट "#ffffff" में होता है. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट या बदलने के लिए, आपको insert, update, और patch तरीकों के पैरामीटर में colorRgbFormat=true को तय करना होगा. ज़रूरी नहीं. लिखा जा सकता है
hidden boolean इससे पता चलता है कि कैलेंडर को सूची से छिपाया गया है या नहीं. ज़रूरी नहीं. यह एट्रिब्यूट सिर्फ़ तब दिखता है, जब कैलेंडर छिपा हुआ हो. ऐसे में, इसकी वैल्यू true होती है. लिखा जा सकता है
id string कैलेंडर का आइडेंटिफ़ायर.
kind string यह रिसोर्स का टाइप है ("calendar#calendarListEntry").
location string कैलेंडर की भौगोलिक जगह की जानकारी, बिना स्ट्रक्चर वाले लेख के तौर पर. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.
notificationSettings object इस कैलेंडर के लिए, भरोसेमंद व्यक्ति को मिलने वाली सूचनाएं. लिखा जा सकता है
notificationSettings.notifications[] list इस कैलेंडर के लिए सेट की गई सूचनाओं की सूची.
notificationSettings.notifications[].method string नोटिफ़िकेशन भेजने के लिए इस्तेमाल किया गया तरीका. यह वैल्यू इस्तेमाल की जा सकती है:
  • "email" - सूचनाएं ईमेल से भेजी जाती हैं.

सूचना जोड़ते समय यह ज़रूरी है.

 लिखा जा सकता है
notificationSettings.notifications[].type string सूचना का टाइप. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "eventCreation" - कैलेंडर में नया इवेंट जोड़ने पर सूचना भेजी जाती है.
  • "eventChange" - इवेंट में बदलाव होने पर सूचना भेजी जाती है.
  • "eventCancellation" - इवेंट रद्द होने पर सूचना भेजी जाती है.
  • "eventResponse" - यह सूचना तब भेजी जाती है, जब कोई व्यक्ति इवेंट के न्योते का जवाब देता है.
  • "agenda" - इसमें दिन के इवेंट की जानकारी होती है. इसे सुबह भेजा जाता है.

सूचना जोड़ते समय यह ज़रूरी है.

 लिखा जा सकता है
primary boolean यह कैलेंडर, पुष्टि किए गए उपयोगकर्ता का प्राइमरी कैलेंडर है या नहीं. सिर्फ़ पढ़ने के लिए. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
selected boolean इससे पता चलता है कि कैलेंडर का कॉन्टेंट, कैलेंडर के यूज़र इंटरफ़ेस (यूआई) में दिखता है या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. लिखा जा सकता है
summary string कैलेंडर का टाइटल. सिर्फ़ पढ़ने के लिए.
summaryOverride string पुष्टि किए गए उपयोगकर्ता ने इस कैलेंडर के लिए जो खास जानकारी सेट की है. ज़रूरी नहीं. लिखा जा सकता है
timeZone string कैलेंडर का टाइम ज़ोन. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.

तरीके

मिटाएं
इससे उपयोगकर्ता के कैलेंडर की सूची से कैलेंडर हट जाता है.
पाएं
उपयोगकर्ता की कैलेंडर सूची से कोई कैलेंडर दिखाता है.
insert
इससे किसी मौजूदा कैलेंडर को उपयोगकर्ता की कैलेंडर सूची में जोड़ा जाता है.
list
इससे उपयोगकर्ता की कैलेंडर सूची में मौजूद कैलेंडर दिखते हैं.
पैच
इससे उपयोगकर्ता की कैलेंडर सूची में मौजूद कैलेंडर अपडेट होता है. यह तरीका, पैच सिमैंटिक के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध में, तीन कोटा यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करना बेहतर होता है. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड के बारे में नहीं बताया जाता है उनमें कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड के बारे में बताया गया है, तो वे मौजूदा ऐरे को ओवरराइट कर देते हैं. इससे, ऐरे के पिछले सभी एलिमेंट हट जाते हैं.
अपडेट करें
इससे उपयोगकर्ता की कैलेंडर सूची में मौजूद कैलेंडर अपडेट होता है.
watch
CalendarList संसाधनों में हुए बदलावों पर नज़र रखें.