Calendars

אוסף של כל היומנים הקיימים. אפשר גם לעיין במאמר Calendars לעומת 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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}

שם הנכס	ערך	תיאור	הערות
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").
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".) זה שינוי אופציונלי.	ניתן לכתיבה
workingHours	object	מייצג את המידע על שעות העבודה של המשתמש. האפשרות הזו זמינה רק ביומנים הראשיים של משתמשי Google Workspace. כדי לעדכן את שעות העבודה, צריך להעביר את כל האובייקט של שעות העבודה. אם לא מציינים שעות עבודה (או אם מעבירים ערך null או אובייקט ריק), שעות העבודה הקיימות לא משתנות. כדי להשבית את שעות העבודה או לנקות את לוח הזמנים, מגדירים את workingHoursEnabled כ-false (ומשמיטים את availableTimes או מעבירים רשימה ריקה).	ניתן לכתיבה
workingHours.availableTimes[]	list	שעות העבודה. כל תקופת זמינות מייצגת את משבצת שעות העבודה של המשתמש במהלך יום אחד.	ניתן לכתיבה
workingHours.availableTimes[].dayOfWeek	string	היום בשבוע. חובה. הערכים האפשריים הם: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"	ניתן לכתיבה
workingHours.availableTimes[].periodEnd	integer	סוף התקופה, בדקות מתחילת היום, לא כולל. חובה.	ניתן לכתיבה
workingHours.availableTimes[].periodStart	integer	תחילת התקופה, בדקות מתחילת היום, כולל. חובה.	ניתן לכתיבה
workingHours.workingHoursEnabled	boolean	אם שעות העבודה מופעלות ביומן הזה. אי אפשר להגדיר את הערך כ-true כשהשדה availableTimes ריק.	ניתן לכתיבה

Methods

clear

מחיקת כל האירועים ביומן הראשי. הפעולה הזו מוחקת את כל האירועים שמשויכים ליומן הראשי של החשבון.

מחיקה

מחיקת יומן משני. כדי למחוק את כל האירועים ביומנים הראשיים, משתמשים ב-calendars.clear.

get

הפונקציה מחזירה מטא-נתונים של יומן.

insert

יוצרת יומן משני.

המשתמש המאומת של הבקשה הופך לבעלים של הנתונים ביומן החדש.

הערה: מומלץ לבצע אימות בתור הבעלים המיועד של נתוני היומן. אתם יכולים להשתמש בהענקת גישה ברמת הדומיין כדי לאפשר לאפליקציות לפעול בשם משתמש ספציפי. אל תשתמשו בחשבון שירות לאימות. אם אתם משתמשים בחשבון שירות לאימות, חשבון השירות הוא הבעלים של הנתונים, וזה יכול להוביל להתנהגות לא צפויה. לדוגמה, אם חשבון שירות הוא הבעלים של הנתונים, אי אפשר להעביר את הבעלות על הנתונים.

patch

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

transferOwnership

העברת יומן משני בין משתמשים בארגון ב-Google Workspace. צריך אימות משתמש עם הרשאת אדמין לניהול יומנים, ואחד מהיקפי ההרשאות הבאים:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.calendars

בבקשה, מגדירים את useAdminAccess ל-true. כדי להעביר יומן משני, הוא צריך להיות פעיל. אי אפשר להעביר יומנים מושבתים או שנמחקו.

עדכון

עדכון המטא-נתונים של יומן.