Events: insert

הערה: נדרש אישור.

יצירת אירוע. רוצים לנסות?

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר	ערך	תיאור
פרמטרים של נתיב
calendarId	string	מזהה היומן. כדי לאחזר מזהי יומנים, קוראים לשיטה calendarList.list. אם רוצים לגשת ליומן הראשי של המשתמש שמחובר כרגע, משתמשים במילת המפתח primary.
פרמטרים אופציונליים של שאילתה
conferenceDataVersion	integer	מספר הגרסה של נתוני הוועידה שנתמכים על ידי לקוח ה-API. בגרסה 0 אין תמיכה בנתוני שיחות ועידה, והיא מתעלמת מנתוני שיחות ועידה בגוף האירוע. גרסה 1 מאפשרת תמיכה בהעתקה של ConferenceData וגם ביצירה של שיחות ועידה חדשות באמצעות השדה createRequest של conferenceData. ערך ברירת המחדל הוא 0. הערכים הקבילים הם 0 עד 1, כולל.
maxAttendees	integer	המספר המקסימלי של משתתפים שאפשר לכלול בתשובה. אם יש יותר משתתפים מהמספר שצוין, הפונקציה תחזיר רק את המשתתף. אופציונלי.
sendNotifications	boolean	הוצא משימוש. במקומו יש להשתמש ב-sendUpdates. האם לשלוח התראות על יצירת האירוע החדש. שימו לב שגם אם תגדירו את הערך כ-false, יכול להיות שעדיין יישלחו אימיילים. ערך ברירת המחדל הוא false.
sendUpdates	string	האם לשלוח התראות על יצירת האירוע החדש. שימו לב שחלק מהאימיילים עדיין עשויים להישלח. ערך ברירת המחדל הוא false. הערכים הקבילים הם: ‫all: ההתראות נשלחות לכל המשתתפים. ‫externalOnly: ההתראות נשלחות רק למשתתפים שלא משתמשים ביומן Google. ‫none: לא נשלחות התראות. אזהרה: שימוש בערך 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 עם המאפיינים הבאים:

