Settings: list

توجه: نیاز به مجوز دارد.

تمام تنظیمات کاربر را برای کاربر احراز هویت شده برمی گرداند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .

درخواست

درخواست HTTP

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

مولفه های

نام پارامتر	ارزش	شرح
پارامترهای پرس و جو اختیاری
maxResults	integer	حداکثر تعداد ورودی های بازگشتی در یک صفحه نتیجه. به طور پیش فرض مقدار 100 ورودی است. اندازه صفحه هرگز نمی تواند بزرگتر از 250 ورودی باشد. اختیاری.
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

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

درخواست بدن

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

واکنش

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

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}

نام ملک	ارزش	شرح	یادداشت
kind	string	نوع مجموعه (" calendar#settings ").
etag	etag	تگ مجموعه
items[]	list	لیست تنظیمات کاربر
nextPageToken	string	رمز برای دسترسی به صفحه بعدی این نتیجه استفاده می شود. اگر نتایج دیگری در دسترس نباشد حذف می شود، در این صورت nextSyncToken ارائه می شود.
nextSyncToken	string	توکن در زمان بعدی برای بازیابی فقط ورودی هایی که از زمان بازگشت این نتیجه تغییر کرده اند استفاده می شود. در صورت در دسترس بودن نتایج بیشتر حذف می شود، در این صورت nextPageToken ارائه می شود.

مثال ها

توجه: نمونه‌های کد موجود برای این روش همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های سرویس گیرنده مراجعه کنید).

جاوا

از کتابخانه سرویس گیرنده جاوا استفاده می کند.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Setting;
import com.google.api.services.calendar.model.Settings;
// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over all user settings
Settings settings = service.settings().list().execute();

for (Setting setting : settings.getItems()) {
  System.out.println(setting.getId() + ": " + setting.getValue());
}

پایتون

از کتابخانه کلاینت پایتون استفاده می کند.

settings = service.settings().list().execute()

for setting in settings['items']:
  print '%s: %s' % (setting['id'], setting['value'])

PHP

از کتابخانه مشتری PHP استفاده می کند.

$settings = $service->settings->listSettings();

foreach ($settings->getItems() as $setting) {
  echo $setting->getId() . ': ' . $setting->getValue();
}

روبی

از کتابخانه کلاینت Ruby استفاده می کند.

result = client.list_settings
result.items.each do |e|
  print e.id + ": " + e.value + "\n"
end

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

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