Events: patch

עדכון של אירוע. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-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, כולל.
eventLabelVersion integer מספר הגרסה של התכונה 'תווית אירוע' שנתמכת על ידי לקוח ה-API. בגרסה 0 אין תמיכה בתוויות אירועים, והיא מעבדת את השדה colorId לניהול צבעים. גרסה 1 מאפשרת תמיכה בתוויות אירועים ומעבדת את eventLabelId בגוף האירוע. במקרה כזה, המערכת מתעלמת מהשדה colorId. ערך ברירת המחדל הוא 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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

למידע נוסף, ראו את הדף אימות והרשאה.

גוף הבקשה

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

תשובה

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

רוצה לנסות?

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