Events: patch

מעדכנים אירוע. שיטה זו תומכת בסמנטיקה של תיקונים. הערה: כל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-get ואחריו ב-update. ערכי השדות שתציינו יחליפו את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם מחליפים את המערכים הקיימים. הפעולה תגרום למחיקת רכיבי המערך הקודמים. רוצים לנסות עכשיו?

בקשה

בקשת HTTP

PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId

פרמטרים

שם הפרמטר Value התיאור
פרמטרים של נתיב
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 משתתפים שאמורים לקבל התראות על העדכון באירוע (לדוגמה: שינוי הכותרת וכו').

הערכים הקבילים הם:
  • "all": ההתראות נשלחות לכל האורחים.
  • 'externalOnly': ההתראות נשלחות רק למשתתפים שלא משתמשים ביומן Google.
  • 'none': לא נשלחו התראות. למשימות העברה של יומן, מומלץ להשתמש במקום זאת בשיטה Events.import.
supportsAttachments boolean האם פעולת ביצוע של לקוח API תומכת בקבצים מצורפים לאירועים. אפשרות. ברירת המחדל היא False.

הרשאות

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

היקף
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

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

גוף הבקשה

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

תשובה

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

רוצה לנסות?

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