אוסף של כל היומנים הקיימים. אפשר גם לעיין במאמר Calendars vs CalendarList.
רשימה של שיטות שקשורות למשאב הזה מופיעה בסוף הדף הזה.
ייצוגים של משאבים
{
"kind": "calendar#calendar",
"etag": etag,
"id": string,
"summary": string,
"description": string,
"location": string,
"timeZone": string,
"dataOwner": string,
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
string
]
},
"labelProperties": {
"eventLabels": [
{
"id": string,
"backgroundColor": string,
"name": string
}
]
},
"autoAcceptInvitations": boolean
}| שם הנכס | ערך | תיאור | הערות |
|---|---|---|---|
autoAcceptInvitations |
boolean |
האם ההזמנות מאושרות אוטומטית ביומן הזה. ההגדרה הזו תקפה רק ליומנים של משאבים. | |
conferenceProperties |
nested object |
מאפיינים של שיחות ועידה ביומן הזה, למשל אילו סוגים של שיחות ועידה מותרים. | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
סוגי הפתרונות לשיחות ועידה שנתמכים ביומן הזה. הערכים האפשריים הם:
|
|
dataOwner |
string |
כתובת האימייל של הבעלים של היומן. ההגדרה הזו רלוונטית רק ליומנים משניים. קריאה בלבד. | |
description |
string |
תיאור היומן. אופציונלי. | ניתן לכתיבה |
etag |
etag |
ETag של המשאב. | |
id |
string |
מזהה היומן. כדי לאחזר מזהים, מפעילים את השיטה calendarList.list(). | |
kind |
string |
סוג המשאב ("calendar#calendar"). |
|
labelProperties |
nested object |
מאפייני התוויות שהוגדרו ביומן הזה. אם מציינים תוויות חדשות, הן מחליפות את מאפייני התוויות הקיימות. אם לא מציינים את המאפיינים, הם נשארים ללא שינוי. | ניתן לכתיבה |
labelProperties.eventLabels[] |
list |
תוויות האירועים שמוגדרות ביומן הזה. אם התג הזה מופיע כשמעדכנים את היומן, הוא יחליף את התוויות הקיימות של האירוע. כדי להוסיף סיווג חדש לאירוע, מרחיבים את הרשימה. כדי למחוק סיווג מהיומן, מסירים את הישויות מהרשימה. כל לוח שנה יכול להכיל עד 200 תוויות. |
ניתן לכתיבה |
labelProperties.eventLabels[].backgroundColor |
string |
צבע הרקע של התווית בפורמט הקסדצימלי, כמו "#039be5". אירועים עם התווית הזו מוצגים בצבע הזה. חובה. |
ניתן לכתיבה |
labelProperties.eventLabels[].id |
string |
המזהה של התווית. אופציונלי כשמוסיפים תווית חדשה. אם לא מספקים מזהה, המערכת יוצרת מזהה ייחודי. חובה כשמעדכנים תווית. אם מספקים מזהה, הוא צריך להיות ייחודי ביומן ולעמוד בדרישות הפורמט של UUID. |
ניתן לכתיבה |
labelProperties.eventLabels[].name |
string |
שם התווית. אופציונלי. אם מספקים את הערך הזה, הוא יכול להכיל עד 50 תווים. |
ניתן לכתיבה |
location |
string |
המיקום הגיאוגרפי של היומן כטקסט חופשי. אופציונלי. | ניתן לכתיבה |
summary |
string |
השם של היומן. | ניתן לכתיבה |
timeZone |
string |
אזור הזמן של היומן. (בפורמט של שם במסד הנתונים IANA Time Zone Database, לדוגמה, 'Europe/Zurich'). אופציונלי. | ניתן לכתיבה |
Methods
- ניקוי
- מחיקת היומן הראשי. הפעולה הזו מוחקת את כל האירועים שמשויכים ליומן הראשי של החשבון.
- מחיקה
- מחיקת יומן משני. משתמשים ב-calendars.clear כדי למחוק את כל האירועים ביומנים הראשיים.
- לקבל
- הפונקציה מחזירה מטא-נתונים של יומן.
- הוספה
- יוצר יומן משני.
המשתמש המאומת ששלח את הבקשה הופך לבעלים של הנתונים ביומן החדש.
- patch
- Updates metadata for a calendar. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-
getואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא צוינו בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים. - transferOwnership
- העברת יומן משני בין משתמשים בארגון Google Workspace. כדי לעשות את זה צריך אימות משתמש עם הרשאת אדמין לניהול יומנים, ואחת מהרשאות הגישה הבאות:
https://www.googleapis.com/auth/calendarhttps://www.googleapis.com/auth/calendar.calendars
useAdminAccessלערךtrue. כדי להעביר יומן משני, הוא צריך להיות פעיל. אי אפשר להעביר יומנים מושבתים או שנמחקו. - עדכון
- Updates metadata for a calendar.