CalendarList: list

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

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים אופציונליים של שאילתות
maxResults integer המספר המקסימלי של רשומות שמוחזרות בדף תוצאות אחד. ערך ברירת המחדל הוא 100 רשומות. גודל הדף לא יכול להכיל יותר מ-250 רשומות. אופציונלי.
minAccessRole string תפקיד הגישה המינימלי של המשתמש ברשאות שהוחזרו. אופציונלי. ברירת המחדל היא ללא הגבלה.

הערכים הקבילים הם:
  • 'freeBusyReader': המשתמש יכול לקרוא את המידע על סטטוס הזמינות.
  • 'owner': המשתמש יכול לקרוא ולשנות אירועים ורשימות של בקרת גישה.
  • 'reader': המשתמש יכול לקרוא אירועים שאינם פרטיים.
  • 'writer': המשתמש יכול לקרוא ולשנות אירועים.
pageToken string אסימון שמציין איזה דף תוצאות להציג. אופציונלי.
showDeleted boolean אם לכלול בתוצאה רשומות שנמחקו מרשימת היומנים. אופציונלי. ברירת המחדל היא False.
showHidden boolean האפשרות להציג רשומות מוסתרות. אופציונלי. ברירת המחדל היא False.
syncToken string אסימון שהתקבל מהשדה nextSyncToken שהוחזר בדף התוצאות האחרון של הבקשה הקודמת לרשימת הפריטים. כך התוצאה של בקשת הרשימה הזו תכלול רק רשומות שהשתנו מאז. אם השתנו רק שדות לקריאה בלבד, כמו מאפייני יומן או רשימות ACL, הרשומה לא תוחזר. כל הרשומות שנמחקו והוסתרו מאז בקשת הרשימה הקודמת תמיד יהיו בקבוצת התוצאות, ואי אפשר להגדיר את showDeleted או את showHidden כ-False.
כדי להבטיח עקביות במצב הלקוח, לא ניתן לציין את פרמטר השאילתה minAccessRole יחד עם nextSyncToken.
אם התוקף של syncToken יפוג, השרת יגיב עם קוד התגובה 410 GONE והלקוח צריך לנקות את האחסון שלו ולבצע סנכרון מלא ללא syncToken.
מידע נוסף על סנכרון מצטבר
אופציונלי. ברירת המחדל היא להחזיר את כל הרשומות.

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:

היקף
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

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

גוף הבקשה

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

תשובה

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

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
שם הנכס ערך תיאור הערות
kind string סוג האוסף ('calendar#calendarList').
etag etag ה-ETag של האוסף.
nextPageToken string אסימון המשמש לגישה לדף הבא של התוצאה הזו. השדה הזה לא מופיע אם אין תוצאות נוספות, ובמקרה כזה מוצג הערך nextSyncToken.
items[] list יומנים שמופיעים ברשימת היומנים של המשתמש.
nextSyncToken string אסימון שמשמש בשלב מאוחר יותר כדי לאחזר רק את הרשומות שהשתנו מאז שהתוצאה הזו הוחזרה. השדה הזה לא מוצג אם יש תוצאות נוספות, ובמקרה כזה מוצג הערך nextPageToken.

נסה בעצמך!

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