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

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

עורכים

הגדרת המניפסט של תוסף 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 יוצג.