همه تنظیمات کاربر را برای کاربر اصالت‌سنجی‌شده برمی‌گرداند. اکنون امتحان کنید.
درخواست
درخواست HTTP
GET https://www.googleapis.com/calendar/v3/users/me/settings
پارامترها
| نام پارامتر | مقدار | شرح |
|---|---|---|
| پارامترهای پُرسمان اختیاری | ||
maxResults |
integer |
حداکثر تعداد ورودی‌های برگردانده‌شده در یک صفحه نتایج. به‌طور پیش‌فرض، این مقدار ۱۰۰ ورودی است. اندازه صفحه هرگز نمی‌تواند بزرگ‌تر از ۲۵۰ ورودی باشد. اختیاری. |
pageToken |
string |
نشانه‌ای که مشخص می‌کند کدام صفحه نتایج برگردانده شود. اختیاری. |
syncToken |
string |
نشان به‌دست‌آمده از فیلد nextSyncToken در آخرین صفحه نتایج از درخواست فهرست قبلی برگردانده شد. این باعث می‌شود که نتیجه این درخواست فهرست فقط شامل ورودی‌هایی باشد که از آن زمان تغییر کرده‌اند. اگر syncToken منقضی شود، سرور با کد پاسخ 410 GONE پاسخ خواهد داد و کارخواه باید فضای ذخیره‌سازی خود را پاک کند و همگام‌سازی کامل را بدون هیچ syncToken انجام دهد. درباره همگام‌سازی افزایشی بیشتر بدانید. اختیاری. به‌طور پیش‌فرض، همه ورودی‌ها برگردانده می‌شود. |
صدور مجوز
این درخواست به مجوز با حداقل یکی از دامنه‌های زیر نیاز دارد:
| حوزه |
|---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.settings.readonly |
https://www.googleapis.com/auth/calendar.settings |
برای اطلاعات بیشتر، به صفحه اصالت‌سنجی و صدور مجوز مراجعه کنید.
متن درخواست
با این روش، بدنه درخواست ارائه نکنید.
پاسخ
درصورت موفقیت‌آمیز بودن، این روش بدنه پاسخی با ساختار زیر برمی‌گرداند:
{
"kind": "calendar#settings",
"etag": etag,
"nextPageToken": string,
"nextSyncToken": string,
"items": [
settings Resource
]
}| نام دارایی | مقدار | شرح | یادداشت‌ها |
|---|---|---|---|
kind |
string |
نوع مجموعه («calendar#settings»). |
|
etag |
etag |
Etag مجموعه. | |
items[] |
list |
فهرست تنظیمات کاربر. | |
nextPageToken |
string |
نشان استفاده‌شده برای دسترسی به صفحه بعدی این نتیجه. اگر نتایج بیشتری دردسترس نباشد، حذف می‌شود و در این صورت nextSyncToken ارائه می‌شود. |
|
nextSyncToken |
string |
نشانه‌ای که در زمان دیگری برای بازیابی فقط ورودی‌هایی استفاده می‌شود که از زمان برگرداندن این نتیجه تغییر کرده‌اند. اگر نتایج بیشتری دردسترس باشد، حذف می‌شود که دراین‌صورت nextPageToken ارائه می‌شود. |
امتحان کنید!
از «کاوشگر میاناهای برنامه‌سازی کاربردی» زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.