משאב של המניפסט של 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 Script שמופעלת כשהטריגר מופעל.

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

unconditional

object

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

SelectAction

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

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

string

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

פרטים נוספים זמינים במאמר הוספת פונקציית טריגר.

text

string

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