Package google.apps.script.type

אינדקס

• ‫AddOnWidgetSet (הודעה)
• AddOnWidgetSet.WidgetType (enum)
• ‫CommonAddOnManifest (הודעה)
• ‫CreateActionExtensionPoint (הודעה)
• GranularOauthPermissionSupport (enum)
• ‫HomepageExtensionPoint (הודעה)
• HttpAuthorizationHeader (enum)
• ‫HttpOptions (הודעה)
• ‫LayoutProperties (הודעה)
• ‫LinkPreviewExtensionPoint (הודעה)
• ‫MenuItemExtensionPoint (הודעה)
• ‫UniversalActionExtensionPoint (הודעה)
• ‫UriPattern (הודעה)

AddOnWidgetSet

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

שדות
usedWidgets[]	WidgetType רשימת הווידג'טים שמשמשים בתוסף.

WidgetType

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

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

CommonAddOnManifest

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

שדות
name	string חובה. השם המוצג של התוסף.
logoUrl	string חובה. כתובת ה-URL של תמונת הלוגו שמוצגת בסרגל הכלים של התוסף.
layoutProperties	LayoutProperties מאפייני פריסה נפוצים לכרטיסי התוסף.
addOnWidgetSet	AddOnWidgetSet הווידג'טים שבהם נעשה שימוש בתוסף. אם לא מציינים את השדה הזה, המערכת משתמשת בערכת ברירת המחדל.
useLocaleFromApp	bool האם להעביר מידע על הלוקאל מאפליקציית המארח.
homepageTrigger	HomepageExtensionPoint מגדיר נקודת קצה שתופעל בכל הקשר, בכל מארח. כל הכרטיסים שנוצרים על ידי הפונקציה הזו תמיד יהיו זמינים למשתמש, אבל יכול להיות שהתוכן ההקשרי יסתיר אותם כשהתוסף הזה יצהיר על טריגרים ממוקדים יותר.
universalActions[]	UniversalActionExtensionPoint ההגדרה הזו מגדירה רשימה של נקודות הרחבה בתפריט הפעולות האוניברסלי, שמשמש כתפריט הגדרות לתוסף. נקודת ההרחבה יכולה להיות כתובת URL של קישור לפתיחה או נקודת קצה להפעלה כטופס שנשלח.
openLinkUrlPrefixes	ListValue בפעולה OpenLink אפשר להשתמש רק בכתובת URL עם סכימה של HTTPS, MAILTO או TEL. בקישורים מסוג HTTPS, כתובת ה-URL צריכה גם להתאים לאחת מהקידומות שצוינו ברשימת ההיתרים. אם הקידומת לא כוללת את הסכימה, המערכת מניחה שזו HTTPS. קישורי HTTP נכתבים מחדש באופן אוטומטי כקישורי HTTPS.

CreateActionExtensionPoint

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

שדות
id	string חובה. המזהה הייחודי שמבדיל בין נקודות ההרחבה. המזהה יכול להכיל עד 64 תווים והוא צריך להיות בפורמט [a-zA-Z0-9-]+.
labelText	string חובה. הטקסט שמוצג לצד סמל של נקודת כניסה ליצירת משאב, כמו Create support case. הטקסט הזה סטטי ומוצג לפני שהמשתמשים מפעילים את התוסף.
localizedLabelText	map<string, string> אופציונלי. מפה של labelText להתאמה לשפות אחרות. השפה צריכה להיות בפורמט ISO 639 והמדינה או האזור צריכים להיות בפורמט ISO 3166, כשהם מופרדים במקף -. לדוגמה, en-US. אם הלוקאל של המשתמש מופיע במפת המקשים, המשתמש רואה את הגרסה המותאמת לשפה של labelText.
runFunction	string חובה. נקודת קצה להפעלה כשמופעל תהליך עבודה ליצירת משאב כדי ליצור קישור.
logoUrl	string אופציונלי. הסמל שמוצג לנקודת הכניסה ליצירת משאבים. אם לא מציינים סמל, התפריט משתמש בסמל של התוסף בסרגל הכלים, logoUrl.

GranularOauthPermissionSupport

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

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

HomepageExtensionPoint

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

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

HttpAuthorizationHeader

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

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

HttpOptions

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

שדות
authorizationHeader	HttpAuthorizationHeader הגדרות לטוקן שנשלח בכותרת ההרשאות HTTP.
granularOauthPermissionSupport	GranularOauthPermissionSupport האם התוסף הפעיל הבעת הסכמה פרטנית ל-OAuth.

LayoutProperties

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

שדות
primaryColor	string הצבע הראשי של התוסף. הוא מגדיר את הצבע של סרגל הכלים. אם לא מוגדר צבע ראשי, המערכת משתמשת בערך ברירת המחדל שסופק על ידי המסגרת.
secondaryColor	string הצבע המשני של התוסף. הוא קובע את צבע הכפתורים. אם הצבע הראשי מוגדר אבל הצבע המשני לא מוגדר, הצבע המשני יהיה זהה לצבע הראשי. אם לא מוגדר צבע ראשי ולא מוגדר צבע משני, המערכת משתמשת בערך ברירת המחדל שסופק על ידי המסגרת.
useNewMaterialDesign (deprecated)	bool הפריט הזה יצא משימוש. הגדרה שמאפשרת עיצוב חומרים לכרטיסים.

LinkPreviewExtensionPoint

ההגדרה של טריגר שמופעל כשמשתמש מקליד או מדביק קישור משירות של צד שלישי או משירות שאינו של Google לקובץ ב-Google Docs, ‏Sheets או Slides.

שדות
labelText	string חובה. הטקסט של צ’יפ חכם לדוגמה שמציע למשתמשים לראות תצוגה מקדימה של הקישור, כמו Example: Support case. הטקסט הזה סטטי ומוצג לפני שהמשתמשים מפעילים את התוסף.
localizedLabelText	map<string, string> אופציונלי. מפה של labelText להתאמה לשפות אחרות. השפה צריכה להיות בפורמט ISO 639 והמדינה או האזור צריכים להיות בפורמט ISO 3166, כשהם מופרדים במקף -. לדוגמה, en-US. אם הלוקאל של המשתמש מופיע במפת המקשים, המשתמש רואה את הגרסה המותאמת לשפה של labelText.
patterns[]	UriPattern חובה. מערך של תבניות URL שמפעילות את התוסף כדי להציג תצוגה מקדימה של קישורים.
runFunction	string חובה. נקודת קצה להפעלה כשמופעלת תצוגה מקדימה של קישור.
logoUrl	string אופציונלי. הסמל שמוצג בצ'יפ החכם ובכרטיס התצוגה המקדימה. אם לא מציינים סמל, התוסף משתמש בסמל שלו בסרגל הכלים, logoUrl.

MenuItemExtensionPoint

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

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

UniversalActionExtensionPoint

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

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

UriPattern

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

שדות
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 ריק.