API Reference

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

סוגי המשאבים

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

Acl

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

שיטה	בקשת HTTP	תיאור
מזהי URI יחסיים לכתובת https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
מחיקה	DELETE  /calendars/calendarId/acl/ruleId	מחיקה של כלל בקרת גישה.
get	GET  /calendars/calendarId/acl/ruleId	הפונקציה מחזירה כלל של בקרת גישה.
insert	POST  /calendars/calendarId/acl	יצירת כלל של בקרת גישה.
list	GET  /calendars/calendarId/acl	הפונקציה מחזירה את הכללים ברשימת בקרת הגישה של היומן.
תיקון	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	GET  /users/me/calendarList/calendarId	הפונקציה מחזירה יומן מרשימת היומנים של המשתמש.
insert	POST  /users/me/calendarList	הוספה של יומן קיים לרשימת היומנים של המשתמש.
list	GET  /users/me/calendarList	הפונקציה מחזירה את היומנים ברשימת היומנים של המשתמש.
תיקון	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, אלא אם צוין אחרת
clear	POST  /calendars/calendarId/clear	ניקוי יומן ראשי. הפעולה הזו מוחקת את כל האירועים שמשויכים ליומן הראשי של החשבון.
מחיקה	DELETE  /calendars/calendarId	מחיקה של יומן משני. כדי למחוק את כל האירועים מהיומנים הראשיים, משתמשים בפונקציה calendars.clear.
get	GET  /calendars/calendarId	הפונקציה מחזירה מטא-נתונים של יומן.
insert	POST  /calendars	יצירת יומן משני.
תיקון	PATCH  /calendars/calendarId	עדכון המטא-נתונים של יומן. השיטה הזו תומכת בסמינטיקה של תיקונים. חשוב לזכור שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שציינתם יחליפו את הערכים הקיימים. שדות שלא מציינים בבקשה לא משתנים. אם מציינים שדות מערך, הם מחליפים את המערכים הקיימים. הפעולה הזו מוחקת את כל רכיבי המערך הקודמים.
עדכון	PUT  /calendars/calendarId	עדכון המטא-נתונים של יומן.

ערוצים

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

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

צבעים

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

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

אירועים

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

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/calendar/v3, אלא אם צוין אחרת
מחיקה	DELETE  /calendars/calendarId/events/eventId	מחיקה של אירוע.
get	GET  /calendars/calendarId/events/eventId	הפונקציה מחזירה אירוע על סמך המזהה שלו ביומן Google. כדי לאחזר אירוע באמצעות מזהה ה-iCalendar שלו, צריך להפעיל את ה-method events.list באמצעות הפרמטר iCalUID.
import	POST  /calendars/calendarId/events/import	ייבוא אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. אפשר לייבא רק אירועים עם הערך default בשדה eventType. התנהגות שיצאה משימוש: אם מייבאים אירוע שאינו מסוג default, הסוג שלו ישתנה ל-default וכל המאפיינים הספציפיים לסוג האירוע יימחקו.
insert	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  /calendars/calendarId/events/eventId	עדכון אירוע. השיטה הזו תומכת בסמינטיקה של תיקונים. חשוב לזכור שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שציינתם יחליפו את הערכים הקיימים. שדות שלא מציינים בבקשה לא משתנים. אם מציינים שדות מערך, הם מחליפים את המערכים הקיימים. הפעולה הזו מוחקת את כל רכיבי המערך הקודמים.
quickAdd	POST  /calendars/calendarId/events/quickAdd	יצירת אירוע על סמך מחרוזת טקסט פשוטה. פרמטרים נדרשים של שאילתה: text
עדכון	PUT  /calendars/calendarId/events/eventId	עדכון אירוע. השיטה הזו לא תומכת בסמינטיקה של תיקון, והיא תמיד מעדכנת את משאב האירוע כולו. כדי לבצע עדכון חלקי, מבצעים get ואחריו update באמצעות etags כדי להבטיח אטומיות.
watch	POST  /calendars/calendarId/events/watch	לעקוב אחרי שינויים במשאבים של אירועים.

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

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

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

הגדרות

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

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