Package google.apps.script.type

אינדקס

• AddOnWidgetSet (הודעה)
• AddOnWidgetSet.WidgetType (טיפוסים בני מנייה (enum))
• CommonAddOnManifest (הודעה)
• CreateActionExtensionPoint (הודעה)
• HomepageExtensionPoint (הודעה)
• HttpAuthorizationHeader (טיפוסים בני מנייה (enum))
• HttpOptions (הודעה)
• LayoutProperties (הודעה)
• LinkPreviewExtensionPoint (הודעה)
• MenuItemExtensionPoint (הודעה)
• UniversalActionExtensionPoint (הודעה)
• UriPattern (הודעה)

AddOnWidgetSet

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

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

WidgetType

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

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

HomepageExtensionPoint

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

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

HttpAuthorizationHeader

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

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

HttpOptions

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

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

LayoutProperties

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

שדות
primaryColor	string הצבע הראשי של התוסף. ההגדרה הזו קובעת את הצבע של סרגל הכלים. אם לא הוגדר צבע ראשי, ייעשה שימוש בערך ברירת המחדל שסופק על ידי ה-framework.
secondaryColor	string הצבע המשני של התוסף. הוא מגדיר את צבע הלחצנים. אם הצבע הראשי הוגדר אבל לא הוגדר צבע משני, הצבע המשני יהיה זהה לצבע הראשי. אם לא הוגדר צבע ראשי ולא צבע משני, ייעשה שימוש בערך ברירת המחדל שסופק על ידי ה-framework.
useNewMaterialDesign	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 חובה. נקודת קצה (endpoint) לביצוע כשמופעלת תצוגה מקדימה של קישור.
logoUrl	string אפשרות. הסמל שמופיע בצ'יפ החכם ובכרטיס התצוגה המקדימה. אם הוא יושמט, התוסף ישתמש בסמל סרגל הכלים שלו, logoUrl.

MenuItemExtensionPoint

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

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

UniversalActionExtensionPoint

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

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

UriPattern

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

שדות
hostPattern	string נדרש עבור כל תבנית כתובת אתר לתצוגה מקדימה. הדומיין של תבנית ה-URL. התצוגות המקדימות של התוסף כוללות את הדומיין הזה בכתובת ה-URL. כדי לראות תצוגה מקדימה של קישורים לתת-דומיין ספציפי, כמו subdomain.example.com, צריך לכלול את תת-הדומיין. כדי לראות תצוגה מקדימה של קישורים עבור הדומיין כולו, צריך לציין תו כללי לחיפוש עם כוכבית (*) בתור תת-הדומיין. לדוגמה, *.example.com תואם עם subdomain.example.com ועם another.subdomain.example.com.
pathPrefix	string אפשרות. הנתיב שמוסיף את הדומיין של hostPattern. לדוגמה, אם תבנית המארח של כתובת ה-URL היא support.example.com, צריך להזין cases כדי להתאים לכתובות ה-URL עבור מקרים שמתארחים ב-support.example.com/cases/. כדי להתאים לכל כתובות ה-URL בדומיין של תבנית המארח, צריך להשאיר את השדה pathPrefix ריק.