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

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

הפעלת Material Design לכרטיסים.

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

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

boolean

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

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

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

UniversalActionExtensionPoint

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

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

  "openLink": string,
  "runFunction": string
}
שדות
label

string

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

string

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

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

ContextualTrigger

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

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

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
שדות
onTriggerFunction

string

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

object (UnconditionalTrigger)

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

UnconditionalTrigger

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

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

UniversalAction

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

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

  "openLink": string,
  "runFunction": string
}
שדות
text

string

חובה. טקסט שגלוי למשתמש ומתאר את הפעולה, לדוגמה, "הוספת איש קשר חדש".
סוג הפעולה קובע את ההתנהגות של Gmail כשהמשתמש מפעיל את הפעולה. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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

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

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)

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

אופציונלי. מופעל כשאירוע נוצר או מתעדכן ביומן שהמשתמש רשום אליו. ההגדרה הזו רלוונטית רק לטריגרים שנוצרו על ידי HTTP endpoints באמצעות CalendarSubscriptionActionMarkup.

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

לא רלוונטי ל-Apps Script add-ons ול-Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

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

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

string

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

string

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

string

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

string

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

CalendarExtensionPoint

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

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

string

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

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

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

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.

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

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

string

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

string

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

enum (State)

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

boolean

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

string

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

string

גרסה של כתובת ה-URL של הלוגו במצב כהה.
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 התוסף צריך להיפתח בתהליך התצוגה "focus".
AUGMENT התוסף אמור לפעול בתהליך התצוגה "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

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

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

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

HttpOptions

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

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