אובייקטים מסוג Action מאפשרים לכם ליצור התנהגות אינטראקטיבית בתוספים ל-Google Workspace. הם מגדירים מה קורה כשמשתמש מבצע אינטראקציה עם ווידג'ט (למשל, לחצן) בממשק המשתמש של התוסף.
פעולה מצורפת לווידג'ט נתון באמצעות פונקציית טיפול בווידג'ט, שמגדירה גם את התנאי שמפעיל את הפעולה. כשהפעולה מופעלת, היא מבצעת פונקציית קריאה חוזרת שהוגדרה מראש. לפונקציית ה-callback מועבר אובייקט אירוע שמכיל מידע על האינטראקציות של המשתמש בצד הלקוח. צריך להטמיע את פונקציית ה-callback ולגרום לה להחזיר אובייקט תגובה ספציפי.
לדוגמה, נניח שאתם רוצים ליצור לחצן שיוצר כרטיס חדש ומציג אותו כשלוחצים עליו. לשם כך, צריך ליצור ווידג'ט לחצן חדש ולהשתמש בפונקציית הטיפול בווידג'ט הלחצן setOnClickAction(action) כדי להגדיר Action ליצירת כרטיסים. הערך של Action שצריך להגדיר מציין פונקציית קריאה חוזרת של Apps Script שתתבצע כשמקישים על הלחצן. במקרה כזה, צריך להטמיע את פונקציית הקריאה החוזרת כדי ליצור את הכרטיס הרצוי ולהחזיר אובייקט ActionResponse. אובייקט התגובה מורה לתוסף להציג את הכרטיס שפונקציית הקריאה החוזרת יצרה.
בדף הזה מתוארות פעולות של ווידג'טים שספציפיות ל-Gmail, שאפשר לכלול בתוסף.
אינטראקציות ב-Gmail
תוספים של Google Workspace שמרחיבים את Gmail יכולים לכלול פעולת ווידג'ט נוספת ספציפית ל-Gmail לכתיבה של טיוטות של הודעות. כדי לבצע את הפעולה הזו, פונקציית הקריאה החוזרת של הפעולה המשויכת צריכה להחזיר אובייקט תגובה מיוחד:
| ניסיון הפעולה | פונקציית הקריאה החוזרת צריכה להחזיר |
|---|---|
| כתיבת טיוטות של הודעות | ComposeActionResponse |
כדי להשתמש באובייקטים של התגובה ובפעולות הווידג'ט האלה, התוסף צריך לכלול את היקף https://www.googleapis.com/auth/gmail.addons.current.action.compose במניפסט שלו.
כתיבת הודעה
תוסף ל-Google Workspace שמרחיב את Gmail יכול להגדיר ווידג'ט, שבאמצעותו אפשר ליצור טיוטות של הודעות ב-Gmail (הודעות חדשות או תשובות). כדי לעשות זאת, צריך לשייך את הווידג'ט שמפעיל את האירוע לפונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse. כשפונקציית הקריאה החוזרת מסתיימת, Gmail משתמש באובייקט התגובה הזה כדי לפתוח וליישב חלון כתיבה של טיוטה.
למידע נוסף ולדוגמה, ראו כתיבת טיוטות של הודעות.