CalendarList: list

تقویم‌های موجود در فهرست تقویم کاربر را برمی‌گرداند. اکنون آن را امتحان کنید .

درخواست

درخواست HTTP 

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

پارامترها

نام پارامتر ارزش توضیحات
پارامترهای پرس و جو اختیاری
maxResults integer حداکثر تعداد ورودی‌های برگردانده شده در یک صفحه نتیجه. به طور پیش‌فرض مقدار ۱۰۰ ورودی است. اندازه صفحه هرگز نمی‌تواند بزرگتر از ۲۵۰ ورودی باشد. اختیاری.
minAccessRole string حداقل نقش دسترسی برای کاربر در ورودی‌های برگشتی. اختیاری. پیش‌فرض بدون محدودیت است.

مقادیر قابل قبول عبارتند از:
  • « freeBusyReader »: کاربر می‌تواند اطلاعات آزاد/مشغول را بخواند.
  • « owner »: کاربر می‌تواند رویدادها را بخواند و تغییر دهد و به لیست‌های کنترل دسترسی دسترسی داشته باشد.
  • « reader »: کاربر می‌تواند رویدادهایی را که خصوصی نیستند، بخواند.
  • « writer »: کاربر می‌تواند رویدادها را بخواند و تغییر دهد.
  • « writerWithoutPrivateAccess »: کاربر می‌تواند رویدادها را بخواند و تغییر دهد، اما نمی‌تواند به رویدادهای خصوصی دسترسی داشته باشد.
pageToken string توکنی که مشخص می‌کند کدام صفحه نتیجه برگردانده شود. اختیاری.
showDeleted boolean آیا ورودی‌های حذف‌شده‌ی لیست تقویم در نتیجه لحاظ شوند یا خیر. اختیاری. پیش‌فرض False است.
showHidden boolean نمایش ورودی‌های پنهان. اختیاری. پیش‌فرض False است.
syncToken string توکنی که از فیلد nextSyncToken در آخرین صفحه نتایج درخواست لیست قبلی برگردانده شده است. این توکن باعث می‌شود نتیجه این درخواست لیست فقط شامل ورودی‌هایی باشد که از آن زمان تغییر کرده‌اند. اگر فقط فیلدهای فقط خواندنی مانند ویژگی‌های تقویم یا ACLها تغییر کرده باشند، ورودی برگردانده نمی‌شود. تمام ورودی‌های حذف شده و پنهان شده از درخواست لیست قبلی همیشه در مجموعه نتایج وجود خواهند داشت و تنظیم showDeleted یا showHidden روی False مجاز نیست.
برای اطمینان از ثبات وضعیت کلاینت، پارامتر کوئری minAccessRole را نمی‌توان همراه با nextSyncToken مشخص کرد.
اگر syncToken منقضی شود، سرور با کد پاسخ 410 GONE پاسخ می‌دهد و کلاینت باید حافظه خود را پاک کرده و همگام‌سازی کامل را بدون هیچ syncToken انجام دهد.
درباره همگام‌سازی افزایشی بیشتر بدانید .
اختیاری. پیش‌فرض این است که همه ورودی‌ها را برگرداند.

مجوز

این درخواست نیاز به مجوز با حداقل یکی از حوزه‌های زیر دارد:

محدوده
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

برای اطلاعات بیشتر، به صفحه احراز هویت و مجوز مراجعه کنید.

درخواست بدنه

با این روش، بدنه درخواست را ارائه ندهید.

پاسخ

در صورت موفقیت، این متد یک بدنه پاسخ با ساختار زیر برمی‌گرداند: 

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
نام ملک ارزش توضیحات یادداشت‌ها
kind string نوع مجموعه (" calendar#calendarList ").
etag etag برچسب الکترونیکی مجموعه.
nextPageToken string توکنی که برای دسترسی به صفحه بعدی این نتیجه استفاده می‌شود. در صورت عدم وجود نتایج بیشتر، حذف می‌شود، در این صورت nextSyncToken ارائه می‌شود.
items[] list تقویم‌هایی که در فهرست تقویم‌های کاربر موجود هستند.
nextSyncToken string توکنی که در برهه‌ای از زمان برای بازیابی فقط ورودی‌هایی که از زمان برگرداندن این نتیجه تغییر کرده‌اند، استفاده می‌شود. در صورت موجود بودن نتایج بیشتر، حذف می‌شود که در این صورت nextPageToken ارائه می‌شود.

امتحانش کن!

از API Explorer زیر برای فراخوانی این متد روی داده‌های زنده و مشاهده پاسخ استفاده کنید.