דף זה תורגם על ידי Cloud Translation API.

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
    }
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": 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`, המשתתפים שההגדרה 'הוספת הזמנות ליומן שלי' יהיו במצב 'רק אם עניתי להזמנה באימייל' לא יראו אירוע ביומן שלהם, אלא אם הם יבחרו לשנות את התשובה שלהם להזמנה באימייל של ההזמנה לאירוע.	ניתן לכתיבה
`attendees[].self`	`boolean`	האם הרשומה הזו מייצגת את היומן שבו מופיע עותק האירוע הזה. קריאה בלבד. ברירת המחדל היא False.
`colorId`	`string`	הצבע של האירוע. זהו מזהה שמפנה לרשומה בקטע `event` של הגדרת הצבעים (ניתן לעיין ב נקודת הקצה של הצבעים). אופציונלי.	ניתן לכתיבה
`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"` עבור משתמשים בגרסה הקלאסית של Hangouts למשתמשי Google Workspace (האפשרות הוצאה משימוש. ייתכן שאירועים קיימים יציגו את סוג הפתרון הזה לשיחות ועידה, אבל אי אפשר ליצור שיחות ועידה חדשות) `"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"` עבור משתמשים בגרסה הקלאסית של Hangouts למשתמשי Google Workspace (האפשרות הוצאה משימוש. ייתכן שאירועים קיימים יציגו את סוג הפתרון הזה לשיחות ועידה, אבל אי אפשר ליצור שיחות ועידה חדשות) `"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-THRESHOLD עבור `phone`: +1 123 268 2601 עבור `sip`: 12345678@altostrat.com עבור `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`	קוד האימות של שיחת הוועידה. האורך המרבי הוא 128 תווים. כשיוצרים נתונים חדשים לשיחת הוועידה, מאכלסים רק את קבוצת המשנה של השדות {`meetingCode`, `accessCode`, `passcode`, `password`, `pin`} שתואמים למונחים שהספק של שיחת הוועידה משתמש בהם. רק השדות המאוכלסים יוצגו. אופציונלי.
`conferenceData.entryPoints[].uri`	`string`	ה-URI של נקודת הכניסה. האורך המרבי הוא 1300 תווים. פורמט: נדרשת סכימה `video`, `http:` או `https:`. עבור `phone`, נדרשת סכימה `tel:`. ה-URI צריך לכלול את כל רצף החיוג (למשל: tel:+12345678900,,123456789;1234). עבור `sip`, נדרשת סכימת `sip:`, למשל sip:12345678@myprovider.com. נדרשת סכימה `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, למשל "Europe/Zurich".) עבור אירועים חוזרים, זהו שדה חובה והוא מציין את אזור הזמן שבו החזרה תתרחב. עבור אירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע.	ניתן לכתיבה
`endTimeUnspecified`	`boolean`	אם שעת הסיום בפועל לא צוינה. עדיין צוינה שעת סיום מטעמי תאימות, גם אם המאפיין הזה מוגדר כ-True. ברירת המחדל היא False.
`etag`	`etag`	ה-ETag של המשאב.
`eventType`	`string`	סוג האירוע הספציפי. לא ניתן לשנות את השדה הזה לאחר יצירת האירוע. הערכים האפשריים הם: "`default`" – אירוע רגיל או שלא צוין עוד. "`outOfOffice`" – אירוע מסוג 'לא בעבודה' "`focusTime`" – אירוע 'זמן לעצמי'. "`workingLocation`" – אירוע של מיקום עבודה. נכון לעכשיו אפשר ליצור רק אירועים מסוג '`default`' ו-'`workingLocation`' באמצעות ה-API. תמיכה נוספת בסוגי אירועים אחרים תהיה זמינה בגרסאות הבאות.	ניתן לכתיבה
`extendedProperties`	`object`	מאפיינים מורחבים של האירוע.
`extendedProperties.private`	`object`	מאפיינים שהם פרטיים לעותק של האירוע שמופיע ביומן הזה.	ניתן לכתיבה
`extendedProperties.private.(key)`	`string`	שם הנכס הפרטי והערך התואם.
`extendedProperties.shared`	`object`	מאפיינים שמשותפים בין עותקים של האירוע ביומנים של משתתפים אחרים.	ניתן לכתיבה
`extendedProperties.shared.(key)`	`string`	שם הנכס המשותף והערך התואם.
`gadget`	`object`	גאדג'ט שמרחיב את האירוע. גאדג'טים הוצאו משימוש. במקום זאת המבנה הזה משמש רק למטא-נתונים שמוחזרים ביומן של ימי הולדת.
`gadget.display`	`string`	מצב התצוגה של הגאדג'ט. הוּצא משימוש. הערכים האפשריים הם: "`icon`" - הגאדג'ט מוצג ליד כותרת האירוע בתצוגת היומן. "`chip`" – הגאדג'ט מוצג כשלוחצים על האירוע.	ניתן לכתיבה
`gadget.height`	`integer`	גובה הגאדג'ט בפיקסלים. הגובה חייב להיות מספר שלם הגדול מ-0. אופציונלי. הוּצא משימוש.	ניתן לכתיבה
`gadget.iconLink`	`string`	כתובת ה-URL של הסמל של הגאדג'ט. סכימת כתובת ה-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 Hangouts המשויך לאירוע הזה. קריאה בלבד.
`htmlLink`	`string`	קישור מוחלט לאירוע הזה בממשק המשתמש של יומן Google באינטרנט. קריאה בלבד.
`iCalUID`	`string`	מזהה ייחודי לאירוע כפי שמוגדר ב-RFC5545. היא משמשת לזיהוי ייחודי של אירועים בין מערכות היומן, ויש לספק אותה כשמייבאים אירועים באמצעות שיטת הייבוא. לתשומת ליבכם: ה-`iCalUID` וה-`id` אינם זהים, ויש לספק רק אחד מהם בזמן יצירת האירוע. ההבדל בין הסמנטיקה של אירועים אלה הוא שבאירועים חוזרים, לכל אירוע יש אירוע `id` שונה, וכולם חולקים את אותם `iCalUID`. כדי לאחזר אירוע באמצעות `iCalUID` שלו, צריך לקרוא ל-event.list שיטה באמצעות הפרמטר `iCalUID`. כדי לאחזר אירוע באמצעות `id`, צריך לקרוא לשיטה events.get.
`id`	`string`	מזהה אטום של האירוע. כשיוצרים אירועים חדשים או חוזרים, אפשר לציין את המזהים שלהם. המזהים שצוינו חייבים לעמוד בכללים הבאים: התווים המותרים במזהה הם אלה המשמשים בקידוד base32hex, כלומר אותיות קטנות a-v וספרות 0-9, ראה סעיף 3.1.2 ב-RFC2938 אורך המזהה חייב להיות בין 5 ל-1024 תווים המזהה צריך להיות ייחודי לכל יומן בגלל האופי המבוזר של המערכת, לא נוכל להבטיח שהתנגשויות המזהים יזוהו בזמן יצירת האירוע. כדי למזער את הסיכון לתאונות, אנחנו ממליצים להשתמש באלגוריתם UUID קיים, כמו זה המתואר ב-RFC4122. אם לא תציינו מזהה, הוא יופק באופן אוטומטי על ידי השרת. לתשומת ליבכם: ה-`icalUID` וה-`id` אינם זהים, ויש לספק רק אחד מהם בזמן יצירת האירוע. ההבדל בין הסמנטיקה של אירועים אלה הוא שבאירועים חוזרים, לכל אירוע יש אירוע `id` שונה, וכולם חולקים את אותם `icalUID`.	ניתן לכתיבה
`kind`	`string`	סוג המשאב ("`calendar#event`").
`location`	`string`	המיקום הגיאוגרפי של האירוע כטקסט חופשי. אופציונלי.	ניתן לכתיבה
`locked`	`boolean`	בין אם מדובר בעותק נעול של אירוע, שבו לא ניתן לבצע שינויים בשדות הראשיים של אירועים: "סיכום", "תיאור", "מיקום", "התחלה", "סיום" או "חזרה". ברירת המחדל היא False. קריאה בלבד.
`organizer`	`object`	מארגן האירוע. אם המארגן/ת גם משתתף/ת, זה מצוין עם רשומה נפרדת ב-`attendees` והשדה `organizer` מוגדר כ-True. כדי לשנות את המארגן, צריך להשתמש בפעולה העברה. קריאה בלבד, אלא כשמייבאים אירוע.	ניתן לכתיבה
`organizer.displayName`	`string`	שם המארגן, אם יש כזה.	ניתן לכתיבה
`organizer.email`	`string`	כתובת האימייל של המארגן, אם היא זמינה. כתובת האימייל חייבת להיות חוקית, בהתאם ל-RFC5322.	ניתן לכתיבה
`organizer.id`	`string`	מזהה הפרופיל של המארגן, אם יש כזה.
`organizer.self`	`boolean`	אם המארגן תואם ליומן שבו מופיע העותק הזה של האירוע. קריאה בלבד. ברירת המחדל היא False.
`originalStartTime`	`nested object`	במקרה של אירוע חוזר, זה הזמן שבו האירוע הזה יתחיל בהתאם לנתוני החזרה של האירוע החוזר שזוהה על ידי האירוע החוזר. זהו מזהה ייחודי של המופע בסדרה של האירועים החוזרים, גם אם המופע הועבר למועד אחר. לא ניתן לשינוי.
`originalStartTime.date`	`date`	את התאריך, בפורמט "yyyy-mm-dd", אם האירוע הזה נמשך כל היום.	ניתן לכתיבה
`originalStartTime.dateTime`	`datetime`	השעה כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לבחור הבדלי זמן באזור הזמן, אלא אם אזור הזמן צוין במפורש ב-`timeZone`.	ניתן לכתיבה
`originalStartTime.timeZone`	`string`	אזור הזמן שמוגדר בו הזמן. (הפורמט הזה נקרא שם מסד הנתונים של אזור הזמן IANA, למשל "Europe/Zurich".) עבור אירועים חוזרים, זהו שדה חובה והוא מציין את אזור הזמן שבו החזרה תתרחב. עבור אירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע.	ניתן לכתיבה
`privateCopy`	`boolean`	אם המדיניות מוגדרת כ-True, הפצת אירועים מושבתת. שימו לב: זה לא אותו הדבר כמו מאפייני אירועים פרטיים. אופציונלי. לא ניתן לשינוי. ברירת המחדל היא False.
`recurrence[]`	`list`	רשימת שורות RRESTRICT, EXMETRIC, RDATE ו-EXDATE עבור אירוע חוזר, כפי שמצוין ב-RFC5545. חשוב לדעת שאסור להשתמש בשורות DTSTART ו-DTEND בשדה הזה. זמני ההתחלה והסיום של אירועים מצוינים בשדות `start` ו-`end`. השדה הזה מושמט עבור אירועים יחידים או מופעים של אירועים חוזרים.	ניתן לכתיבה
`recurringEventId`	`string`	במקרה של אירוע חוזר, זהו `id` של האירוע החוזר שאליו המופע שייך. לא ניתן לשינוי.
`reminders`	`object`	מידע על התזכורות של המשתמש המאומת לאירוע.
`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, למשל "Europe/Zurich".) עבור אירועים חוזרים, זהו שדה חובה והוא מציין את אזור הזמן שבו החזרה תתרחב. עבור אירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע.	ניתן לכתיבה
`status`	`string`	סטטוס האירוע. אופציונלי. הערכים האפשריים הם: "`confirmed`" – האירוע אושר. זהו סטטוס ברירת המחדל. "`tentative`" – האירוע אושר זמנית. "`cancelled`" – האירוע בוטל (נמחק). השיטה רשימה מחזירה אירועים שבוטלו רק בסנכרון מצטבר (כאשר מצוינים `syncToken` או `updatedMin`) או אם הדגל `showDeleted` מוגדר לערך `true`. שיטת get תמיד מחזירה אותם. סטטוס ביטול מייצג שני מצבים שונים, בהתאם לסוג האירוע: חריגות שבוטלו לגבי אירוע חוזר שלא בוטל מעידות שהמופע הזה כבר לא מוצג למשתמש. לקוחות צריכים לאחסן את האירועים האלה לאורך כל משך החיים של האירוע החוזר. כדי לוודא שהחריגות יבוטלו, הערכים שלהן יאוכלסו רק בשדות `id`, `recurringEventId` ו-`originalStartTime`. ייתכן שהשדות האחרים יהיו ריקים. כל שאר האירועים שבוטלו מייצגים אירועים שנמחקו. הלקוחות צריכים להסיר את העותקים שסונכרנו באופן מקומי. אירועים כאלה שבוטלו ייעלמו בסופו של דבר, לכן אין להסתמך על כך שיהיו זמינים ללא הגבלת זמן. מובטח שאירועים שנמחקו יאוכלסו רק בשדה `id`. ביומן של המארגן, אירועים שבוטלו ממשיכים לחשוף את פרטי האירוע (סיכום, מיקום וכו') כדי שיהיה אפשר לשחזר אותם (בלי למחוק אותם). באופן דומה, האירועים שמשתמשים הוזמנו אליהם והם הוסרו באופן ידני ממשיכים לספק פרטים. עם זאת, בקשות סנכרון מצטברות שבהן הערך של `showDeleted` מוגדר כ-False לא יחזירו את הפרטים האלה. אם אירוע משנה את המארגן (לדוגמה, באמצעות פעולת ההעברה) והמארגן המקורי לא נמצא ברשימת המשתתפים, הוא ישאיר אירוע מבוטל שבו רק השדה `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`" – המשתמש עובד ממיקום מותאם אישית. כל הפרטים צוינו בשדה משנה של השם שצוין, אבל יכול להיות שהשדה יהיה חסר אם הוא ריק. המערכת מתעלמת מכל שדה אחר. חובה כשמוסיפים מאפיינים של מיקום עבודה.	ניתן לכתיבה

שיטות

מחיקה: מוחק אירוע.
הורדה: מחזיר אירוע על סמך המזהה שלו ביומן Google. כדי לאחזר אירוע באמצעות המזהה שלו ב-iCalendar, צריך לקרוא למתודה events.list" באמצעות הפרמטר iCalUID.
ייבוא: המערכת מייבאת אירוע. פעולה זו משמשת להוספת עותק פרטי של אירוע קיים ליומן.
הוספה: המערכת יוצרת אירוע.
מכונות: מחזיר מופעים של האירוע החוזר שצוין.
list: מחזיר אירועים ביומן שצוין.
העברה: מעביר אירוע ליומן אחר, כלומר משנה את המארגן של אירוע.
תיקון: מעדכן אירוע. שיטה זו תומכת בסמנטיקה של תיקון. לתשומת ליבך, לכל בקשת תיקון נדרשות שלוש יחידות מכסה. עדיף להשתמש ב-get ואחריו update. ערכי השדות שציינתם מחליפים את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. שדות מערך, אם צוינו, מחליפים את המערכים הקיימים. הפעולה הזו מבטלת את הרכיבים הקודמים של המערך.
QuickAdd: המערכת יוצרת אירוע על סמך מחרוזת טקסט פשוטה.
עדכון: מעדכן אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקון ומעדכנת תמיד את משאב האירוע כולו. כדי לבצע עדכון חלקי, צריך לבצע get ולאחר מכן update באמצעות etags כדי להבטיח פעילות.
שעון: שימו לב לשינויים במשאבי האירועים.