Events

ב-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,
  "eventLabelId": 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,
      "asyncOperation": string
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
שם הנכס ערך תיאור הערות
anyoneCanAddSelf boolean האם מישהו יכול להזמין את עצמו לאירוע (המאפיין הזה הוצא משימוש). אופציונלי. ברירת המחדל היא False. ניתן לכתיבה
attachments[] list קבצים שמצורפים לאירוע.

כדי לשנות קבצים מצורפים, צריך להגדיר את פרמטר הבקשה supportsAttachments לערך true.

אפשר לצרף לכל אירוע עד 25 קבצים,
attachments[].fileId string מזהה הקובץ המצורף. קריאה בלבד.

עבור קבצים ב-Google Drive, זהו המזהה של רשומת המשאב התואמת Files ב-Drive API.
attachments[].fileUrl string כתובת URL לקישור לקובץ המצורף.

כדי להוסיף קבצים מצורפים מ-Google Drive, משתמשים באותו פורמט כמו במאפיין alternateLink של משאב Files ב-Drive API.

חובה כשמוסיפים קובץ מצורף.

 ניתן לכתיבה
attachments[].mimeType string סוג המדיה באינטרנט (סוג MIME) של הקובץ המצורף.
attachments[].title string שם הקובץ המצורף.
attendeesOmitted boolean האם יכול להיות שמשתתפים לא נכללו בייצוג של האירוע. יכול להיות שהסיבה לכך היא הגבלה שצוינה בפרמטר השאילתה maxAttendee. כשמעדכנים אירוע, אפשר להשתמש בפרמטר הזה כדי לעדכן רק את התשובה של המשתתף. אופציונלי. ברירת המחדל היא False. ניתן לכתיבה
attendees[] list המשתתפים באירוע. מידע נוסף על תזמון אירועים עם משתמשים אחרים ביומן זמין במאמר אירועים עם משתתפים. חשבונות שירות צריכים להשתמש בהענקת הרשאות גישה ברמת הדומיין כדי לאכלס את רשימת המשתתפים. ניתן לכתיבה
attendees[].additionalGuests integer מספר האורחים הנוספים. אופציונלי. ערך ברירת המחדל הוא 0. ניתן לכתיבה
attendees[].asyncOperation string אם קיים, מציין את הסטטוס של פעולה אסינכרונית שמתבצעת עבור המשתתף הזה (למשל, רשימה של חברים בקבוצות גדולות של משתתפים). קריאה בלבד. ברירת המחדל היא לא להציג את השדה.

הערכים האפשריים הם:

  • ‫inProgress – הפעולה האסינכרונית מתבצעת.
  • ‫(not present) – אחרת.
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.
birthdayProperties nested object נתונים של ימי הולדת או אירועים מיוחדים. המאפיין הזה משמש אם הערך של eventType הוא "birthday". אי אפשר לשנות. ניתן לכתיבה
birthdayProperties.contact string שם המשאב של איש הקשר שאליו מקושר אירוע יום ההולדת הזה. אפשר להשתמש בזה כדי לאחזר פרטים של אנשי קשר מ-People API. פורמט: "people/c12345" קריאה בלבד.
birthdayProperties.customTypeName string תווית של סוג מותאם אישית שצוינה לאירוע הזה. השדה הזה יאוכלס אם הערך של birthdayProperties.type הוא "custom". קריאה בלבד.
birthdayProperties.type string סוג יום ההולדת או האירוע המיוחד. הערכים האפשריים הם:
  • "anniversary" – יום נישואין או אירוע אחר שאינו יום הולדת. תמיד יש contact.
  • ‫"birthday" – אירוע יום הולדת. זהו ערך ברירת המחדל.
  • ‫"custom" – תאריך מיוחד שהתווית שלו מצוינת בשדה customTypeName. תמיד יש contact.
  • ‫"other" – תאריך מיוחד שלא נכלל בקטגוריות האחרות, ואין לו תווית בהתאמה אישית. תמיד יש contact.
  • ‫"self" – יום ההולדת של הבעלים של היומן. אי אפשר להשתמש ב-contact.
Calendar API תומך רק ביצירת אירועים מהסוג "birthday". אי אפשר לשנות את הסוג אחרי שיוצרים את האירוע.		 ניתן לכתיבה
colorId string הצבע של האירוע. זהו מזהה שמתייחס לרשומה בקטע event בהגדרת הצבעים (ראו נקודת הקצה של הצבעים). אופציונלי. ניתן לכתיבה
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-ccc
  • ל-phone: ‎+1 123 268 2601
  • ‫for 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:.
  • חובה להשתמש בסכימה tel: בשביל phone. ה-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 של המשאב.
