CalendarList: list

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

درخواست کنید

درخواست HTTP 

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

پارامترها

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

مقادیر قابل قبول عبارتند از:
  • " freeBusyReader ": کاربر می تواند اطلاعات آزاد/مشغول را بخواند.
  • " owner ": کاربر می تواند رویدادها و لیست های کنترل دسترسی را بخواند و تغییر دهد.
  • " reader ": کاربر می تواند رویدادهایی را که خصوصی نیستند بخواند.
  • " writer ": کاربر می تواند رویدادها را بخواند و تغییر دهد.
pageToken string نشانه ای که مشخص می کند کدام صفحه نتیجه را برگرداند. اختیاری.
showDeleted boolean اینکه آیا ورودی‌های فهرست تقویم حذف شده در نتیجه گنجانده شود یا خیر. اختیاری. پیش فرض نادرست است.
showHidden boolean آیا برای نشان دادن ورودی های پنهان. اختیاری. پیش فرض نادرست است.
syncToken string رمز به دست آمده از قسمت nextSyncToken در آخرین صفحه نتایج از درخواست لیست قبلی بازگردانده شد. این باعث می شود که نتیجه این درخواست لیست فقط شامل ورودی هایی باشد که از آن زمان تغییر کرده اند. اگر فقط فیلدهای فقط خواندنی مانند ویژگی‌های تقویم یا ACL تغییر کرده باشند، ورودی برگردانده نخواهد شد. همه ورودی‌های حذف شده و پنهان شده از درخواست لیست قبلی همیشه در مجموعه نتیجه خواهند بود و نمی‌توان showDeleted یا showHidden روی False تنظیم کرد.
برای اطمینان از سازگاری حالت کلاینت، پارامتر query 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 ETag مجموعه
nextPageToken string رمز برای دسترسی به صفحه بعدی این نتیجه استفاده می شود. اگر نتایج دیگری در دسترس نباشد حذف می شود، در این صورت nextSyncToken ارائه می شود.
items[] list تقویم هایی که در لیست تقویم کاربر وجود دارند.
nextSyncToken string توکن در زمان بعدی برای بازیابی فقط ورودی هایی که از زمان بازگشت این نتیجه تغییر کرده اند استفاده می شود. در صورت در دسترس بودن نتایج بیشتر حذف می شود، در این صورت nextPageToken ارائه می شود.

آن را امتحان کنید!

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

،

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

درخواست کنید

درخواست HTTP 

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

پارامترها

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

مقادیر قابل قبول عبارتند از:
  • " freeBusyReader ": کاربر می تواند اطلاعات آزاد/مشغول را بخواند.
  • " owner ": کاربر می تواند رویدادها و لیست های کنترل دسترسی را بخواند و تغییر دهد.
  • " reader ": کاربر می تواند رویدادهایی را که خصوصی نیستند بخواند.
  • " writer ": کاربر می تواند رویدادها را بخواند و تغییر دهد.
pageToken string نشانه ای که مشخص می کند کدام صفحه نتیجه را برگرداند. اختیاری.
showDeleted boolean اینکه آیا ورودی‌های فهرست تقویم حذف شده در نتیجه گنجانده شود یا خیر. اختیاری. پیش فرض نادرست است.
showHidden boolean آیا برای نشان دادن ورودی های پنهان. اختیاری. پیش فرض نادرست است.
syncToken string رمز به دست آمده از قسمت nextSyncToken در آخرین صفحه نتایج از درخواست لیست قبلی بازگردانده شد. این باعث می شود که نتیجه این درخواست لیست فقط شامل ورودی هایی باشد که از آن زمان تغییر کرده اند. اگر فقط فیلدهای فقط خواندنی مانند ویژگی‌های تقویم یا ACL تغییر کرده باشند، ورودی برگردانده نخواهد شد. همه ورودی‌های حذف شده و پنهان شده از درخواست لیست قبلی همیشه در مجموعه نتیجه خواهند بود و نمی‌توان showDeleted یا showHidden روی False تنظیم کرد.
برای اطمینان از سازگاری حالت کلاینت، پارامتر query 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 ETag مجموعه
nextPageToken string رمز برای دسترسی به صفحه بعدی این نتیجه استفاده می شود. اگر نتایج دیگری در دسترس نباشد حذف می شود، در این صورت nextSyncToken ارائه می شود.
items[] list تقویم هایی که در لیست تقویم کاربر وجود دارند.
nextSyncToken string توکن در زمان بعدی برای بازیابی فقط ورودی هایی که از زمان بازگشت این نتیجه تغییر کرده اند استفاده می شود. در صورت در دسترس بودن نتایج بیشتر حذف می شود، در این صورت nextPageToken ارائه می شود.

آن را امتحان کنید!

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