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

הגדרת המשאב שמשמשת להגדרת התוכן וההתנהגות של תוסף ל-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)

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

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

ייצוג ב-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.