eventLabelId string המזהה של תווית האירוע שהוקצתה לאירוע. אופציונלי. המזהה הזה מתייחס למזהה של רשומה במאפיין labelProperties.eventLabels של היומן (ראו את נקודת הקצה Calendars.get).

הנכס הזה מחליף את הנכס colorId שמבוסס על אינדקס. כדי להגדיר או לשנות את המאפיין הזה, צריך לציין את הערך eventLabelVersion=1 בפרמטרים של השיטות insert,‏ import,‏ update ו-patch.

אם מגדירים מחרוזת ריקה או לא מגדירים את השדה הזה בכלל, התווית הקיימת תוסר מהאירוע.

 ניתן לכתיבה
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 הודעת תגובה שמוגדרת אם אירוע קיים או הזמנה חדשה נדחים אוטומטית על ידי היומן.
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 במקרה של מופע של אירוע חוזר, זהו הזמן שבו האירוע הזה יתחיל בהתאם לנתוני החזרה באירוע החוזר שמזוהה על ידי recurringEventId. המזהה הזה מזהה באופן ייחודי את המופע בסדרת האירועים החוזרים, גם אם המופע הועבר לשעה אחרת. אי אפשר לשנות.
originalStartTime.date date התאריך בפורמט yyyy-mm-dd, אם מדובר באירוע של יום שלם. ניתן לכתיבה
originalStartTime.dateTime datetime השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין את ההפרש מאזור הזמן, אלא אם מציינים אזור זמן באופן מפורש ב-timeZone. ניתן לכתיבה
originalStartTime.timeZone string אזור הזמן שבו מצוין הזמן. (בפורמט של שם במסד הנתונים IANA Time Zone Database, לדוגמה, 'Europe/Zurich'). באירועים חוזרים, חובה למלא את השדה הזה ולציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית לשעת ההתחלה או הסיום של האירוע. ניתן לכתיבה
outOfOfficeProperties nested object נתוני אירועים מסוג 'לא בעבודה'. המאפיין הזה משמש אם הערך של eventType הוא outOfOffice. ניתן לכתיבה
outOfOfficeProperties.autoDeclineMode string האם לדחות הזמנות לפגישות שחופפות לאירועים מסוג 'לא בעבודה'. הערכים האפשריים הם declineNone, כלומר לא נדחות הזמנות לפגישות; declineAllConflictingInvitations, כלומר נדחות כל ההזמנות לפגישות שחופפות לאירוע; ו-declineOnlyNewConflictingInvitations, כלומר נדחות רק הזמנות חדשות לפגישות שחופפות לאירוע, שמגיעות בזמן שהאירוע 'לא בעבודה' מופיע ביומן.
outOfOfficeProperties.declineMessage string הודעת תגובה שמוגדרת אם אירוע קיים או הזמנה חדשה נדחים אוטומטית על ידי היומן.
privateCopy boolean אם המדיניות מוגדרת כ-True, הפצת אירועים מושבתת. שימו לב: זה לא אותו דבר כמו מאפיינים של אירועים פרטיים. אופציונלי. אי אפשר לשנות. ברירת המחדל היא False.
recurrence[] list רשימה של שורות RRULE, ‏ EXRULE, ‏ RDATE ו-EXDATE לאירוע חוזר, כפי שמפורט ב-RFC5545. שימו לב שאסור להשתמש בשורות DTSTART ו-DTEND בשדה הזה. שעות ההתחלה והסיום של האירוע מצוינות בשדות start ו-end. השדה הזה לא מופיע באירועים בודדים או במופעים של אירועים חוזרים. ניתן לכתיבה
recurringEventId string במקרה של מופע של אירוע חוזר, זהו id של האירוע החוזר שאליו שייך המופע הזה. אי אפשר לשנות.
reminders object מידע על התזכורות לאירוע עבור המשתמש המאומת. שימו לב: שינוי התזכורות לא משנה את updated המאפיין של האירוע המכיל.
reminders.overrides[] list אם לאירוע לא מוגדרות תזכורות כברירת מחדל, בעמודה הזו מפורטות התזכורות הספציפיות לאירוע, או מצוין שלא מוגדרות תזכורות לאירוע הזה. המספר המקסימלי של תזכורות לביטול הוא 5. ניתן לכתיבה
reminders.overrides[].method string השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
  • ‫email – התזכורות נשלחות באימייל.
  • ‫popup – התזכורות נשלחות באמצעות חלון קופץ בממשק המשתמש.

חובה כשמוסיפים תזכורת.

 ניתן לכתיבה
