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 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 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 GET  /calendars/calendarId מחזירה מטא-נתונים של יומן.
הוספה POST  /calendars יוצר יומן משני.

המשתמש המאומת של הבקשה הופך לבעלים של הנתונים ביומן החדש.
patch PATCH  /calendars/calendarId מעדכן את המטא-נתונים של היומן. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא מצוינים בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
עדכון PUT  /calendars/calendarId מעדכן את המטא-נתונים של היומן.

ערוצים

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

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