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": {
    "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[].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: ID הוא שם ה-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-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 של נקודת הכניסה. האורך המרבי הוא 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" – אירוע מיקום עבודה.
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.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. המזהה משמש לאירועים באופן ייחודי במערכות של יומנים, ויש לספק אותו כאשר מייבאים אירועים באמצעות שיטת ייבוא.

לתשומת ליבכם: 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 במקרה של אירוע חוזר, זה הזמן שבו האירוע הזה יתחיל בהתאם לנתוני החזרה של האירוע החוזר המזוהה על ידי מופע חוזר. הוא מזהה באופן ייחודי את המופע בתוך סדרת האירועים החוזרים, גם אם המכונה הועברה לזמן אחר. לא ניתן לשינוי.
originalStartTime.date date התאריך, בפורמט "yyyy-mm-dd", אם הוא חלק מאירוע שנמשך כל היום. ניתן לכתיבה
originalStartTime.dateTime datetime השעה כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה להזין הבדלי זמן באזור הזמן, אלא אם אזור הזמן הוגדר במפורש בשדה timeZone. ניתן לכתיבה
originalStartTime.timeZone string אזור הזמן שמציין את השעה. (מוגדר כשם מסד הנתונים של אזור הזמן IANA, לדוגמה "Europe/Zurich".) עבור אירועים חוזרים, זהו שדה חובה והוא מציין את אזור הזמן שבו החזרה תתרחב. עבור אירועים בודדים, השדה הזה אופציונלי ומציין אזור זמן מותאם אישית להתחלה/לסיום של האירוע. ניתן לכתיבה
privateCopy boolean אם המדיניות מוגדרת כ-True, הפצת אירועים מושבתת. שימו לב: זה לא אותו הדבר כמו מאפייני אירועים פרטיים. אופציונלי. לא ניתן לשינוי. ברירת המחדל היא False.
recurrence[] list רשימה של שורות RRULE, EXRULE, 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" – האירוע בוטל (נמחק). השיטה 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 שלו. כדי לאחזר אירוע באמצעות מזהה ה-iCalendar שלו, מפעילים את השיטה events.list באמצעות הפרמטר iCalUID.
ייבוא
מייבא אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן.
הוספה
יצירת אירוע.
מופעים
החזרה של מופעים של האירוע החוזר שצוין.
list
מחזיר אירועים ביומן שצוין.
העברה
מעביר אירוע ליומן אחר, כלומר משנה את המארגן של האירוע.
תיקון
מעדכנת אירוע. שיטה זו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. עדיף להשתמש ב-get ואחריו update. ערכי השדה שתציינו יחליפו את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם ערכי המערכים שצוינו קיימים, הם מחליפים את המערכים הקיימים. הפעולה הזו מבטלת את המערכים הקודמים של המערכים.
QuickAdd
יצירת אירוע על סמך מחרוזת טקסט פשוטה.
עדכון
מעדכנת אירוע. שיטה זו לא תומכת בסמנטיקה של תיקון ותמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, צריך לבצע get ולאחר מכן update באמצעות etags כדי להבטיח פעילות אטומית.
שעון
שימו לב לשינויים במשאבי האירועים.