Package google.apps.script.type.gmail

אינדקס

• ComposeTrigger (מֶסֶר)
• ComposeTrigger.DraftAccess (טיפוסים בני מנייה)
• ContextualTrigger (מֶסֶר)
• GmailAddOnManifest (מֶסֶר)
• UnconditionalTrigger (מֶסֶר)
• UniversalAction (מֶסֶר)

ComposeTrigger

טריגר שמופעל כשהמשתמש כותב אימייל.

שדות
actions[]	MenuItemExtensionPoint מגדיר את קבוצת הפעולות של תוסף זמן כתיבה. אלו פעולות שמשתמשים יכולים להפעיל בתוסף זמן כתיבה.
draftAccess	DraftAccess המדיניות הזו מגדירה את רמת הגישה לנתונים כאשר תוסף זמן כתיבת הנתונים מופעל.

DraftAccess

טיפוסים בני מנייה (enum) שמגדיר את רמת הגישה לנתונים שנדרשת לטריגר הכתיבה.

טיפוסים בני מנייה (enums)
UNSPECIFIED	ערך ברירת המחדל כשלא הוגדר שום דבר ל-draftAccess.
NONE	לטריגר של כתיבת ההודעה אין גישה לנתונים של הטיוטה כשתוסף כתיבה מופעל.
METADATA	נותנת לטריגר הכתיבה הרשאה לגשת למטא-נתונים של הטיוטה, כשתוסף הכתיבה מופעל. המידע הזה כולל את רשימת החברים בקהל, כמו רשימת 'אל' ו'עותק' של טיוטת ההודעה.

ContextualTrigger

מגדיר טריגר שיופעל כשהאימייל הפתוח עומד בקריטריונים מסוימים. כשהטריגר מופעל, הוא מפעיל נקודת קצה (endpoint) ספציפית, בדרך כלל כדי ליצור כרטיסים חדשים ולעדכן את ממשק המשתמש.

שדות
onTriggerFunction	string חובה. השם של נקודת הקצה (endpoint) שאליה יש לקרוא כאשר הודעה תואמת לטריגר.
שדה איחוד trigger. סוג הטריגר קובע את התנאים שבהם Gmail משתמש כדי להציג את התוסף. הערך של trigger יכול להיות רק אחת מהאפשרויות הבאות:
unconditional	UnconditionalTrigger מפעילים ללא תנאי מופעלים כאשר כל הודעת דואר נפתחת.

GmailAddOnManifest

מאפיינים שמתאימים אישית את המראה וההפעלה של תוסף ל-Gmail.

שדות
homepageTrigger	HomepageExtensionPoint מגדירה נקודת קצה שתבוצע בהקשרים שלא תואמים לטריגר לפי הקשר שהוצהר. כרטיסים שנוצרו על ידי הפונקציה הזו תמיד יהיו זמינים למשתמש, אבל יכול להיות שיפסיד תוכן לפי הקשר כשהתוסף הזה מצהיר על טריגרים מטורגטים יותר. אם יש כזו, היא מבטלת את ההגדרה מ-addOns.common.homepageTrigger.
contextualTriggers[]	ContextualTrigger מגדיר את קבוצת התנאים שיפעילו את התוסף.
universalActions[]	UniversalAction מגדיר קבוצה של פעולות אוניברסליות לתוסף. המשתמש מפעיל פעולות אוניברסליות מתפריט סרגל הכלים של התוסף.
composeTrigger	ComposeTrigger מגדיר את הטריגר של זמן כתיבה לתוסף זמן כתיבה. זהו הטריגר שגורם לתוסף לפעול כשהמשתמש כותב אימייל. כל התוספים בזמן הכתיבה חייבים להיות בהיקף gmail.addons.current.action.compose, אף על פי שייתכן שהם לא יערכו את הטיוטה.
authorizationCheckFunction	string השם של נקודת קצה (endpoint) שמאמתת שלתוסף יש את כל ההרשאות הנדרשות מצד שלישי, על ידי בדיקת ממשקי ה-API של הצד השלישי. אם פונקציית הבדיקה נכשלת, הפונקציה צריכה לזרוק חריג כדי להתחיל את תהליך ההרשאה. הפונקציה הזו מופעלת לפני כל הפעלה של התוסף כדי להבטיח חוויית משתמש חלקה.

UnconditionalTrigger

אין שדות בסוג הזה.

טריגר שמופעל בכל פעם שהודעת אימייל כלשהי נפתחת.

UniversalAction

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

שדות
text	string חובה. טקסט גלוי למשתמש שמתאר את הפעולה, לדוגמה, 'הוספת איש קשר חדש'.
שדה איחוד action_type. סוג הפעולה קובע את ההתנהגות של Gmail כשהמשתמש מפעיל את הפעולה. הערך של action_type יכול להיות רק אחת מהאפשרויות הבאות:
openLink	string קישור שנפתח ב-Gmail כשהמשתמש מפעיל את הפעולה.
runFunction	string נקודת קצה מופעלת כשהמשתמש גורם לפעולה. לפרטים נוספים, אפשר לעיין במדריך הפעולות האוניברסלי.