CalendarList: update

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

अनुरोध

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

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

पैरामीटर

पैरामीटर का नाम मान ब्यौरा
पाथ पैरामीटर
calendarId string कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको लॉग इन किए हुए उपयोगकर्ता का प्राइमरी कैलेंडर ऐक्सेस करना है, तो "primary" कीवर्ड का इस्तेमाल करें.
ज़रूरी नहीं क्वेरी पैरामीटर
colorRgbFormat boolean कैलेंडर के रंग (आरजीबी) लिखने के लिए, foregroundColor और backgroundColor फ़ील्ड का इस्तेमाल करना है या नहीं. इस सुविधा का इस्तेमाल करने पर, इंडेक्स पर आधारित colorId फ़ील्ड अपने-आप सबसे अच्छे मैचिंग विकल्प पर सेट हो जाएगा. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होता है.

अनुमति देना

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

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

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

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

अनुरोध के मुख्य हिस्से में, इन प्रॉपर्टी के साथ CalendarList रिसॉर्स दें:

प्रॉपर्टी का नाम मान ब्यौरा नोट
ज़रूरी नहीं प्रॉपर्टी
backgroundColor string हेक्साडेसिमल फ़ॉर्मैट "#0088aa" में कैलेंडर का मुख्य रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, update, और patch तरीकों के पैरामीटर में colorRgbFormat=true की वैल्यू देनी होगी. ज़रूरी नहीं. लिखा जा सकता है
colorId string कैलेंडर का रंग. यह एक आईडी है, जो कलर की परिभाषा के calendar सेक्शन में मौजूद किसी एंट्री का रेफ़रंस देता है. कलर एंडपॉइंट देखें. इस प्रॉपर्टी की जगह backgroundColor और foregroundColor प्रॉपर्टी का इस्तेमाल किया जाता है. साथ ही, इन प्रॉपर्टी का इस्तेमाल करते समय इस प्रॉपर्टी को अनदेखा किया जा सकता है. ज़रूरी नहीं. लिखा जा सकता है
defaultReminders[] list इस कैलेंडर के लिए, पुष्टि किए गए उपयोगकर्ता के डिफ़ॉल्ट रिमाइंडर. लिखा जा सकता है
defaultReminders[].method string इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. वैल्यू इस तरह की हो सकती हैं:
  • "email" - रिमाइंडर ईमेल से भेजे जाते हैं.
  • "popup" - रिमाइंडर, यूज़र इंटरफ़ेस (यूआई) पॉप-अप के ज़रिए भेजे जाते हैं.

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

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

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

 लिखा जा सकता है
foregroundColor string हेक्साडेसिमल फ़ॉर्मैट "#ffffff" में, कैलेंडर के फ़ोरग्राउंड का रंग. यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट करने या बदलने के लिए, आपको insert, update, और patch तरीकों के पैरामीटर में colorRgbFormat=true की वैल्यू देनी होगी. ज़रूरी नहीं. लिखा जा सकता है
hidden boolean कैलेंडर को सूची से छिपाया गया है या नहीं. ज़रूरी नहीं. यह एट्रिब्यूट सिर्फ़ तब दिखता है, जब कैलेंडर छिपा हो. इस मामले में, वैल्यू true होती है. लिखा जा सकता है
notificationSettings object इस कैलेंडर के लिए, पुष्टि किए गए उपयोगकर्ता को मिलने वाली सूचनाएं. लिखा जा सकता है
notificationSettings.notifications[].method string सूचना भेजने के लिए इस्तेमाल किया गया तरीका. इसकी वैल्यू इस तरह की हो सकती है:
  • "email" - सूचनाएं ईमेल से भेजी जाती हैं.

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

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

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

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

जवाब

अगर यह तरीका कामयाब होता है, तो यह जवाब के मुख्य हिस्से में CalendarList रिसॉर्स दिखाता है.

उदाहरण

ध्यान दें: इस तरीके के लिए दिए गए कोड के उदाहरणों में इसके साथ काम करने वाली सभी प्रोग्रामिंग भाषाएं नहीं दिखाई गई हैं (इसके साथ काम करने वाली भाषाओं की सूची के लिए क्लाइंट लाइब्रेरी वाला पेज देखें).

Java

Java क्लाइंट लाइब्रेरी का इस्तेमाल करता है.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

Python क्लाइंट लाइब्रेरी का इस्तेमाल करता है.

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

PHP

PHP क्लाइंट लाइब्रेरी का इस्तेमाल करता है.

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

Ruby क्लाइंट लाइब्रेरी का इस्तेमाल करता है.

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

इसे आज़माएं!

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