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

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

עורכים

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