API Reference

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

סוגי המשאבים

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

Acl

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

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

יומנים

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

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

ערוצים

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

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

צבעים

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

שיטה	בקשת 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	מייבאת אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. ניתן לייבא רק אירועים עם eventType של default. התנהגות שהוצאה משימוש: אם מייבאים אירוע שאינו default, הסוג שלו ישתנה ל-default וכל המאפיינים הספציפיים לסוג האירוע יוסרו.
הוספה	POST  /calendars/calendarId/events	ייווצר אירוע.
מכונות	GET  /calendars/calendarId/events/eventId/instances	מחזירה מופעים של האירוע החוזר שצוין.
list	GET  /calendars/calendarId/events	מחזירה אירועים ביומן שצוין.
העברה	POST  /calendars/calendarId/events/eventId/move	מעביר אירוע ליומן אחר, כלומר משנה את מארגן האירוע. לתשומת ליבך, אפשר להעביר רק default אירועים. לא ניתן להעביר אירועים מסוג outOfOffice, focusTime ו-workingLocation. פרמטרים נדרשים של שאילתה: destination
patch	PATCH  /calendars/calendarId/events/eventId	מעדכן אירוע. השיטה הזו תומכת בסמנטיקה של תיקונים. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-get ולאחר מכן ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם יחליפו את המערכים הקיימים. הפעולה הזו תמחק את כל רכיבי המערך הקודמים.
quickAdd	POST  /calendars/calendarId/events/quickAdd	יצירת אירוע על סמך מחרוזת טקסט פשוטה. פרמטרים נדרשים של שאילתה: text
עדכון	PUT  /calendars/calendarId/events/eventId	מעדכן אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקון ותמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, מבצעים get ולאחר מכן update באמצעות תגים כדי להבטיח אטימות.
שעון	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	מחזירה את כל הגדרות המשתמש עבור המשתמש המאומת.
שעון	POST  /users/me/settings/watch	חשוב לשים לב לשינויים במשאבי ההגדרות.