CalendarList

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

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

संसाधन निरूपण

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": 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 प्रॉपर्टी की जगह ले लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको शामिल करें, अपडेट, और पैच तरीकों के पैरामीटर में colorRgbFormat=true की जानकारी देनी होगी. ज़रूरी नहीं. लिखा जा सकता है
colorId string कैलेंडर का रंग. यह आईडी, कलर डेफ़िनिशन के calendar सेक्शन में की गई एंट्री को रेफ़र करता है. (कलर एंडपॉइंट देखें). इस प्रॉपर्टी को backgroundColor और foregroundColor प्रॉपर्टी इस्तेमाल करती हैं. इसलिए, इन प्रॉपर्टी का इस्तेमाल करते समय इसे अनदेखा किया जा सकता है. ज़रूरी नहीं. लिखा जा सकता है
conferenceProperties nested object इस कैलेंडर के लिए कॉन्फ़्रेंसिंग प्रॉपर्टी, जैसे कि किस तरह की कॉन्फ़्रेंस की अनुमति है.
conferenceProperties.allowedConferenceSolutionTypes[] list इस कैलेंडर के साथ काम करने वाले कॉन्फ़्रेंस सलूशन के टाइप.

आपको ये वैल्यू दिख सकती हैं:

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

रिमाइंडर जोड़ते समय ज़रूरी है.

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

रिमाइंडर जोड़ते समय ज़रूरी है.

 लिखा जा सकता है
deleted boolean क्या कैलेंडर सूची से इस सूची की एंट्री मिटा दी गई है. सिर्फ़ पढ़ने के लिए. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.
description string कैलेंडर का ब्यौरा. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.
etag etag संसाधन का ETag.
foregroundColor string हेक्साडेसिमल फ़ॉर्मैट "#ffffff" में कैलेंडर का फ़ोरग्राउंड रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह ले लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको शामिल करें, अपडेट, और पैच तरीकों के पैरामीटर में 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 कैलेंडर, पुष्टि किए गए उपयोगकर्ता का मुख्य कैलेंडर है या नहीं. सिर्फ़ पढ़ने के लिए. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है.
selected boolean कैलेंडर के यूज़र इंटरफ़ेस (यूआई) में कैलेंडर का कॉन्टेंट दिखता है या नहीं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू 'गलत' पर सेट होती है. लिखा जा सकता है
summary string कैलेंडर का टाइटल. सिर्फ़ पढ़ने के लिए.
summaryOverride string वह सारांश जिसे प्रमाणित उपयोगकर्ता ने इस कैलेंडर के लिए सेट किया है. ज़रूरी नहीं. लिखा जा सकता है
timeZone string कैलेंडर का टाइम ज़ोन. ज़रूरी नहीं. सिर्फ़ पढ़ने के लिए.

तरीके

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