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

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

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

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

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

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

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

פיתוח הממשק של התוסף ביומן

אתם יכולים להרחיב את Google Calendar באמצעות תוסף של Google Workspace. לשם כך, פועלים לפי השלבים הבאים:

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

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

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

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

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

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

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

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

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

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

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

מתבצע עדכון של אירועים ביומן

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

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

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

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

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

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

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

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