משאב מניפסט של עריכה

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

עורכים

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

ייצוג JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
שדות
homepageTrigger

object (HomepageTrigger)

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

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

חובה אם התוסף כולל התנהגות ספציפית למסמך הנוכחי ב-Editor, ומופעל כשהמשתמש נותן הרשאה להיקף drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

חובה בתצוגות מקדימות של קישורים. רשימה של טריגרים לתצוגה מקדימה של קישורים בקובץ Google Docs, Sheets או Slides. מידע נוסף זמין במאמר תצוגה מקדימה של קישורים עם צ'יפים חכמים.

createActionTriggers[]

object (createActionTriggers)

חובה כשמדובר ביצירת משאבים של צד שלישי. רשימת טריגרים ליצירת משאבים בשירות של צד שלישי מתפריט ה-@. מידע נוסף מופיע במאמר איך יוצרים משאבים של צד שלישי באמצעות צ'יפים חכמים.

OnFileScopeGrantedTrigger

הגדרה של טריגר לפי הקשר שמופעל כשתיבת הדו-שיח של הבקשה להיקף הקובץ באמצעות CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); והמשתמש נותנים הרשאת היקף ל-drive.file.

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

string

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

LinkPreviewTriggers

ההגדרה של טריגר שמופעל כשמשתמש מקליד או מדביק קישור משירות של צד שלישי או משירות שאינו של Google בקובץ Docs, Sheets או Slides.

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

ייצוג JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
שדות
labelText

string

חובה. הטקסט של צ'יפ חכם לדוגמה שמבקש מהמשתמשים לראות תצוגה מקדימה של הקישור, כמו Example: Support case. הטקסט הזה סטטי ומוצג לפני שהמשתמשים מפעילים את התוסף.
localizedLabelText

map (key: string, value: string)

אפשרות. מפה של labelText להתאמה לשוק המקומי לשפות אחרות. פורמט השפה ב-ISO 639 והמדינה/האזור צריכים להיות בפורמט ISO 3166, מופרדים במקף -. לדוגמה, en-US

אם הלוקאל של המשתמש מופיע במפתחות של המפה, המשתמש יראה את הגרסה של labelText המותאמת לשוק המקומי.

patterns[]

object (UriPattern)

חובה. מערך של תבניות URL שגורמות לתוסף להציג תצוגה מקדימה של קישורים.
runFunction

string

חובה. שם הפונקציה שתרוץ כשהמשתמש יאשר את ההיקף של https://www.googleapis.com/auth/workspace.linkpreview. אם צוין, יש להטמיע את הפונקציה הזו כדי לקבל אובייקט אירוע שמכיל EDITOR_NAME.matchedUrl.url כארגומנט ולהחזיר אובייקט Card יחיד שמציג תצוגה מקדימה של קישור בממשק המשתמש של התוסף.
logoUrl

string

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

UriPattern

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

ייצוג JSON
{
  "hostPattern": string,
  "pathPrefix" : string
}
שדות
hostPattern

string

חובה לכל תבנית כתובת URL לתצוגה מקדימה.הדומיין של תבנית ה-URL. התצוגות המקדימות של התוסף כוללות את הדומיין הזה בכתובת ה-URL. כדי לראות תצוגה מקדימה של קישורים לתת-דומיין ספציפי, כמו subdomain.example.com, צריך לכלול את תת-הדומיין. כדי לראות תצוגה מקדימה של קישורים עבור הדומיין כולו, צריך לציין תו כללי לחיפוש עם כוכבית (*) בתור תת-הדומיין.

לדוגמה, *.example.com תואם עם subdomain.example.com ועם another.subdomain.example.com.

pathPrefix

string

אפשרות. הנתיב שמוסיף את הדומיין של hostPattern.

לדוגמה, אם תבנית המארח של כתובת ה-URL היא support.example.com, כדי להתאים לכתובות URL במקרים שמתארחים ב-support.example.com/cases/, משתמשים ב-cases.

כדי להתאים לכל כתובות ה-URL בדומיין של תבנית המארח, צריך להשאיר את השדה pathPrefix ריק.

CreateActionTriggers

ההגדרה של טריגר שמופעל כשמשתמש בוחר אפשרות בתפריט של שילוב צד שלישי מתפריט ה-@ של Google Docs.

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

ייצוג JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
שדות
id

string

חובה. המזהה הייחודי כדי להבדיל את נקודת התוסף הזו. המזהה יכול להכיל עד 64 תווים, והוא צריך להיות בפורמט [a-zA-Z0-9-]+..
labelText

string

חובה. הטקסט שמופיע בתפריט ה-@, כמו Create support case.
localizedLabelText

map (key: string, value: string)

אפשרות. מפה של labelText להתאמה לשוק המקומי לשפות אחרות. פורמט השפה ב-ISO 639 והמדינה/האזור צריכים להיות בפורמט ISO 3166, מופרדים במקף -. לדוגמה, en-US

אם הלוקאל של המשתמש מופיע במפתחות של המפה, המשתמש יראה את הגרסה של labelText המותאמת לשוק המקומי.

runFunction

string

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

string

אפשרות. הסמל שיופיע בתפריט ה-@. אם התוסף יושמט, הוא ישתמש בסמל סרגל הכלים, logoUrl.