יצירת ממשקים ליומן Google

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

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

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

איך ניגשים לממשק המשתמש של התוסף

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

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

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

כדי להרחיב את השימוש בתוסף Google Workspace ליומן Google:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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