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

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

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

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

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

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

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

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

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

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

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

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

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

בכל מקרה, אתם צריכים לספק את השם של פונקציית הפעלה של דף הבית בפרויקט הסקריפט של התוסף. המערכת קוראת לפונקציה הזו באופן אוטומטי כדי ליצור את דף הבית של היומן כשצריך. מטמיעים את הפונקציה הזו כדי ליצור ולהחזיר אובייקט 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 משמש בדרך כלל לביצוע אחת או יותר מהפעולות הבאות:

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

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

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

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

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