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