این مرجع API بر اساس نوع منبع سازماندهی شده است. هر نوع منبع دارای یک یا چند نمایش داده و یک یا چند متد است.
انواع منابع
لیگاند ای سی ال
برای جزئیات منابع Acl، به صفحه نمایش منابع مراجعه کنید.
| روش | درخواست 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 | یک قانون کنترل دسترسی را به‌روزرسانی می‌کند. این روش از معنای وصله (patch semantics) پشتیبانی می‌کند. توجه داشته باشید که هر درخواست وصله سه واحد سهمیه مصرف می‌کند؛ بهتر است از 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 | یک تقویم موجود در فهرست تقویم کاربر را به‌روزرسانی می‌کند. این روش از معنای وصله (patch semantics) پشتیبانی می‌کند. توجه داشته باشید که هر درخواست وصله سه واحد سهمیه مصرف می‌کند؛ بهتر است از 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 | یک رویداد را بر اساس شناسه تقویم گوگل آن برمی‌گرداند. برای بازیابی یک رویداد با استفاده از شناسه 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 را می‌توان منتقل کرد؛ رویدادهای birthday ، focusTime ، fromGmail ، outOfOffice و workingLocation قابل انتقال نیستند. پارامترهای پرس و جوی مورد نیاز: |
| پچ | PATCH /calendars/ calendarId /events/ eventId | یک رویداد را به‌روزرسانی می‌کند. این روش از معنای وصله (patch semantics) پشتیبانی می‌کند. توجه داشته باشید که هر درخواست وصله سه واحد سهمیه مصرف می‌کند؛ بهتر است از get و به دنبال آن update استفاده کنید. مقادیر فیلدی که مشخص می‌کنید جایگزین مقادیر موجود می‌شوند. فیلدهایی که در درخواست مشخص نمی‌کنید بدون تغییر باقی می‌مانند. فیلدهای آرایه، در صورت مشخص شدن، آرایه‌های موجود را بازنویسی می‌کنند. این کار عناصر آرایه قبلی را حذف می‌کند. |
| افزودن سریع | POST /calendars/ calendarId /events/quickAdd | یک رویداد بر اساس یک رشته متنی ساده ایجاد می‌کند. پارامترهای پرس و جوی مورد نیاز: |
| به‌روزرسانی | PUT /calendars/ calendarId /events/ eventId | یک رویداد را به‌روزرسانی می‌کند. این روش از معنای وصله پشتیبانی نمی‌کند و همیشه کل منبع رویداد را به‌روزرسانی می‌کند. برای انجام یک به‌روزرسانی جزئی، برای اطمینان از اتمی بودن، یک get و به دنبال آن یک update با استفاده از etags انجام دهید. |
| تماشا کنید | 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 | مراقب تغییرات در منابع تنظیمات باشید. |