שם הנכס	ערך	תיאור	הערות
מאפייני חובה
end	nested object	שעת הסיום (לא כולל) של האירוע. באירוע חוזר, זו שעת הסיום של המופע הראשון.
start	nested object	שעת ההתחלה (כולל) של האירוע. באירוע חוזר, זו שעת ההתחלה של המופע הראשון.
מאפיינים אופציונליים
anyoneCanAddSelf	boolean	האם מישהו יכול להזמין את עצמו לאירוע (המאפיין הזה הוצא משימוש). אופציונלי. ברירת המחדל היא False.	ניתן לכתיבה
attachments[].fileUrl	string	כתובת ה-URL של הקישור לקובץ המצורף. כדי להוסיף קבצים מצורפים מ-Google Drive, משתמשים באותו פורמט כמו במאפיין alternateLink של משאב Files ב-Drive API. חובה כשמוסיפים קובץ מצורף.	ניתן לכתיבה
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	סטטוס התשובה של המשתתף. הערכים האפשריים הם: ‫needsAction – המשתתף לא הגיב להזמנה (מומלץ לאירועים חדשים). ‫declined – המשתתף דחה את ההזמנה. ‫tentative – המשתתף אישר את ההזמנה באופן זמני. ‫accepted – המשתתף אישר את ההזמנה. אזהרה: אם מוסיפים אירוע באמצעות הערכים declined, tentative או accepted, יכול להיות שהתשובה של המשתתפים שהגדירו את ההגדרה 'הוספת הזמנות ליומן שלי' לערך 'רק אם עניתי להזמנה באימייל' או 'רק אם השולח מוכר לי' תאופס לערך needsAction, והם לא יראו את האירוע ביומן שלהם אלא אם הם ישנו את התשובה שלהם באימייל להזמנה לאירוע. בנוסף, אם מוזמנים לאירוע יותר מ-200 משתתפים, סטטוס התגובה לא מועבר אליהם.	ניתן לכתיבה
birthdayProperties	nested object	נתונים של ימי הולדת או אירועים מיוחדים. המאפיין הזה משמש אם הערך של eventType הוא "birthday". אי אפשר לשנות.	ניתן לכתיבה
birthdayProperties.type	string	סוג יום ההולדת או האירוע המיוחד. הערכים האפשריים הם: "anniversary" – יום נישואין או אירוע אחר שאינו יום הולדת. תמיד יש contact. ‫"birthday" – אירוע יום הולדת. זהו ערך ברירת המחדל. ‫"custom" – תאריך מיוחד שהתווית שלו מצוינת בשדה customTypeName. תמיד יש contact. ‫"other" – תאריך מיוחד שלא נכלל בקטגוריות האחרות ואין לו תווית בהתאמה אישית. תמיד יש contact. ‫"self" – יום ההולדת של הבעלים של היומן. אי אפשר להשתמש ב-contact. Calendar API תומך רק ביצירת אירועים מהסוג "birthday". אי אפשר לשנות את הסוג אחרי שיוצרים את האירוע.	ניתן לכתיבה
colorId	string	הצבע של האירוע. זהו מזהה שמתייחס לרשומה בקטע event של הגדרת הצבעים (ראו נקודת הקצה של הצבעים). אופציונלי.	ניתן לכתיבה
conferenceData	nested object	המידע שקשור לשיחת הוועידה, כמו הפרטים של שיחת הוועידה ב-Google Meet. כדי ליצור פרטים חדשים של שיחות ועידה, משתמשים בשדה createRequest. כדי שהשינויים יישמרו, חשוב להגדיר את פרמטר הבקשה conferenceDataVersion לערך 1 בכל הבקשות לשינוי אירועים. אזהרה: שימוש חוזר בנתוני ועידה של Google Meet באירועים שונים עלול לגרום לבעיות בגישה ולחשוף את פרטי הפגישה למשתמשים לא רצויים. כדי לשמור על פרטיות הפגישה, מומלץ תמיד ליצור פגישה ייחודית לכל אירוע באמצעות השדה createRequest.	ניתן לכתיבה
description	string	תיאור האירוע. יכול להכיל HTML. אופציונלי.	ניתן לכתיבה
end.date	date	התאריך בפורמט 'yyyy-mm-dd', אם מדובר באירוע שנמשך כל היום.	ניתן לכתיבה
end.dateTime	datetime	השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין את ההפרש מאזור הזמן, אלא אם מציינים אזור זמן באופן מפורש ב-timeZone.	ניתן לכתיבה
end.timeZone	string	אזור הזמן שבו מצוין הזמן. (הפורמט הוא שם של אזור זמן במסד הנתונים של IANA, למשל Europe/Zurich). באירועים חוזרים, חובה למלא את השדה הזה ולציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית לתחילת האירוע ולסיום שלו.	ניתן לכתיבה
eventType	string	סוג ספציפי של האירוע. אי אפשר לשנות את ההגדרה הזו אחרי שיוצרים את האירוע. הערכים האפשריים הם: ‫birthday – אירוע מיוחד שנמשך כל היום וחוזר מדי שנה. ‫"default" – אירוע רגיל או אירוע שלא צוין לגביו פרטים נוספים. ‫focusTime – אירוע מסוג 'זמן לעצמי'. ‫fromGmail – אירוע מ-Gmail. אי אפשר ליצור אירועים מהסוג הזה. ‫outOfOffice – אירוע מסוג 'לא בעבודה'. ‫"workingLocation" – אירוע של מיקום עבודה.	ניתן לכתיבה
extendedProperties.private	object	מאפיינים שפרטיים לעותק של האירוע שמופיע ביומן הזה.	ניתן לכתיבה
extendedProperties.shared	object	מאפיינים שמשותפים בין עותקים של האירוע ביומנים של משתתפים אחרים.	ניתן לכתיבה
focusTimeProperties	nested object	נתוני אירועים של 'זמן לעצמי'. המאפיין הזה משמש אם הערך של eventType הוא focusTime.	ניתן לכתיבה
gadget.display	string	מצב התצוגה של הגאדג'ט. הוצא משימוש. הערכים האפשריים הם: ‫icon – הגאדג'ט מוצג לצד שם האירוע בתצוגת היומן. ‫chip – הגאדג'ט מוצג כשלוחצים על האירוע.	ניתן לכתיבה
gadget.height	integer	גובה הגאדג'ט בפיקסלים. הגובה חייב להיות מספר שלם שגדול מ-0. אופציונלי. הוצא משימוש.	ניתן לכתיבה
gadget.iconLink	string	כתובת ה-URL של הסמל של הגאדג'ט. סכימת כתובת ה-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.	ניתן לכתיבה
id	string	מזהה אטום של האירוע. כשיוצרים אירועים חדשים, חד-פעמיים או חוזרים, אפשר לציין את המזהים שלהם. המזהים שאתם מספקים צריכים לעמוד בכללים הבאים: התווים שמותרים במזהה הם אלה שמשמשים בקידוד base32hex, כלומר אותיות קטנות a-v וספרות 0-9.מידע נוסף זמין בקטע 3. 1.2 ב-RFC2938. אורך המזהה צריך להיות בין 5 ל-1,024 תווים המזהה חייב להיות ייחודי לכל לוח שנה בגלל שהמערכת מבוזרת באופן גלובלי, אנחנו לא יכולים להבטיח שיתגלו התנגשויות של מזהים בזמן יצירת האירוע. כדי לצמצם את הסיכון להתנגשויות, מומלץ להשתמש באלגוריתם UUID מבוסס, כמו זה שמתואר ב-RFC4122. אם לא מציינים מזהה, השרת יוצר אותו באופן אוטומטי. שימו לב שהתגים icalUID ו-id לא זהים, וצריך לספק רק אחד מהם בזמן יצירת האירוע. הבדל אחד בסמנטיקה הוא שבאירועים חוזרים, לכל המופעים של אירוע אחד יש ערכי id שונים, אבל לכולם יש את אותם ערכי icalUID.	ניתן לכתיבה
location	string	המיקום הגיאוגרפי של האירוע כטקסט חופשי. אופציונלי.	ניתן לכתיבה
originalStartTime.date	date	התאריך בפורמט 'yyyy-mm-dd', אם מדובר באירוע שנמשך כל היום.	ניתן לכתיבה
originalStartTime.dateTime	datetime	השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין את ההפרש מאזור הזמן, אלא אם מציינים אזור זמן באופן מפורש ב-timeZone.	ניתן לכתיבה
originalStartTime.timeZone	string	אזור הזמן שבו מצוין הזמן. (הפורמט הוא שם של אזור זמן במסד הנתונים של IANA, למשל Europe/Zurich). באירועים חוזרים, חובה למלא את השדה הזה ולציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית לתחילת האירוע ולסיום שלו.	ניתן לכתיבה
outOfOfficeProperties	nested object	נתונים של אירועים מסוג 'לא בעבודה'. המאפיין הזה משמש אם הערך של eventType הוא outOfOffice.	ניתן לכתיבה
recurrence[]	list	רשימה של שורות RRULE, ‏ EXRULE, ‏ RDATE ו-EXDATE לאירוע חוזר, כפי שמפורט ב-RFC5545. שימו לב שאסור להשתמש בשורות DTSTART ו-DTEND בשדה הזה. שעות ההתחלה והסיום של האירוע מצוינות בשדות start ו-end. השדה הזה לא מופיע באירועים בודדים או במופעים של אירועים חוזרים.	ניתן לכתיבה
reminders.overrides[]	list	אם לאירוע לא מוגדרות תזכורות ברירת המחדל, בעמודה הזו מפורטות התזכורות הספציפיות לאירוע, או מצוין שלא מוגדרות תזכורות לאירוע הזה. המספר המקסימלי של תזכורות לביטול הוא 5.	ניתן לכתיבה
reminders.overrides[].method	string	השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם: ‫email – התזכורות נשלחות באימייל. ‫popup – התזכורות נשלחות באמצעות חלון קופץ בממשק המשתמש. חובה כשמוסיפים תזכורת.	ניתן לכתיבה
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, למשל Europe/Zurich). באירועים חוזרים, חובה למלא את השדה הזה ולציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית לתחילת האירוע ולסיום שלו.	ניתן לכתיבה
status	string	הסטטוס של האירוע. אופציונלי. הערכים האפשריים הם: ‫confirmed – האירוע אושר. זהו סטטוס ברירת המחדל. ‫"tentative" – האירוע אושר באופן זמני. ‫cancelled – האירוע בוטל (נמחק). השיטה list מחזירה אירועים שבוטלו רק בסנכרון מצטבר (כשמציינים את syncToken או updatedMin) או אם הדגל showDeleted מוגדר לערך true. השיטה get תמיד מחזירה אותם. הסטטוס 'בוטל' מייצג שני מצבים שונים, בהתאם לסוג האירוע: מקרים חריגים שבוטלו של אירוע חוזר שלא בוטל מציינים שהמופע הזה לא צריך להיות מוצג יותר למשתמש. אפליקציות הלקוח צריכות לאחסן את האירועים האלה למשך חיי האירוע החוזר הראשי. מובטח שרק בשדות id, recurringEventId ו-originalStartTime של חריגים שבוטלו יופיעו ערכים. יכול להיות ששאר השדות יהיו ריקים. כל שאר האירועים שבוטלו מייצגים אירועים שנמחקו. הלקוחות צריכים להסיר את העותקים שסונכרנו באופן מקומי. אירועים שבוטלו ייעלמו בסופו של דבר, לכן לא כדאי להסתמך על כך שהם יהיו זמינים ללא הגבלת זמן. השדה id הוא השדה היחיד שמופיע בוודאות באירועים שנמחקו. ביומן של מארגן האירוע, פרטי האירועים שבוטלו (סיכום, מיקום וכו') עדיין מוצגים כדי שאפשר יהיה לשחזר אותם (לבטל את המחיקה). באופן דומה, האירועים שאליהם המשתמש הוזמן והוא הסיר אותם ידנית ממשיכים לספק פרטים. עם זאת, בקשות לסנכרון מצטבר עם showDeleted שמוגדר כ-false לא יחזירו את הפרטים האלה. אם מארגן האירוע משתנה (לדוגמה, באמצעות הפעולה העברה) והמארגן המקורי לא נמצא ברשימת המשתתפים, יישאר אירוע מבוטל שרק השדה id שלו יאוכלס בוודאות.	ניתן לכתיבה
summary	string	שם האירוע.	ניתן לכתיבה
transparency	string	האם האירוע חוסם זמן ביומן. אופציונלי. הערכים האפשריים הם: ‫opaque – ערך ברירת המחדל. האירוע חוסם זמן ביומן. זה שווה להגדרה של הצגת המצב שלי כעסוק/ה בממשק המשתמש של יומן Google. ‫"transparent" – האירוע לא חוסם זמן ביומן. ההגדרה הזו שוות ערך להגדרה של הסטטוס שלי לזמין/ה בממשק המשתמש של היומן.	ניתן לכתיבה
visibility	string	הרשאות הגישה לאירוע. אופציונלי. הערכים האפשריים הם: ‫default – נעשה שימוש בברירת המחדל של הרשאות הגישה לאירועים ביומן. זהו ערך ברירת המחדל. ‫"public" – האירוע גלוי לכולם וכל מי שיכול לקרוא את היומן יכול לראות את פרטי האירוע. ‫private – האירוע פרטי ורק המשתתפים יכולים לראות את הפרטים שלו. ‫confidential – האירוע הוא פרטי. הערך הזה מסופק מטעמי תאימות.	ניתן לכתיבה
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	סוג מיקום העבודה. הערכים האפשריים הם: ‫"homeOffice" – המשתמש עובד מהבית. ‫officeLocation – המשתמש עובד מהמשרד. ‫customLocation – המשתמש עובד ממיקום מותאם אישית. כל הפרטים מצוינים בשדה משנה של השם שצוין, אבל השדה הזה עשוי להיות חסר אם הוא ריק. המערכת תתעלם מכל שאר השדות. חובה כשמוסיפים מאפיינים של מיקום עבודה.	ניתן לכתיבה

תשובה

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

רוצה לנסות?

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