این مرجع API بر اساس نوع منبع سازماندهی شده است. هر نوع منبع دارای یک یا چند نمایش داده و یک یا چند روش است.
انواع منابع
Acl
برای جزئیات Acl Resource، صفحه نمایش منبع را ببینید.
روش | درخواست HTTP | شرح |
---|---|---|
URI های مربوط به https://www.googleapis.com/calendar/v3، مگر اینکه خلاف آن ذکر شده باشد | ||
حذف | DELETE /calendars/ calendarId /acl/ ruleId | یک قانون کنترل دسترسی را حذف می کند. |
گرفتن | GET /calendars/ calendarId /acl/ ruleId | یک قانون کنترل دسترسی را برمی گرداند. |
درج کنید | POST /calendars/ calendarId /acl | یک قانون کنترل دسترسی ایجاد می کند. |
فهرست | GET /calendars/ calendarId /acl | قوانین موجود در لیست کنترل دسترسی برای تقویم را برمی گرداند. |
پچ | PATCH /calendars/ calendarId /acl/ ruleId | یک قانون کنترل دسترسی را به روز می کند. این روش از معنای پچ پشتیبانی می کند. توجه داشته باشید که هر درخواست پچ سه واحد سهمیه مصرف می کند. ترجیح می دهند از یک get و به دنبال آن یک update استفاده کنند. مقادیر فیلدی که مشخص می کنید جایگزین مقادیر موجود می شوند. فیلدهایی که در درخواست مشخص نمی کنید بدون تغییر باقی می مانند. فیلدهای آرایه، در صورت مشخص شدن، آرایه های موجود را بازنویسی می کنند. این هر عنصر آرایه قبلی را کنار می گذارد. |
به روز رسانی | PUT /calendars/ calendarId /acl/ ruleId | یک قانون کنترل دسترسی را به روز می کند. |
تماشا کردن | POST /calendars/ calendarId /acl/watch | مراقب تغییرات در منابع ACL باشید. |
فهرست تقویم
برای جزئیات منابع CalendarList، صفحه نمایش منبع را ببینید.
روش | درخواست HTTP | شرح |
---|---|---|
URI های مربوط به https://www.googleapis.com/calendar/v3، مگر اینکه خلاف آن ذکر شده باشد | ||
حذف | DELETE /users/me/calendarList/ calendarId | یک تقویم را از لیست تقویم کاربر حذف می کند. |
گرفتن | GET /users/me/calendarList/ calendarId | یک تقویم را از لیست تقویم کاربر برمی گرداند. |
درج کنید | POST /users/me/calendarList | یک تقویم موجود را در لیست تقویم کاربر درج می کند. |
فهرست | 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 | یک تقویم ثانویه را حذف می کند. از calendars.clear برای پاک کردن همه رویدادها در تقویمهای اصلی استفاده کنید. |
گرفتن | 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 /colors | تعاریف رنگ تقویم ها و رویدادها را برمی گرداند. |
مناسبت ها
برای جزئیات منابع رویدادها، صفحه نمایش منبع را ببینید.
روش | درخواست HTTP | شرح |
---|---|---|
URI های مربوط به https://www.googleapis.com/calendar/v3، مگر اینکه خلاف آن ذکر شده باشد | ||
حذف | DELETE /calendars/ calendarId /events/ eventId | یک رویداد را حذف می کند. |
گرفتن | GET /calendars/ calendarId /events/ eventId | رویدادی را بر اساس شناسه تقویم Google آن برمیگرداند. برای بازیابی یک رویداد با استفاده از شناسه iCalendar آن، روش events.list را با استفاده از پارامتر iCalUID فراخوانی کنید. |
وارد كردن | POST /calendars/ calendarId /events/import | یک رویداد را وارد می کند. این عملیات برای افزودن یک کپی خصوصی از یک رویداد موجود به یک تقویم استفاده می شود. فقط رویدادهایی با eventType default میتوانند وارد شوند. رفتار منسوخ شده: اگر یک رویداد غیر |
درج کنید | POST /calendars/ calendarId /events | یک رویداد ایجاد می کند. |
نمونه ها | GET /calendars/ calendarId /events/ eventId /instances | نمونه هایی از رویداد تکرارشونده مشخص شده را برمی گرداند. |
فهرست | GET /calendars/ calendarId /events | رویدادها را در تقویم مشخص شده برمیگرداند. |
حرکت | POST /calendars/ calendarId /events/ eventId /move | یک رویداد را به تقویم دیگری منتقل می کند، یعنی سازمان دهنده یک رویداد را تغییر می دهد. توجه داشته باشید که فقط رویدادهای default را می توان منتقل کرد. رویدادهای outOfOffice ، focusTime ، workingLocation و fromGmail قابل جابجایی نیستند. پارامترهای پرس و جو مورد نیاز: |
پچ | PATCH /calendars/ calendarId /events/ eventId | یک رویداد را به روز می کند. این روش از معنای پچ پشتیبانی می کند. توجه داشته باشید که هر درخواست پچ سه واحد سهمیه مصرف می کند. ترجیح می دهند از یک get و به دنبال آن یک update استفاده کنند. مقادیر فیلدی که مشخص می کنید جایگزین مقادیر موجود می شوند. فیلدهایی که در درخواست مشخص نمی کنید بدون تغییر باقی می مانند. فیلدهای آرایه، در صورت مشخص شدن، آرایه های موجود را بازنویسی می کنند. این هر عنصر آرایه قبلی را کنار می گذارد. |
سریع افزودن | POST /calendars/ calendarId /events/quickAdd | یک رویداد بر اساس یک رشته متن ساده ایجاد می کند. پارامترهای پرس و جو مورد نیاز: |
به روز رسانی | PUT /calendars/ calendarId /events/ eventId | یک رویداد را به روز می کند. این روش از معنای پچ پشتیبانی نمی کند و همیشه کل منبع رویداد را به روز می کند. برای انجام یک به روز رسانی جزئی، یک get و سپس یک update با استفاده از تگ ها برای اطمینان از اتمی بودن انجام دهید. |
تماشا کردن | POST /calendars/ calendarId /events/watch | مراقب تغییرات در منابع رویدادها باشید. |
رایگان
برای جزئیات منبع Freebusy، صفحه نمایش منبع را ببینید.
روش | درخواست HTTP | شرح |
---|---|---|
URI های مربوط به https://www.googleapis.com/calendar/v3، مگر اینکه خلاف آن ذکر شده باشد | ||
پرس و جو | POST /freeBusy | اطلاعات آزاد/مشغول را برای مجموعه ای از تقویم ها برمی گرداند. |
تنظیمات
برای جزئیات منبع تنظیمات، صفحه نمایش منبع را ببینید.
روش | درخواست HTTP | شرح |
---|---|---|
URI های مربوط به https://www.googleapis.com/calendar/v3، مگر اینکه خلاف آن ذکر شده باشد | ||
گرفتن | GET /users/me/settings/ setting | تنظیمات یک کاربر را برمیگرداند. |
فهرست | GET /users/me/settings | تمام تنظیمات کاربر را برای کاربر احراز هویت شده برمی گرداند. |
تماشا کردن | POST /users/me/settings/watch | مراقب تغییرات در منابع تنظیمات باشید. |