דף זה תורגם על ידי Cloud Translation API.

API Reference

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

סוגי המשאבים

ACL
רשימת יומנים
יומנים
ערוצים
צבעים
אירועים
פנוי/ה
הגדרות

ACL

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

‏Method	בקשת 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 /calendars/calendarId/acl/ruleId`	עדכון כלל של בקרת גישה. שיטה זו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-`get` ואחריו `update`. ערכי השדה שתציינו יחליפו את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם ערכי המערכים שצוינו קיימים, הם מחליפים את המערכים הקיימים. הפעולה הזו מבטלת את המערכים הקודמים של המערכים.
עדכון	`PUT /calendars/calendarId/acl/ruleId`	עדכון כלל של בקרת גישה.
שעון	`POST /calendars/calendarId/acl/watch`	היזהר משינויים במשאבי ACL.

רשימת היומנים

כדי לראות את הפרטים של משאב יומן, צריך להיכנס לדף ייצוג משאבים.

‏Method	בקשת 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 /users/me/calendarList/calendarId`	עדכון יומן קיים ברשימת היומנים של המשתמש. שיטה זו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-`get` ואחריו `update`. ערכי השדה שתציינו יחליפו את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם ערכי המערכים שצוינו קיימים, הם מחליפים את המערכים הקיימים. הפעולה הזו מבטלת את המערכים הקודמים של המערכים.
עדכון	`PUT /users/me/calendarList/calendarId`	עדכון יומן קיים ברשימת היומנים של המשתמש.
שעון	`POST /users/me/calendarList/watch`	בקרוב יחולו שינויים במשאבי היומן של ListList.

יומנים

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

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

ערוצים

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

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

צבעים

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

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

אירועים

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

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

פנוי/ה

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

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

הגדרות

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

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