ה-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 |
קבצים מצורפים של האירוע. כדי לשנות קבצים מצורפים, צריך להגדיר את פרמטר הבקשה אפשר לצרף עד 25 קבצים לכל אירוע, |
|
attachments[].fileId |
string |
המזהה של הקובץ המצורף. קריאה בלבד. לקבצים ב-Google Drive, זהו המזהה של רשומת המשאב |
|
attachments[].fileUrl |
string |
קישור לכתובת ה-URL של הקובץ המצורף. כדי להוסיף קבצים מ-Google Drive, צריך להשתמש בפורמט זהה לזה של המאפיין נדרש בעת הוספת קובץ מצורף. |
ניתן לכתיבה |
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 |
סטטוס התשובה של המשתתף. הערכים האפשריים הם:
|
ניתן לכתיבה |
attendees[].self |
boolean |
אם הרשומה הזו מייצגת את היומן שבו מופיע העותק הזה של האירוע. קריאה בלבד. ערך ברירת המחדל הוא False. | |
colorId |
string |
הצבע של האירוע. זהו מזהה שמתייחס לרשומה בקטע event של הגדרת הצבעים (מידע נוסף זמין ב נקודת הקצה של הצבעים). זה שינוי אופציונלי. |
ניתן לכתיבה |
conferenceData |
nested object |
מידע שקשור לשיחת הוועידה, כמו פרטים של שיחת ועידה ב-Google Meet. כדי ליצור פרטים חדשים של שיחת הוועידה, צריך להשתמש בשדה createRequest . כדי לשמור על השינויים, חשוב לזכור להגדיר את פרמטר הבקשה conferenceDataVersion ל-1 בכל הבקשות לשינוי אירועים. |
ניתן לכתיבה |
conferenceData.conferenceId |
string |
המזהה של שיחת הוועידה. יכול לשמש מפתחים למעקב אחר שיחות ועידה. אין להציג אותו למשתמשים. הפורמט של ערך המזהה לכל סוג של פתרון שיחת ועידה שונה:
|
|
conferenceData.conferenceSolution |
nested object |
הפתרון לשיחת ועידה, למשל Google Meet. ביטול ההגדרה לשיחת ועידה שנכשלה. צריך להזין |
|
conferenceData.conferenceSolution.iconUri |
string |
הסמל הגלוי למשתמש של הפתרון הזה. | |
conferenceData.conferenceSolution.key |
nested object |
המפתח שיכול לזהות באופן ייחודי את הפתרון לשיחת ועידה באירוע הזה. | |
conferenceData.conferenceSolution.key.type |
string |
סוג הפתרון של שיחת הוועידה. אם לקוח נתקל בסוג לא מוכר או ריק, הוא עדיין יכול להציג את נקודות הכניסה. עם זאת, הוא אמור למנוע שינויים. הערכים האפשריים הם:
|
|
conferenceData.conferenceSolution.name |
string |
השם של הפתרון הזה הגלוי למשתמש. לא מותאם לשוק המקומי. | |
conferenceData.createRequest |
nested object |
בקשה ליצור שיחת ועידה חדשה ולצרף אותה לאירוע. הנתונים נוצרים באופן אסינכרוני. כדי לבדוק אם הנתונים קיימים, צריך לבדוק את השדה status . צריך להזין |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
פתרון לשיחות ועידה, כמו Hangouts או Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
סוג הפתרון של שיחת הוועידה. אם לקוח נתקל בסוג לא מוכר או ריק, הוא עדיין יכול להציג את נקודות הכניסה. עם זאת, הוא אמור למנוע שינויים. הערכים האפשריים הם:
|
|
conferenceData.createRequest.requestId |
string |
המזהה הייחודי שנוצר על ידי הלקוח לבקשה הזו. לקוחות צריכים ליצור מחדש את המזהה הזה לכל בקשה חדשה. אם המזהה שסופק זהה לזה של הבקשה הקודמת, המערכת תתעלם מהבקשה. |
|
conferenceData.createRequest.status |
nested object |
סטטוס הבקשה ליצירת שיחת ועידה. | |
conferenceData.createRequest.status.statusCode |
string |
הסטטוס הנוכחי של הבקשה ליצירת שיחת ועידה. קריאה בלבד. הערכים האפשריים הם:
|
|
conferenceData.entryPoints[] |
list |
מידע על נקודות כניסה נפרדות לשיחות ועידה, כמו כתובות URL או מספרי טלפון. כולם צריכים להשתייך לאותה שיחת ועידה. צריך להזין |
|
conferenceData.entryPoints[].accessCode |
string |
קוד הגישה לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות { זה שינוי אופציונלי. |
|
conferenceData.entryPoints[].entryPointType |
string |
הסוג של נקודת הכניסה לשיחת הוועידה. הערכים האפשריים הם:
|
|
conferenceData.entryPoints[].label |
string |
התווית של ה-URI. גלוי למשתמשי הקצה. לא מותאם לשוק המקומי. האורך המקסימלי הוא 512 תווים. דוגמאות:
זה שינוי אופציונלי. |
|
conferenceData.entryPoints[].meetingCode |
string |
קוד הפגישה כדי להיכנס לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות { זה שינוי אופציונלי. |
|
conferenceData.entryPoints[].passcode |
string |
קוד הגישה לכניסה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות { |
|
conferenceData.entryPoints[].password |
string |
הסיסמה לכניסה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות { זה שינוי אופציונלי. |
|
conferenceData.entryPoints[].pin |
string |
קוד הגישה כדי להיכנס לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. כשיוצרים נתונים חדשים של שיחת ועידה, צריך לאכלס רק את קבוצת המשנה של השדות { זה שינוי אופציונלי. |
|
conferenceData.entryPoints[].uri |
string |
ה-URI של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים. פורמט:
|
|
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 |
סוג ספציפי של האירוע. אי אפשר לשנות את ההגדרה הזו אחרי שהאירוע נוצר. הערכים האפשריים הם:
|
ניתן לכתיבה |
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 |
מצב התצוגה של הגאדג'ט. הוצא משימוש. הערכים האפשריים הם:
|
ניתן לכתיבה |
gadget.height |
integer |
גובה הגאדג'ט בפיקסלים. הגובה חייב להיות מספר שלם הגדול מ-0. זה שינוי אופציונלי. הוצא משימוש. | ניתן לכתיבה |
gadget.iconLink |
string |
כתובת האתר של סמל הגאדג'ט. סכימת כתובת ה-URL חייבת להיות HTTPS. הוצא משימוש. | ניתן לכתיבה |
gadget.link |
string |
כתובת ה-URL של הגאדג'ט. סכימת כתובת ה-URL חייבת להיות HTTPS. הוצא משימוש. | ניתן לכתיבה |
gadget.preferences |
object |
העדפות. | ניתן לכתיבה |
gadget.preferences.(key) |
string |
שם ההעדפה והערך התואם. | |
gadget.title |
string |
כותרת הגאדג'ט. הוצא משימוש. | ניתן לכתיבה |
gadget.type |
string |
סוג הגאדג'ט. הוצא משימוש. | ניתן לכתיבה |
gadget.width |
integer |
רוחב הגאדג'ט בפיקסלים. הרוחב חייב להיות מספר שלם הגדול מ-0. זה שינוי אופציונלי. הוצא משימוש. | ניתן לכתיבה |
guestsCanInviteOthers |
boolean |
האם משתתפים אחרים מלבד המארגן יכולים להזמין אחרים לאירוע. זה שינוי אופציונלי. ערך ברירת המחדל הוא True. | ניתן לכתיבה |
guestsCanModify |
boolean |
האם משתתפים אחרים מלבד המארגן יכולים לשנות את האירוע. זה שינוי אופציונלי. ערך ברירת המחדל הוא False. | ניתן לכתיבה |
guestsCanSeeOtherGuests |
boolean |
אם משתתפים אחרים לא מהמארגן יכולים לראות מי המשתתפים באירוע. זה שינוי אופציונלי. ערך ברירת המחדל הוא True. | ניתן לכתיבה |
hangoutLink |
string |
קישור מוחלט ל-Google Hangouts המשויך לאירוע הזה. קריאה בלבד. | |
htmlLink |
string |
קישור מוחלט לאירוע הזה בממשק המשתמש של יומן Google באינטרנט. קריאה בלבד. | |
iCalUID |
string |
מזהה ייחודי של אירוע, כפי שמוגדר ב-RFC5545. הוא משמש לזיהוי ייחודי של אירועים במערכות יומן, וצריך לספק אותו כשמייבאים אירועים באמצעות שיטת הייבוא. הערה: הערכים |
|
id |
string |
מזהה אטום של האירוע. כשיוצרים אירועים חדשים או אירועים חוזרים, אפשר לציין את המזהים שלהם. המזהים שאתם מספקים חייבים לעמוד בכללים הבאים:
אם לא תציינו מזהה, הוא יופק באופן אוטומטי על ידי השרת. הערה: הערכים |
ניתן לכתיבה |
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, לדוגמה "אירופה/ציריך".) לאירועים חוזרים, השדה הזה הוא חובה והוא מציין את אזור הזמן שבו החזרה מורחבת. לאירועים בודדים, השדה הזה הוא אופציונלי ומציין אזור זמן מותאם אישית בשביל ההתחלה/הסיום של האירוע. | ניתן לכתיבה |
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 |
השיטה שבה נעשה שימוש בתזכורת הזו. הערכים האפשריים הם:
חובה בעת הוספת תזכורת. |
ניתן לכתיבה |
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 |
סטטוס האירוע. זה שינוי אופציונלי. הערכים האפשריים הם:
|
ניתן לכתיבה |
summary |
string |
שם האירוע. | ניתן לכתיבה |
transparency |
string |
האם האירוע חוסם זמן ביומן. זה שינוי אופציונלי. הערכים האפשריים הם:
|
ניתן לכתיבה |
updated |
datetime |
מועד השינוי האחרון של נתוני האירוע הראשיים (כחותמת זמן מסוג RFC3339). העדכון של תזכורות לאירועים לא יגרום לשינוי הזה. קריאה בלבד. | |
visibility |
string |
הרשאות הגישה של האירוע. זה שינוי אופציונלי. הערכים האפשריים הם:
|
ניתן לכתיבה |
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 |
המיקום של מיקום העבודה. הערכים האפשריים הם:
חובה כשמוסיפים מאפיינים של מיקום עבודה. |
ניתן לכתיבה |
שיטות
- מחיקה
- מוחקים אירוע.
- הורדה
- מחזיר אירוע לפי המזהה שלו ביומן Google. כדי לאחזר אירוע באמצעות מזהה ה-icalendar שלו, קוראים לmethod שלevents.list באמצעות הפרמטר
iCalUID
. - ייבוא
- מייבאת אירוע. הפעולה הזו משמשת להוספת עותק פרטי של אירוע קיים ליומן. ניתן לייבא רק אירועים עם
eventType
שלdefault
.התנהגות שהוצאה משימוש: אם מייבאים אירוע שאינו
default
, הסוג שלו ישתנה ל-default
וכל המאפיינים הספציפיים לסוג אירוע מסוים יוסרו. - הוספה
- יוצר אירוע.
- מכונות
- מחזירה מופעים של האירוע החוזר שצוין.
- list
- מחזירה אירועים ביומן שצוין.
- העברה
- מעביר אירוע ליומן אחר, כלומר משנה את המארגן של האירוע. לתשומת ליבכם: אפשר להעביר רק
default
אירועים. לא ניתן להעביר את האירועיםoutOfOffice
,focusTime
,workingLocation
ו-fromGmail
. - תיקון
- מעדכנת אירוע. השיטה הזו תומכת בסמנטיקה של תיקונים. חשוב לזכור שכל בקשת תיקון צורכת שלוש יחידות מכסה; עדיף להשתמש ב-
get
ואחריוupdate
. ערכי השדות שמציינים מחליפים את הערכים הקיימים. שדות שלא תציינו בבקשה יישארו ללא שינוי. אם צוינו שדות מערך, הם יחליפו את המערכים הקיימים. הפעולה הזו מוחקת את כל רכיבי המערך הקודמים. - quickAdd
- יצירת אירוע על סמך מחרוזת טקסט פשוטה.
- עדכון
- מעדכנת אירוע. השיטה הזו לא תומכת בסמנטיקה של תיקונים והיא תמיד מעדכנת את כל משאב האירוע. כדי לבצע עדכון חלקי, צריך לבצע
get
ואחריוupdate
באמצעות etags כדי להבטיח אטימוּת. - שעון
- חשוב לשים לב לשינויים במשאבי האירועים.