REST Resource: projects.deployments

משאב: פריסה

פריסה של תוסף ל-Google Workspace

ייצוג JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
שדות
name

string

השם של משאב הפריסה. דוגמה: projects/123/deployments/my_deployment
oauthScopes[]

string

רשימת היקפי ההרשאות של OAuth של Google שנדרשת עבורן הסכמה ממשתמשי הקצה לפני הפעלה של נקודת קצה לתוסף.
addOns

object (AddOns)

ההגדרות האישיות של תוסף Google Workspace.
etag

string

השרת מחשב את הערך הזה על סמך גרסת הפריסה באחסון, והוא יכול להישלח בבקשות לעדכון ולמחיקה כדי לוודא שללקוח יש ערך עדכני לפני שממשיכים.

AddOns

הגדרה של תוסף Google Workspace.

ייצוג JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
שדות
common

object (CommonAddOnManifest)

הגדרה משותפת לכל התוספים ל-Google Workspace.
gmail

object (GmailAddOnManifest)

הגדרה של תוסף Gmail.
drive

object (DriveAddOnManifest)

הגדרה של תוסף Drive.
calendar

object (CalendarAddOnManifest)

הגדרה של תוסף היומן.
docs

object (DocsAddOnManifest)

הגדרת תוסף Docs.
sheets

object (SheetsAddOnManifest)

הגדרה של תוסף Sheets.
slides

object (SlidesAddOnManifest)

הגדרה של תוסף Slides
httpOptions

object (HttpOptions)

אפשרויות לשליחת בקשות לנקודות קצה (endpoint) של HTTP בתוסף

CommonAddOnManifest

הגדרת תוספים משותפת לכל האפליקציות המארחים של התוספים.

ייצוג JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
שדות
name

string

חובה. השם המוצג של התוסף.
logoUrl

string

חובה. כתובת ה-URL של תמונת הלוגו שמוצגת בסרגל הכלים של התוסף.
layoutProperties

object (LayoutProperties)

מאפייני פריסה נפוצים של כרטיסי התוספים.
addOnWidgetSet

object (AddOnWidgetSet)

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

boolean

הגדרה שקובעת אם להעביר פרטי לוקאל מהאפליקציה המארחת.
homepageTrigger

object (HomepageExtensionPoint)

מגדירה נקודת קצה שתבוצע בכל הקשר ובכל מארח. כרטיסים שייווצרו על ידי הפונקציה הזו תמיד יהיו זמינים למשתמש, אבל יכול להיות שתוכן לפי הקשר יסתיר אותם כשהתוסף הזה כולל הצהרה על טריגרים ממוקדים יותר.
universalActions[]

object (UniversalActionExtensionPoint)

מגדיר רשימה של נקודות תוסף בתפריט הפעולות האוניברסלי, שמשמש כתפריט ההגדרות של התוסף. נקודת התוסף יכולה להיות כתובת URL של קישור לפתיחה או נקודת קצה להפעלה כשליחת טופס.
openLinkUrlPrefixes

array (ListValue format)

פעולת OpenLink יכולה להשתמש רק בכתובת URL עם הסכמה HTTPS, MAILTO או TEL. לקישורי HTTPS, כתובת ה-URL צריכה גם להתאים לאחת מהקידומות שצוינו ברשימת ההיתרים. אם התחילית לא תשמיט את הסכימה, ההנחה היא ש-HTTPS. קישורים מסוג HTTP משוכתבים באופן אוטומטי לHTTPS קישורים.

LayoutProperties

המאפיינים של פריסת הכרטיסים משותפים בכל האפליקציות המארחות של התוספים.

ייצוג JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
שדות
primaryColor

string

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

string

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

boolean

הפעלת עיצוב מהותי לכרטיסים.

AddOnWidgetSet

קבוצת המשנה של הווידג'ט שמשמש את התוסף.

ייצוג JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
שדות
usedWidgets[]

enum (WidgetType)

רשימת הווידג'טים שנעשה בהם שימוש בתוסף.

WidgetType

סוג הווידג'ט. WIDGET_TYPE_UNSPECIFIED הוא קבוצת הווידג'טים הבסיסית.

טיפוסים בני מנייה (enum)
WIDGET_TYPE_UNSPECIFIED הווידג'ט הוא ברירת המחדל.
DATE_PICKER החלונית לבחירת תאריך.
STYLED_BUTTONS לחצנים מעוצבים כוללים לחצנים מלאים ולחצנים מושבתים.
PERSISTENT_FORMS טפסים קבועים מאפשרים לשמור ערכי טופס במהלך פעולות.
UPDATE_SUBJECT_AND_RECIPIENTS מעדכנים את הנושא והנמענים של הטיוטה.
GRID_WIDGET ווידג'ט הרשת.
ADDON_COMPOSE_UI_ACTION פעולה של תוסף ל-Gmail שחלה על ממשק המשתמש של התוסף לכתיבה.

