משאב של המניפסט של Gmail

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

Gmail

תצורת המניפסט של תוסף Google Workspace לתוספים ל-Gmail. למידע נוסף, ראו הרחבה של Gmail באמצעות תוספים ל-Google Workspace.

ייצוג JSON
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
שדות
authorizationCheckFunction

string

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

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

composeTrigger

object (ComposeTrigger)

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

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

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

המפרט של פונקציית הטריגר ליצירת דף הבית של התוסף במארח ב-Gmail. ההגדרה הזו מבטלת את addOns.common.homepageTrigger.

ComposeTrigger

התצורה של פעולת כתיבה. למידע נוסף, ראו הרחבה של ממשק המשתמש של כתיבת הודעות.

ייצוג JSON
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
שדות
draftAccess

string

המדיניות מגדירה את רמת הגישה לנתונים הזמינה לפונקציה של טריגר כתיבת אימייל. האפשרויות החוקיות הן:

  • NONE, הגדרת ברירת המחדל. זה גורם לכך שאובייקט האירוע שמועבר לפונקציה של הפעלת הכתיבה יהיה ריק ברובו.
  • METADATA, שמאכלס את אובייקט האירוע שהועבר לפונקציה של טריגר הכתיבה עם רשימות של נמענים של ההודעה. ההגדרה הזו מחייבת שהתוסף יכלול את ההיקף של gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

רשימה של פעולות כתיבה שיוצרות ממשקי משתמש של כתיבה. עם זאת, הרשימה הזו מוגבלת לפעולה אחת לכל תוסף. לפעולת הכתיבה יש סמל מתאים שמוצג בחלון הכתיבה של Gmail. הסמל מצוין על ידי gmail.logoUrl.

ContextualTrigger

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

ייצוג JSON
{
  "onTriggerFunction": string,
  "unconditional": {},
}
שדות
onTriggerFunction

string

חובה לכל טריגר לפי הקשר. השם של פונקציית הסקריפט של Apps שמופעלת כשהטריגר מופעל.

במאמר פונקציית טריגר לפי הקשר מוסבר איך להגדיר את הפונקציה הזו.

unconditional

object

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

SelectAction

התצורה של פעולת הכתיבה שקובעת איזו פונקציה תפעל כשהמשתמש בוחר את פעולת הכתיבה.

ייצוג JSON
{
  "runFunction": string,
  "text": string
}
שדות
runFunction

string

חובה לפעולות כתיבה. השם של פונקציית Apps Script שפעילה כשפעולת הכתיבה הזו נבחרת. הפונקציה של הפעלת הכתיבה יוצרת את ממשק המשתמש של כתיבת התוסף.

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

text

string

חובה לפעולות כתיבה. תיאור קצר של פעולת הכתיבה.