Events

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

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

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

{
  "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[].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 - המשתתף אישר את ההזמנה.
 ניתן לכתיבה
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-bbb-ccc
  • עבור 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 של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים.

פורמט:

  • נדרשת סכימה של video, http: או https:.
  • עבור phone, נדרשת סכימה tel:. ה-URI צריך לכלול את רצף החוגה כולו (לדוגמה, tel:+12345678900,,123456789;1234).
  • בשדה sip, נדרש הסכימה sip:, למשל: sip:12345678@myprovider.com.
  • נדרשת סכימה של 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 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.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. ניתן לכתיבה
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. כדי להחליף את שם המארגן, משתמשים בפעולה העברה. לקריאה בלבד, אלא אם מייבאים אירוע. ניתן לכתיבה
organizer.displayName string שם המארגן, אם קיים. ניתן לכתיבה
organizer.email string כתובת האימייל של מארגן/ת הפגישה, אם יש כזו. זו חייבת להיות כתובת אימייל תקינה בהתאם ל-RFC5322. ניתן לכתיבה
organizer.id string מזהה הפרופיל של המארגן, אם יש כזה.
organizer.self boolean האם מארגן האירוע תואם ליומן שבו מופיע העותק הזה של האירוע. קריאה בלבד. ברירת המחדל היא False.
originalStartTime nested object במקרה של אירוע חוזר, זוהי השעה שבה האירוע יתחיל בהתאם לנתוני החזרה באירוע החוזר שזוהה על ידי repeatedEventId. הוא מזהה באופן ייחודי את המופע בסדרת האירועים החוזרים, גם אם המכונה הועברה לזמן אחר. בלתי ניתן לשינוי.
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 רשימה של שורות Rכלל, EXכלל, 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 תמיד מחזירה אותן.

    סטטוס 'בוטל' מייצג שני מצבים שונים, בהתאם לסוג האירוע:

    1. חריגים שבוטלו של אירוע חוזר שלא בוטל מציינים שכבר לא צריך להציג את המופע הזה למשתמש. על הלקוחות לאחסן את האירועים האלה לכל משך החיים של האירוע החוזר הראשי.

      במקרה של חריגים שבוטלו, מובטח רק ערכים של השדות id, recurringEventId ו-originalStartTime. יכול להיות שהשדות האחרים יהיו ריקים.

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

      כשמדובר באירועים שנמחקו, רק השדה 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 שלו, קוראים לmethod שלevents.list באמצעות הפרמטר iCalUID.
import
מייבאת אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. ניתן לייבא רק אירועים עם eventType של default.

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

הוספה
יוצר אירוע.
instances
מחזירה מופעים של האירוע החוזר שצוין.
list
מחזירה אירועים ביומן שצוין.
העברה
מעביר אירוע ליומן אחר, כלומר משנה את המארגן של האירוע. לתשומת ליבכם: אפשר להעביר רק default אירועים. לא ניתן להעביר את האירועים birthday, focusTime, fromGmail, outOfOffice ו-workingLocation.
תיקון
מעדכנת אירוע. השיטה הזו תומכת בסמנטיקה של תיקונים. חשוב לזכור שכל בקשת תיקון צורכת שלוש יחידות מכסה; עדיף להשתמש ב-get ואחריו update. ערכי השדות שמציינים מחליפים את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם יחליפו את המערכים הקיימים. הפעולה הזו מוחקת את כל רכיבי המערך הקודמים.
quickAdd
יצירת אירוע על סמך מחרוזת טקסט פשוטה.
עדכון
מעדכנת אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקונים והיא תמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, צריך לבצע get ואחריו update באמצעות etags כדי להבטיח אטימוּת.
שעון
חשוב לשים לב לשינויים במשאבי האירועים.