התוספים ל-Google Workspace יכולים לספק ממשקים מותאמים אישית כשהמשתמש צופה ביומנים ובאירועים ביומן או עורך אותם. כך תוכלו לספק למשתמשים עוד מידע רלוונטי, להפוך משימות לאוטומטיות ולחבר ליומן Google מערכות של צד שלישי.
כשמפתחים ממשק תוסף ליומן Google, אתם יכולים לספק דף בית. אתם יכולים להשתמש באותו דף בית למספר מארחים, או לעצב דף בית ספציפי ליומן Google.
התוסף יכול גם להגדיר ממשק שמופיע כשהמשתמש פותח אירוע ביומן.
גישה לממשק המשתמש של התוסף
בהתאם לאופן שבו פותחים את התוסף, תוספים ל-Google Workspace יכולים להגדיר את הממשק של דף הבית, ממשק האירועים של יומן Google, ממשק לבחירת קבצים מצורפים או את כל השלושה:
- אם משתמש לוחץ על סמל התוסף בתצוגת יומן, התוסף יפעיל את הפונקציה
calendar.homepageTriggerהמתאימה (אם קיימת). הפונקציה הזו יוצרת ומחזירה כרטיס של דף הבית ליומן להצגה. אם לא מוגדרת פונקציהcalendar.homepageTrigger, יוצג במקום זאת כרטיס גנרי של דף הבית. - אם משתמש פותח אירוע ביומן ואז לוחץ על סמל התוסף, או אם התוסף פתוח כשהמשתמש פותח אירוע, התוסף יפעיל את הפונקציה
eventOpenTriggerהמתאימה (אם היא קיימת). הפונקציה הזו יוצרת את ממשק האירוע של התוסף ביומן Google וחוזרת ליומן Google להצגה. - אם בתוסף מוגדרת פונקציה
eventAttachmentTrigger, הוא יופיע כספק של קובץ מצורף כשהמשתמש ילחץ על צירוף קובץ בזמן עריכת אירוע ביומן. כשבוחרים את התוסף, הפונקציהeventAttachmentTriggerיוצרת את ממשק הבחירה לקבצים המצורפים של התוסף ומחזירה אותו לתצוגה ביומן Google.
פיתוח הממשק של התוסף ליומן Google
כדי להרחיב את יומן Google באמצעות תוסף של Google Workspace:
- מחליטים אם לתוסף יהיה דף בית ספציפי ליומן Google. עליכם גם להחליט אם אתם רוצים לספק ממשק מותאם אישית בזמן שהמשתמש עורך אירועים ביומן.
- מוסיפים את השדות
addOns.commonו-addOns.calendarבהתאם למניפסט של פרויקט התוסף, כולל היקפי הרשאות. - אם מספקים דף בית ספציפי ליומן, כדאי להטמיע את הפונקציה
calendar.homepageTriggerכדי ליצור את הממשק הזה. אפשר גם להשתמש בממשקcommon.homepageTriggerלכמה מארחים ב-Google Workspace. - אם אתם מספקים ממשק של אירועים ביומן, עליכם להטמיע פונקציית
calendar.eventOpenTriggerכדי ליצור את הממשק הזה. לפרטים נוספים, ראו הרחבת ממשק האירועים של יומן Google. - צריך להטמיע את פונקציות הקריאה החוזרת המשויכות שנדרשות כדי להגיב לאינטראקציות של המשתמש בממשק המשתמש, כמו לחיצות על לחצנים.
דפי הבית של יומן Google
אתם יכולים להציג דף בית לתוספים ל-Google Workspace ביומן Google.
כדי להציג את דף הבית המשותף של התוסף ביומן Google, צריך לוודא שהמניפסט של התוסף כולל שדה addOns.calendar.
אפשר גם להוסיף calendar.homepageTrigger למניפסט של התוסף כדי ליצור דף בית ספציפי ליומן.
בכל מקרה, אתם צריכים לציין את השם של פונקציית הטריגר בדף הבית בפרויקט הסקריפט של התוסף. הפונקציה מפעילה את הפונקציה הזו באופן אוטומטי כדי ליצור את דף הבית של יומן Google במקרה הצורך. צריך להטמיע את הפונקציה הזו כדי ליצור ולהחזיר אובייקט Card יחיד או מערך של אובייקטים מסוג Card שמרכיבים את דף הבית. פונקציית הטריגר בדף הבית מועברת כאובייקט אירוע כפרמטר שמכיל מידע כללי, כמו הפלטפורמה של הלקוח. אפשר להשתמש בנתונים של אובייקט האירוע כדי להתאים אישית את המבנה של דף הבית.
הרחבת ממשק האירועים של יומן Google
יומן Google מסתמך על טריגר לפי הקשר כדי לקבוע איזה ממשק (אם בכלל) יוצג כשהמשתמש עורך אירוע ביומן. כשהטריגר מופעל, הוא מריצים את פונקציית הטריגר לפי הקשר שצוינה בשדה calendar.eventOpenTrigger במניפסט התוסף.
עליכם להטמיע את הפונקציה בעלת השם בשדה calendar.eventOpenTrigger. הפונקציה הזו מקבלת אובייקט אירוע כארגומנט וחייבת להחזיר אובייקט Card יחיד או מערך של Card אובייקטים כדי להציג את האירוע ביומן Google בזמן שהאירוע פתוח.
אובייקטים של אירוע
אובייקט אירוע נוצר ומועבר לפונקציית הטריגר לפי הקשר calendar.eventOpenTrigger כשמשתמש פותח אירוע ביומן. פונקציית הטריגר יכולה להשתמש במידע שבאובייקט האירוע הזה כדי לקבוע איך ליצור כרטיסי תוספים או איך לשלוט בהתנהגות של התוסף. אובייקטים של אירועים נוצרים ומועברים לפונקציות homepageTrigger בפעם הראשונה שפותחים תוסף, וכשהמשתמש לוחץ או בוחר בווידג'טים אינטראקטיביים.
המבנה המלא של אובייקטי אירועים מתואר בקטע אובייקטים של אירועים. כשיומן 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. בסקירה הכללית על שיחות ועידה של צד שלישי מוסבר איך בונים תוסף שמוסיף פתרונות חדשים לשיחות ועידה. אין צורך לבנות ממשק משתמש לתוסף מהסוג הזה. הפתרונות הנוספים פשוט מופיעים כאפשרויות בתפריט הנפתח בממשק המשתמש של האירוע ביומן Google.