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

הגדרת המשאב שמשמשת להגדרת התוכן וההתנהגות של תוסף ל-Google Workspace בתוך כלי העריכה. מניפסטים של תוספים ל-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)

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

ההגדרה של טריגר שמופעל כשמשתמש מקליד או מדביק קישור משירות צד שלישי בקובץ 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, עם מקף - ביניהם.
patterns[]

object (UriPattern)

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

string

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

string

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

UriPattern

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

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

string

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

string

אופציונלי. הנתיב שנוסף לדומיין. כדי להתאים את כל כתובות ה-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, עם מקף - ביניהם.
runFunction

string

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

string

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