מעדכנים אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקונים ותמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, מבצעים get
ולאחר מכן update
באמצעות תגים אלקטרוניים (etags).
אפשר לנסות עכשיו או לראות דוגמה.
בקשה
בקשת HTTP
PUT 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 |
משתתפים שאמורים לקבל התראות על העדכון באירוע (לדוגמה: שינוי הכותרת וכו').
הערכים הקבילים הם:
|
supportsAttachments |
boolean |
האם פעולת ביצוע של לקוח API תומכת בקבצים מצורפים לאירועים. אפשרות. ברירת המחדל היא False. |
הרשאות
בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים:
היקף |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
מידע נוסף זמין בדף אימות והרשאה.
גוף הבקשה
בגוף הבקשה, מציינים משאב אירועים עם המאפיינים הבאים:
שם הנכס | Value | תיאור | הערות |
---|---|---|---|
מאפיינים נדרשים | |||
end |
nested object |
שעת הסיום (הבלעדית) של האירוע. באירוע חוזר, זוהי שעת הסיום של המופע הראשון. | |
start |
nested object |
שעת ההתחלה (כולל) של האירוע. באירוע חוזר, זוהי שעת ההתחלה של המופע הראשון. | |
מאפיינים אופציונליים | |||
anyoneCanAddSelf |
boolean |
אם כל אחד יכול להזמין את עצמו לאירוע (הוצא משימוש). אפשרות. ברירת המחדל היא False. | ניתן לכתיבה |
attachments[].fileUrl |
string |
קישור לכתובת ה-URL של הקובץ המצורף. כדי להוסיף קבצים מצורפים מ-Google Drive צריך להשתמש בפורמט זהה לזה שבמאפיין נדרש בעת הוספת קובץ מצורף. |
ניתן לכתיבה |
attendees[] |
list |
משתתפי האירוע. מידע נוסף על תזמון אירועים עם משתמשים אחרים ביומן זמין במדריך אירועים עם משתתפים. כדי לאכלס את רשימת המשתתפים, צריך להשתמש בחשבונות שירות בהענקת סמכויות ברמת הדומיין. | ניתן לכתיבה |
attendees[].additionalGuests |
integer |
מספר האורחים הנוספים. אפשרות. ערך ברירת המחדל הוא 0. | ניתן לכתיבה |
attendees[].comment |
string |
תגובת המשתתף. אפשרות. | ניתן לכתיבה |
attendees[].displayName |
string |
שם המשתתף, אם אפשר. אפשרות. | ניתן לכתיבה |
attendees[].email |
string |
כתובת האימייל של המשתתף, אם היא זמינה. השדה הזה חייב להופיע כשמוסיפים משתתפים. חייבת להיות כתובת אימייל חוקית בהתאם ל-RFC5322. חובה להוסיף משתתפים. |
ניתן לכתיבה |
attendees[].optional |
boolean |
אם מדובר במשתתף אופציונלי. אפשרות. ברירת המחדל היא False. | ניתן לכתיבה |
attendees[].resource |
boolean |
האם המשתתף הוא משאב. ניתן לקבוע רק אם המשתתף יתווסף לאירוע בפעם הראשונה. המערכת מתעלמת מהשינויים הבאים. אפשרות. ברירת המחדל היא False. | ניתן לכתיבה |
attendees[].responseStatus |
string |
סטטוס התגובה של המשתתף. הערכים האפשריים הם:
|
ניתן לכתיבה |
attendeesOmitted |
boolean |
האם ייתכן שהמשתתפים הושמטו מייצוג האירוע. באחזור אירוע, יכול להיות שהסיבה לכך היא מגבלה שצוינה בפרמטר של השאילתה maxAttendee . כאשר מעדכנים אירוע, ניתן להשתמש באפשרות הזו רק כדי לעדכן את התגובה של המשתתף. אפשרות. ברירת המחדל היא False. |
ניתן לכתיבה |
colorId |
string |
צבע האירוע. זהו מזהה שמפנה לרשומה בקטע event של הגדרת הצבעים (אפשר לעיין ב נקודת הקצה של הצבעים). אפשרות. |
ניתן לכתיבה |
conferenceData |
nested object |
מידע שקשור לשיחת הוועידה, כמו פרטים של שיחת ועידה ב-Google Meet. כדי ליצור פרטים חדשים של שיחת הוועידה, צריך להשתמש בשדה createRequest . כדי לשמור על השינויים, חשוב לזכור להגדיר את פרמטר הבקשה conferenceDataVersion לערך 1 בכל הבקשות לשינוי אירועים. |
ניתן לכתיבה |
description |
string |
תיאור האירוע. יכול להכיל HTML. אפשרות. | ניתן לכתיבה |
end.date |
date |
התאריך, בפורמט 'yyyy-mm-dd', אם מדובר באירוע של יום שלם. | ניתן לכתיבה |
end.dateTime |
datetime |
השעה, כערך משולב של תאריך ושעה (בפורמט בהתאם ל-RFC3339). חובה להגדיר קיזוז אזור זמן, אלא אם אזור הזמן צוין במפורש ב-timeZone . |
ניתן לכתיבה |
end.timeZone |
string |
אזור הזמן שבו השעה מצוינת. (בפורמט של שם מסד נתונים של אזור זמן IANA, לדוגמה "אירופה/ציריך"). עבור אירועים חוזרים, שדה זה הוא שדה חובה ומציין את אזור הזמן שבו החזרה מורחבת. לאירועים בודדים השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע. | ניתן לכתיבה |
extendedProperties.private |
object |
מאפיינים שהם פרטיים לעותק של האירוע שמופיע ביומן הזה. | ניתן לכתיבה |
extendedProperties.shared |
object |
מאפיינים שמשותפים בין עותקים של האירוע ביומנים של משתתפים אחרים. | ניתן לכתיבה |
focusTimeProperties |
nested object |
נתונים של אירועי 'זמן לעצמי'. משמש אם הערך של eventType הוא focusTime . |
ניתן לכתיבה |
gadget.display |
string |
מצב התצוגה של הגאדג'ט. הוּצא משימוש. הערכים האפשריים הם:
|
ניתן לכתיבה |
gadget.height |
integer |
גובה הגאדג'ט בפיקסלים. הגובה חייב להיות מספר שלם הגדול מ-0. אפשרות. הוּצא משימוש. | ניתן לכתיבה |
gadget.iconLink |
string |
כתובת האתר של סמל הגאדג'ט. סכימת כתובת ה-URL חייבת להיות HTTPS. הוּצא משימוש. | ניתן לכתיבה |
gadget.link |
string |
כתובת ה-URL של הגאדג'ט. סכימת כתובת ה-URL חייבת להיות HTTPS. הוּצא משימוש. | ניתן לכתיבה |
gadget.preferences |
object |
העדפות. | ניתן לכתיבה |
gadget.title |
string |
שם הגאדג'ט. הוּצא משימוש. | ניתן לכתיבה |
gadget.type |
string |
סוג הגאדג'ט. הוּצא משימוש. | ניתן לכתיבה |
gadget.width |
integer |
רוחב הגאדג'ט בפיקסלים. הרוחב חייב להיות מספר שלם הגדול מ-0. אפשרות. הוּצא משימוש. | ניתן לכתיבה |
guestsCanInviteOthers |
boolean |
אם משתתפים אחרים מלבד המארגן יכולים להזמין לאירוע אחרים. אפשרות. ברירת המחדל היא True. | ניתן לכתיבה |
guestsCanModify |
boolean |
האם משתתפים אחרים מלבד המארגן יכולים לשנות את האירוע. אפשרות. ברירת המחדל היא False. | ניתן לכתיבה |
guestsCanSeeOtherGuests |
boolean |
האם משתתפים אחרים מלבד המארגן יכולים לראות מי הם משתתפי האירוע. אפשרות. ברירת המחדל היא True. | ניתן לכתיבה |
location |
string |
המיקום הגיאוגרפי של האירוע, כטקסט חופשי. אפשרות. | ניתן לכתיבה |
originalStartTime.date |
date |
התאריך, בפורמט 'yyyy-mm-dd', אם מדובר באירוע של יום שלם. | ניתן לכתיבה |
originalStartTime.dateTime |
datetime |
השעה, כערך משולב של תאריך ושעה (בפורמט בהתאם ל-RFC3339). חובה להגדיר קיזוז אזור זמן, אלא אם אזור הזמן צוין במפורש ב-timeZone . |
ניתן לכתיבה |
originalStartTime.timeZone |
string |
אזור הזמן שבו השעה מצוינת. (בפורמט של שם מסד נתונים של אזור זמן IANA, לדוגמה "אירופה/ציריך"). עבור אירועים חוזרים, שדה זה הוא שדה חובה ומציין את אזור הזמן שבו החזרה מורחבת. לאירועים בודדים השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע. | ניתן לכתיבה |
outOfOfficeProperties |
nested object |
נתוני אירועים מסוג 'לא בעבודה'. משמש אם הערך של eventType הוא outOfOffice . |
ניתן לכתיבה |
recurrence[] |
list |
רשימה של השורות RBLOCK, EXBLOCK, RDATE ו-EXDATE עבור אירוע חוזר, כפי שמצוין ב-RFC5545. לתשומת ליבך, לא ניתן להשתמש בשורות DTSTART ו-DTEND בשדה הזה. זמני ההתחלה והסיום של אירועים מצוינים בשדות start ו-end . השדה הזה יושמט לאירועים בודדים או למופעים של אירועים חוזרים. |
ניתן לכתיבה |
reminders.overrides[] |
list |
אם האירוע לא משתמש בתזכורות ברירת המחדל, יוצגו התזכורות הספציפיות לאירוע. אם לא הגדרת את התזכורות, לא הוגדרו תזכורות לאירוע הזה. אפשר לשנות עד 5 תזכורות. | ניתן לכתיבה |
reminders.overrides[].method |
string |
השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
חובה כשמוסיפים תזכורת. |
ניתן לכתיבה |
reminders.overrides[].minutes |
integer |
מספר הדקות לפני תחילת האירוע שבהן התזכורת צריכה להתחיל. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות). חובה כשמוסיפים תזכורת. |
ניתן לכתיבה |
reminders.useDefault |
boolean |
אם תזכורות ברירת המחדל של היומן חלות על האירוע. | ניתן לכתיבה |
sequence |
integer |
מספר רצף בהתאם ל-icalendar. | ניתן לכתיבה |
source.title |
string |
כותרת המקור; לדוגמה, כותרת של דף אינטרנט או נושא של אימייל. | ניתן לכתיבה |
source.url |
string |
כתובת ה-URL של המקור שמפנה למשאב. סכימת כתובת ה-URL חייבת להיות HTTP או HTTPS. | ניתן לכתיבה |
start.date |
date |
התאריך, בפורמט 'yyyy-mm-dd', אם מדובר באירוע של יום שלם. | ניתן לכתיבה |
start.dateTime |
datetime |
השעה, כערך משולב של תאריך ושעה (בפורמט בהתאם ל-RFC3339). חובה להגדיר קיזוז אזור זמן, אלא אם אזור הזמן צוין במפורש ב-timeZone . |
ניתן לכתיבה |
start.timeZone |
string |
אזור הזמן שבו השעה מצוינת. (בפורמט של שם מסד נתונים של אזור זמן IANA, לדוגמה "אירופה/ציריך"). עבור אירועים חוזרים, שדה זה הוא שדה חובה ומציין את אזור הזמן שבו החזרה מורחבת. לאירועים בודדים השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע. | ניתן לכתיבה |
status |
string |
סטטוס האירוע. אפשרות. הערכים האפשריים הם:
|
ניתן לכתיבה |
summary |
string |
שם האירוע. | ניתן לכתיבה |
transparency |
string |
האם האירוע חוסם את הזמן ביומן. אפשרות. הערכים האפשריים הם:
|
ניתן לכתיבה |
visibility |
string |
היכולת לראות את האירוע. אפשרות. הערכים האפשריים הם:
|
ניתן לכתיבה |
workingLocationProperties |
nested object |
נתוני אירועים של מיקום העבודה. | ניתן לכתיבה |
workingLocationProperties.customLocation |
object |
אם השדה הזה קיים, המשמעות היא שהמשתמש עובד ממיקום מותאם אישית. | ניתן לכתיבה |
workingLocationProperties.customLocation.label |
string |
תווית נוספת (אופציונלי) כדי לקבל מידע נוסף. | ניתן לכתיבה |
workingLocationProperties.homeOffice |
any value |
אם השדה הזה קיים, המשמעות היא שהמשתמש עובד בבית. | ניתן לכתיבה |
workingLocationProperties.officeLocation |
object |
אם השדה הזה קיים, המשמעות היא שהמשתמש עובד במשרד. | ניתן לכתיבה |
workingLocationProperties.officeLocation.buildingId |
string |
מזהה מבנה אופציונלי. צריך להפנות למזהה מבנה במסד הנתונים של המשאבים של הארגון. | ניתן לכתיבה |
workingLocationProperties.officeLocation.deskId |
string |
מזהה שולחן עבודה וירטואלי אופציונלי. | ניתן לכתיבה |
workingLocationProperties.officeLocation.floorId |
string |
מזהה קומה אופציונלי. | ניתן לכתיבה |
workingLocationProperties.officeLocation.floorSectionId |
string |
מזהה אופציונלי של קטע הקומה. | ניתן לכתיבה |
workingLocationProperties.officeLocation.label |
string |
שם המשרד שמוצג בלקוחות יומן Google באינטרנט ובנייד. מומלץ לציין שם של מבנה במסד הנתונים של המשאבים של הארגון. | ניתן לכתיבה |
workingLocationProperties.type |
string |
הסוג של מיקום העבודה. הערכים האפשריים הם:
נדרש כשמוסיפים מאפיינים של מיקום עבודה. |
ניתן לכתיבה |
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאב אירועים בגוף התגובה.
דוגמאות
הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).
Java
משתמש בספריית הלקוח של Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the event from the API Event event = service.events().get("primary", "eventId").execute(); // Make a change event.setSummary("Appointment at Somewhere"); // Update the event Event updatedEvent = service.events().update("primary", event.getId(), event).execute(); System.out.println(updatedEvent.getUpdated());
Python
עושה שימוש בספריית הלקוח של Python.
# First retrieve the event from the API. event = service.events().get(calendarId='primary', eventId='eventId').execute() event['summary'] = 'Appointment at Somewhere' updated_event = service.events().update(calendarId='primary', eventId=event['id'], body=event).execute() # Print the updated date. print updated_event['updated']
PHP
נעשה שימוש בספריית הלקוח של PHP.
// First retrieve the event from the API. $event = $service->events->get('primary', 'eventId'); $event->setSummary('Appointment at Somewhere'); $updatedEvent = $service->events->update('primary', $event->getId(), $event); // Print the updated date. echo $updatedEvent->getUpdated();
Ruby
נעשה שימוש בספריית הלקוח של Ruby.
event = client.get_event('primary', 'eventId') event.summary = 'Appointment at Somewhere' result = client.update_event('primary', event.id, event) print result.updated
רוצה לנסות?
ניתן להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.