עדכון אירוע. השיטה הזו תומכת בסמינטיקה של תיקונים. חשוב לזכור שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שציינתם יחליפו את הערכים הקיימים. שדות שלא מציינים בבקשה לא משתנים. אם מציינים שדות מערך, הם מחליפים את המערכים הקיימים. הפעולה הזו מוחקת את כל רכיבי המערך הקודמים.
רוצים לנסות?
בקשה
בקשת HTTP
PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
פרמטרים
| שם הפרמטר | ערך | תיאור |
|---|---|---|
| פרמטרים של נתיב | ||
calendarId |
string |
מזהה היומן. כדי לאחזר את מזהי היומנים, קוראים לשיטה calendarList.list. כדי לגשת ליומן הראשי של המשתמש שמחובר כרגע, משתמשים במילות המפתח primary.
|
eventId |
string |
מזהה האירוע. |
| פרמטרים אופציונליים של שאילתות | ||
alwaysIncludeEmail |
boolean |
הוצא משימוש והמערכת מתעלמת ממנו. תמיד יוחזר ערך בשדה email עבור המארגן, היוצר והמשתתפים, גם אם אין כתובת אימייל אמיתית זמינה (כלומר, יופיע ערך שנוצר ולא פעיל).
|
conferenceDataVersion |
integer |
מספר הגרסה של נתוני הכנס שנתמכים בלקוח ה-API. בגרסה 0 לא מוגדרת תמיכה בנתוני כנסים, והמערכת מתעלמת מנתוני כנסים בגוף האירוע. בגרסה 1 יש תמיכה בהעתקה של ConferenceData וגם ביצירת שיחות ועידה חדשות באמצעות השדה createRequest של conferenceData. ערך ברירת המחדל הוא 0.
הערכים הקבילים הם 0 עד 1, כולל.
|
maxAttendees |
integer |
המספר המקסימלי של משתתפים שאפשר לכלול בתשובה. אם יש יותר ממספר הנוכחים שצוין, רק המשתתף יוחזר. זה שינוי אופציונלי. |
sendNotifications |
boolean |
הוצא משימוש. במקום זאת, יש להשתמש בפונקציה sendUpdates. האם לשלוח התראות על עדכון האירוע (לדוגמה, שינויים בתיאור וכו'). חשוב לדעת שחלק מהאימיילים עדיין עשויים להישלח גם אם תגדירו את הערך ל- false. ערך ברירת המחדל הוא false.
|
sendUpdates |
string |
האורחים שצריכים לקבל התראות על עדכון האירוע (לדוגמה, שינויים בכותרת וכו').
הערכים הקבילים הם:
|
supportsAttachments |
boolean |
האם לקוח ה-API שמבצע את הפעולה תומך בקבצים מצורפים לאירועים. זה שינוי אופציונלי. ברירת המחדל היא False. |
אישור
הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:
| היקף |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
מידע נוסף זמין בדף אימות והרשאה.
גוף הבקשה
בגוף הבקשה, מספקים את החלקים הרלוונטיים של משאב אירועים, בהתאם לכללי הסמנטיקה של התיקון.
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב אירועים בגוף התגובה.
נסה בעצמך!
אפשר להשתמש ב-API Explorer שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.