פיתוח הממשקים של יומן Google

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

כשמפתחים ממשק של תוסף ליומן Google, אפשר לספק דף בית. אפשר להשתמש באותו דף בית לכמה מארחים, או לעצב דף בית ספציפי ליומן Google.

תוסף יכול גם להגדיר ממשק שמופיע כשהמשתמש פותח אירוע ביומן.

גישה לממשק המשתמש של התוסף

בהתאם לאופן שבו פותחים את התוסף, הוא יכול להגדיר ממשק של דף הבית, ממשק של אירוע ביומן Google, ממשק לבחירת קבצים מצורפים או את שלושתם:

• אם משתמש לוחץ על סמל התוסף בתצוגת היומן, התוסף מפעיל את הפונקציה התואמת calendar.homepageTrigger (אם היא קיימת). הפונקציה הזו יוצרת כרטיס לדף הבית ומחזירה אותו ליומן לתצוגה. אם לא מוגדרת פונקציה של calendar.homepageTrigger, מוצג במקומה כרטיס גנרי של דף הבית.
• אם המשתמש פותח אירוע ביומן ואז לוחץ על סמל התוסף, או אם התוסף פתוח כשהמשתמש פותח אירוע, התוסף מפעיל את הפונקציה התואמת של eventOpenTrigger (אם היא קיימת). הפונקציה הזו יוצרת את ממשק האירועים ביומן של התוסף וחוזרת ליומן Google כדי להציג אותו.
• אם התוסף מגדיר פונקציה של eventAttachmentTrigger, התוסף מופיע כספק קבצים מצורפים כשהמשתמש לוחץ על הוספת קובץ מצורף בזמן עריכת אירוע ביומן. כשבוחרים את התוסף, הפונקציה eventAttachmentTrigger יוצרת את ממשק בחירת הקבצים המצורפים של התוסף ומחזירה אותו ליומן Google לתצוגה.

יצירת ממשק היומן של התוסף

כדי להוסיף ליומן Google תוסף של Google Workspace, פועלים לפי השלבים הבאים:

1. מחליטים אם רוצים שלתוסף תהיה דף בית ספציפי ליומן. כדאי גם להחליט אם רוצים לספק ממשק מותאם אישית בזמן שהמשתמש עורך אירועים ביומן.
2. מוסיפים את השדות המתאימים addOns.common ו-addOns.calendar למניפסט של פרויקט הסקריפט של התוסף, כולל היקפי ההרשאות הנדרשים.
3. אם אתם מספקים דף בית ספציפי ליומן, אתם צריכים להטמיע את הפונקציה calendar.homepageTrigger כדי ליצור את הממשק הזה. אפשר גם להשתמש בממשק common.homepageTrigger למספר מארחים של Google Workspace.
4. אם אתם מספקים ממשק לאירוע ביומן, אתם צריכים להטמיע פונקציה של calendar.eventOpenTrigger כדי לבנות את הממשק הזה. פרטים נוספים זמינים במאמר בנושא הרחבת הממשק של אירועים ביומן.
5. מטמיעים את פונקציות הקריאה החוזרת שנדרשות כדי להגיב לאינטראקציות של המשתמש עם ממשק המשתמש, כמו לחיצות על כפתורים.

דפי הבית של יומן Google

יומן Google תומך בהצגת דפי הבית של תוספים ל-Google Workspace. כדי להציג את דף הבית המשותף של התוסף ביומן Google, פשוט מוודאים שיש שדה addOns.calendar במניפסט של התוסף.

אפשר גם להוסיף את התג calendar.homepageTrigger למניפסט של התוסף כדי לספק דף בית ספציפי ליומן.

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

הרחבת הממשק של אירוע ביומן

יומן Google מסתמך על טריגר הקשרי כדי לקבוע איזה ממשק (אם בכלל) יוצג כשהמשתמש עורך אירוע ביומן. כשהטריגר מופעל, הוא מפעיל את פונקציית הטריגר ההקשרית שצוינה בשדה calendar.eventOpenTrigger במניפסט של התוסף.

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

אובייקטים של אירועים

אובייקט אירוע נוצר ומועבר לפונקציית ההפעלה ההקשרית calendar.eventOpenTrigger כשמשתמש פותח אירוע ביומן. פונקציית הטריגר יכולה להשתמש במידע באובייקט האירוע הזה כדי לקבוע איך ליצור כרטיסי תוסף או לשלוט בהתנהגות התוסף. אובייקטים של אירועים נוצרים גם כשפותחים תוסף בפעם הראשונה, וכשהמשתמש לוחץ על ווידג'טים אינטראקטיביים או בוחר אותם, והם מועברים לפונקציות של homepageTrigger.

'אירועים ביומן'.

המבנה המלא של אובייקטים של אירועים מתואר במאמר אובייקטים של אירועים. כשיומן Google הוא אפליקציית המארח של התוסף, אובייקטים של אירועים להפעלת ווידג'טים וטריגרים לפי הקשר כוללים את השדה Calendar event object שמכיל מידע ספציפי ללקוח של יומן Google.

עדכון אירועים ביומן

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

• הוספת משתתף אחד או יותר.
• הסרה של משתתף אחד או יותר.
• הוספה או מעבר לפתרון אחר לשיחות ועידה.

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

הפרמטר calendar.eventUpdateTrigger משמש בדרך כלל לאחת או יותר מהפעולות הבאות:

• עדכון הממשק של אירוע ביומן של התוסף בתגובה לשינויים שמשתמשים מבצעים באירוע ביומן.
• סנכרון נתוני אירועים ביומן עם מערכת של צד שלישי, כמו מערכת ועידות שמתחברת ליומן Google.

אם התוסף צריך לבצע שינויים בנתונים של אירוע ביומן (למשל, ברשימת המשתתפים), צריך להגדיר את שדה המניפסט של התוסף calendar.currentEventAccess לערך WRITE או READ_WRITE. בנוסף, התוסף צריך לקבל את היקף ההרשאות https://www.googleapis.com/auth/calendar.addons.current.event.write.

הוספת פתרונות לשיחות ועידה

תוספים ל-Google Workspace.

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