אוסף היומנים ברשימת היומנים של המשתמש. ראו גם יומנים לעומת CalendarList.
רשימה של שיטות למשאב הזה מופיעה בסוף הדף.
ייצוגים של משאבים
{ "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 ] } }
שם הנכס | Value | התיאור | הערות |
---|---|---|---|
accessRole |
string |
תפקיד הגישה בפועל שיש למשתמש המאומת ביומן. קריאה בלבד. הערכים האפשריים הם:
|
|
backgroundColor |
string |
הצבע הראשי של היומן בפורמט ההקסדצימלי "#0088aa ". המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין colorRgbFormat=true בפרמטרים של השיטות insert, update ו-תיקון. אפשרות. |
ניתן לכתיבה |
colorId |
string |
צבע היומן. זהו מזהה שמפנה לרשומה בקטע calendar של הגדרת הצבעים (אפשר לעיין בנקודת הקצה של הצבעים). המאפיין הזה מוחלף במאפיינים backgroundColor ו-foregroundColor , וניתן להתעלם ממנו כשמשתמשים במאפיינים האלה. אפשרות. |
ניתן לכתיבה |
conferenceProperties |
nested object |
מאפיינים של שיחות ועידה ביומן הזה. לדוגמה, אילו סוגים של שיחות ועידה מותרים. | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
סוגי הפתרונות לשיחות ועידה שנתמכים ביומן הזה. הערכים האפשריים הם:
|
|
defaultReminders[] |
list |
תזכורות ברירת המחדל שיש למשתמש המאומת עבור היומן הזה. | ניתן לכתיבה |
defaultReminders[].method |
string |
השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
חובה כשמוסיפים תזכורת. |
ניתן לכתיבה |
defaultReminders[].minutes |
integer |
מספר הדקות לפני תחילת האירוע שבהן התזכורת צריכה להתחיל. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות). חובה כשמוסיפים תזכורת. |
ניתן לכתיבה |
deleted |
boolean |
אם הרשומה הזו ברשימת היומנים נמחקה מרשימת היומנים. קריאה בלבד. אפשרות. ברירת המחדל היא False. | |
description |
string |
תיאור היומן. אפשרות. קריאה בלבד. | |
etag |
etag |
ETag של המשאב. | |
foregroundColor |
string |
הצבע הקדמי של היומן בפורמט ההקסדצימלי '#ffffff '. המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין colorRgbFormat=true בפרמטרים של השיטות insert, update ו-תיקון. אפשרות. |
ניתן לכתיבה |
id |
string |
מזהה היומן. | |
kind |
string |
סוג המשאב ("calendar#calendarListEntry"). | |
location |
string |
המיקום הגיאוגרפי של היומן כטקסט חופשי. אפשרות. קריאה בלבד. | |
notificationSettings |
object |
ההתראות שהמשתמש המאומת מקבל עבור היומן הזה. | ניתן לכתיבה |
notificationSettings.notifications[] |
list |
רשימת ההתראות שהוגדרו ליומן הזה. | |
notificationSettings.notifications[].method |
string |
השיטה ששימשה להעברת ההתראה. הערך האפשרי הוא:
חובה כשמוסיפים תזכורת. |
ניתן לכתיבה |
notificationSettings.notifications[].type |
string |
סוג ההתראה. הערכים האפשריים הם:
חובה כשמוסיפים תזכורת. |
ניתן לכתיבה |
primary |
boolean |
האם היומן הוא היומן הראשי של המשתמש המאומת. קריאה בלבד. אפשרות. ברירת המחדל היא False. | |
selected |
boolean |
האם תוכן היומן מופיע בממשק המשתמש של היומן. אפשרות. ברירת המחדל היא False. | ניתן לכתיבה |
summary |
string |
שם היומן. קריאה בלבד. | |
summaryOverride |
string |
הסיכום שהמשתמש המאומת הגדיר עבור היומן הזה. אפשרות. | ניתן לכתיבה |
timeZone |
string |
אזור הזמן של היומן. אפשרות. קריאה בלבד. |
שיטות
- מחיקה
- מסיר יומן מרשימת היומנים של המשתמש.
- מקבלים
- מחזיר יומן מרשימת היומנים של המשתמש.
- הוספה
- הוספה של יומן קיים לרשימת היומנים של המשתמש.
- list
- החזרה של היומנים שברשימת היומנים של המשתמש.
- תיקון
- עדכון יומן קיים ברשימת היומנים של המשתמש. שיטה זו תומכת בסמנטיקה של תיקונים. הערה: כל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-
get
ואחריו ב-update
. ערכי השדות שתציינו יחליפו את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם מחליפים את המערכים הקיימים. הפעולה תגרום למחיקת רכיבי המערך הקודמים. - עדכון
- עדכון יומן קיים ברשימת היומנים של המשתמש.
- שעון
- חשוב לשים לב לשינויים במשאבי CalendarList.