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

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

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

string

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

boolean

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

AddOnWidgetSet

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

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

enum (WidgetType)

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

WidgetType

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

טיפוסים בני מנייה (enums)
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

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

GmailAddOnManifest

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

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

object (HomepageExtensionPoint)

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

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

object (ContextualTrigger)

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

object (UniversalAction)

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

object (ComposeTrigger)

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

string

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

ContextualTrigger

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

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

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

טיפוסים בני מנייה (enums)
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

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

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

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

טיפוסים בני מנייה (enums)
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

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

ייצוג JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
שדות
hostPattern

string

נדרש עבור כל תבנית כתובת אתר לתצוגה מקדימה. הדומיין של תבנית ה-URL. התצוגות המקדימות של התוסף כוללות את הדומיין הזה בכתובת ה-URL. כדי לראות תצוגה מקדימה של קישורים לתת-דומיין ספציפי, כמו subdomain.example.com, צריך לכלול את תת-הדומיין. כדי לראות תצוגה מקדימה של קישורים עבור הדומיין כולו, צריך לציין תו כללי לחיפוש עם כוכבית (*) בתור תת-הדומיין.

לדוגמה, *.example.com תואם עם subdomain.example.com ועם another.subdomain.example.com.
pathPrefix

string

אפשרות. הנתיב שמוסיף את הדומיין של hostpattern.

לדוגמה, אם תבנית המארח של כתובת ה-URL היא support.example.com, צריך להזין cases כדי להתאים לכתובות ה-URL עבור מקרים שמתארחים ב-support.example.com/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

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

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

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

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

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

שיטות

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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