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

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

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

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

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

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

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

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

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

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

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

הגבלות

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

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