משאב של המניפסט של 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

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

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

unconditional

object

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

SelectAction

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

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

string

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

ראו פרטים נוספים על יצירת פונקציית הטריגר

text

string

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