HomepageExtensionPoint

פורמט נפוץ להצהרה על תצוגת דף הבית של תוסף.

ייצוג JSON 
{
  "runFunction": string,
  "enabled": boolean
}
שדות
runFunction

string

חובה. נקודת הקצה להפעלה כשנקודת התוסף הזו מופעלת.
enabled

boolean

זה שינוי אופציונלי. אם המדיניות מוגדרת לערך false, תצוגת דף הבית מושבתת בהקשר הזה.

אם המדיניות לא מוגדרת, ערך ברירת המחדל הוא true.

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

UniversalActionExtensionPoint

פורמט להצהרה על נקודת תוסף של פריט בתפריט פעולות אוניברסלי.

ייצוג JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
שדות
label

string

חובה. טקסט גלוי למשתמש שמתאר את הפעולה שננקטה על ידי הפעלת נקודת התוסף הזו. לדוגמה, "הוספת איש קשר חדש".
שדה איחוד action_type. חובה. סוג הפעולה שנתמך בפריט פעולות אוניברסלי בתפריט הפעולות. הוא יכול להיות קישור לפתיחה או נקודת קצה להפעלה. action_type יכול להיות רק אחת מהאפשרויות הבאות:
runFunction

string

נקודת הקצה שתופעל על ידי UniversalAction.

GmailAddOnManifest

מאפיינים שמתאימים אישית את המראה וההפעלה של תוסף ל-Gmail.

ייצוג JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

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

אם היא קיימת, היא מבטלת את ההגדרות האישיות של addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

הגדרה של קבוצת התנאים שיפעילו את התוסף.
universalActions[]

object (UniversalAction)

מגדיר קבוצה של פעולות אוניברסליות לתוסף. המשתמש מפעיל פעולות אוניברסליות מתפריט סרגל הכלים של התוסף.
composeTrigger

object (ComposeTrigger)

מגדיר את טריגר זמן הכתיבה של תוסף מסוג זמן כתיבה. זהו הטריגר שגורם לתוסף לבצע פעולה כשהמשתמש כותבים אימייל. לכל התוספים מסוג 'זמן כתיבה' חייב להיות ההיקף gmail.addons.current.action.compose, אבל יכול להיות שהם לא עורכים את הטיוטה.
authorizationCheckFunction

string

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

ContextualTrigger

מגדיר טריגר שמופעל כאשר כתובת האימייל הפתוחה עומדת בקריטריונים ספציפיים. כשהטריגר מופעל, הוא מפעיל נקודת קצה (endpoint) ספציפית, בדרך כלל כדי ליצור כרטיסים חדשים ולעדכן את ממשק המשתמש.

ייצוג JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
שדות
onTriggerFunction

string

חובה. השם של נקודת הקצה (endpoint) שצריך להפעיל כשהודעה תואמת לטריגר.
שדה איחוד trigger. סוג הטריגר קובע את התנאים שבהם Gmail משתמש כדי להציג את התוסף. trigger יכול להיות רק אחת מהאפשרויות הבאות:
unconditional

object (UnconditionalTrigger)

טריגרים ללא תנאי מבוצעים כשנפתחת הודעת אימייל.

UnconditionalTrigger

אין שדות בסוג הזה.

טריגר שמופעל כשהודעת אימייל כלשהי נפתחת.

UniversalAction

הפעולה הזו תמיד זמינה בתפריט סרגל הכלים של התוסף, ללא קשר להקשר של ההודעה.

ייצוג JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
שדות
text

string

חובה. טקסט גלוי למשתמש שמתאר את הפעולה, לדוגמה, 'הוספת איש קשר חדש'.
שדה איחוד action_type. סוג הפעולה קובע את ההתנהגות של Gmail כשהמשתמש מפעיל את הפעולה. action_type יכול להיות רק אחת מהאפשרויות הבאות:
runFunction

string

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

ComposeTrigger

טריגר שמופעל כשהמשתמש כותב אימייל.

ייצוג JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
שדות
actions[]

object (MenuItemExtensionPoint)

מגדיר את קבוצת הפעולות של תוסף זמן כתיבה. אלו פעולות שמשתמשים יכולים להפעיל בתוסף מסוג 'זמן כתיבה'.
draftAccess

enum (DraftAccess)

המדיניות הזו מגדירה את רמת הגישה לנתונים כשתוסף זמן הכתיבה מופעל.

DraftAccess

'טיפוסים בני מנייה (enum)' שמגדיר את רמת הגישה לנתונים שנדרשת לטריגר הכתיבה.

