דף זה תורגם על ידי Cloud Translation API.

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`	ה-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 שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.