Calendars

सभी मौजूदा कैलेंडर का कलेक्शन. Calendars vs CalendarList भी देखें.

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

संसाधन के फ़ॉर्मैट

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
प्रॉपर्टी का नाम मान ब्यौरा नोट
autoAcceptInvitations boolean यह कैलेंडर, न्योते अपने-आप स्वीकार करता है या नहीं. यह सुविधा सिर्फ़ रिसॉर्स कैलेंडर के लिए उपलब्ध है.
conferenceProperties nested object इस कैलेंडर के लिए कॉन्फ़्रेंसिंग प्रॉपर्टी. जैसे, किस तरह की कॉन्फ़्रेंस की अनुमति है.
conferenceProperties.allowedConferenceSolutionTypes[] list इस कैलेंडर के लिए, कॉन्फ़्रेंस के किन समाधानों का इस्तेमाल किया जा सकता है.

संभावित वैल्यू ये हैं:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
ज़रूरी नहीं.

dataOwner string कैलेंडर के मालिक का ईमेल. यह सिर्फ़ सेकंडरी कैलेंडर के लिए सेट किया जाता है. रीड-ओनली.
description string कैलेंडर की जानकारी. ज़रूरी नहीं. लिखा जा सकता है
etag etag संसाधन का ETag.
id string कैलेंडर का आइडेंटिफ़ायर. आईडी पाने के लिए, calendarList.list() तरीके का इस्तेमाल करें.
kind string संसाधन का टाइप ("calendar#calendar").
labelProperties nested object इस कैलेंडर के लिए तय की गई लेबल प्रॉपर्टी. अगर यह तय की जाती है, तो मौजूदा लेबल प्रॉपर्टी ओवरराइट हो जाती हैं. अगर यह तय नहीं की जाती है, तो लेबल प्रॉपर्टी में कोई बदलाव नहीं होता. लिखा जा सकता है
labelProperties.eventLabels[] list इस कैलेंडर के लिए तय किए गए इवेंट लेबल. कैलेंडर को अपडेट करते समय, अगर यह मौजूद है, तो मौजूदा इवेंट लेबल की जगह यह आ जाएगा.

नया इवेंट लेबल जोड़ने के लिए, सूची को बड़ा करें. साथ ही, कैलेंडर से कोई लेबल मिटाने के लिए, सूची से इकाइयां हटाएं.

हर कैलेंडर में ज़्यादा से ज़्यादा 200 लेबल हो सकते हैं.

लिखा जा सकता है
labelProperties.eventLabels[].backgroundColor string हेक्साडेसिमल फ़ॉर्मैट में लेबल का बैकग्राउंड कलर. जैसे, "#039be5". इस लेबल वाले इवेंट, इसी रंग में दिखते हैं. ज़रूरी है. लिखा जा सकता है
labelProperties.eventLabels[].id string लेबल का आईडी. नया लेबल जोड़ते समय, यह ज़रूरी नहीं है. अगर यह उपलब्ध नहीं कराया जाता है, तो एक यूनीक आईडी जनरेट किया जाएगा. लेबल अपडेट करते समय, यह ज़रूरी है.

अगर यह उपलब्ध कराया जाता है, तो आईडी, कैलेंडर में यूनीक होना चाहिए. साथ ही, यह यूयूआईडी फ़ॉर्मैट में होना चाहिए.

लिखा जा सकता है
labelProperties.eventLabels[].name string लेबल का नाम. ज़रूरी नहीं.

अगर यह उपलब्ध कराया जाता है, तो इसमें ज़्यादा से ज़्यादा 50 वर्ण होने चाहिए.

लिखा जा सकता है
location string कैलेंडर की भौगोलिक जगह. इसे किसी भी फ़ॉर्मैट में लिखा जा सकता है. ज़रूरी नहीं. लिखा जा सकता है
summary string कैलेंडर का टाइटल. लिखा जा सकता है
timeZone string कैलेंडर का टाइम ज़ोन. (इसे आईएएनए टाइम ज़ोन डेटाबेस के नाम के तौर पर फ़ॉर्मैट किया जाता है. जैसे, "Europe/Zurich".) ज़रूरी नहीं. लिखा जा सकता है

तरीके

clear
मुख्य कैलेंडर से सभी इवेंट हटाता है. इस कार्रवाई से, किसी खाते के मुख्य कैलेंडर से जुड़े सभी इवेंट मिट जाते हैं.
delete
सेकंडरी कैलेंडर मिटाता है. मुख्य कैलेंडर के सभी इवेंट मिटाने के लिए, calendars.clear का इस्तेमाल करें.
get
किसी कैलेंडर का मेटाडेटा दिखाता है.
insert
सेकंडरी कैलेंडर बनाता है.

अनुरोध के लिए पुष्टि किया गया उपयोगकर्ता, नए कैलेंडर का डेटा मालिक बन जाता है.

patch
किसी कैलेंडर का मेटाडेटा अपडेट करता है. यह तरीका, पैच सिमैंटिक्स के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध, कोटे की तीन यूनिट इस्तेमाल करता है. इसलिए, हमारा सुझाव है कि get के बाद update का इस्तेमाल करें. आपके तय किए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में तय नहीं किए गए फ़ील्ड की वैल्यू में कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड तय किए जाते हैं, तो वे मौजूदा ऐरे को ओवरराइट कर देते हैं. इससे पहले के सभी ऐरे एलिमेंट मिट जाते हैं.
transferOwnership
Google Workspace का इस्तेमाल करने वाले किसी संगठन में, एक उपयोगकर्ता से दूसरे उपयोगकर्ता को सेकंडरी कैलेंडर ट्रांसफ़र करता है. इसके लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है. साथ ही, उसके पास 'कैलेंडर मैनेज करें' एडमिन का अधिकार और अनुमति के ये स्कोप होने चाहिए:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
अनुरोध में, useAdminAccess को true पर सेट करें. सेकंडरी कैलेंडर को ट्रांसफ़र करने के लिए, उसका चालू होना ज़रूरी है. बंद किए गए या मिटाए गए कैलेंडर ट्रांसफ़र नहीं किए जा सकते.
update
किसी कैलेंडर का मेटाडेटा अपडेट करता है.