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

Settings: list

הפונקציה מחזירה את כל הגדרות המשתמש של המשתמש המאומת. רוצים לנסות?

בקשה

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`

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

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

אם הפעולה בוצעה ללא שגיאות, ה-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`.

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