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
https://www.googleapis.com/auth/calendar.settings

מידע נוסף זמין בדף אימות והרשאה.

גוף הבקשה

אל תספקו גוף בקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזירה גוף תגובה במבנה הבא:

{
  "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.

רוצה לנסות?

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