Events

ה-API של יומן Google מציע משאבים בדרכים שונות. ניתן למצוא מידע נוסף במאמר מידע על אירועים.

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

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

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}

שם הנכס	ערך	תיאור	הערות
anyoneCanAddSelf	boolean	אם כל אחד יכול להזמין את עצמו לאירוע (תכונה לא מומלצת). זה שינוי אופציונלי. ברירת המחדל היא False.	לכתיבה
attachments[]	list	קבצים מצורפים של האירוע. כדי לשנות קבצים מצורפים, צריך להגדיר את פרמטר הבקשה supportsAttachments ל-true. אפשר לצרף עד 25 קבצים לכל אירוע.
attachments[].fileId	string	המזהה של הקובץ המצורף. קריאה בלבד. בקבצים ב-Google Drive, זהו המזהה של רשומת המשאב Files התואמת ב-Drive API.
attachments[].fileUrl	string	קישור לכתובת ה-URL של הקובץ המצורף. להוספת קבצים מ-Google Drive, צריך להשתמש בפורמט זהה לזה של המאפיין alternateLink במשאב Files ב-Drive API. נדרש בעת הוספת קובץ מצורף.	ניתן לכתיבה
attachments[].iconLink	string	הקישור לכתובת ה-URL של הסמל של הקובץ המצורף. אפשר לשנות את השדה הזה רק בקבצים מצורפים מותאמים אישית של צד שלישי.
attachments[].mimeType	string	סוג המדיה באינטרנט (סוג MIME) של הקובץ המצורף.
attachments[].title	string	כותרת הקובץ המצורף.
attendeesOmitted	boolean	האם ייתכן שהמשתתפים הושמטו מהייצוג של האירוע. כשמאחזרים אירוע, יכול להיות שהסיבה לכך היא הגבלה שצוינה על ידי פרמטר השאילתה maxAttendee. כשמעדכנים אירוע, אפשר להשתמש באפשרות הזו רק כדי לעדכן את התשובה של המשתתף. זה שינוי אופציונלי. ברירת המחדל היא False.	לכתיבה
attendees[]	list	המשתתפים באירוע. למידע נוסף על תזמון אירועים עם משתמשים אחרים ביומן, אפשר לעיין במדריך אירועים עם משתתפים. כדי לאכלס את רשימת המשתתפים, צריך להגדיר בחשבונות שירות הענקת גישה ברמת הדומיין.	לכתיבה
attendees[].additionalGuests	integer	מספר האורחים הנוספים. זה שינוי אופציונלי. ערך ברירת המחדל הוא 0.	לכתיבה
attendees[].comment	string	תגובתו של המשתתף. זה שינוי אופציונלי.	לכתיבה
attendees[].displayName	string	השם של המשתתף, אם יש כזה. זה שינוי אופציונלי.	לכתיבה
attendees[].email	string	כתובת האימייל של המשתתף, אם יש כזו. השדה הזה חייב להופיע כשמוסיפים משתתף. היא חייבת להיות כתובת אימייל תקינה בהתאם ל-RFC5322. חובה להוסיף את השם כשמוסיפים משתתף.	לכתיבה
attendees[].id	string	מזהה הפרופיל של המשתתף, אם הוא זמין.
attendees[].optional	boolean	אם הנוכחות של המשתתף הזה היא אופציונלית. זה שינוי אופציונלי. ברירת המחדל היא False.	ניתן לכתיבה
attendees[].organizer	boolean	אם המשתתף הוא מארגן האירוע. קריאה בלבד. ברירת המחדל היא False.
attendees[].resource	boolean	אם המשתתף הוא משאב. אפשר להגדיר את האפשרות הזו רק כשהמשתתף מתווסף לאירוע בפעם הראשונה. המערכת מתעלמת משינויים נוספים. זה שינוי אופציונלי. ערך ברירת המחדל הוא False.	לכתיבה
attendees[].responseStatus	string	סטטוס התשובה של המשתתף. הערכים האפשריים הם: 'needsAction' – המשתתף לא הגיב להזמנה (מומלץ לאירועים חדשים). 'declined' – המשתתף דחה את ההזמנה. 'tentative' – המשתתף או המשתתפת אישרו את ההזמנה באופן זמני. 'accepted' – המשתתף אישר את ההזמנה. אזהרה: אם תוסיפו אירוע באמצעות הערכים declined, ‏ tentative או accepted, ייתכן שהתשובה של משתתפים שהגדרתם להם את ההגדרה 'הוספת הזמנות ליומן שלי' ל'רק אם עניתי להזמנה באימייל' או ל'רק אם השולח מוכר לי' תתאפס ל-needsAction והם לא יראו את האירוע ביומן, אלא אם ישנו את התשובה באימייל עם ההזמנה לאירוע. בנוסף, אם מוזמנים לאירוע יותר מ-200 משתתפים, סטטוס התשובות לא מועבר למשתתפים.	לכתיבה
attendees[].self	boolean	האם הרשומה הזו מייצגת את היומן שבו מופיעה העותק הזה של האירוע. קריאה בלבד. ברירת המחדל היא False.
birthdayProperties	nested object	נתוני יום הולדת או אירועים מיוחדים. משמש אם הערך של eventType הוא "birthday". בלתי ניתן לשינוי.	ניתן לכתיבה
birthdayProperties.contact	string	שם המשאב של איש הקשר שאליו מקושר אירוע יום ההולדת הזה. אפשר להשתמש בו כדי לאחזר פרטי אנשי קשר מ-People API. פורמט: "people/c12345". קריאה בלבד.
birthdayProperties.customTypeName	string	תווית של סוג מותאם אישית שצוינה לאירוע הזה. השדה מאוכלס אם הערך של birthdayProperties.type מוגדר כ-"custom". קריאה בלבד.
birthdayProperties.type	string	סוג יום ההולדת או האירוע המיוחד. הערכים האפשריים הם: "anniversary" – יום הולדת של אירוע אחר. תמיד יש contact. "birthday" - אירוע יום הולדת. זהו ערך ברירת המחדל. "custom" – תאריך מיוחד שהתווית שלו מצוינה בשדה customTypeName. תמיד יש contact. "other" – תאריך מיוחד שלא שייך לאף אחת מהקטגוריות האחרות ואין לו תווית מותאמת אישית. תמיד יש contact. "self" – יום ההולדת של הבעלים של היומן. לא יכול להיות contact. ‏Calendar API תומך רק ביצירת אירועים מהסוג "birthday". לא ניתן לשנות את הסוג אחרי שיוצרים את האירוע.	לכתיבה
colorId	string	הצבע של האירוע. זהו מזהה שמתייחס לרשומה בקטע event של הגדרת הצבעים (ראו נקודת הקצה colors). זה שינוי אופציונלי.	ניתן לכתיבה
conferenceData	nested object	המידע שקשור לוועידה, כמו פרטי ועידה ב-Google Meet. כדי ליצור פרטים חדשים של שיחת הוועידה, צריך להשתמש בשדה createRequest. כדי לשמור את השינויים, חשוב להגדיר את פרמטר הבקשה conferenceDataVersion לערך 1 בכל הבקשות לשינוי אירועים.	לכתיבה
conferenceData.conferenceId	string	המזהה של שיחת הוועידה. המפתחים יכולים להשתמש בה כדי לעקוב אחרי כנסים. לא צריך להציג אותה למשתמשים. ערך המזהה נוצר באופן שונה לכל סוג של פתרון לשיחות ועידה: eventHangout: המזהה לא הוגדר. (סוג הפגישה הזה הוצא משימוש). eventNamedHangout: מזהה הוא שם ה-Hangout. (סוג הפגישה הזה הוצא משימוש). hangoutsMeet: מזהה הפגישה בן 10 האותיות, לדוגמה aaa-bbbb-ccc. addOn: המזהה מוגדר על ידי ספק הצד השלישי. (אופציונלי).
conferenceData.conferenceSolution	nested object	פתרון הווידאו, כמו Google Meet. לא מוגדר לוועידה עם בקשת יצירה שנכשלה. צריך להזין את השדה conferenceSolution ואת השדה entryPoint לפחות פעם אחת, או את השדה createRequest.
conferenceData.conferenceSolution.iconUri	string	הסמל שגלוי למשתמשים לפתרון הזה.
conferenceData.conferenceSolution.key	nested object	המפתח שיכול לזהות באופן ייחודי את הפתרון לשיחת ועידה באירוע הזה.
conferenceData.conferenceSolution.key.type	string	סוג הפתרון לשיחות ועידה. אם לקוח נתקל בסוג לא מוכר או ריק, הוא עדיין אמור להיות מסוגל להציג את נקודות הכניסה. עם זאת, אסור לאפשר שינויים. הערכים האפשריים הם: "eventHangout" ל-Hangouts לצרכנים (התכונה הוצאה משימוש. יכול להיות שאירועים קיימים יוצגו עם סוג הפתרון הזה לכנסים, אבל אי אפשר ליצור כנסים חדשים) "eventNamedHangout" למשתמשים ב-Google Workspace בגרסה הקלאסית של Hangouts (התכונה הזו הוצאה משימוש. יכול להיות שאירועים קיימים יוצגו עם סוג הפתרון הזה לפגישות ועידה, אבל אי אפשר ליצור פגישות ועידה חדשות) "hangoutsMeet" ל-Google Meet‏ (http://meet.google.com) "addOn" לספקי שירותי ועידה של צד שלישי
conferenceData.conferenceSolution.name	string	השם של הפתרון שגלוי למשתמשים. לא מותאם לשוק המקומי.
conferenceData.createRequest	nested object	בקשה ליצירת ועידה חדשה ולצרוף אותה לאירוע. הנתונים נוצרים באופן אסינכרוני. כדי לבדוק אם הנתונים קיימים, צריך לבדוק את השדה status. צריך להזין את השדה conferenceSolution ואת השדה entryPoint לפחות פעם אחת, או את השדה createRequest.
conferenceData.createRequest.conferenceSolutionKey	nested object	פתרון לשיחות ועידה, כמו Hangouts או Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type	string	סוג הפתרון של שיחת הוועידה. אם לקוח נתקל בסוג לא מוכר או ריק, הוא עדיין אמור להיות מסוגל להציג את נקודות הכניסה. עם זאת, אסור לאפשר שינויים. הערכים האפשריים הם: "eventHangout" ל-Hangouts לצרכנים (התכונה הוצאה משימוש. יכול להיות שאירועים קיימים יוצגו עם סוג הפתרון הזה לכנסים, אבל אי אפשר ליצור כנסים חדשים) "eventNamedHangout" למשתמשים ב-Google Workspace בגרסה הקלאסית של Hangouts (התכונה הזו הוצאה משימוש. יכול להיות שאירועים קיימים יוצגו עם סוג הפתרון הזה לפגישות ועידה, אבל אי אפשר ליצור פגישות ועידה חדשות) "hangoutsMeet" ל-Google Meet‏ (http://meet.google.com) "addOn" לספקי שירותי ועידה של צד שלישי
conferenceData.createRequest.requestId	string	המזהה הייחודי שנוצר על ידי הלקוח לבקשה הזו. לקוחות צריכים ליצור מחדש את המזהה הזה לכל בקשה חדשה. אם המזהה שצוין זהה למזהה של הבקשה הקודמת, המערכת תתעלם מהבקשה.
conferenceData.createRequest.status	nested object	סטטוס הבקשה ליצירת שיחת ועידה.
conferenceData.createRequest.status.statusCode	string	הסטטוס הנוכחי של בקשת היצירה של שיחת הוועידה. קריאה בלבד. הערכים האפשריים הם: "pending": הבקשה ליצירת הכינוס עדיין נמצאת בעיבוד. "success": הבקשה ליצירת שיחת ועידה בוצעה בהצלחה, נקודות הכניסה מאוכלסות. "failure": הבקשה ליצירת שיחת ועידה נכשלה, אין נקודות כניסה.
conferenceData.entryPoints[]	list	מידע על נקודות כניסה נפרדות לפגישה, כמו כתובות URL או מספרי טלפון. כולם צריכים להשתייך לאותה ועידה. צריך להזין את השדה conferenceSolution ואת השדה entryPoint לפחות פעם אחת, או את השדה createRequest.
conferenceData.entryPoints[].accessCode	string	קוד הגישה לצורך הצטרפות לוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות {meetingCode, accessCode, passcode, password, pin} שתואמים למונחים שהספק של שיחת הוועידה משתמש בהם. יש להציג רק את השדות המאוכלסים. זה שינוי אופציונלי.
conferenceData.entryPoints[].entryPointType	string	הסוג של נקודת הכניסה לוועידה. הערכים האפשריים הם: "video" – הצטרפות לשיחת ועידה באמצעות HTTP. לשיחת ועידה יכולה להיות אפס נקודות כניסה מסוג video או אחת. "phone" – הצטרפות לשיחת ועידה על ידי חיוג למספר טלפון. שיחת ועידה יכולה לכלול אפס נקודות כניסה של phone או יותר. "sip" – הצטרפות לפגישה דרך SIP. לשיחת ועידה יכולה להיות אפס נקודות כניסה מסוג sip או אחת. "more" – הוראות נוספות להצטרפות לשיחת הוועידה, למשל מספרי טלפון נוספים. לשיחת ועידה יכולה להיות אפס נקודות כניסה מסוג more או אחת. שיחת ועידה עם נקודת כניסה מסוג more בלבד היא לא שיחת ועידה תקינה.
conferenceData.entryPoints[].label	string	התווית של ה-URI. גלוי למשתמשי הקצה. לא מותאם לשוק המקומי. האורך המקסימלי הוא 512 תווים. דוגמאות: עבור video: meet.google.com/aaa-bbbb-ccc ל-phone: [phone] עבור sip: [e-mail] בשדה more: לא צריך למלא זה שינוי אופציונלי.
conferenceData.entryPoints[].meetingCode	string	קוד הפגישה כדי להיכנס לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות {meetingCode, accessCode, passcode, password, pin} שתואמים למונחים שהספק של שיחת הוועידה משתמש בהם. יש להציג רק את השדות המאוכלסים. זה שינוי אופציונלי.
conferenceData.entryPoints[].passcode	string	קוד הגישה לכניסה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של כנס, מאכלסים רק את קבוצת המשנה של השדות {meetingCode, accessCode, passcode, password, pin} שתואמת לטרמינולוגיה שבה משתמש ספק הכנס. צריך להציג רק את השדות שאוכלסו.
conferenceData.entryPoints[].password	string	הסיסמה לגישה לוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות {meetingCode, accessCode, passcode, password, pin} שתואמים למונחים שהספק של שיחת הוועידה משתמש בהם. יש להציג רק את השדות המאוכלסים. זה שינוי אופציונלי.
conferenceData.entryPoints[].pin	string	מספר הזיהוי האישי (PIN) כדי לגשת לוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות {meetingCode, accessCode, passcode, password, pin} שתואמים למונחים שהספק של שיחת הוועידה משתמש בהם. יש להציג רק את השדות המאוכלסים. זה שינוי אופציונלי.
conferenceData.entryPoints[].uri	string	ה-URI של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים. פורמט: נדרשת סכימה של video, http: או https:. עבור phone, נדרשת הסכימה tel:. ה-URI צריך לכלול את כל רצף החוגה (לדוגמה, tel:[phone],,123456789;1234). בשדה sip, נדרש הסכימה sip:, למשל: sip:[e-mail]. נדרש סכימה של more, ‏ http: או https:.
conferenceData.notes	string	הערות נוספות (כמו הוראות מאדמין הדומיין, הודעות משפטיות) שמוצגות למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2048 תווים. זה שינוי אופציונלי.
conferenceData.signature	string	החתימה של נתוני הוועידה. נוצר בצד השרת. לא מוגדר לוועידה עם בקשת יצירה שנכשלה. אופציונלי לשיחות ועידה עם בקשה ליצירה בהמתנה.
created	datetime	מועד היצירה של האירוע (כחותמת זמן של RFC3339). קריאה בלבד.
creator	object	יוצר האירוע. קריאה בלבד.
creator.displayName	string	שם היוצר, אם קיים.
creator.email	string	כתובת האימייל של היוצר, אם יש כזו.
creator.id	string	מזהה הפרופיל של היוצר, אם יש כזה.
creator.self	boolean	אם היוצר תואם ליומן שבו מופיע העותק הזה של האירוע. קריאה בלבד. ברירת המחדל היא False.
description	string	תיאור האירוע. יכול להכיל HTML. זה שינוי אופציונלי.	לכתיבה
end	nested object	שעת הסיום (לא בלעדית) של האירוע. במקרה של אירוע חוזר, זוהי שעת הסיום של המופע הראשון.
end.date	date	התאריך, בפורמט 'yyyy-mm-dd', אם מדובר באירוע שנמשך כל היום.	לכתיבה
end.dateTime	datetime	השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין אזור זמן, אלא אם צוין אזור זמן באופן מפורש ב-timeZone.	לכתיבה
end.timeZone	string	אזור הזמן שבו מצוין השעה. (בפורמט של שם במסד הנתונים IANA Time Zone Database, למשל 'Europe/Zurich'). בשדות של אירועים חוזרים, השדה הזה נדרש ומציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה או לסיום של האירוע.	לכתיבה
endTimeUnspecified	boolean	האם שעת הסיום בפועל לא צוינה. מועד הסיום עדיין מצוין מסיבות תאימות, גם אם המאפיין הזה מוגדר כ-True. ברירת המחדל היא False.
etag	etag	ה-ETag של המשאב.
eventType	string	סוג ספציפי של האירוע. לא ניתן לשנות את ההגדרה הזו אחרי שיוצרים את האירוע. הערכים האפשריים הם: 'birthday' – אירוע מיוחד שנמשך יום שלם וחוזר מדי שנה. default – אירוע רגיל או אירוע ללא ציון נוסף. 'focusTime' – אירוע מסוג 'זמן לעצמי'. 'fromGmail' – אירוע מ-Gmail. לא ניתן ליצור אירוע מהסוג הזה. 'outOfOffice' – אירוע מסוג 'לא בעבודה'. 'workingLocation' – אירוע של מיקום עבודה.	ניתן לכתיבה
extendedProperties	object	מאפיינים מורחבים של האירוע.
extendedProperties.private	object	מאפיינים שיהיו פרטיים להעתק של האירוע שיופיע ביומן הזה.	לכתיבה
extendedProperties.private.(key)	string	השם של המאפיין הפרטי והערך התואם.
extendedProperties.shared	object	מאפיינים שמשותפים בין עותקים של האירוע ביומנים של משתתפים אחרים.	לכתיבה
extendedProperties.shared.(key)	string	שם הנכס המשותף והערך התואם.
focusTimeProperties	nested object	נתוני אירועים מסוג 'זמן לעצמי'. משמש אם הערך של eventType הוא focusTime.	לכתיבה
focusTimeProperties.autoDeclineMode	string	האם לדחות הזמנות לפגישות שחופפות לאירועי 'זמן לעצמי'. הערכים התקינים הם declineNone, כלומר לא נדחות הזמנות לפגישות, declineAllConflictingInvitations, כלומר כל ההזמנות לפגישות שנמצאות בקונפליקט עם האירוע יידחו, ו-declineOnlyNewConflictingInvitations, כלומר רק הזמנות חדשות לפגישות שנמצאות בקונפליקט עם האירוע יידחו.
focusTimeProperties.chatStatus	string	הסטטוס שצריך לסמן את המשתמש ב-Chat ובמוצרים קשורים. הערך יכול להיות available או doNotDisturb.
focusTimeProperties.declineMessage	string	הודעת התשובה שתוגדר אם אירוע קיים או הזמנה חדשה נדחים באופן אוטומטי על ידי יומן Google.
gadget	object	גאדג'ט שמרחיב את האירוע הזה. הגאדג'טים הוצאו משימוש. המבנה הזה משמש במקום זאת רק להחזרת מטא-נתונים של יומני ימי הולדת.
gadget.display	string	מצב התצוגה של הכלי. הוצא משימוש. הערכים האפשריים הם: 'icon' – הכלי יוצג לצד שם האירוע בתצוגת היומן. 'chip' – הכלי יוצג כשלוחצים על האירוע.	ניתן לכתיבה
gadget.height	integer	גובה הגאדג'ט בפיקסלים. הגובה חייב להיות מספר שלם גדול מ-0. זה שינוי אופציונלי. הוצא משימוש.	לכתיבה
gadget.iconLink	string	כתובת האתר של סמל הגאדג'ט. סכימת כתובת ה-URL חייבת להיות HTTPS. הוצא משימוש.	ניתן לכתיבה
gadget.link	string	כתובת ה-URL של הכלי. סכימת כתובת ה-URL חייבת להיות HTTPS. הוצא משימוש.	לכתיבה
gadget.preferences	object	העדפות.	לכתיבה
gadget.preferences.(key)	string	שם ההעדפה והערך התואם.
gadget.title	string	כותרת הגאדג'ט. הוצא משימוש.	לכתיבה
gadget.type	string	סוג הגאדג'ט. הוצא משימוש.	ניתן לכתיבה
gadget.width	integer	רוחב הווידג'ט בפיקסלים. הרוחב חייב להיות מספר שלם גדול מ-0. זה שינוי אופציונלי. הוצא משימוש.	לכתיבה
guestsCanInviteOthers	boolean	אם משתתפים אחרים, מלבד המארגן, יכולים להזמין אנשים אחרים לאירוע. זה שינוי אופציונלי. ברירת המחדל היא True.	לכתיבה
guestsCanModify	boolean	אם משתתפים אחרים מלבד המארגן יכולים לשנות את האירוע. זה שינוי אופציונלי. ברירת המחדל היא False.	ניתן לכתיבה
guestsCanSeeOtherGuests	boolean	אם משתתפים אחרים מלבד המארגן יוכלו לראות מי המשתתפים באירוע. זה שינוי אופציונלי. ערך ברירת המחדל הוא True.	לכתיבה
hangoutLink	string	קישור מוחלט ל-Google Hangout שמשויך לאירוע הזה. קריאה בלבד.
htmlLink	string	קישור מוחלט לאירוע הזה בממשק המשתמש האינטרנטי של יומן Google. קריאה בלבד.
iCalUID	string	מזהה ייחודי של אירוע כפי שמוגדר ב-RFC5545. הוא משמש לזיהוי ייחודי של אירועים במערכות יומנים שונות, וצריך לספק אותו כשמייבאים אירועים באמצעות השיטה import. הערה: הערכים iCalUID ו-id לא זהים, וצריך לספק רק אחד מהם בזמן יצירת האירוע. אחד ההבדלים בסמנטיקה שלהם הוא שבאירועים חוזרים, לכל המופעים של אירוע אחד יש ערכים שונים של id, אבל לכל המופעים יש את אותם ערכים של iCalUID. כדי לאחזר אירוע באמצעות הערך של iCalUID שלו, צריך להפעיל את השיטה events.list באמצעות הפרמטר iCalUID. כדי לאחזר אירוע באמצעות id שלו, צריך להפעיל את השיטה events.get.
id	string	מזהה אטום של האירוע. כשיוצרים אירועים חד-פעמיים או חוזרים, אפשר לציין את המזהים שלהם. המזהים שסופקו חייבים לעמוד בכללים הבאים: התווים שמותר להשתמש בהם במזהה הם אלה שמשמשים בקידוד base32hex, כלומר אותיות קטנות a-v וספרות 0-9.אפשר לעיין בקטע 3. 1.2 במסמך RFC2938. אורך המזהה צריך להיות בין 5 ל-1,024 תווים המזהה צריך להיות ייחודי בכל יומן בגלל אופי ההפצה הגלובלי של המערכת, אנחנו לא יכולים להבטיח שיזוהו התנגשויות בין מזהי אירועים בזמן יצירת האירוע. כדי למזער את הסיכון להתנגשויות, אנחנו ממליצים להשתמש באלגוריתם UUID מבוסס, כמו אלגוריתם המתואר ב-RFC4122. אם לא מציינים מזהה, הוא נוצר באופן אוטומטי על ידי השרת. חשוב לזכור שהשדות icalUID ו-id הם לא זהים, ויש לספק רק אחד מהם בזמן יצירת האירוע. אחד ההבדלים בסמנטיקה שלהם הוא שבאירועים חוזרים, לכל המופעים של אירוע אחד יש ערכים שונים של id, אבל לכל המופעים יש את אותם ערכים של icalUID.	לכתיבה
kind	string	סוג המשאב (calendar#event).
location	string	המיקום הגיאוגרפי של האירוע כטקסט חופשי. זה שינוי אופציונלי.	ניתן לכתיבה
locked	boolean	אם מדובר בעותק אירוע נעול שבו אי אפשר לבצע שינויים בשדות האירוע הראשיים 'סיכום', 'תיאור', 'מיקום', 'התחלה', 'סיום' או 'תדירות'. ברירת המחדל היא False. קריאה בלבד.
organizer	object	מארגן האירוע. אם גם המארגן/ת הוא משתתף/ת, ניתן לראות זאת באמצעות רשומה נפרדת ב-attendees כשהשדה organizer מוגדר כ-True. כדי לשנות את המארגן, משתמשים בפעולה move. קריאה בלבד, מלבד כשמייבאים אירוע.	לכתיבה
organizer.displayName	string	השם של המארגן, אם הוא זמין.	לכתיבה
organizer.email	string	כתובת האימייל של מארגן/ת הפגישה, אם יש כזו. היא חייבת להיות כתובת אימייל תקינה בהתאם ל-RFC5322.	ניתן לכתיבה
organizer.id	string	מזהה הפרופיל של המארגן, אם יש כזה.
organizer.self	boolean	אם המארגן תואם ליומן שבו עותק האירוע הזה מופיע. קריאה בלבד. ברירת המחדל היא False.
originalStartTime	nested object	עבור מופע של אירוע חוזר, זו השעה שבה האירוע הזה יתחיל בהתאם לנתוני התדירות באירוע החוזר שמזוהה לפי recurringEventId. הוא מזהה באופן ייחודי את המופע בתוך סדרת האירועים החוזרים, גם אם המופע הועבר לשעה אחרת. קבוע.
originalStartTime.date	date	התאריך בפורמט 'yyyy-mm-dd', אם מדובר באירוע של יום שלם.	ניתן לכתיבה
originalStartTime.dateTime	datetime	השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין את הפרש השעות באזור הזמן, אלא אם צוין אזור זמן באופן מפורש ב-timeZone.	לכתיבה
originalStartTime.timeZone	string	אזור הזמן שבו מצוין השעה. (בפורמט של שם במסד הנתונים IANA Time Zone Database, למשל 'Europe/Zurich'). בשדות של אירועים חוזרים, השדה הזה נדרש ומציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה או לסיום של האירוע.	לכתיבה
outOfOfficeProperties	nested object	נתוני אירועים מסוג 'לא בעבודה'. משמש אם הערך של eventType הוא outOfOffice.	לכתיבה
outOfOfficeProperties.autoDeclineMode	string	האם לדחות הזמנות לפגישות שמתנגשות עם אירועים מסוג 'לא בעבודה'. הערכים החוקיים הם declineNone, כלומר המערכת לא דוחה הזמנות לפגישות; declineAllConflictingInvitations – כלומר כל ההזמנות הסותרות לפגישה שמתנגשות עם האירוע נדחות; ו-declineOnlyNewConflictingInvitations – כלומר, המערכת דוחה רק הזמנות מתנגשות חדשות לפגישות שמגיעות כשהאירוע 'לא בעבודה' מתקיים.
outOfOfficeProperties.declineMessage	string	הודעת התשובה שתוגדר אם אירוע קיים או הזמנה חדשה נדחים באופן אוטומטי על ידי יומן Google.
privateCopy	boolean	אם הערך מוגדר כ-True, העברת אירועים מושבתת. חשוב לזכור שזה לא אותו הדבר כמו נכסי אירועים פרטיים. זה שינוי אופציונלי. בלתי ניתן לשינוי. ברירת המחדל היא False.
recurrence[]	list	רשימה של שורות RRULE, ‏ EXRULE, ‏ RDATE ו-EXDATE לאירוע חוזר, כפי שמפורט ב-RFC5545. לתשומת ליבך, אסור להשתמש בשורות DTSTART ו-DTEND בשדה הזה. זמני ההתחלה והסיום של האירועים מצוינים בשדות start ו-end. השדה הזה לא מופיע באירועים בודדים או במופעים של אירועים חוזרים.	לכתיבה
recurringEventId	string	עבור מופע של אירוע חוזר, זהו הערך של id של האירוע החוזר שאליו שייך המופע הזה. קבוע.
reminders	object	מידע על התזכורות של האירוע עבור המשתמש המאומת. חשוב לשים לב ששינוי תזכורות לא משנה גם את המאפיין updated של האירוע המצורף.
reminders.overrides[]	list	אם לא הוגדרו תזכורות ברירת מחדל לאירוע, יופיעו כאן התזכורות הספציפיות לאירוע. אם לא הוגדרו תזכורות, יופיע הכיתוב 'לא הוגדרו תזכורות'. המספר המקסימלי של תזכורות לשינוי ברירת המחדל הוא 5.	לכתיבה
reminders.overrides[].method	string	השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם: 'email' – התזכורות נשלחות באימייל. 'popup' – התזכורות נשלחות דרך חלון קופץ בממשק המשתמש. נדרש כשמוסיפים תזכורת.	לכתיבה
reminders.overrides[].minutes	integer	מספר הדקות לפני תחילת האירוע שבהן התזכורת אמורה להופיע. הערכים החוקיים הם בין 0 ל-40320 (4 שבועות בדקות). חובה בעת הוספת תזכורת.	ניתן לכתיבה
reminders.useDefault	boolean	אם תזכורות ברירת המחדל של היומן חלות על האירוע.	לכתיבה
sequence	integer	מספר רצף לפי iCalendar.	לכתיבה
source	object	המקור שממנו נוצר האירוע. לדוגמה, דף אינטרנט, הודעת אימייל או כל מסמך שאפשר לזהות באמצעות כתובת URL עם הסכימה HTTP או HTTPS. רק היוצר של האירוע יכול לראות או לשנות אותו.
source.title	string	כותרת המקור. לדוגמה, כותרת של דף אינטרנט או נושא של אימייל.	לכתיבה
source.url	string	כתובת ה-URL של המקור שמפנה למשאב. סכימת כתובת ה-URL חייבת להיות HTTP או HTTPS.	לכתיבה
start	nested object	שעת ההתחלה (כולל) של האירוע. במקרה של אירוע חוזר, זוהי שעת ההתחלה של המופע הראשון.
start.date	date	התאריך, בפורמט 'yyyy-mm-dd', אם מדובר באירוע שנמשך כל היום.	לכתיבה
start.dateTime	datetime	השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין את הפרש השעות באזור הזמן, אלא אם צוין אזור זמן באופן מפורש ב-timeZone.	לכתיבה
start.timeZone	string	אזור הזמן שבו מצוין השעה. (בפורמט של שם במסד הנתונים IANA Time Zone Database, למשל 'Europe/Zurich'). בשדות של אירועים חוזרים, השדה הזה נדרש ומציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה או לסיום של האירוע.	לכתיבה
status	string	סטטוס האירוע. זה שינוי אופציונלי. הערכים האפשריים הם: 'confirmed' – האירוע אושר. זהו סטטוס ברירת המחדל. 'tentative' – האירוע אושר באופן זמני. 'cancelled' – האירוע בוטל (נמחק). השיטה list מחזירה אירועים שבוטלו רק בסנכרון מצטבר (כשמציינים syncToken או updatedMin) או אם הדגל showDeleted מוגדר לערך true. הם תמיד מוחזרים על ידי השיטה get. הסטטוס 'מבוטל' מייצג שני מצבים שונים, בהתאם לסוג האירוע: אם יש חריגות שבוטלו באירוע חוזר שלא בוטל, המשמעות היא שהאירוע הזה לא אמור להופיע יותר למשתמש. על הלקוחות לאחסן את האירועים האלה לכל משך החיים של האירוע החוזר הראשי. מובטח שרק בשדות id, ‏ recurringEventId ו-originalStartTime של החרגות שבוטלו יהיו ערכים מאוכלסים. יכול להיות שהשדות האחרים יהיו ריקים. כל שאר האירועים שבוטלו מייצגים אירועים שנמחקו. לקוחות צריכים להסיר את העותקים שלהם שסונכרנו באופן מקומי. אירועים כאלה שבוטלו ייעלמו בסופו של דבר, לכן אל תסמכו על כך שהם יהיו זמינים ללא הגבלת זמן. כשמדובר באירועים שנמחקו, רק השדה id יאוכלס בפרטים של האירועים שנמחקו. ביומן של המארגן, פרטי האירועים שבוטלו (סיכום, מיקום וכו') עדיין גלויים, כדי שניתן יהיה לשחזר אותם (לבטל את המחיקה שלהם). באופן דומה, האירועים שהמשתמש הוזמן אליהם והסיר אותם באופן ידני ימשיכו לספק פרטים. עם זאת, בקשות סנכרון מצטברות שבהן showDeleted מוגדר כ-False לא יחזירו את הפרטים האלה. אם מארגן האירוע ישתנה (למשל באמצעות הפעולה move) והמארגן המקורי לא נכלל ברשימת הנוכחים, יישאר אירוע מבוטל שבו רק השדה id יהיה מאוכלס.	לכתיבה
summary	string	שם האירוע.	לכתיבה
transparency	string	אם האירוע חוסם זמן ביומן. זה שינוי אופציונלי. הערכים האפשריים הם: 'opaque' – ערך ברירת המחדל. האירוע חוסם זמן ביומן. זהו מצב מקביל להגדרה של הצגת המצב שלי כעסוק בממשק המשתמש של יומן Google. 'transparent' – האירוע לא חוסם זמן ביומן. זהו מצב מקביל להגדרה הצגת הסטטוס שלי בתור זמין בממשק המשתמש של יומן Google.	לכתיבה
updated	datetime	זמן השינוי האחרון של נתוני האירוע הראשי (כחותמת זמן RFC3339). עדכון התזכורות לאירועים לא ישנה את המצב הזה. קריאה בלבד.
visibility	string	מי יכול לראות את האירוע. זה שינוי אופציונלי. הערכים האפשריים הם: 'default' – המערכת משתמשת בהרשאות הגישה שמוגדרות כברירת מחדל לאירועים ביומן. זהו ערך ברירת המחדל. 'public' – האירוע גלוי לכולם ופרטי האירוע גלויים לכל קוראי היומן. 'private' – האירוע פרטי ורק המשתתפים בו יכולים לראות את פרטי האירוע. 'confidential' – האירוע הוא פרטי. הערך הזה מוצג מטעמי תאימות.	לכתיבה
workingLocationProperties	nested object	נתוני אירועים של מיקום עבודה.	לכתיבה
workingLocationProperties.customLocation	object	אם השדה הזה קיים, המשמעות היא שהמשתמש עובד ממיקום מותאם אישית.	לכתיבה
workingLocationProperties.customLocation.label	string	תווית נוספת אופציונלית למידע נוסף.	ניתן לכתיבה
workingLocationProperties.homeOffice	any value	אם השדה הזה קיים, המשמעות היא שהמשתמש עובד מהבית.	לכתיבה
workingLocationProperties.officeLocation	object	אם השדה הזה מופיע, המשמעות היא שהמשתמש עובד ממשרד.	לכתיבה
workingLocationProperties.officeLocation.buildingId	string	מזהה אופציונלי של בניין. המזהה הזה צריך להפנות למזהה של בניין במסד הנתונים של המשאבים של הארגון.	לכתיבה
workingLocationProperties.officeLocation.deskId	string	מזהה שולחן אופציונלי.	לכתיבה
workingLocationProperties.officeLocation.floorId	string	מזהה קומה אופציונלי.	לכתיבה
workingLocationProperties.officeLocation.floorSectionId	string	מזהה אופציונלי של קטע בקומה.	לכתיבה
workingLocationProperties.officeLocation.label	string	שם המשרד שמוצג בלקוחות של יומן Google באינטרנט ובנייד. מומלץ להפנות לשם בניין במסד הנתונים של המשאבים בארגון.	לכתיבה
workingLocationProperties.type	string	המיקום של מיקום העבודה. הערכים האפשריים הם: 'homeOffice' – המשתמש עובד מהבית. 'officeLocation' – המשתמש עובד ממשרד. 'customLocation' – המשתמש עובד ממיקום מותאם אישית. כל הפרטים מצוינים בשדה משנה של השם שצוין, אבל יכול להיות שהשדה הזה יהיה חסר אם הוא ריק. המערכת תתעלם משדות אחרים. חובה כשמוסיפים מאפיינים של מיקום עבודה.	לכתיבה

שיטות

מחיקה

מחיקת אירוע.

get

מחזירה אירוע על סמך המזהה שלו ביומן Google. כדי לאחזר אירוע באמצעות מזהה ה-icalendar שלו, קוראים לmethod שלevents.list באמצעות הפרמטר iCalUID.

import

ייבוא אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. אפשר לייבא רק אירועים עם הערך default של default.eventType

התנהגות שיצאה משימוש: אם מייבאים אירוע שאינו מסוג default, הסוג שלו ישתנה ל-default וכל המאפיינים הספציפיים לסוג האירוע יימחקו.

insert

יצירת אירוע.

instances

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

list

מחזירה אירועים ביומן שצוין.

העברה

העברת אירוע ליומן אחר, כלומר שינוי המארגן של האירוע. חשוב לדעת: אפשר להעביר רק אירועים מסוג default. אי אפשר להעביר אירועים מסוג birthday, focusTime, fromGmail, outOfOffice ו-workingLocation.

תיקון

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

quickAdd

יצירת אירוע על סמך מחרוזת טקסט פשוטה.

עדכון

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

שעון

חשוב לשים לב לשינויים במשאבי האירועים.