עדכון המטא-נתונים של היומן. רוצים לנסות?
בקשה
בקשת HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarIdפרמטרים
| שם הפרמטר | ערך | תיאור |
|---|---|---|
| פרמטרים של נתיבים | ||
calendarId |
string |
מזהה היומן. כדי לאחזר מזהי יומנים, קוראים לשיטה calendarList.list. אם רוצים לגשת ליומן הראשי של המשתמש שמחובר כרגע, משתמשים במילת המפתח primary.
|
אישור
כדי לבצע את הבקשה הזו, צריך להעניק הרשאה עם אחת מההיקפים הבאים:
| היקף |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendars |
למידע נוסף, ראו את הדף אימות והרשאה.
גוף הבקשה
בגוף הבקשה, מציינים משאב 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'). אופציונלי. | ניתן לכתיבה |
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאב Calendars בגוף התגובה.
רוצה לנסות?
אפשר להשתמש בכלי APIs Explorer שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.