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)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "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.
meet

object (MeetAddOnManifest)

הגדרת תוסף ל-Meet.
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
(deprecated)

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 של צד שלישי. אם הבקשה לבדיקת תקינות (probe) נכשלת, הפונקציה צריכה להקפיץ הודעת שגיאה (throw) חריג כדי להתחיל את תהליך ההרשאה. הפונקציה הזו מופעלת לפני כל הפעלה של התוסף, כדי להבטיח חוויית משתמש חלקה.

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

טיפוסים בני מנייה (enum)
UNSPECIFIED ערך ברירת המחדל אם לא מוגדר כלום עבור draftaccess.
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)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

אופציונלי. הגדרה של פתרונות לשיחות ועידה שהתוסף הזה מספק. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.
createSettingsUrlFunction

string

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

object (CalendarExtensionPoint)

נקודת קצה שמופעלת כשפותחים אירוע כדי לצפות בו או לערוך אותו.
eventUpdateTrigger

object (CalendarExtensionPoint)

נקודת קצה שמופעלת כשאירוע הפתיחה מתעדכן.
calendarNotificationTrigger

object (CalendarExtensionPoint)

אופציונלי. הטריגר מופעל כשאירוע נוצר או מתעדכן ביומן שהמשתמש רשום אליו. ההסבר הזה רלוונטי רק למפעילים שנוצרו על ידי Alt-Runtime add-ons באמצעות CalendarSubscriptionActionMarkup. לא רלוונטי ל-Apps Script add-ons ול-Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

הגדרת ערכים שקשורים לוועידה. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.

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

string

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

נקודת קצה להפעלה כשניתנת הרשאה להיקף הקובץ עבור צמד המסמך/המשתמש הזה.
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

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

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

string

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

MeetAddOnManifest

מניפסט של תוסף ל-Meet.

ייצוג ב-JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
שדות
homepageTrigger

object (HomepageExtensionPoint)

אם הפרמטר הזה קיים, הוא מבטל את ההגדרה מ-addons.common.homepageTrigger.
web

object (Web)

פרטים על תוספים שמשפרים את לקוח האינטרנט של Meet.
supportsCollaboration

boolean

אם התוסף תומך בשיתוף פעולה או בהזמנת אנשים אחרים לשימוש בתוסף.
termsUri

string

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

פיתוח אתרים

פרטים על תוספים שמשפרים את לקוח האינטרנט של Meet.

ייצוג ב-JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
שדות
sidePanelUri
(deprecated)

string

כתובת ה-URI של ה-iframe של החלונית הצדדית.
sidePanelUrl

string

כתובת ה-URL של ה-iframe של חלונית הצד.
mainStageUri
(deprecated)

string

מזהה ה-URI של ה-iframe של הבמה הראשית.
supportsScreenSharing

boolean

האם התוסף תומך בשיתוף מסך של הבמה הראשית.
supportsCollaboration
(deprecated)

boolean

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

boolean

האם התוסף תומך בחוויית תמונה בתוך תמונה (PIP) בדפדפן.
hostOrigins[]
(deprecated)

string

הוצא משימוש, שם מדור קודם. מקורות שצריך להוסיף למאפיין frame-src של ה-iframe שמכיל את אתר הצד השלישי. במקום זאת, צריך להשתמש ב-addonorigins.
addOnOrigins[]

string

מקורות שצריך להוסיף למאפיין frame-src של ה-iframe שמכיל את אתר הצד השלישי.
openState

enum (State)

המצב ההתחלתי כשפותחים את התוסף.
supportsCollaborationHostControls

boolean

האם תוסף שיתוף הפעולה תומך באמצעי בקרה למארחים.
logoUrl

string

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

string

גרסה של logourl במצב כהה.
displayFlow
(deprecated)

enum (DisplayFlow)

הזרימה של התצוגה שהתוסף יפעל לפיה כשהוא יופעל.

מדינה (State)

סוג Enum להגדרת מצב הפתיחה הראשוני של התוסף.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין מצב התחלתי בתוסף.
SIDE_PANEL_ONLY התוסף ייפתח כשהחלונית הצדדית בלבד פעילה.
MAIN_STAGE_ONLY התוסף נפתח כשהבמה הראשית בלבד פעילה.
SIDE_PANEL_AND_MAIN_STAGE התוסף ייפתח כשהחלונית הצדדית והשלב הראשי פעילים.

DisplayFlow

סוג Enum שמציין את תהליך ההצגה שהתוסף יפעל לפיו כשהוא יופעל

טיפוסים בני מנייה (enum)
DISPLAY_FLOW_UNSPECIFIED לא צוין תהליך לתצוגה.
FOCUS התוסף צריך להיפתח בתהליך ההצגה של 'מצב פוקוס'.
AUGMENT תוסף צריך להיפתח בתהליך ההצגה 'הגדלה'.

SheetsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

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

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

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

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

string

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

HttpOptions

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

ייצוג ב-JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
שדות
authorizationHeader

enum (HttpAuthorizationHeader)

הגדרות לטוקן שנשלח בכותרת ההרשאות HTTP.
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

האם התוסף הפעיל הסכמה מפורטת ל-OAuth.

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

האם התוסף הפעיל הסכמה מפורטת ל-OAuth.

טיפוסים בני מנייה (enum)
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED ערך ברירת מחדל, אין להשתמש בו.
OPT_IN התוסף מוגדר להשתמש בהסכמה מפורטת ל-OAuth.
OPT_OUT התוסף לא משתמש בהסכמה מפורטת ל-OAuth.

Methods

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

 יוצר או מחליף פריסה עם השם שצוין.

uninstall

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