טיפוסים בני מנייה (enum)
UNSPECIFIED ערך ברירת המחדל כשלא מוגדר שום דבר לגישה במצב טיוטה.
NONE לטריגר הכתיבה אין גישה לנתונים של הטיוטה כשתוסף הכתיבה מופעל.
METADATA מעניקה לטריגר הכתיבה הרשאה לגשת למטא-נתונים של הטיוטה כאשר תוסף לכתיבה מופעל. זה כולל את רשימת החברים בקהל, כמו רשימת 'אל' ו'עותק' של טיוטת הודעה.

DriveAddOnManifest

מאפיינים שמתאימים אישית את המראה וההפעלה של תוסף ב-Drive.

ייצוג JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

אם היא קיימת, היא מבטלת את ההגדרות האישיות של addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

תואמת להתנהגות שמופעלת כשהפריטים נבחרים בתצוגה הרלוונטית ב-Drive, כמו רשימת המסמכים ב'האחסון שלי'.

DriveExtensionPoint

פורמט נפוץ להצהרה על טריגרים של תוספים ב-Drive.

ייצוג JSON 
{
  "runFunction": string
}
שדות
runFunction

string

חובה. נקודת הקצה להפעלה כשנקודת התוסף מופעלת.

CalendarAddOnManifest

מאפיינים שמאפשרים להתאים אישית את המראה וההפעלה של תוסף ליומן Google.

ייצוג JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

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

אם היא קיימת, היא מבטלת את ההגדרות האישיות של addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

הגדרת הפתרונות לשיחות ועידה שהתוסף הזה מספק.
createSettingsUrlFunction

string

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

object (CalendarExtensionPoint)

נקודת קצה (endpoint) שמופעלת כשאירוע פתוח לצפייה או לעריכה.
eventUpdateTrigger

object (CalendarExtensionPoint)

נקודת קצה (endpoint) שמופעלת כשמתבצע עדכון של האירוע הפתוח.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

הגדרה של טריגר לפי הקשר, שמופעל כשהמשתמש לוחץ על ספק הקבצים המצורפים של התוסף בתפריט הנפתח של יומן Google.
currentEventAccess

enum (EventAccess)

מגדירה את רמת הגישה לנתונים כשתוסף אירוע מופעל.

ConferenceSolution

הגדרת ערכים שקשורים לשיחות ועידה.

ייצוג JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
שדות
onCreateFunction

string

חובה. נקודת הקצה (endpoint) לקריאה כשצריך ליצור את הנתונים של שיחת הוועידה.
id

string

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

string

חובה. השם המוצג של פתרון שיחת הוועידה.
logoUrl

string

חובה. כתובת ה-URL של תמונת הלוגו של פתרון שיחת הוועידה.

CalendarExtensionPoint

פורמט נפוץ להצהרה על טריגרים של תוספים ביומן.

ייצוג JSON 
{
  "runFunction": string
}
שדות
runFunction

string

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

EventAccess

טיפוסים בני מנייה (enum) שמגדיר את רמת הטריגרים של אירועי גישה לנתונים שנדרשים.

טיפוסים בני מנייה (enum)
UNSPECIFIED ערך ברירת המחדל כשלא מוגדר שום דבר ל-eventAccess.
METADATA ההגדרה מעניקה לאירוע מפעיל את ההרשאה לגשת למטא-נתונים של אירועים, כמו מזהה האירוע ומזהה היומן.
READ הפעולה הזו מאפשרת להפעיל גישה לכל שדות האירוע שמסופקים, כולל המטא-נתונים, המשתתפים והנתונים של שיחת הוועידה.
WRITE התפקיד הזה מאפשר להפעיל גישה למטא-נתונים של האירועים ואת היכולת לבצע את כל הפעולות, כולל הוספת משתתפים והגדרת נתוני שיחת ועידה.
READ_WRITE כך האירוע מאפשר גישה לכל שדות האירוע שסופקו, כולל המטא-נתונים, המשתתפים ונתוני שיחת הוועידה, ואפשרות לבצע את כל הפעולות.

DocsAddOnManifest

מאפיינים שמתאימים אישית את המראה וההפעלה של תוסף ל-Google Docs.

ייצוג JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

אם היא קיימת, היא מבטלת את ההגדרות האישיות של addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

נקודת קצה (endpoint) להפעלה כשניתנת הרשאה להיקף הקובץ עבור צמד המסמכים/המשתמשים האלה.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

רשימה של נקודות תוסף לתצוגה מקדימה של קישורים במסמך Google Docs. מידע נוסף מופיע במאמר בנושא תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.
createActionTriggers[]

object (CreateActionExtensionPoint)

