API Reference

הפניית ה-API הזו מסודרת לפי סוג המשאב. לכל סוג משאב יש ייצוג נתונים אחד או יותר ושיטה אחת או יותר.

סוגי המשאבים

1. Acl
2. CalendarList
3. יומנים
4. Channels
5. צבעים
6. אירועים
7. Freebusy
8. הגדרות

Acl

פרטים על משאב Acl זמינים בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי ה-URI הם יחסי לכתובת https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
מחיקה	DELETE  /calendars/calendarId/acl/ruleId	מחיקת כלל של בקרת גישה.
לקבל	GET  /calendars/calendarId/acl/ruleId	מחזירה כלל של בקרת גישה.
הוספה	POST  /calendars/calendarId/acl	יצירת כלל בקרת גישה.
list	GET  /calendars/calendarId/acl	מחזירה את הכללים ברשימת בקרת הגישה ליומן.
patch	PATCH  /calendars/calendarId/acl/ruleId	עדכון של כלל בקרת גישה. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא צוינו בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
עדכון	PUT  /calendars/calendarId/acl/ruleId	עדכון של כלל בקרת גישה.
watch	POST  /calendars/calendarId/acl/watch	כדאי לעקוב אחרי שינויים במשאבי ACL.

CalendarList

פרטים על משאב CalendarList זמינים בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
מחיקה	DELETE  /users/me/calendarList/calendarId	הסרת יומן מרשימת היומנים של המשתמש.
לקבל	GET  /users/me/calendarList/calendarId	מחזירה יומן מרשימת היומנים של המשתמש.
הוספה	POST  /users/me/calendarList	הוספת יומן קיים לרשימת היומנים של המשתמש.
list	GET  /users/me/calendarList	הפונקציה מחזירה את היומנים ברשימת היומנים של המשתמש.
patch	PATCH  /users/me/calendarList/calendarId	מעדכן יומן קיים ברשימת היומנים של המשתמש. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא צוינו בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
עדכון	PUT  /users/me/calendarList/calendarId	מעדכן יומן קיים ברשימת היומנים של המשתמש.
watch	POST  /users/me/calendarList/watch	כדאי לעקוב אחרי שינויים במשאבי CalendarList.

יומנים

פרטים על משאבים ביומן זמינים בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
ניקוי	POST  /calendars/calendarId/clear	מחיקת היומן הראשי. הפעולה הזו מוחקת את כל האירועים שמשויכים ליומן הראשי של החשבון.
מחיקה	DELETE  /calendars/calendarId	מוחק יומן משני. משתמשים ב-calendars.clear כדי למחוק את כל האירועים ביומנים הראשיים.
לקבל	GET  /calendars/calendarId	מחזירה מטא-נתונים של יומן.
הוספה	POST  /calendars	יוצר יומן משני. המשתמש המאומת ששלח את הבקשה הופך לבעלים של הנתונים ביומן החדש. הערה: מומלץ לבצע אימות כבעלים המיועד של הנתונים ביומן. אתם יכולים להשתמש בהענקת גישה ברמת הדומיין כדי לאפשר לאפליקציות לפעול בשם משתמש ספציפי. לא משתמשים בחשבון שירות לצורך אימות. אם משתמשים בחשבון שירות לאימות, חשבון השירות הוא בעל הנתונים, וזה עלול להוביל להתנהגות לא צפויה. לדוגמה, אם חשבון שירות הוא הבעלים של הנתונים, אי אפשר להעביר את הבעלות על הנתונים.
patch	PATCH  /calendars/calendarId	עדכון המטא-נתונים של היומן. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא צוינו בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
transferOwnership	POST  /calendars/calendarId/transferOwnership	העברה של יומן משני בין משתמשים בארגון Google Workspace. כדי לעשות את זה צריך אימות משתמש עם הרשאת אדמין לניהול יומנים, ואחת מהרשאות הגישה הבאות: https://www.googleapis.com/auth/calendar https://www.googleapis.com/auth/calendar.calendars בבקשה, מגדירים את useAdminAccess לערך true. כדי להעביר יומן משני, הוא צריך להיות פעיל. אי אפשר להעביר יומנים מושבתים או שנמחקו. פרמטרים נדרשים של שאילתה: newDataOwner, useAdminAccess
עדכון	PUT  /calendars/calendarId	עדכון המטא-נתונים של היומן.

ערוצים

פרטים על משאב הערוצים מופיעים בדף ייצוג המשאב.

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
stop	POST  /channels/stop	הפסקת הצפייה במשאבים דרך הערוץ הזה.

צבעים

פרטים על משאב הצבעים זמינים בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
לקבל	GET  /colors	מחזירה את הגדרות הצבע של היומנים והאירועים.

אירועים

פרטים על משאב האירועים זמינים בדף ייצוג המשאב.

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
מחיקה	DELETE  /calendars/calendarId/events/eventId	מחיקת אירוע.
לקבל	GET  /calendars/calendarId/events/eventId	מחזירה אירוע על סמך המזהה שלו ביומן Google. כדי לאחזר אירוע באמצעות מזהה iCalendar שלו, צריך להפעיל את הפרמטר iCalUID ב-method ‏events.list.
ייבוא	POST  /calendars/calendarId/events/import	ייבוא אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. אפשר לייבא רק אירועים עם eventType של default. התנהגות שיצאה משימוש: אם מייבאים אירוע שהוא לא מסוג default, הסוג שלו ישתנה ל-default וכל המאפיינים הספציפיים לסוג האירוע יוסרו.
הוספה	POST  /calendars/calendarId/events	ייווצר אירוע.
instances	GET  /calendars/calendarId/events/eventId/instances	מחזירה מופעים של האירוע החוזר שצוין.
list	GET  /calendars/calendarId/events	מחזירה אירועים ביומן שצוין.
העברה	POST  /calendars/calendarId/events/eventId/move	העברת אירוע ליומן אחר, כלומר שינוי המארגן של האירוע. שימו לב שאפשר להעביר רק אירועים ב-default. אי אפשר להעביר אירועים ב-birthday, ב-focusTime, ב-fromGmail, ב-outOfOffice וב-workingLocation. פרמטרים נדרשים של שאילתה: destination
patch	PATCH  /calendars/calendarId/events/eventId	עדכון של אירוע. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא צוינו בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
quickAdd	POST  /calendars/calendarId/events/quickAdd	יצירת אירוע על סמך מחרוזת טקסט פשוטה. פרמטרים נדרשים של שאילתה: text
עדכון	PUT  /calendars/calendarId/events/eventId	עדכון של אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקון, ותמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, מבצעים get ואז update באמצעות תגי ETag כדי להבטיח אטומיות.
watch	POST  /calendars/calendarId/events/watch	כדאי לעקוב אחרי שינויים במשאבי Events.

אפשר לקבוע / אי-אפשר לקבוע

פרטים על משאבים לזמינות מופיעים בדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
שאילתה	POST  /freeBusy	מחזירה מידע על זמן פנוי/לא פנוי עבור קבוצה של יומנים.

הגדרות

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

שיטה	בקשת HTTP	תיאור
כתובות URI יחסיות ל-https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
לקבל	GET  /users/me/settings/setting	מחזירה הגדרה אחת של משתמש.
list	GET  /users/me/settings	הפונקציה מחזירה את כל הגדרות המשתמש עבור המשתמש המאומת.
watch	POST  /users/me/settings/watch	שימו לב לשינויים במשאבי ההגדרות.