Events

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

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

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

{
  "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
    }
  ],
  "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: מזהה הוא השם של ה-Hangouts. (סוג שיחת הוועידה הזה הוצא משימוש). 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-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	קוד האימות לצורך גישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים לשיחות ועידה, צריך לאכלס רק את קבוצת המשנה של השדות {meetingCode, accessCode, passcode, password, pin} שתואמים למונחים שבהם הספק של שיחת הוועידה משתמש. צריך להציג רק את השדות שאוכלסו. זה שינוי אופציונלי.
conferenceData.entryPoints[].uri	string	ה-URI של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים. פורמט: עבור הסכימה video, http: או https: יש צורך. עבור phone, נדרשת סכימה tel:. ה-URI צריך לכלול את רצף החיוג המלא (לדוגמה, טל:[phone],,,123456789;1234). עבור sip, נדרשת הסכימה sip:. לדוגמה: sip:[e-mail]. עבור הסכימה more, http: או https: יש צורך.
conferenceData.notes	string	הערות נוספות (כגון הוראות ממנהל הדומיין, הודעות משפטיות) שיש להציג למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2,048 תווים. זה שינוי אופציונלי.
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, לדוגמה: "אירופה/ציריך"). עבור אירועים חוזרים, השדה הזה הוא חובה ומציין את אזור הזמן שבו החזרה מורחבת. באירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע.	ניתן לכתיבה
endTimeUnspecified	boolean	האם שעת הסיום בפועל לא צוינה. עדיין צריך לציין שעת סיום מטעמי תאימות, גם אם המאפיין הזה מוגדר כ-True. ברירת המחדל היא False.
etag	etag	ה-ETag של המשאב.
eventType	string	הסוג הספציפי של האירוע. אי אפשר לשנות את ההגדרה הזו אחרי שהאירוע נוצר. הערכים האפשריים הם: "default" - אירוע רגיל או שלא צוין יותר. 'outOfOffice' – אירוע 'לא בעבודה'. 'focusTime' – אירוע מסוג 'זמן לעצמי'. '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 של סמל הגאדג'ט. סכימת כתובת ה-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 שלו, צריך להפעיל את ה-method 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. כדי לשנות את המארגן, צריך לבצע את הפעולה העברה. קריאה בלבד, חוץ מאשר כשמייבאים אירוע.	ניתן לכתיבה
organizer.displayName	string	שם המארגן, אם קיים.	ניתן לכתיבה
organizer.email	string	כתובת האימייל של המארגן, אם יש כזו. כתובת האימייל צריכה להיות חוקית בהתאם לתקן RFC5322.	ניתן לכתיבה
organizer.id	string	מזהה הפרופיל של מארגן האירוע, אם הוא זמין.
organizer.self	boolean	האם המארגן תואם ליומן שבו מופיע העותק של האירוע. קריאה בלבד. ברירת המחדל היא False.
originalStartTime	nested object	לגבי מופע של אירוע חוזר, זוהי השעה שבה האירוע יתחיל בהתאם לנתוני החזרה של האירוע החוזר המזוהים על ידי InvalidEventId. הוא מזהה באופן ייחודי את המופע מתוך סדרת האירועים החוזרים, גם אם הוא הועבר למועד אחר. בלתי משתנה.
originalStartTime.date	date	התאריך, בפורמט "yyyy-mm-dd", אם זהו אירוע שנמשך כל היום.	ניתן לכתיבה
originalStartTime.dateTime	datetime	השעה, כערך משולב של תאריך ושעה (בפורמט בהתאם ל-RFC3339). חובה לציין קיזוז אזור זמן, אלא אם צוין אזור זמן במפורש ב-timeZone.	ניתן לכתיבה
originalStartTime.timeZone	string	אזור הזמן שבו השעה מצוינת. (בפורמט של שם מסד נתונים של אזור זמן IANA, לדוגמה: "אירופה/ציריך"). עבור אירועים חוזרים, השדה הזה הוא חובה ומציין את אזור הזמן שבו החזרה מורחבת. באירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע.	ניתן לכתיבה
outOfOfficeProperties	nested object	נתוני אירועים מסוג 'לא בעבודה'. בשימוש אם הערך של eventType הוא outOfOffice.	ניתן לכתיבה
outOfOfficeProperties.autoDeclineMode	string	האם לדחות הזמנות לפגישות שחופפות לאירועים מסוג 'לא בעבודה'. הערכים החוקיים הם declineNone, כלומר אף הזמנה לפגישה לא נדחתה. declineAllConflictingInvitations כלומר, כל ההזמנות לפגישות שמתנגשות עם האירוע נדחות, וגם declineOnlyNewConflictingInvitations, כלומר רק הזמנות לפגישות מתנגשות חדשות שמגיעים בזמן שהאירוע 'לא בעבודה' נדחה.
outOfOfficeProperties.declineMessage	string	הודעת תגובה שמגדירה אם אירוע קיים או הזמנה חדשה יידחו אוטומטית על ידי יומן Google.
privateCopy	boolean	אם המדיניות מוגדרת כ-True, הפצת האירועים מושבתת. חשוב לשים לב שהנתונים האלה הם שונים מנכסים של אירועים פרטיים. זה שינוי אופציונלי. בלתי משתנה. ברירת המחדל היא False.
recurrence[]	list	רשימה של שורות R חדשים, EXBLOCK, 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, לדוגמה: "אירופה/ציריך"). עבור אירועים חוזרים, השדה הזה הוא חובה ומציין את אזור הזמן שבו החזרה מורחבת. באירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע.	ניתן לכתיבה
status	string	סטטוס האירוע. זה שינוי אופציונלי. הערכים האפשריים הם: 'confirmed' – האירוע אושר. זהו סטטוס ברירת המחדל. 'tentative' – האירוע אושר זמנית. 'cancelled' – האירוע בוטל (נמחק). שיטת list מחזירה אירועים שבוטלו רק בסנכרון מצטבר (כאשר צוינו syncToken או updatedMin) או אם הדגל showDeleted מוגדר ל-true. השיטה get תמיד מחזירה אותן. סטטוס 'בוטל' מייצג שני מצבים שונים, בהתאם לסוג האירוע: חריגים שבוטלו של אירוע חוזר שלא בוטל מציינים שאין להציג יותר את המופע הזה למשתמש. לקוחות צריכים לאחסן את האירועים האלה למשך כל משך החיים של האירוע החוזר ההורה. חריגות שבוטלו מובטחות רק ערכים בשדות id, recurringEventId ו-originalStartTime. יכול להיות שהשדות האחרים יהיו ריקים. כל שאר האירועים שבוטלו מייצגים אירועים שנמחקו. על הלקוחות להסיר את העותקים שסונכרנו באופן מקומי. אירועים מבוטלים כאלה ייעלמו בסופו של דבר, לכן לא כדאי להסתמך עליהם שיהיו זמינים לזמן בלתי מוגבל. יכול להיות שהשדה id יאוכלס רק באירועים שנמחקו. ביומן של המארגן, אירועים שבוטלו ממשיכים לחשוף את פרטי האירוע (סיכום, מיקום וכו') כדי שאפשר יהיה לשחזר אותם (לבטל את המחיקה). באופן דומה, האירועים שאליהם המשתמש הוזמן ושאותו המשתמש הסיר באופן ידני ימשיכו לספק פרטים. עם זאת, בקשות לסנכרון מצטבר שבהן הערך של showDeleted מוגדר כ-False לא יחזירו את הפרטים האלה. אם המארגן של אירוע משנה את המארגן שלו (למשל, על ידי פעולת העברה) והמארגן המקורי לא נכלל ברשימת המשתתפים, הוא ישאיר אחרי אירוע מבוטל שבו רק השדה id יאוכלס.	ניתן לכתיבה
summary	string	שם האירוע.	ניתן לכתיבה
transparency	string	האם האירוע חוסם זמן ביומן. זה שינוי אופציונלי. הערכים האפשריים הם: 'opaque' – ערך ברירת המחדל. האירוע כן חוסם את הזמן ביומן. האפשרות הזו זהה להגדרה של הצג אותי במצב עסוק בממשק המשתמש של יומן Google. 'transparent' – האירוע לא חוסם את הזמן ביומן. ההגדרה הזו מקבילה להגדרת Show me as כ-זמין בממשק המשתמש של יומן 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

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

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

הוספה

יצירת אירוע.

מכונות

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

list

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

העברה

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

patch

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

quickAdd

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

עדכון

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

שעון

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