reminders.overrides[].minutes integer מספר הדקות לפני תחילת האירוע שבהן התזכורת צריכה לפעול. הערכים התקפים הם בין 0 ל-40320 (4 שבועות בדקות).

חובה כשמוסיפים תזכורת.

 ניתן לכתיבה
reminders.useDefault boolean האם התזכורות שמוגדרות כברירת מחדל ביומן חלות על האירוע. ניתן לכתיבה
sequence integer מספר סידורי לפי iCalendar. ניתן לכתיבה
source object המקור שממנו נוצר האירוע. לדוגמה, דף אינטרנט, הודעת אימייל או כל מסמך שאפשר לזהות באמצעות כתובת URL עם סכימת HTTP או HTTPS. רק מי שיצר את האירוע יכול לראות או לשנות אותו.
source.title string הכותרת של המקור, למשל הכותרת של דף אינטרנט או נושא של אימייל. ניתן לכתיבה
source.url string כתובת ה-URL של המקור שמפנה למשאב. סכימת כתובת ה-URL חייבת להיות HTTP או HTTPS. ניתן לכתיבה
start nested object שעת ההתחלה (כולל) של האירוע. באירוע חוזר, זו שעת ההתחלה של המופע הראשון.
start.date date התאריך בפורמט yyyy-mm-dd, אם מדובר באירוע של יום שלם. ניתן לכתיבה
start.dateTime datetime השעה, כערך משולב של תאריך ושעה (בפורמט RFC3339). חובה לציין את ההפרש מאזור הזמן, אלא אם מציינים אזור זמן באופן מפורש ב-timeZone. ניתן לכתיבה
start.timeZone string אזור הזמן שבו מצוין הזמן. (בפורמט של שם במסד הנתונים IANA Time Zone Database, לדוגמה, 'Europe/Zurich'). באירועים חוזרים, חובה למלא את השדה הזה ולציין את אזור הזמן שבו התדירות מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית לשעת ההתחלה או הסיום של האירוע. ניתן לכתיבה
status string הסטטוס של האירוע. אופציונלי. הערכים האפשריים הם:
  • ‫confirmed – האירוע אושר. זהו סטטוס ברירת המחדל.
  • ‫tentative – האירוע אושר באופן זמני.
  • ‫"cancelled" – האירוע בוטל (נמחק). השיטה list מחזירה אירועים שבוטלו רק בסנכרון מצטבר (כשמציינים את syncToken או updatedMin) או אם הדגל showDeleted מוגדר לערך true. השיטה get תמיד מחזירה אותם.

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

    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 'officeLocation' – המשתמש עובד מהמשרד.
  • ‫customLocation – המשתמש עובד ממיקום מותאם אישית.
כל הפרטים מצוינים בשדה משנה של השם שצוין, אבל השדה הזה עשוי להיות חסר אם הוא ריק. המערכת תתעלם מכל שאר השדות.

חובה כשמוסיפים מאפיינים של מיקום עבודה.

 ניתן לכתיבה

Methods

מחיקה
‫
מחיקת אירוע.
לקבל
‫
מחזיר אירוע על סמך מזהה יומן Google שלו. כדי לאחזר אירוע באמצעות מזהה iCalendar שלו, צריך להפעיל את הפרמטר iCalUID ב-method ‏events.list.
ייבוא
‫
Imports an event. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. אפשר לייבא רק אירועים עם eventType של default.

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

הוספה
‫
יוצר אירוע.
instances
הפונקציה מחזירה מופעים של האירוע החוזר שצוין.
list
מחזירה אירועים ביומן שצוין.
העברה
העברת אירוע ליומן אחר, כלומר שינוי המארגן של האירוע. שימו לב שאפשר להעביר רק אירועים ב-default. אי אפשר להעביר אירועים ב-birthday, ב-focusTime, ב-fromGmail, ב-outOfOffice וב-workingLocation.
patch
עדכון אירוע. השיטה הזו תומכת בסמנטיקה של תיקון. שימו לב שכל בקשת תיקון צורכת שלוש יחידות מכסה. מומלץ להשתמש ב-get ואחריו ב-update. ערכי השדות שאתם מציינים מחליפים את הערכים הקיימים. השדות שלא צוינו בבקשה לא משתנים. אם מציינים שדות מסוג מערך, הם מחליפים את המערכים הקיימים, כך שכל רכיבי המערך הקודמים נמחקים.
quickAdd
‫
יצירת אירוע על סמך מחרוזת טקסט פשוטה.
עדכון
עדכון אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקון, ותמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, מבצעים get ואז update באמצעות תגי ETag כדי להבטיח אטומיות.
watch
שימו לב לשינויים במשאבי האירועים.