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

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

תוספים

הגדרה של תוסף 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)

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

object (DocsAddOnManifest)

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

object (SheetsAddOnManifest)

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

object (SlidesAddOnManifest)

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

object (HttpOptions)

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

CommonAddOnManifest

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

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

string

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

string

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

object (LayoutProperties)

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

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

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

object (UniversalActionExtensionPoint)

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

array (ListValue format)

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

LayoutProperties

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

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

string

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

string

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

boolean

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

AddOnWidgetSet

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

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

enum (WidgetType)

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

WidgetType

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

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

HomepageExtensionPoint

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

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

string

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

boolean

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

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

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

UniversalActionExtensionPoint

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

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

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

string

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

string

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

GmailAddOnManifest

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

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

object (HomepageExtensionPoint)

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

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

object (ContextualTrigger)

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

object (UniversalAction)

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

object (ComposeTrigger)

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

string

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

ContextualTrigger

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

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

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

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

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

string

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

string

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

string

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

string

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

CalendarExtensionPoint

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

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

string

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

EventAccess

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

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

DocsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

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

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

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

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

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

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

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

שיטות

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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