אינדקס
Action
(הודעה)Action.ActionParameter
(הודעה)Action.Interaction
(טיפוסים בני מנייה (enum))Action.LoadIndicator
(טיפוסים בני מנייה (enum))BorderStyle
(הודעה)BorderStyle.BorderType
(טיפוסים בני מנייה (enum))Button
(הודעה)ButtonList
(הודעה)Card
(הודעה)Card.CardAction
(הודעה)Card.CardFixedFooter
(הודעה)Card.CardHeader
(הודעה)Card.DisplayStyle
(טיפוסים בני מנייה (enum))Card.DividerStyle
(טיפוסים בני מנייה (enum))Card.Section
(הודעה)Columns
(הודעה)Columns.Column
(הודעה)Columns.Column.HorizontalSizeStyle
(טיפוסים בני מנייה (enum))Columns.Column.VerticalAlignment
(טיפוסים בני מנייה (enum))Columns.Column.Widgets
(הודעה)DateTimePicker
(הודעה)DateTimePicker.DateTimePickerType
(טיפוסים בני מנייה (enum))DecoratedText
(הודעה)DecoratedText.SwitchControl
(הודעה)DecoratedText.SwitchControl.ControlType
(טיפוסים בני מנייה (enum))Divider
(הודעה)EndNavigation
(הודעה)EndNavigation.Action
(טיפוסים בני מנייה (enum))GetAutocompletionResponse
(הודעה)Grid
(הודעה)Grid.GridItem
(הודעה)Grid.GridItem.GridItemLayout
(טיפוסים בני מנייה (enum))Icon
(הודעה)Image
(הודעה)ImageComponent
(הודעה)ImageCropStyle
(הודעה)ImageCropStyle.ImageCropType
(טיפוסים בני מנייה (enum))Link
(הודעה)LinkPreview
(הודעה)MaterialIcon
(הודעה)Navigation
(הודעה)Notification
(הודעה)OnClick
(הודעה)OpenLink
(הודעה)OpenLink.OnClose
(טיפוסים בני מנייה (enum))OpenLink.OpenAs
(טיפוסים בני מנייה (enum))RenderActions
(הודעה)RenderActions.Action
(הודעה)SelectionInput
(הודעה)SelectionInput.PlatformDataSource
(הודעה)SelectionInput.PlatformDataSource.CommonDataSource
(טיפוסים בני מנייה (enum))SelectionInput.SelectionItem
(הודעה)SelectionInput.SelectionType
(טיפוסים בני מנייה (enum))SubmitFormResponse
(הודעה)Suggestions
(הודעה)Suggestions.SuggestionItem
(הודעה)TextInput
(הודעה)TextInput.Type
(טיפוסים בני מנייה (enum))TextParagraph
(הודעה)Widget
(הודעה)Widget.HorizontalAlignment
(טיפוסים בני מנייה (enum))Widget.ImageType
(טיפוסים בני מנייה (enum))
פעולה
פעולה שמתארת את ההתנהגות בזמן שליחת הטופס. לדוגמה, אפשר להפעיל סקריפט של Apps Script כדי לטפל בטופס. אם הפעולה מופעלת, ערכי הטופס נשלחים לשרת.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
function |
פונקציה מותאמת אישית להפעלה כשמשתמש לוחץ על הרכיב המכיל או מופעל בצורה אחרת. דוגמה לשימוש: קריאת נתוני טפסים. |
parameters[] |
רשימת פרמטרים של פעולות. |
loadIndicator |
מציין את אינדיקטור הטעינה שהפעולה מוצגת בזמן ביצוע הקריאה לפעולה. |
persistValues |
מציין אם ערכי הטופס נשארים אחרי הפעולה. ערך ברירת המחדל הוא אם הערך הוא אם הערך הוא |
interaction |
זה שינוי אופציונלי. חובה כשפותחים תיבת דו-שיח. מה לעשות בתגובה לאינטראקציה עם משתמש, למשל לחיצה על לחצן בהודעת כרטיס. אם לא צוין אחרת, האפליקציה מגיבה באמצעות ביצוע ציון זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace. |
ActionParameter
רשימת פרמטרים של מחרוזות שצריך לספק כששיטת הפעולה מופעלת. לדוגמה, נניח שיש לכם שלושה לחצני 'לטיפול בהמשך': 'לטיפול בהמשך', 'לטיפול בהמשך' ביום אחד או ל'נודניק' בשבוע הבא. אפשר להשתמש ב-action method = snooze()
, להעביר את סוג הנודניק ואת משך ההשהיה ברשימת הפרמטרים של המחרוזת.
מידע נוסף זמין בכתובת CommonEventObject
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
key |
שם הפרמטר של סקריפט הפעולה. |
value |
ערך הפרמטר. |
אינטראקציה
זה שינוי אופציונלי. חובה כשפותחים תיבת דו-שיח.
מה לעשות בתגובה לאינטראקציה עם משתמש, למשל לחיצה על לחצן בהודעת כרטיס.
אם לא צוין אחרת, האפליקציה מגיבה באמצעות ביצוע action
, כמו פתיחת קישור או הפעלת פונקציה, כרגיל.
ציון interaction
מאפשר לאפליקציה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את interaction
לערך OPEN_DIALOG
, האפליקציה יכולה לפתוח תיבת דו-שיח.
אם המדיניות מוגדרת, לא יוצג אינדיקטור לטעינה. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג שום דבר אצל הלקוח.
זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
INTERACTION_UNSPECIFIED |
ערך ברירת המחדל. הפונקציה action פועלת כרגיל. |
OPEN_DIALOG |
פתיחת תיבת דו-שיח, ממשק מבוסס-חלונות עם חלון שמשמש אפליקציות צ'אט לאינטראקציה עם משתמשים. התכונה נתמכת רק באפליקציות ל-Chat בתגובה לקליקים על הודעות בכרטיס. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג שום דבר אצל הלקוח. זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace. |
LoadIndicator
מציין את אינדיקטור הטעינה שהפעולה מוצגת בזמן ביצוע הקריאה לפעולה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
SPINNER |
הצגת סימן גרפי שמסמן שהתוכן נטען. |
NONE |
שום דבר לא מוצג. |
BorderStyle
אפשרויות הסגנון של הגבול של כרטיס או ווידג'ט, כולל הסוג והצבע של הגבול.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
type |
סוג הגבול. |
strokeColor |
הצבעים שבהם יש להשתמש כאשר הסוג הוא |
cornerRadius |
רדיוס הפינה של הגבול. |
BorderType
מייצג את סוגי הגבולות שהוחלו על ווידג'טים.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
BORDER_TYPE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
NO_BORDER |
ערך ברירת המחדל. ללא גבול. |
STROKE |
מתאר. |
לחצן
לחצן עם טקסט, סמל או טקסט וסמל שהמשתמשים יכולים ללחוץ עליהם. תוכלו לראות דוגמה בהוספת לחצן באפליקציות Google Chat.
כדי להפוך תמונה ללחצן קליקבילי, צריך לציין
(לא Image
) ולהגדיר את הפעולה ImageComponent
onClick
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
text |
הטקסט שמוצג בתוך הלחצן. |
icon |
תמונת הסמל. אם גם |
color |
אם האפשרות מוגדרת, הלחצן מתמלא בצבע רקע אחיד וצבע הגופן משתנה כדי לשמור על הניגודיות לצבע הרקע. לדוגמה, אם מגדירים רקע כחול, סביר להניח שיופיע טקסט לבן. אם המדיניות לא מוגדרת, רקע התמונה יהיה לבן וצבע הגופן הוא כחול. עבור אדום, ירוק וכחול, הערך של כל שדה הוא מספר אפשר להגדיר את
עבור לדוגמה, הצבע הבא מייצג חצי אדום שקוף:
|
onClick |
חובה. הפעולה שצריך לבצע כשמשתמש לוחץ על הלחצן, כמו פתיחת היפר-קישור או הפעלת פונקציה מותאמת אישית. |
disabled |
אם |
altText |
הטקסט החלופי שמשמש לנגישות. מומלץ להגדיר טקסט תיאורי שמאפשר למשתמשים לדעת מה הלחצן עושה. לדוגמה, אם לחצן פותח היפר-קישור, אפשר לכתוב: "נפתח כרטיסייה חדשה בדפדפן ועוברים לתיעוד למפתחים של Google Chat בכתובת https://developers.google.com/workspace/chat". |
ButtonList
רשימת לחצנים בפריסה אופקית. תוכלו לראות דוגמה בהוספת לחצן באפליקציות Google Chat.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
buttons[] |
מערך של לחצנים. |
קלפים
ממשק של כרטיס שמוצג בהודעה ב-Google Chat או בתוסף של Google Workspace.
הכרטיסים תומכים בפריסה מוגדרת, ברכיבים אינטראקטיביים בממשק המשתמש כמו לחצנים ובמדיה עשירה כמו תמונות. אפשר להשתמש בכרטיסים כדי להציג מידע מפורט, לאסוף מידע מהמשתמשים ולהדריך את המשתמשים בשלבים הבאים.
עצב כרטיסים והצג תצוגה מקדימה שלהם באמצעות הכלי ליצירת כרטיסים.
לפתיחת הכלי ליצירת כרטיסיםכדי ללמוד איך ליצור כרטיסים, אפשר להיעזר במסמכים הבאים:
- למידע על אפליקציות Google Chat, תוכלו לקרוא את המאמר עיצוב הרכיבים של כרטיס או תיבת דו-שיח.
- מידע על תוספים ל-Google Workspace זמין במאמר ממשקים מבוססי כרטיסים.
דוגמה: הודעה בכרטיס לאפליקציה של Google Chat
כדי ליצור את ההודעה לדוגמה עם הכרטיס ב-Google Chat, צריך להשתמש בקובץ ה-JSON הבא:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
שדות | |
---|---|
header |
הכותרת של הכרטיס. כותרת מכילה בדרך כלל תמונה מובילה וכותרת. כותרות מופיעות תמיד בחלק העליון של כרטיס. |
sections[] |
מכיל אוסף של ווידג'טים. לכל קטע יש כותרת אופציונלית משלו. קטעים מופרדים באופן חזותי באמצעות קו מפריד. דוגמה באפליקציות Google Chat מופיעה במאמר הגדרת קטע בכרטיס. |
sectionDividerStyle |
סגנון ההפרדה בין הקטעים. |
cardActions[] |
הפעולות בכרטיס. הפעולות מתווספות לתפריט סרגל הכלים של הכרטיס. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. לדוגמה, קובץ ה-JSON הבא בונה תפריט פעולות בכרטיס עם האפשרויות
|
name |
שם הכרטיס. משמש כמזהה כרטיס בניווט כרטיסים. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
fixedFooter |
הכותרת התחתונה הקבועה שמוצגת בתחתית הכרטיס הזה. הגדרה של אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. |
displayStyle |
בתוספים ל-Google Workspace, מגדירה את מאפייני התצוגה של זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
peekCardHeader |
כשמציגים תוכן לפי הקשר, הכותרת של כרטיס ההצצה משמשת כ-placeholder, כדי שהמשתמש יוכל לנווט קדימה בין הכרטיסים בדף הבית לבין הכרטיסים לפי ההקשר. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
CardAction
פעולה בכרטיס היא הפעולה שמשויכת לכרטיס. לדוגמה, כרטיס חשבונית יכול לכלול פעולות כמו מחיקת חשבונית, חשבונית באימייל או פתיחת החשבונית בדפדפן.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
שדות | |
---|---|
actionLabel |
התווית שמוצגת כפריט בתפריט הפעולות. |
onClick |
הפעולה |
CardHeader
מייצג את כותרת הכרטיס. דוגמה בנושא הוספת כותרת באפליקציות של Google Chat.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
title |
חובה. הכותרת של כותרת הכרטיס. לכותרת יש גובה קבוע: אם מצוינות גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את הכותרת, היא תיכלל בשתי השורות. |
subtitle |
כותרת המשנה של כותרת הכרטיס. אם צוין, יופיע בשורה נפרדת מתחת ל- |
imageType |
הצורה שמשמשת לחיתוך התמונה. אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. |
imageUrl |
כתובת ה-URL מסוג HTTPS של התמונה בכותרת הכרטיס. |
imageAltText |
הטקסט החלופי של התמונה הזו שמשמש לנגישות. |
DisplayStyle
התוספים ל-Google Workspace קובעים איך הכרטיס יוצג.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
טיפוסים בני מנייה (enums) | |
---|---|
DISPLAY_STYLE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
PEEK |
כותרת הכרטיס מופיעה בתחתית סרגל הצד, ומכסה באופן חלקי את הכרטיס העליון של הערימה. לחיצה על הכותרת מקפיצה את הכרטיס לערימת הכרטיסים. אם אין לכרטיס כותרת, המערכת תשתמש בכותרת שנוצרה במקום זאת. |
REPLACE |
ערך ברירת המחדל. כדי להציג את הכרטיס, צריך להחליף את תצוגת הכרטיס העליון בערימת הכרטיסים. |
DividerStyle
סגנון המחיצה בכרטיס. בשלב זה משמש רק כמפרידים בין חלקי הכרטיסים.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
DIVIDER_STYLE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
SOLID_DIVIDER |
אפשרות ברירת המחדל. יוצרים הפרדה מלאה בין הקטעים. |
NO_DIVIDER |
אם היא מוגדרת, לא תוצג חלוקה בין קטעים. |
קטע
מקטע מכיל אוסף של ווידג'טים שעברו רינדור אנכי, לפי הסדר שבו הם צוינו.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
header |
טקסט שמופיע בחלק העליון של קטע. תומך בטקסט פשוט בפורמט HTML. למידע נוסף על עיצוב טקסט, אפשר לקרוא את המאמרים עיצוב הטקסט באפליקציות Google Chat ועיצוב הטקסט בתוספים ל-Google Workspace. |
widgets[] |
כל הווידג'טים שבקטע. צריכה להכיל ווידג'ט אחד לפחות. |
collapsible |
השדה הזה מציין אם ניתן לכווץ את הקטע הזה. קטעים מתכווצים מסתירים חלק מהווידג'טים או את כולם, אבל המשתמשים יכולים להרחיב את הקטע כדי לחשוף את הווידג'טים המוסתרים על ידי לחיצה על עוד. המשתמשים יכולים להסתיר שוב את הווידג'טים על ידי לחיצה על הצגת פחות. כדי לקבוע אילו ווידג'טים יוסתרו, אפשר לציין |
uncollapsibleWidgetsCount |
מספר הווידג'טים שאינם ניתנים לכיווץ שנשארים גלויים גם כאשר קטע מכווץ. לדוגמה, אם קטע מכיל חמישה ווידג'טים והשדה |
עמודות
בווידג'ט Columns
מוצגות עד 2 עמודות בכרטיס או בתיבת דו-שיח. ניתן להוסיף ווידג'טים לכל עמודה. הווידג'טים מופיעים לפי הסדר שבו צוינו. אפשר לראות דוגמה באפליקציות של Google Chat במאמר הצגת כרטיסים ותיבות דו-שיח בעמודות.
הגובה של כל עמודה נקבע לפי העמודה הגבוהה יותר. לדוגמה, אם העמודה הראשונה גבוהה מהעמודה השנייה, שתי העמודות יכללו את הגובה של העמודה הראשונה. מאחר שכל עמודה יכולה להכיל מספר שונה של ווידג'טים, לא ניתן להגדיר שורות או ליישר ווידג'טים בין העמודות.
העמודות מוצגות זו לצד זו. אפשר להתאים אישית את הרוחב של כל עמודה באמצעות השדה HorizontalSizeStyle
. אם רוחב המסך של המשתמש צר מדי, העמודה השנייה תגלוש מתחת לעמודה הראשונה:
- באינטרנט, העמודה השנייה גולשת אם רוחב המסך קטן מ-480 פיקסלים או שווה לו.
- במכשירי iOS, העמודה השנייה גולשת אם רוחב המסך קטן מ-300 נק' או שווה לו.
- במכשירי Android, העמודה השנייה גולשת אם רוחב המסך קטן מ-320dp או שווה לו.
כדי לכלול יותר מ-2 עמודות או להשתמש בשורות, צריך להשתמש בווידג'ט
.Grid
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. העמודות של תוספים ל-Google Workspace נמצאות בתצוגה המקדימה למפתחים.
שדות | |
---|---|
columnItems[] |
מערך של עמודות. אפשר לכלול עד 2 עמודות בכרטיס או בתיבת דו-שיח. |
עמודה
עמודה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. העמודות של תוספים ל-Google Workspace נמצאות בתצוגה המקדימה למפתחים.
שדות | |
---|---|
horizontalSizeStyle |
מציין איך עמודה ממלאת את רוחב הכרטיס. |
horizontalAlignment |
ההגדרה קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה. |
verticalAlignment |
ההגדרה קובעת אם הווידג'טים מיושרים לחלק העליון, לתחתית או למרכז העמודה. |
widgets[] |
מערך של ווידג'טים בעמודה. הווידג'טים מופיעים לפי הסדר שבו צוינו. |
HorizontalSizeStyle
מציין איך עמודה ממלאת את רוחב הכרטיס. הרוחב של כל עמודה תלוי גם ב-HorizontalSizeStyle
וגם ברוחב הווידג'טים של העמודה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. העמודות של תוספים ל-Google Workspace נמצאות בתצוגה המקדימה למפתחים.
טיפוסים בני מנייה (enums) | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
FILL_AVAILABLE_SPACE |
ערך ברירת המחדל. עמודה ממלאת את השטח הזמין, עד 70% מרוחב הכרטיס. אם שתי העמודות מוגדרות לערך FILL_AVAILABLE_SPACE , כל עמודה תמלא 50% מהשטח. |
FILL_MINIMUM_SPACE |
העמודה ממלאת את השטח המינימלי האפשרי, ולא יותר מ-30% מרוחב הכרטיס. |
VerticalAlignment
ההגדרה קובעת אם הווידג'טים מיושרים לחלק העליון, לתחתית או למרכז העמודה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. העמודות של תוספים ל-Google Workspace נמצאות בתצוגה המקדימה למפתחים.
טיפוסים בני מנייה (enums) | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
CENTER |
ערך ברירת המחדל. יישור ווידג'טים למרכז עמודה. |
TOP |
יישור ווידג'טים לחלק העליון של עמודה. |
BOTTOM |
יישור ווידג'טים לתחתית של עמודה. |
ווידג'טים
הווידג'טים הנתמכים שניתן לכלול בעמודה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. העמודות של תוספים ל-Google Workspace נמצאות בתצוגה המקדימה למפתחים.
שדות | |
---|---|
שדה איחוד
|
|
textParagraph |
ווידג'ט |
image |
ווידג'ט |
decoratedText |
ווידג'ט |
buttonList |
ווידג'ט |
textInput |
ווידג'ט |
selectionInput |
ווידג'ט |
dateTimePicker |
ווידג'ט |
DateTimePicker
מאפשרת למשתמשים להזין תאריך, שעה או גם תאריך וגם שעה. תוכלו לראות דוגמה באפליקציית Google Chat בקטע איך לאפשר למשתמש לבחור תאריך ושעה.
המשתמשים יכולים להזין טקסט או להשתמש בבורר כדי לבחור תאריכים ושעות. אם המשתמשים מזינים תאריך או שעה לא תקינים, בבורר תוצג שגיאה שתבקש מהמשתמשים להזין את המידע בצורה נכונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
name |
השם שבו למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
label |
הטקסט שמבקש מהמשתמשים להזין תאריך, שעה או תאריך ושעה. לדוגמה, אם משתמשים קובעים תור או פגישה, יש להשתמש בתווית כמו |
type |
האם הווידג'ט תומך בהזנת תאריך, שעה או תאריך ושעה. |
valueMsEpoch |
ערך ברירת המחדל המוצג בווידג'ט, באלפיות השנייה מאז ראשית זמן יוניקס (Unix epoch). צריך לציין את הערך על סמך סוג הבורר (
|
timezoneOffsetDate |
המספר שמייצג את סטיית אזור הזמן מ-UTC, בדקות. אם המדיניות מוגדרת, |
onChangeAction |
מופעל כשהמשתמש לוחץ על שמירה או על ניקוי בממשק |
DateTimePickerType
הפורמט של התאריך והשעה בווידג'ט DateTimePicker
. קובעת אם המשתמשים יכולים להזין תאריך, שעה או גם תאריך ושעה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
DATE_AND_TIME |
המשתמשים מזינים תאריך ושעה. |
DATE_ONLY |
המשתמשים מזינים תאריך. |
TIME_ONLY |
המשתמשים מזינים שעה. |
DecoratedText
ווידג'ט שמציג טקסט עם עיטורים אופציונליים, כמו תווית מעל או מתחת לטקסט, סמל לפני הטקסט, ווידג'ט של בחירה או לחצן אחרי הטקסט. תוכלו להיעזר בדוגמה שלמעלה באפליקציות Google Chat במאמר הצגת טקסט עם טקסט דקורטיבי.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
icon |
הוצא משימוש לטובת |
startIcon |
הסמל שמוצג לפני הטקסט. |
topLabel |
הטקסט שמופיע מעל |
text |
חובה. הטקסט הראשי. תומך בעיצוב פשוט. למידע נוסף על עיצוב טקסט, אפשר לקרוא את המאמרים עיצוב הטקסט באפליקציות Google Chat ועיצוב הטקסט בתוספים ל-Google Workspace. |
wrapText |
ההגדרה של גלישת הטקסט. אם הערך הוא רלוונטי רק לגבי |
bottomLabel |
הטקסט שמופיע מתחת ל- |
onClick |
הפעולה הזו מופעלת כשמשתמשים לוחצים על |
שדה איחוד control . לחצן, מתג, תיבת סימון או תמונה שמופיעים בצד שמאל של הטקסט בווידג'ט decoratedText . control יכול להיות רק אחד מהבאים: |
|
button |
לחצן שהמשתמש יכול ללחוץ עליו כדי להפעיל פעולה. |
switchControl |
ווידג'ט מתג שהמשתמש יכול ללחוץ עליו כדי לשנות את המצב שלו ולהפעיל פעולה. |
endIcon |
סמל שמוצג אחרי הטקסט. תומכת בסמלים מובנים ובסמלים מותאמים אישית. |
SwitchControl
מתג בסגנון מתג או תיבת סימון בתוך ווידג'ט decoratedText
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
התכונה נתמכת רק בווידג'ט decoratedText
.
שדות | |
---|---|
name |
השם שבו הווידג'ט של החלפת המצב מזוהה באירוע של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
value |
הערך שהוזן על ידי משתמש, שהוחזר כחלק מאירוע של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
selected |
כאשר |
onChangeAction |
הפעולה שצריך לבצע כשמצב המתג משתנה, למשל איזו פונקציה להרצה. |
controlType |
איך המתג מוצג בממשק המשתמש. אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. |
ControlType
איך המתג מוצג בממשק המשתמש.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
SWITCH |
מתג בסגנון. |
CHECKBOX |
הוצא משימוש לטובת CHECK_BOX . |
CHECK_BOX |
תיבת סימון. |
קו מפריד
אין שדות בסוג הזה.
מציג קו מפריד בין הווידג'טים. תוכלו לראות דוגמה באפליקציית Google Chat במאמר הוספת קו מפריד אופקי בין ווידג'טים.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:
"divider": {}
GetAutocompletionResponse
תגובה לקבלת מאגר של השלמה אוטומטית, שכוללת רכיבים שדרושים להצגת פריטים עם השלמה אוטומטית בשדה הטקסט.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. למשל:
{
"autoComplete": {
"items": [
{
"text": "C++"
},
{
"text": "Java"
},
{
"text": "JavaScript"
},
{
"text": "Python"
}
]
}
}
שדות | |
---|---|
autoComplete |
|
schema |
זהו שדה של סכימה ללא תפעול שעשוי להופיע בתגי העיצוב לצורך בדיקת תחביר. |
תצוגת רשת
הצגת רשת עם אוסף של פריטים. פריטים יכולים לכלול רק טקסט או תמונות. כדי להציג עמודות רספונסיביות, או כדי לכלול יותר מטקסט או תמונות, אפשר להשתמש בפונקציה
. דוגמה באפליקציית Google Chat מופיעה בקטע הצגת רשת עם אוסף פריטים.Columns
רשת תומכת בכל מספר של עמודות ופריטים. מספר השורות נקבע על ידי חלוקה של הפריטים במספר העמודות. רשת שמכילה 10 פריטים ו-2 עמודות מכילה 5 שורות. רשת שמכילה 11 פריטים ו-2 עמודות מכילה 6 שורות.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
לדוגמה, קובץ ה-JSON הבא יוצר רשת של שתי עמודות עם פריט אחד:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
שדות | |
---|---|
title |
הטקסט שמוצג בכותרת הרשת. |
items[] |
הפריטים שיוצגו ברשת. |
borderStyle |
סגנון הגבול שיש להחיל על כל פריט ברשת. |
columnCount |
מספר העמודות שיוצגו ברשת. המערכת תשתמש בערך ברירת מחדל אם לא צוין ערך בשדה הזה. ערך ברירת המחדל משתנה בהתאם למיקום של תצוגת רשת (תיבת דו-שיח לעומת תצוגה נלווית). |
onClick |
כל פריט ברשת עושה שימוש חוזר בקריאה חוזרת, אבל המזהה והאינדקס של הפריט ברשימת הפריטים מתווספים לפרמטרים של הקריאה החוזרת. |
GridItem
מייצג פריט בפריסת רשת. פריטים יכולים להכיל טקסט, תמונה או גם טקסט וגם תמונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
id |
מזהה שצוין על ידי המשתמש לפריט הרשת הזה. המזהה הזה מוחזר בפרמטרים |
image |
התמונה שמוצגת בפריט הרשת. |
title |
שם הפריט ברשת. |
subtitle |
כותרת המשנה של פריט הרשת. |
layout |
הפריסה שבה יש להשתמש עבור פריט הרשת. |
GridItemLayout
מייצג את אפשרויות הפריסה השונות הזמינות לפריט רשת.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
TEXT_BELOW |
הכותרת וכותרת המשנה מוצגות מתחת לתמונה של פריט הרשת. |
TEXT_ABOVE |
הכותרת וכותרת המשנה מוצגות מעל לתמונה של פריט הרשת. |
סמל
סמל שמוצג בווידג'ט בכרטיס. תוכלו לראות דוגמה בהוספת סמל באפליקציות של Google Chat.
תומכת בסמלים מובנים ובסמלים מותאמים אישית.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
altText |
זה שינוי אופציונלי. תיאור של הסמל שמשמש לנגישות. אם לא צוין ערך ברירת מחדל, הערך אם הסמל מוגדר ב- |
imageType |
סגנון החיתוך שהוחל על התמונה. במקרים מסוימים, החלת חיתוך מסוג |
שדה איחוד icons . הסמל שמוצג בווידג'ט בכרטיס. icons יכול להיות רק אחד מהבאים: |
|
knownIcon |
להציג את אחד מהסמלים המובנים של Google Workspace. לדוגמה, כדי להציג סמל מטוס, צריך לציין רשימה מלאה של הסמלים הנתמכים זמינה במאמר סמלים מובנים. |
iconUrl |
הצגה של סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS. למשל:
סוגי הקבצים הנתמכים כוללים |
materialIcon |
להציג את אחד מהסמלים של Google Materials. לדוגמה, כדי להציג סמל של תיבת סימון, השתמש ב-
זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace. |
תמונה
תמונה שמצוינת באמצעות כתובת URL ויכולה לכלול פעולה מסוג onClick
. לדוגמה, ראו הוספת תמונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
imageUrl |
כתובת ה-URL מסוג HTTPS שמארחת את התמונה. למשל:
|
onClick |
כשמשתמש לוחץ על התמונה, הקליק מפעיל את הפעולה הזו. |
altText |
הטקסט החלופי של התמונה הזו שמשמש לנגישות. |
ImageComponent
מייצג תמונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
imageUri |
כתובת ה-URL של התמונה. |
altText |
תווית הנגישות של התמונה. |
cropStyle |
סגנון החיתוך שצריך להחיל על התמונה. |
borderStyle |
סגנון הגבול שיוחל על התמונה. |
ImageCropStyle
מייצג את סגנון החיתוך שהוחל על תמונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
לדוגמה, כך מגדירים יחס גובה-רוחב של 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
שדות | |
---|---|
type |
סוג החיתוך. |
aspectRatio |
יחס הגובה-רוחב שבו יש להשתמש אם סוג החיתוך הוא לדוגמה, כך מגדירים יחס גובה-רוחב של 16:9:
|
ImageCropType
מייצג את סגנון החיתוך שהוחל על תמונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
SQUARE |
ערך ברירת המחדל. מחיל חיתוך מרובע. |
CIRCLE |
יוצר חיתוך עגול. |
RECTANGLE_CUSTOM |
מחיל חיתוך מלבני עם יחס גובה-רוחב מותאם אישית. מגדירים את יחס הגובה-רוחב המותאם אישית באמצעות aspectRatio . |
RECTANGLE_4_3 |
מחיל חיתוך מלבני עם יחס גובה-רוחב של 4:3. |
קישור
אובייקט הקישור של משאב הצד השלישי שמוחזר לתוסף. מידע נוסף זמין במאמר יצירת משאבים של צד שלישי מתפריט ה-@.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
שדות | |
---|---|
url |
כתובת ה-URL של הקישור להחזרת התוסף. |
title |
שם הקישור שצריך לחזור לתוסף. |
LinkPreview
פעולה בכרטיס שמציגה תצוגה מקדימה של קישור לצד שלישי על ידי הצגת כרטיס וצ'יפ חכם. מידע נוסף זמין במאמר תצוגה מקדימה של קישורים עם צ'יפים חכמים.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
לדוגמה, קובץ ה-JSON הבא מחזיר כותרת ייחודית לתצוגה המקדימה של הקישור ולצ'יפ החכם שלו, וכרטיס תצוגה מקדימה עם כותרת ותיאור טקסט:
{
"action": {
"linkPreview": {
"title": "Smart chip title",
"linkPreviewTitle": "Link preview title",
"previewCard": {
"header": {
"title": "Preview card header",
},
"sections": [
{
"widgets": [
{
"textParagraph": {
"text": "Description of the link."
}
}
]
}
]
}
}
}
}
הדוגמה מחזירה את התצוגה המקדימה הבאה של הקישור:
שדות | |
---|---|
previewCard |
כרטיס שמציג מידע על קישור משירות של צד שלישי. |
title |
השם שמוצג בצ'יפ החכם בתצוגה המקדימה של הקישור. אם המדיניות לא מוגדרת, הצ'יפ החכם יציג את הכותרת של |
linkPreviewTitle |
הכותרת שמוצגת בתצוגה המקדימה של הקישור. אם המדיניות לא מוגדרת, בתצוגה המקדימה של הקישור תוצג הכותרת של |
MaterialIcon
סמל של חומר לימוד של Google, שכולל יותר מ-2500 אפשרויות.
לדוגמה, כדי להציג סמל של תיבת סימון עם משקל וציון מותאמים אישית, כותבים את הפרטים הבאים:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
name |
שם הסמל שמוגדר בסמל של Google Analytics, לדוגמה, |
fill |
אם הסמל מוצג כמלא. ערך ברירת המחדל הוא False. כדי להציג הגדרות שונות של סמלים, עוברים אל Google Fonts ומשנים את ההגדרות בקטע התאמה אישית. |
weight |
עובי הקו של הסמל. יש לבחור מבין האפשרויות {100, 200, 300, 400, 500, 600, 700}. אם השדה חסר, ערך ברירת המחדל הוא 400. אם צוין ערך אחר, המערכת תשתמש בערך ברירת המחדל. כדי להציג הגדרות שונות של סמלים, עוברים אל Google Fonts ומשנים את ההגדרות בקטע התאמה אישית. |
grade |
המשקל והציון משפיעים על העובי של הסמל. התאמות של הציון מפורטות יותר מהתאמות במשקל, ויש להן השפעה קטנה על גודל הסמל. יש לבחור מבין האפשרויות {-25, 0, 200}. אם השדה חסר, ערך ברירת המחדל הוא 0. אם צוין ערך אחר, המערכת תשתמש בערך ברירת המחדל. כדי להציג הגדרות שונות של סמלים, עוברים אל Google Fonts ומשנים את ההגדרות בקטע התאמה אישית. |
התראה
פעולה בכרטיס שמציגה התראה באפליקציה המארחת.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
שדות | |
---|---|
text |
טקסט פשוט להצגה עבור ההתראה, ללא תגי HTML. |
OnClick
מייצגות את האופן שבו משתמשים לוחצים על רכיב אינטראקטיבי בכרטיס, כמו לחצן.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
שדה איחוד
|
|
action |
אם צוין, פעולה מסוימת תופעל על ידי |
openLink |
אם המדיניות |
openDynamicLinkAction |
תוסף מפעיל את הפעולה הזו כשצריך לפתוח קישור בפעולה. התכונה הזו שונה מ- זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
card |
כרטיס חדש יידחף לערימת הכרטיסים לאחר לחיצה, אם צוין. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
OpenLink
מייצג אירוע onClick
שפותח היפר-קישור.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
url |
כתובת ה-URL לפתיחה. |
openAs |
איך פותחים קישור. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
onClose |
האם הלקוח שוכח בקישור אחרי שהוא פותח אותו, או צופה בו עד שהחלון נסגר. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
OnClose
מה הלקוח עושה כשקישור שנפתח על ידי פעולה OnClick
נסגר.
ההטמעה תלויה ביכולות הפלטפורמה של הלקוח. לדוגמה, דפדפן אינטרנט עשוי לפתוח קישור בחלון קופץ עם handler של OnClose
.
אם גם OnOpen
וגם OnClose
מוגדרים, ופלטפורמת הלקוח לא יכולה לתמוך בשני הערכים, המדיניות OnClose
מקבלת עדיפות.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
טיפוסים בני מנייה (enums) | |
---|---|
NOTHING |
ערך ברירת המחדל. הכרטיס לא נטען מחדש. לא קורה כלום. |
RELOAD |
טעינת הכרטיס מחדש אחרי שחלון הצאצא נסגר. אם משתמשים בו בשילוב עם |
OpenAs
כשפעולה OnClick
פותחת קישור, הלקוח יכול לפתוח אותו כחלון בגודל מלא (אם זו המסגרת שבה משתמש הלקוח), או כשכבת-על (כמו חלון קופץ). ההטמעה תלויה ביכולות של פלטפורמת הלקוח, ויכול להיות שהמערכת תתעלם מהערך שנבחר אם הלקוח לא תומך בה. כל הלקוחות תומכים ב-FULL_SIZE
.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.
טיפוסים בני מנייה (enums) | |
---|---|
FULL_SIZE |
הקישור נפתח כחלון בגודל מלא (אם זו המסגרת שהלקוח משתמש בה). |
OVERLAY |
הקישור נפתח כשכבת-על, כמו חלון קופץ. |
RenderActions
קבוצה של הוראות עיבוד שמסבירות לכרטיס לבצע פעולה, או מנחה את האפליקציה המארחת של התוסף או את אפליקציית Chat לבצע פעולה ספציפית לאפליקציה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
action |
|
hostAppAction |
פעולות שמטופלות על ידי אפליקציות מארחות נפרדות. |
schema |
זהו שדה של סכימה ללא תפעול שעשוי להופיע בתגי העיצוב לצורך בדיקת תחביר. |
פעולה
שדות | |
---|---|
navigations[] |
דחוף, הקפץ או עדכן את הכרטיסים המוצגים. |
link |
פתח מיד את קישור היעד בכרטיסייה חדשה או בחלון קופץ. |
notification |
הצגת התראה למשתמש הקצה. |
linkPreview |
הצגת תצוגה מקדימה של הקישור למשתמש הקצה. |
links[] |
הקישור למשאב של צד שלישי שנוצר מתוך אפליקציה של Google Workspace. בפורמט של מערך אובייקטים עם פריט אחד. מידע נוסף זמין במאמר יצירת משאבים של צד שלישי מתפריט ה-@. |
SelectionInput
ווידג'ט שיוצר פריט אחד או יותר בממשק המשתמש שהמשתמשים יכולים לבחור. לדוגמה, תפריט נפתח או תיבות סימון. אפשר להשתמש בווידג'ט הזה כדי לאסוף נתונים שניתן לחזות או לספור. דוגמה באפליקציות Google Chat: הוספת רכיבים ניתנים לבחירה בממשק המשתמש.
אפליקציות צ'אט יכולות לעבד את הערך של פריטים שהמשתמשים בוחרים או מזינים. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס.
כדי לאסוף נתונים לא מוגדרים או מופשטים ממשתמשים, יש להשתמש בווידג'ט TextInput
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
name |
השם שמזהה את קלט הבחירה באירוע של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
label |
הטקסט שמופיע מעל לשדה הבחירה להזנת קלט בממשק המשתמש. צריך לציין טקסט שעוזר למשתמש להזין את המידע שהאפליקציה צריכה. לדוגמה, אם משתמשים בוחרים את מידת הדחיפות של כרטיס עבודה מתפריט נפתח, התווית יכולה להיות 'דחיפות' או 'בחירת דחיפות'. |
type |
סוג הפריטים שמוצגים למשתמשים בווידג'ט |
items[] |
מערך של פריטים שאפשר לבחור. לדוגמה, מערך של לחצני בחירה או תיבות סימון. תמיכה ב-100 פריטים לכל היותר. |
onChangeAction |
אם מציינים את הפרמטר הזה, הטופס נשלח כשהבחירה משתנה. אם לא, צריך לציין לחצן נפרד לשליחת הטופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
multiSelectMaxSelectedItems |
בתפריטים של בחירה מרובה, מספר הפריטים המקסימלי שמשתמש יכול לבחור. הערך המינימלי הוא פריט אחד. אם לא צוין, ברירת המחדל היא 3 פריטים. |
multiSelectMinQueryLength |
בתפריטים של בחירה מרובה, מספר תווי הטקסט שהמשתמש מזין לפני השלמה אוטומטית של שאילתות באפליקציה, והצגת הצעות לפריטים בתפריט. אם לא צוין אחרת, ברירת המחדל היא 0 תווים במקורות נתונים סטטיים ו-3 תווים במקורות נתונים חיצוניים. |
שדה איחוד זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace. |
|
externalDataSource |
מקור נתונים חיצוני, כמו בסיס נתונים יחסי. |
platformDataSource |
מקור נתונים מ-Google Workspace. |
PlatformDataSource
לווידג'ט של
שנעשה בו שימוש בתפריט לבחירה מרובה, מקור נתונים מ-Google Workspace. משמש לאכלוס פריטים בתפריט בחירה מרובה.SelectionInput
זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
שדה איחוד data_source . מקור הנתונים. data_source יכול להיות רק אחד מהבאים: |
|
commonDataSource |
מקור נתונים שמשותף לכל האפליקציות של Google Workspace, כמו משתמשים בארגון ב-Google Workspace. |
hostAppDataSource |
מקור נתונים ייחודי לאפליקציית אירוח ב-Google Workspace, כמו מרחבים משותפים ב-Google Chat. |
CommonDataSource
מקור נתונים שמשותף לכל האפליקציות של Google Workspace.
זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN |
ערך ברירת המחדל. אין להשתמש בו. |
USER |
משתמשי Google Workspace. המשתמש יכול רק להציג ולבחור משתמשים מהארגון שלהם ב-Google Workspace. |
SelectionItem
פריט שהמשתמשים יכולים לבחור בקלט של בחירה, כמו תיבת סימון או מתג.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
text |
הטקסט שמזהה או מתאר את הפריט למשתמשים. |
value |
הערך שמשויך לפריט הזה. הלקוח צריך להשתמש בו כערך של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
selected |
אם הפריט נבחר כברירת מחדל. אם קלט הבחירה מקבל ערך אחד בלבד (לדוגמה, ללחצני בחירה או לתפריט נפתח), יש להגדיר את השדה הזה לפריט אחד בלבד. |
startIconUri |
בתפריטים של בחירה מרובה, כתובת ה-URL של הסמל שמוצג לצד השדה |
bottomText |
בתפריטים של בחירה מרובה, תיאור טקסט או תווית שמוצגים מתחת לשדה |
SelectionType
הפורמט של הפריטים שהמשתמשים יכולים לבחור. האפשרויות השונות תומכות בסוגים שונים של אינטראקציות. לדוגמה, משתמשים יכולים לסמן כמה תיבות סימון, אבל הם יכולים לבחור רק פריט אחד מתוך תפריט נפתח.
כל קלט של בחירה תומך בסוג אחד של בחירה. לדוגמה, אין תמיכה בשילוב של תיבות סימון ומתגים.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
CHECK_BOX |
קבוצה של תיבות סימון. המשתמשים יכולים לבחור תיבת סימון אחת או יותר. |
RADIO_BUTTON |
קבוצה של לחצני בחירה. המשתמשים יכולים לבחור לחצן בחירה אחד. |
SWITCH |
קבוצת מתגים. המשתמשים יכולים להפעיל מתג אחד או יותר. |
DROPDOWN |
תפריט נפתח. המשתמשים יכולים לבחור פריט אחד מהתפריט. |
MULTI_SELECT |
תפריט לבחירה מרובה עבור נתונים סטטיים או דינמיים. בסרגל התפריטים, המשתמשים בוחרים אפשרות אחת או יותר. המשתמשים יכולים גם להזין ערכים כדי לאכלס נתונים דינמיים. לדוגמה, משתמשים יכולים להתחיל להקליד את השם של מרחב משותף ב-Google Chat, והווידג'ט יציע אוטומטית את המרחב המשותף. כדי לאכלס פריטים בתפריט של בחירה מרובה, אפשר להשתמש באחד מהסוגים הבאים של מקורות נתונים:
לדוגמאות איך להטמיע תפריטים של בחירה מרובה, ראו הוספת תפריט של בחירה מרובה. אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. האפשרות 'בחירה מרובה' לתוספים ל-Google Workspace זמינה בתצוגה מקדימה למפתחים. |
SubmitFormResponse
תגובה לטופס שלא נשלח, מלבד קבלה של מאגר להשלמה אוטומטית, שמכיל את הפעולות שהכרטיס צריך לבצע ו/או האפליקציה המארחת של התוסף צריכה לבצע, וכן לציין אם מצב הכרטיס השתנה.
זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. למשל:
{
"renderActions": {
"action": {
"notification": {
"text": "Email address is added: salam.heba@example.com"
}
},
"hostAppAction": {
"gmailAction": {
"openCreatedDraftAction": {
"draftId": "msg-a:r-79766936926021702",
"threadServerPermId": "thread-f:15700999851086004"
}
}
}
}
}
שדות | |
---|---|
renderActions |
קבוצה של הוראות עיבוד שמנחה את הכרטיס לבצע פעולה ו/או מנחה את האפליקציה המארחת של התוסף לבצע פעולה ספציפית לאפליקציה. |
stateChanged |
האם מצב הכרטיסים השתנה והנתונים בכרטיסים הקיימים לא פעילים. |
schema |
זהו שדה סכימה ללא תפעול שעשוי להופיע בתגי העיצוב לצורך בדיקת תחביר. |
הצעות
ערכים מוצעים שהמשתמשים יכולים להזין. הערכים האלה מופיעים כשמשתמשים לוחצים בתוך השדה להזנת הטקסט. בזמן שהמשתמשים מקלידים, הערכים המוצעים מסוננים באופן דינמי כדי להתאים למה שהמשתמשים הזינו.
לדוגמה, שדה להזנת טקסט לשפת התכנות עשוי להציע את Java, JavaScript, Python ו-C++. כשמשתמשים מתחילים להקליד Jav
, רשימת ההצעות מסננת להצגת Java
ו-JavaScript
.
ההצעות לערכים עוזרות לכוון את המשתמשים להזנת ערכים שיכולים להיות רלוונטיים לאפליקציה. כאשר מתייחסים ל-JavaScript, חלק מהמשתמשים עשויים להזין javascript
ואחרים java script
. ההצעה של JavaScript
יכולה לקבוע סטנדרט אחיד לאינטראקציה של המשתמשים עם האפליקציה.
כשהיא מוגדרת, TextInput.type
הוא תמיד SINGLE_LINE
, גם אם הוא מוגדר לערך MULTIPLE_LINE
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
items[] |
רשימת הצעות שמשמשות להמלצות להשלמה אוטומטית בשדות להזנת טקסט. |
SuggestionItem
ערך מוצע אחד שהמשתמשים יכולים להזין בשדה להזנת טקסט.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
שדה איחוד
|
|
text |
הערך של קלט מוצע בשדה להזנת טקסט. הערך הזה זהה לטקסט שהמשתמשים מזינים את עצמם. |
TextInput
שדה שבו המשתמשים יכולים להזין טקסט. תומכת בהצעות ובפעולות שינוי. דוגמה לכך באפליקציות Google Chat מופיעה במאמר הוספת שדה שבו המשתמש יכול להזין טקסט.
אפליקציות צ'אט מקבלות ויכולות לעבד את הערך של טקסט שהוזן במהלך אירועים של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס.
אם אתם צריכים לאסוף נתונים לא מוגדרים או מופשטים ממשתמשים, כדאי להשתמש בקלט טקסט. כדי לאסוף נתונים מוגדרים או ממוינים ממשתמשים, צריך להשתמש בווידג'ט SelectionInput
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
name |
השם שבאמצעותו קלט הטקסט מזוהה באירוע של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
label |
הטקסט שמופיע מעל השדה להזנת הטקסט בממשק המשתמש. צריך לציין טקסט שעוזר למשתמש להזין את המידע שהאפליקציה צריכה. לדוגמה, אם שאלת לשמו של מישהו, אך אתה צריך את שם המשפחה שלו, עליך לכתוב חובה אם לא צוין |
hintText |
טקסט שמופיע מתחת לשדה של קלט הטקסט, ומטרתו לעזור למשתמשים להזין ערך מסוים. הטקסט הזה תמיד גלוי. חובה אם לא צוין |
value |
הערך שהוזן על ידי משתמש, שהוחזר כחלק מאירוע של קלט טופס. למידע על עבודה עם קלט של טופס, אפשר לעיין במאמר קבלת נתוני טופס. |
type |
איך שדה להזנת קלט מופיע בממשק המשתמש. לדוגמה, אם השדה הוא שורה אחת או מספר שורות. |
onChangeAction |
מה לעשות כאשר מתרחש שינוי בשדה של קלט הטקסט. לדוגמה, משתמש שמוסיף טקסט לשדה או מוחק טקסט. לדוגמה, אפשר להריץ פונקציה בהתאמה אישית או לפתוח תיבת דו-שיח ב-Google Chat. |
initialSuggestions |
ערכים מוצעים שהמשתמשים יכולים להזין. הערכים האלה מופיעים כשמשתמשים לוחצים בתוך השדה להזנת הטקסט. בזמן שהמשתמשים מקלידים, הערכים המוצעים מסוננים באופן דינמי כדי להתאים למה שהמשתמשים הזינו. לדוגמה, שדה להזנת טקסט לשפת התכנות עשוי להציע Java , JavaScript , Python ו-C++. כשמשתמשים מתחילים להקליד ההצעות לערכים עוזרות לכוון את המשתמשים להזנת ערכים שיכולים להיות רלוונטיים לאפליקציה. כאשר מתייחסים ל-JavaScript, חלק מהמשתמשים עשויים להזין כשהיא מוגדרת, אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. |
autoCompleteAction |
זה שינוי אופציונלי. מציינים איזו פעולה לבצע כשמוצגות הצעות למשתמשים שמקיימים אינטראקציה עם השדה של קלט הטקסט. אם לא צוין אחרת, ההצעות מוגדרות על ידי אם צוינה בקשה, האפליקציה תבצע את הפעולה שצוינה כאן, למשל הפעלת פונקציה מותאמת אישית. זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat. |
placeholderText |
טקסט שמופיע בשדה להזנת קלט כאשר השדה ריק. הטקסט הזה משמש כדי לבקש מהמשתמשים להזין ערך. לדוגמה, זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace. |
סוג
איך שדה להזנת קלט מופיע בממשק המשתמש. לדוגמה, אם מדובר בשדה להזנת קלט של שורה בודדת או אם מדובר בקלט מרובה שורות. אם מציינים את הערך initialSuggestions
, הערך של type
הוא תמיד SINGLE_LINE
, גם אם הוא מוגדר לערך MULTIPLE_LINE
.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
SINGLE_LINE |
בשדה להזנת הטקסט יש גובה קבוע של שורה אחת. |
MULTIPLE_LINE |
בשדה להזנת הטקסט יש גובה קבוע של כמה שורות. |
TextParagraph
פסקה של טקסט שתומכת בעיצוב. תוכלו להיעזר בדוגמה שבמאמר הוספת פסקה של טקסט מעוצב באפליקציית Google Chat. למידע נוסף על עיצוב טקסט, אפשר לקרוא את המאמרים עיצוב הטקסט באפליקציות Google Chat ועיצוב הטקסט בתוספים ל-Google Workspace.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
שדות | |
---|---|
text |
הטקסט המוצג בווידג'ט. |
ווידג'ט
כל כרטיס מורכב מווידג'טים.
ווידג'ט הוא אובייקט מורכב שיכול לייצג טקסט, תמונות, לחצנים וסוגי אובייקטים אחרים.
שדות | |
---|---|
horizontalAlignment |
ההגדרה קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה. |
שדה איחוד data . ווידג'ט יכול לכלול רק אחד מהפריטים הבאים. אפשר להשתמש בכמה שדות בווידג'ט כדי להציג יותר פריטים. data יכול להיות רק אחד מהבאים: |
|
textParagraph |
הצגת פסקה של טקסט. תומך בטקסט פשוט בפורמט HTML. למידע נוסף על עיצוב טקסט, אפשר לקרוא את המאמרים עיצוב הטקסט באפליקציות Google Chat ועיצוב הטקסט בתוספים ל-Google Workspace. לדוגמה, קובץ ה-JSON הבא יוצר טקסט מודגש:
|
image |
מוצגת תמונה. לדוגמה, קובץ ה-JSON הבא יוצר תמונה עם טקסט חלופי:
|
decoratedText |
מציג פריט טקסט מקושט. לדוגמה, קובץ ה-JSON הבא יוצר ווידג'ט טקסט מעוצב שמציג את כתובת האימייל:
|
buttonList |
רשימת לחצנים. לדוגמה, קובץ ה-JSON הבא יוצר שני לחצנים. הראשון הוא לחצן טקסט כחול והשני הוא לחצן תמונה שפותח קישור:
|
textInput |
הצגת תיבת טקסט שהמשתמשים יכולים להקליד בה. לדוגמה, קובץ ה-JSON הבא יוצר קלט טקסט לכתובת אימייל:
כדוגמה נוספת, קובץ ה-JSON הבא יוצר קלט טקסט עבור שפת תכנות עם הצעות סטטיות:
|
selectionInput |
מציג פקד בחירה שמאפשר למשתמשים לבחור פריטים. פקדי הבחירה יכולים להיות תיבות סימון, לחצני בחירה, מתגים או תפריטים נפתחים. לדוגמה, קובץ ה-JSON הבא יוצר תפריט נפתח שמאפשר למשתמשים לבחור גודל:
|
dateTimePicker |
מציג ווידג'ט שמאפשר למשתמשים להזין תאריך, שעה או תאריך ושעה. לדוגמה, קובץ ה-JSON הבא יוצר חלונית לבחירת תאריך ושעה כדי לקבוע פגישה:
|
divider |
מציג קו אופקי בין ווידג'טים. לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:
|
grid |
הצגת רשת עם אוסף של פריטים. רשת תומכת בכל מספר של עמודות ופריטים. מספר השורות נקבע לפי הגבול העליון של מספר הפריטים, חלקי מספר העמודות. רשת שמכילה 10 פריטים ו-2 עמודות מכילה 5 שורות. רשת שמכילה 11 פריטים ו-2 עמודות מכילה 6 שורות. אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. לדוגמה, קובץ ה-JSON הבא יוצר רשת של שתי עמודות עם פריט אחד:
|
columns |
הצגה של עד 2 עמודות. כדי לכלול יותר מ-2 עמודות או להשתמש בשורות, צריך להשתמש בווידג'ט לדוגמה, קובץ ה-JSON הבא יוצר 2 עמודות שכל אחת מהן מכילה פסקאות טקסט:
|
HorizontalAlignment
ההגדרה קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה.
זמין באפליקציות Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
START |
ערך ברירת המחדל. יישור הווידג'טים למיקום ההתחלה של העמודה. לפריסות משמאל לימין, יישור לשמאל. בפריסות מימין לשמאל, יישור לימין. |
CENTER |
יישור ווידג'טים למרכז העמודה. |
END |
יישור הווידג'טים למיקום הסיום של העמודה. בפריסות משמאל לימין, יישור הווידג'טים ימינה. בפריסות מימין לשמאל, מיישר ווידג'טים לשמאל. |
ImageType
הצורה שמשמשת לחיתוך התמונה.
אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.
טיפוסים בני מנייה (enums) | |
---|---|
SQUARE |
ערך ברירת המחדל. החלת מסכה ריבועית על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת ל-3x3. |
CIRCLE |
החלת מסכה מעוגלת על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לעיגול בקוטר 3. |