CalendarList

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

רשימה של שיטות שקשורות למשאב הזה מופיעה בסוף הדף הזה.

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

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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 – מאפשר גישת ניהול ליומן. לתפקיד הזה יש את כל ההרשאות של תפקיד הכותב, עם היכולת הנוספת לראות ולשנות את רמות הגישה של משתמשים אחרים.

    .
backgroundColor string הצבע הראשי של היומן בפורמט הקסדצימלי #0088aa. המאפיין הזה מחליף את המאפיין colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את colorRgbFormat=true בפרמטרים של השיטות insert, ‏ update ו-patch. אופציונלי. ניתן לכתיבה
colorId string הצבע של היומן. זהו מזהה שמתייחס לרשומה בקטע calendar של הגדרת הצבעים (ראו נקודת הקצה של הצבעים). המאפיין הזה הוחלף במאפיינים backgroundColor ו-foregroundColor, ואפשר להתעלם ממנו כשמשתמשים במאפיינים האלה. אופציונלי. ניתן לכתיבה
conferenceProperties nested object מאפיינים של שיחות ועידה ביומן הזה, למשל אילו סוגים של שיחות ועידה מותרים.
conferenceProperties.allowedConferenceSolutionTypes[] list סוגי הפתרונות לשיחות ועידה שנתמכים ביומן הזה.

הערכים האפשריים הם:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
אופציונלי.
dataOwner string כתובת האימייל של הבעלים של היומן. ההגדרה הזו רלוונטית רק ליומנים משניים. קריאה בלבד.
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 אזור הזמן של היומן. אופציונלי. קריאה בלבד.

Methods

מחיקה
הסרת יומן מרשימת היומנים של המשתמש.
get
‫
מחזירה יומן מרשימת היומנים של המשתמש.
הוספה
הוספה של יומן קיים לרשימת היומנים של המשתמש.
list
‫
מחזירה את היומנים ברשימת היומנים של המשתמש.
patch
מעדכן יומן קיים ברשימת היומנים של המשתמש. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא מצוינים בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
עדכון
מעדכן יומן קיים ברשימת היומנים של המשתמש.
watch
שימו לב לשינויים במשאבי CalendarList.