Settings: list

הערה: לשם כך נדרשת הרשאה.

מחזירה את כל הגדרות המשתמש עבור המשתמש המאומת. אפשר לנסות עכשיו או לראות דוגמה.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר	Value	התיאור
פרמטרים אופציונליים של שאילתה
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
  ]
}

שם הנכס	Value	התיאור	הערות
kind	string	סוג האוסף ("calendar#settings").
etag	etag	תג האוסף.
items[]	list	רשימה של הגדרות משתמש.
nextPageToken	string	האסימון משמש לגישה לדף הבא בתוצאה הזו. יושמט אם אין תוצאות נוספות זמינות, ובמקרה כזה nextSyncToken מסופק.
nextSyncToken	string	אסימון שבו נעשה שימוש בשלב מאוחר יותר כדי לאחזר רק את הרשומות שהשתנו מאז שהתוצאה הזו הוחזרה. יושמט אם יש תוצאות נוספות, ובמקרה כזה nextPageToken מסופק.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

Java

משתמש בספריית הלקוח של Java.

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());
}

Python

עושה שימוש בספריית הלקוח של Python.

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

נעשה שימוש בספריית הלקוח של Ruby.

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

רוצה לנסות?

ניתן להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.