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

CalendarList

אוסף היומנים ברשימת היומנים של המשתמש. ראו גם יומנים לעומת CalendarList.

רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.

ייצוגי משאבים

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}

שם הנכס	ערך	תיאור	הערות
`accessRole`	`string`	תפקיד הגישה האפקטיבי שיש למשתמש המאומת ביומן. קריאה בלבד. הערכים האפשריים הם: `freeBusyReader` - מספקת גישת קריאה לפרטי פנוי/עסוק. `reader` - מספקת גישת קריאה ליומן. אירועים פרטיים יוצגו למשתמשים שיש להם גישת קוראים, אבל פרטי האירועים יוסתרו. `writer` - מספקת גישת קריאה וכתיבה ביומן. אירועים פרטיים יוצגו למשתמשים עם גישת כתיבה, ופרטי האירועים יהיו גלויים. `owner` - מציג בעלות על היומן. לתפקיד הזה יש את כל ההרשאות של תפקיד הכתיבה, ויכולת נוספת לראות רשימות ACL ולשנות אותן.
`backgroundColor`	`string`	הצבע הראשי של היומן בפורמט הקסדצימלי '`#0088aa`'. המאפיין הזה מחליף את נכס `colorId` שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את `colorRgbFormat=true` בפרמטרים של השיטות insert, update ו-patch. זה שינוי אופציונלי.	ניתן לכתיבה
`colorId`	`string`	הצבע של היומן. זהו מזהה שמתייחס לרשומה בקטע `calendar` של הגדרת הצבעים (מידע נוסף זמין בנקודת הקצה של הצבעים). המאפיין הזה מוחלף על ידי המאפיינים `backgroundColor` ו-`foregroundColor`, ואפשר להתעלם ממנו כשמשתמשים במאפיינים האלה. זה שינוי אופציונלי.	ניתן לכתיבה
`conferenceProperties`	`nested object`	המאפיינים של שיחות ועידה ביומן הזה, לדוגמה, הסוגים של שיחות ועידה מותרים.
`conferenceProperties.allowedConferenceSolutionTypes[]`	`list`	סוגי הפתרונות לשיחות ועידה שנתמכים ביומן הזה. הערכים האפשריים הם: `"eventHangout"` `"eventNamedHangout"` `"hangoutsMeet"` (אופציונלי).
`defaultReminders[]`	`list`	תזכורות ברירת המחדל שיש למשתמש המאומת ביומן הזה.	ניתן לכתיבה
`defaultReminders[].method`	`string`	השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם: `email` - התזכורות נשלחות באימייל. `popup` - התזכורות נשלחות דרך חלון קופץ בממשק המשתמש. חובה בעת הוספת תזכורת.	ניתן לכתיבה
`defaultReminders[].minutes`	`integer`	מספר הדקות לפני תחילת האירוע שבו התזכורת אמורה להתחיל. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות). חובה בעת הוספת תזכורת.	ניתן לכתיבה
`deleted`	`boolean`	האם הרשומה הזו של רשימת היומנים נמחקה מרשימת היומנים. קריאה בלבד. זה שינוי אופציונלי. ערך ברירת המחדל הוא False.
`description`	`string`	תיאור היומן. זה שינוי אופציונלי. קריאה בלבד.
`etag`	`etag`	ה-ETag של המשאב.
`foregroundColor`	`string`	צבע החזית של היומן בפורמט הקסדצימלי "`#ffffff`". המאפיין הזה מחליף את נכס `colorId` שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את `colorRgbFormat=true` בפרמטרים של השיטות insert, update ו-patch. זה שינוי אופציונלי.	ניתן לכתיבה
`hidden`	`boolean`	האם היומן הוסתר מהרשימה. זה שינוי אופציונלי. המאפיין מוחזר רק כשהיומן מוסתר, במקרה כזה הערך הוא `true`.	ניתן לכתיבה
`id`	`string`	המזהה של היומן.
`kind`	`string`	סוג המשאב ("calendar#calendarListEntry").
`location`	`string`	המיקום הגיאוגרפי של היומן כטקסט חופשי. זה שינוי אופציונלי. קריאה בלבד.
`notificationSettings`	`object`	ההתראות שהמשתמש המאומת מקבל ביומן הזה.	ניתן לכתיבה
`notificationSettings.notifications[]`	`list`	רשימת התזכורות שנקבעו ליומן הזה.
`notificationSettings.notifications[].method`	`string`	השיטה ששימשה לשליחת ההתראה. הערך האפשרי הוא: `email` - ההתראות נשלחות באימייל. נדרש בעת הוספת התראה.	ניתן לכתיבה
`notificationSettings.notifications[].type`	`string`	סוג ההתראה. הערכים האפשריים הם: `eventCreation` - תקבלו התראה כשאירוע חדש נוסף ליומן. `eventChange` - התראה נשלחת כשאירוע משתנה. `eventCancellation` - נשלחת התראה כשאירוע מבוטל. `eventResponse` - התראה נשלחת כשמשתתף משיב להזמנה לאירוע. `agenda` - סדר יום עם אירועי היום (נשלח בבוקר). נדרש בעת הוספת התראה.	ניתן לכתיבה
`primary`	`boolean`	האם היומן הוא היומן הראשי של המשתמש המאומת. קריאה בלבד. זה שינוי אופציונלי. ערך ברירת המחדל הוא False.
`selected`	`boolean`	אם התוכן של היומן יוצג בממשק המשתמש של היומן. זה שינוי אופציונלי. ערך ברירת המחדל הוא False.	ניתן לכתיבה
`summary`	`string`	שם היומן. קריאה בלבד.
`summaryOverride`	`string`	הסיכום שהמשתמש המאומת הגדיר ליומן הזה. זה שינוי אופציונלי.	ניתן לכתיבה
`timeZone`	`string`	אזור הזמן של היומן. זה שינוי אופציונלי. קריאה בלבד.

שיטות

מחיקה: הסרת יומנים מרשימת היומנים של המשתמש.
הורדה: מחזירה יומן מרשימת היומנים של המשתמש.
הוספה: איך מוסיפים יומן קיים לרשימת היומנים של המשתמש?
list: מחזירה את היומנים ברשימת היומנים של המשתמש.
תיקון: עדכון יומן קיים ברשימת היומנים של המשתמש. השיטה הזו תומכת בסמנטיקה של תיקונים. חשוב לזכור שכל בקשת תיקון צורכת שלוש יחידות מכסה; עדיף להשתמש ב-get ואחריו update. ערכי השדות שמציינים מחליפים את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם יחליפו את המערכים הקיימים. הפעולה הזו מוחקת את כל רכיבי המערך הקודמים.
עדכון: עדכון יומן קיים ברשימת היומנים של המשתמש.
שעון: כדאי לשים לב לשינויים במשאבים של CalendarList.