טריגרים לתוספים של Google Workspace

טריגרים של Apps Script גורמים לפונקציית סקריפט מסוימת (פונקציית הטריגר) לפעול בכל פעם שמתרחש אירוע ספציפי. רק אירועים מסוימים יכולים לגרום להפעלה של טריגרים, וכל אפליקציה של Google Workspace תומכת בקבוצה שונה של אירועים.

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

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

בדף זה מפורטות הנחיות לשימוש בטריגרים בפרויקטים של תוספים ל-Google Workspace.

טריגרים של מניפסט

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

טריגרים של מניפסט מוגדרים לחלוטין במניפסט של התוסף של Google Workspace. דוגמאות לטריגרים של מניפסט:

  • טריגרים לדף הבית שיוצרים ומציגים את דף הבית של התוסף.
  • טריגרים מסוג eventOpen ביומן שמציגים כרטיס חדש או מבצעים פעולות אחרות כשאירוע נפתח ביומן.
  • טריגרים של eventUpdate ביומן, שמאפשרים להציג כרטיס חדש או לבצע פעולות אחרות כשמשתמש עורך ושומר אירוע ביומן.
  • טריגרים של Drive onItemsSelected במטרה להציג כרטיס חדש או לבצע פעולות אחרות כשמשתמש בוחר קובץ אחד או יותר או תיקייה אחת או יותר ב-Drive.
  • טריגרים לכתיבה ב-Gmail שמציגים כרטיס של תוסף כשהמשתמש פותח את התוסף בחלון הכתיבה ב-Gmail.
  • טריגרים לפי הקשר ב-Gmail שמציגים כרטיס חדש או מבצעים פעולות אחרות כשהמשתמש פותח הודעה ב-Gmail.
  • טריגרים מסוג Editor onFileScopeGranted שמציגים כרטיס חדש כשמשתמשים נותנים הרשאה להיקף ה-OAuth drive.file במסמך הנוכחי ב-Editor.

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

בנוסף לטריגרים של המניפסט, תוספי Google Workspace יכולים להשתמש בטריגרים להתקנה של Apps Script.

הגבלות

יש הגבלות מסוימות על השימוש בטריגרים של מניפסט.

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