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 הוא סט הווידג'טים הבסיסי.

טיפוסים בני מנייה (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.

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

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

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

LayoutProperties

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

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