Package google.apps.script.type.gmail

אינדקס

• ComposeTrigger (הודעה)
• ComposeTrigger.DraftAccess (enum)
• ContextualTrigger (הודעה)
• GmailAddOnManifest (הודעה)
• UnconditionalTrigger (הודעה)
• UniversalAction (הודעה)

ComposeTrigger

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

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

DraftAccess

מאפיין enum שמגדיר את רמת הגישה לנתונים שנדרשת לטריגר ה-Compose.

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

ContextualTrigger

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

שדות
onTriggerFunction	string חובה. השם של נקודת הקצה שאליה צריך לקרוא כשהודעה תואמת לטריגר.
שדה האיחוד 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 השם של נקודת קצה שמאמתת שלתוסף יש את כל ההרשאות הנדרשות מצד שלישי, על ידי בדיקה של ממשקי ה-API של הצד השלישי. אם הבדיקה נכשלת, הפונקציה צריכה להוציא חריגה כדי להתחיל את תהליך ההרשאה. הפונקציה הזו נקראת לפני כל הפעלה של התוסף כדי להבטיח חוויית משתמש חלקה.

UnconditionalTrigger

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

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

UniversalAction

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

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