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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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