CalendarList: update

עדכון יומן קיים ברשימת היומנים של המשתמש. רוצים לנסות? או לעיון בדוגמה

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים של נתיב
calendarId string מזהה היומן. כדי לאחזר את מזהי היומנים, קוראים לשיטה calendarList.list. כדי לגשת ליומן הראשי של המשתמש שמחובר כרגע, משתמשים במילות המפתח primary.
פרמטרים אופציונליים של שאילתות
colorRgbFormat boolean האם להשתמש בשדות foregroundColor ו-backgroundColor כדי לכתוב את הצבעים ביומן (RGB). אם משתמשים בתכונה הזו, השדה colorId שמבוסס על האינדקס יוגדר באופן אוטומטי לאפשרות ההתאמה הטובה ביותר. זה שינוי אופציונלי. ברירת המחדל היא False.

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:

היקף
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 שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, ‏ update ו-patch. זה שינוי אופציונלי. לכתיבה
colorId string הצבע של היומן. זהו מזהה שמתייחס לרשומה בקטע calendar של הגדרת הצבעים (ראו נקודת הקצה colors). המאפיין הזה הוחלף במאפיינים backgroundColor ו-foregroundColor, וניתן להתעלם ממנו כשמשתמשים במאפיינים האלה. זה שינוי אופציונלי. לכתיבה
defaultReminders[] list תזכורות ברירת המחדל של המשתמש המאומת ביומן הזה. לכתיבה
defaultReminders[].method string השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
  • 'email' – התזכורות נשלחות באימייל.
  • 'popup' – התזכורות נשלחות דרך חלון קופץ בממשק המשתמש.

נדרש כשמוסיפים תזכורת.

 לכתיבה
defaultReminders[].minutes integer מספר הדקות לפני תחילת האירוע שבהן התזכורת אמורה להופיע. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות).

נדרש כשמוסיפים תזכורת.

 לכתיבה
foregroundColor string צבע החזית של היומן בפורמט הקסדצימלי '#ffffff'. המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, ‏ update ו-patch. זה שינוי אופציונלי. לכתיבה
hidden boolean אם היומן הוסתר מהרשימה. זה שינוי אופציונלי. המאפיין מוחזר רק כשהיומן מוסתר, ובמקרה כזה הערך הוא true. לכתיבה
notificationSettings object ההתראות שהמשתמש המאומת מקבל ביומן הזה. לכתיבה
notificationSettings.notifications[].method string השיטה שבה ההתראה נשלחת. הערך האפשרי הוא:
  • 'email' – ההתראות נשלחות באימייל.

נדרש כשמוסיפים התראה.

 לכתיבה
notificationSettings.notifications[].type string סוג ההתראה. הערכים האפשריים הם:
  • eventCreation – התראה שנשלחת כשאירוע חדש מתווסף ליומן.
  • 'eventChange' – התראה שנשלחת כשאירוע משתנה.
  • eventCancellation – התראה שנשלחת כשאירוע מסוים מבוטל.
  • eventResponse – התראה שנשלחת כשמשתתף משיב להזמנה לאירוע.
  • 'agenda' – יומן עם האירועים של היום (נשלח בבוקר).

נדרש כשמוסיפים התראה.

 לכתיבה
selected boolean אם תוכן היומן יופיע בממשק המשתמש של היומן. זה שינוי אופציונלי. ברירת המחדל היא False. לכתיבה
summaryOverride string הסיכום שהמשתמש המאומת הגדיר ביומן הזה. זה שינוי אופציונלי. לכתיבה

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב 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

נסה בעצמך!

אפשר להשתמש ב-API Explorer שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.