רשימה של נקודות תוסף ליצירת משאבים של צד שלישי מתוך אפליקציות Google Workspace. מידע נוסף זמין בקטע יצירת משאבים של צד שלישי מתפריט ה-@.

DocsExtensionPoint

פורמט נפוץ להצהרה על טריגרים של תוסף Docs.

ייצוג JSON 
{
  "runFunction": string
}
שדות
runFunction

string

חובה. נקודת הקצה להפעלה כשנקודת התוסף הזו מופעלת.

LinkPreviewExtensionPoint

ההגדרה של טריגר שמופעל כשמשתמש מקליד או מדביק קישור משירות של צד שלישי או משירות שאינו של Google בקובץ Google Docs , Sheets או Slides.

ייצוג JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
שדות
labelText

string

חובה. הטקסט של צ'יפ חכם לדוגמה שמזמין את המשתמשים לראות תצוגה מקדימה של הקישור, למשל Example: Support case. הטקסט הזה סטטי ומוצג לפני שהמשתמשים מריצים את התוסף.
localizedLabelText

map (key: string, value: string)

זה שינוי אופציונלי. מפה של labeltext לתרגום לשפות אחרות. פורמט השפה צריך להיות בפורמט ISO 639 והמדינה/האזור ב-ISO 3166, מופרדים במקף -. לדוגמה: en-US.

אם לוקאל המשתמש מופיע במפתחות של המפה, המשתמש יראה את הגרסה של labeltext שמותאמת לשוק המקומי.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (UriPattern)

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

string

חובה. נקודת קצה (endpoint) להפעלה כשמוצגת תצוגה מקדימה של קישור.
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 ריק.

CreateActionExtensionPoint

ההגדרה של טריגר שמופעל כשמשתמש מפעיל את תהליך העבודה ליצירת משאבים באפליקציה של 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 שמותאמת לשוק המקומי.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
runFunction

string

חובה. נקודת קצה (endpoint) שמופעלת כשתהליך העבודה ליצירת משאב מופעל כדי ליצור קישור.
logoUrl

string

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

SheetsAddOnManifest

מאפיינים שמתאימים אישית את המראה וההפעלה של תוסף ל-Google Sheets.

ייצוג JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

אם היא קיימת, היא מבטלת את ההגדרות האישיות של addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

נקודת קצה (endpoint) להפעלה כשניתנת הרשאה להיקף הקובץ עבור צמד המסמכים/המשתמשים האלה.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

פורמט נפוץ להצהרה על טריגרים של תוסף Sheets.

ייצוג JSON 
{
  "runFunction": string
}
שדות
runFunction

string

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

SlidesAddOnManifest

מאפיינים שמתאימים אישית את המראה וההפעלה של תוסף Google Slides.

ייצוג JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

אם היא קיימת, היא מבטלת את ההגדרות האישיות של addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

נקודת קצה (endpoint) להפעלה כשניתנת הרשאה להיקף הקובץ עבור צמד המסמכים/המשתמשים האלה.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

פורמט נפוץ להצהרה על טריגרים של תוסף Slides.

ייצוג JSON 
{
  "runFunction": string
}
שדות
runFunction

string

חובה. נקודת הקצה להפעלה כשנקודת התוסף הזו מופעלת.

HttpOptions

אפשרויות לשליחת בקשות לנקודות קצה (endpoints) של תוסף HTTP.

ייצוג JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
שדות
authorizationHeader

enum (HttpAuthorizationHeader)

הגדרת האסימון שנשלח בכותרת ההרשאה HTTP.

HttpAuthorizationHeader

כותרת ההרשאה נשלחה בבקשות של התוסף HTTP.

טיפוסים בני מנייה (enum)
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED ערך ברירת המחדל, שווה ערך ל-SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN שליחת אסימון מזהה לחשבון שירות המערכת של תוסף Google Workspace הספציפי לפרויקט (ברירת המחדל).
USER_ID_TOKEN צריך לשלוח אסימון מזהה למשתמש הקצה.
NONE אין לשלוח כותרת אימות.

שיטות

create

 יצירת פריסה עם השם ועם ההגדרות האישיות שצוינו.

delete

 מחיקת הפריסה עם השם הנתון.

get

 הפונקציה מקבלת את הפריסה עם השם שצוין.

getInstallStatus

 מקבל את סטטוס ההתקנה של פריסת בדיקה.

install

 התקנת פריסה בחשבון שלך לצורך בדיקה.

list

 רשימה של כל הפריסות בפרויקט מסוים.

replaceDeployment

 יצירה או החלפה של פריסה בשם שצוין.

uninstall

 הסרה של פריסת בדיקה מחשבון המשתמש.