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

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

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)

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

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

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

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

ComposeTrigger

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

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

string

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

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

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

text

string

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