CalendarList: list

הערה: נדרשת הרשאה.

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

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר	ערך	תיאור
פרמטרים אופציונליים של שאילתה
maxResults	integer	המספר המקסימלי של רשומות שמוחזרות בדף תוצאות אחד. כברירת מחדל, הערך הוא 100 רשומות. גודל הדף לא יכול להיות גדול מ-250 רשומות. אופציונלי.
minAccessRole	string	תפקיד הגישה המינימלי של המשתמש ברשומות שהוחזרו. אופציונלי. ברירת המחדל היא ללא הגבלה. הערכים הקבילים הם: ‫"freeBusyReader": המשתמש יכול לקרוא את המידע על הזמינות. ‫owner: המשתמש יכול לקרוא ולשנות אירועים ורשימות בקרת גישה. ‫reader: המשתמש יכול לקרוא אירועים שלא הוגדרו כפרטיים. ‫writer: המשתמש יכול לקרוא ולשנות אירועים. ‫writerWithoutPrivateAccess: המשתמש יכול לקרוא ולשנות אירועים, אבל לא יכול לגשת לאירועים פרטיים.
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

למידע נוסף, ראו את הדף אימות והרשאה.

גוף הבקשה

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

תשובה

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

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

רוצה לנסות?

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