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

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

עורכים

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