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)

הגדרות אישיות של התוסף ליומן Google.
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

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

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

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

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

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)

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

object (MenuItemExtensionPoint)

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

תהליך ההצגה שבו התוסף יוצג כשהוא יופעל.

מדינה

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)

הגדרה של האסימון שנשלח בכותרת Authorization‏ 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

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