Calendars: update

עדכון המטא-נתונים של יומן. רוצים לנסות?

בקשה

בקשת HTTP

PUT https://www.googleapis.com/calendar/v3/calendars/calendarId

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים של הנתיב
calendarId string מזהה היומן. כדי לאחזר מזהי יומנים, צריך להפעיל את ה-method‏ calendarList.list. כדי לגשת ליומן הראשי של המשתמש שמחובר כרגע, צריך להשתמש במילת המפתח "primary".

אישור

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

היקף
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendars

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

גוף הבקשה

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

שם הנכס ערך תיאור הערות
מאפיינים אופציונליים
description string תיאור היומן. זה שינוי אופציונלי. ניתן לכתיבה
labelProperties nested object מאפייני התוויות שמוגדרים ביומן הזה. אם מציינים את הפרמטר הזה, הוא מחליף את מאפייני התווית הקיימים. אם לא מציינים את המאפיינים, הם לא משתנים. ניתן לכתיבה
labelProperties.eventLabels[] list תוויות האירועים שמוגדרות ביומן הזה. אם השדה הזה קיים כשמעדכנים את היומן, הוא יחליף את התוויות הקיימות של האירוע.

כדי להוסיף תווית אירוע חדשה, מרחיבים את הרשימה. כדי למחוק תווית מהיומן, מסירים ישויות מהרשימה.

בכל יומן יכולות להיות עד 200 תוויות.

 ניתן לכתיבה
labelProperties.eventLabels[].backgroundColor string צבע הרקע של התווית בפורמט הקסדצימלי, למשל "#039be5". אירועים עם התווית הזו מוצגים בצבע הזה. חובה. ניתן לכתיבה
labelProperties.eventLabels[].id string המזהה של התווית. אופציונלי כשמוסיפים תווית חדשה. אם לא תציינו מזהה, המערכת תיצור מזהה ייחודי. נדרש כשמעדכנים תווית.

אם מציינים מזהה, הוא צריך להיות ייחודי ביומן ובפורמט UUID.

 ניתן לכתיבה
labelProperties.eventLabels[].name string שם התווית. זה שינוי אופציונלי.

אם מציינים את השדה הזה, הוא יכול להכיל עד 50 תווים.

 ניתן לכתיבה
location string המיקום הגיאוגרפי של היומן כטקסט חופשי. זה שינוי אופציונלי. ניתן לכתיבה
summary string השם של היומן. ניתן לכתיבה
timeZone string אזור הזמן של היומן. (בפורמט של שם במסד הנתונים IANA Time Zone Database, למשל "Europe/Zurich".) זה שינוי אופציונלי. ניתן לכתיבה
workingHours object מייצג את המידע על שעות העבודה של המשתמש. האפשרות הזו זמינה רק ביומנים הראשיים של משתמשי Google Workspace. כדי לעדכן את שעות העבודה, צריך להעביר את כל האובייקט של שעות העבודה. אם לא מציינים שעות עבודה (או אם מעבירים ערך null או אובייקט ריק), שעות העבודה הקיימות לא משתנות. כדי להשבית את שעות העבודה או לנקות את לוח הזמנים, מגדירים את workingHoursEnabled כ-false (ומשמיטים את availableTimes או מעבירים רשימה ריקה). ניתן לכתיבה
workingHours.availableTimes[] list שעות העבודה. כל תקופת זמינות מייצגת את משבצת שעות העבודה של המשתמש במהלך יום אחד. ניתן לכתיבה
workingHours.availableTimes[].dayOfWeek string היום בשבוע. חובה. הערכים האפשריים הם:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
ניתן לכתיבה
workingHours.availableTimes[].periodEnd integer סוף התקופה, בדקות מתחילת היום, לא כולל. חובה. ניתן לכתיבה
workingHours.availableTimes[].periodStart integer תחילת התקופה, בדקות מתחילת היום, כולל. חובה. ניתן לכתיבה
workingHours.workingHoursEnabled boolean אם שעות העבודה מופעלות ביומן הזה. אי אפשר להגדיר את הערך כ-true כשהשדה availableTimes ריק. ניתן לכתיבה

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזירה משאב Calendars בגוף התגובה.

רוצה לנסות?

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