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

מידע נוסף זמין בדף אימות והרשאה.

גוף הבקשה

בגוף הבקשה, מספקים משאב של CalendarList עם המאפיינים הבאים:

שם הנכס ערך תיאור הערות
מאפיינים אופציונליים
backgroundColor string הצבע הראשי של היומן בפורמט הקסדצימלי '#0088aa'. המאפיין הזה מחליף את נכס colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, update ו-patch. זה שינוי אופציונלי. ניתן לכתיבה
colorId string הצבע של היומן. זהו מזהה שמתייחס לרשומה בקטע calendar של הגדרת הצבעים (מידע נוסף זמין בנקודת הקצה של הצבעים). המאפיין הזה מוחלף על ידי המאפיינים 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 הסיכום שהמשתמש המאומת הגדיר ליומן הזה. זה שינוי אופציונלי. ניתן לכתיבה

תשובה

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

נסה בעצמך!

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