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  /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  /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 מחיקת יומן משני. אפשר להשתמש ב-calendar.clear כדי למחוק את כל האירועים ביומנים הראשיים.
get GET  /calendars/calendarId מחזירה מטא-נתונים של יומן.
הוספה POST  /calendars יצירת יומן משני.
תיקון 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 שלו, צריך להפעיל את השיטה events.list באמצעות הפרמטר iCalUID.
import POST  /calendars/calendarId/events/import מייבאת אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן.
הוספה 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  /calendars/calendarId/events/eventId מעדכן אירוע. שיטה זו תומכת בסמנטיקה של תיקון. הערה: כל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-get ואחריו ב-update. ערכי השדות שתציינו יחליפו את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם יחליפו את המערכים הקיימים. פעולה זו תמחק את כל רכיבי המערך הקודמים.
quickAdd POST  /calendars/calendarId/events/quickAdd יצירת אירוע על סמך מחרוזת טקסט פשוטה.

פרמטרים נדרשים של שאילתה: text

עדכון PUT  /calendars/calendarId/events/eventId מעדכן אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקון ותמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, יש לבצע get ולאחר מכן update באמצעות etags כדי להבטיח אטימות.
שעון 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 חשוב לעקוב אחר השינויים במשאבי ההגדרות.