Calendars

אוסף של כל היומנים הקיימים. אפשר גם לעיין במאמר ההבדלים בין Calendars ל-CalendarList.

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

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

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "autoAcceptInvitations": boolean
}
שם הנכס ערך תיאור הערות
autoAcceptInvitations boolean האם ההזמנות מאושרות אוטומטית ביומן הזה. האפשרות הזו תקפה רק ליומנים של משאבים.
conferenceProperties nested object מאפיינים של שיחות ועידה ביומן הזה, למשל אילו סוגים של שיחות ועידה מותרים.
conferenceProperties.allowedConferenceSolutionTypes[] list סוגי הפתרונות לשיחות ועידה שנתמכים ביומן הזה.

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

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
אופציונלי.
dataOwner string כתובת האימייל של הבעלים של היומן. ההגדרה הזו רלוונטית רק ליומנים משניים. קריאה בלבד.
description string תיאור היומן. אופציונלי. ניתן לכתיבה
etag etag ‫ETag של המשאב.
id string מזהה היומן. כדי לאחזר מזהים, מפעילים את השיטה calendarList.list().
kind string סוג המשאב ("calendar#calendar").
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/calendar
  • https://www.googleapis.com/auth/calendar.calendars
בבקשה, מגדירים את useAdminAccess לערך true. כדי להעביר יומן משני, הוא צריך להיות פעיל. אי אפשר להעביר יומנים מושבתים או שנמחקו.
עדכון
‫
Updates metadata for a calendar.