אינדקס
Action
(הודעה)Action.ActionParameter
(הודעה)Action.Interaction
(טיפוס טיפוסים בני מנייה (enum))Action.LoadIndicator
(טיפוס טיפוסים בני מנייה (enum))BorderStyle
(הודעה)BorderStyle.BorderType
(טיפוס טיפוסים בני מנייה (enum))Button
(הודעה)Button.Type
(טיפוס טיפוסים בני מנייה (enum))ButtonList
(הודעה)Card
(הודעה)Card.CardAction
(הודעה)Card.CardFixedFooter
(הודעה)Card.CardHeader
(הודעה)Card.DisplayStyle
(טיפוס טיפוסים בני מנייה (enum))Card.DividerStyle
(enum)Card.Section
(הודעה)Chip
(הודעה)ChipList
(הודעה)ChipList.Layout
(טיפוס טיפוסים בני מנייה (enum))CollapseControl
(הודעה)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
(הודעה)Grid
(הודעה)Grid.GridItem
(הודעה)Grid.GridItem.GridItemLayout
(טיפוס טיפוסים בני מנייה (enum))Icon
(הודעה)Image
(הודעה)ImageComponent
(הודעה)ImageCropStyle
(הודעה)ImageCropStyle.ImageCropType
(enum)MaterialIcon
(הודעה)OnClick
(הודעה)OpenLink
(הודעה)OpenLink.OnClose
(טיפוס טיפוסים בני מנייה (enum))OpenLink.OpenAs
(טיפוס טיפוסים בני מנייה (enum))OverflowMenu
(הודעה)OverflowMenu.OverflowMenuItem
(הודעה)SelectionInput
(הודעה)SelectionInput.PlatformDataSource
(הודעה)SelectionInput.PlatformDataSource.CommonDataSource
(טיפוס טיפוסים בני מנייה (enum))SelectionInput.SelectionItem
(הודעה)SelectionInput.SelectionType
(enum)Suggestions
(הודעה)Suggestions.SuggestionItem
(הודעה)TextInput
(הודעה)TextInput.Type
(טיפוס טיפוסים בני מנייה (enum))TextParagraph
(הודעה)Validation
(הודעה)Validation.InputType
(טיפוס טיפוסים בני מנייה (enum))Widget
(הודעה)Widget.HorizontalAlignment
(enum)Widget.ImageType
(טיפוס טיפוסים בני מנייה (enum))
פעולה
פעולה שמתארת את ההתנהגות בזמן שליחת הטופס. לדוגמה, אפשר להפעיל סקריפט של Apps Script כדי לטפל בטופס. אם הפעולה מופעלת, ערכי הטופס נשלחים לשרת.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
function |
פונקציה מותאמת אישית שמופעלת כשמשתמש לוחץ על הרכיב שמכיל אותו או מופעל בדרך אחרת. לדוגמה שימוש, אפשר לעיין במאמר קריאת נתוני טפסים. |
parameters[] |
רשימה של פרמטרים של פעולות. |
load_indicator |
מציין את אינדיקטור הטעינה שיוצג בזמן הקריאה לפעולה. |
persist_values |
מציין אם ערכי הטופס נשארים אחרי הפעולה. ערך ברירת המחדל הוא אם הערך שלו הוא אם הערך שלו הוא |
interaction |
זה שינוי אופציונלי. חובה כשפותחים תיבת דו-שיח. מה לעשות בתגובה לאינטראקציה עם משתמש, למשל לחיצה על לחצן בהודעה בכרטיס. אם לא צוין אחרת, האפליקציה מגיבה על ידי הפעלה רגילה של כשמציינים זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
required_widgets[] |
אם לווידג'טים שמופיעים כאן אין ערך כשהפעולה הזו מופעלת, שליחת הטופס תבוטל. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
all_widgets_are_required |
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
ActionParameter
רשימת הפרמטרים של המחרוזת שיש לספק כששיטת הפעולה מופעלת. לדוגמה, השתמשו בשלושה לחצני 'לטיפול בהמשך': 'לטיפול בהמשך', 'לטיפול בהמשך' יום אחד או לטיפול בהמשך בשבוע הבא. אפשר להשתמש ב-action method = snooze()
, ולהעביר את סוג ההשהיה ואת משך ההשהיה ברשימה של פרמטרים של מחרוזות.
מידע נוסף זמין בכתובת CommonEventObject
.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
key |
שם הפרמטר לסקריפט הפעולה. |
value |
ערך הפרמטר. |
אינטראקציה
זה שינוי אופציונלי. חובה כשפותחים תיבת דו-שיח.
מה לעשות בתגובה לאינטראקציה עם משתמש, למשל לחיצה על לחצן בהודעה בכרטיס.
אם לא צוין אחרת, האפליקציה מגיבה על ידי הפעלה רגילה של action
, כמו פתיחת קישור או הרצת פונקציה.
כשמציינים interaction
, האפליקציה יכולה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את interaction
לערך OPEN_DIALOG
, האפליקציה יכולה לפתוח תיבת דו-שיח.
אם השדה הזה מוגדר, אינדיקטור הטעינה לא מוצג. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג דבר באפליקציית הלקוח.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
INTERACTION_UNSPECIFIED |
ערך ברירת המחדל. action פועל כרגיל. |
OPEN_DIALOG |
תיפתח תיבת דו-שיח – ממשק מבוסס-חלון עם חלון שמשמש אפליקציות ל-Chat לקיום אינטראקציה עם משתמשים. התכונה נתמכת רק באפליקציות Chat בתגובה ללחיצה על לחצנים על הודעות בכרטיס. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג דבר באפליקציית הלקוח. זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
LoadIndicator
מציינת את אינדיקטור הטעינה שמוצג בזמן ביצוע הקריאה לפעולה.
התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
SPINNER |
מציג סימן גרפי שמצביע על כך שהתוכן נטען. |
NONE |
לא מוצג שום דבר. |
BorderStyle
אפשרויות הסגנון של גבול כרטיס או ווידג'ט, כולל סוג וצבע הגבול.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
type |
סוג הגבולות. |
stroke_color |
הצבעים שבהם צריך להשתמש כשהסוג הוא כדי להגדיר את צבע הקו, צריך לציין ערך בשדות לדוגמה, הדוגמה הבאה מגדירה את הצבע לאדום בעוצמה המקסימלית:
השדה |
corner_radius |
רדיוס הפינה של הגבול. |
BorderType
מייצג את סוגי הגבולות שהוחלו על ווידג'טים.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
BORDER_TYPE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
NO_BORDER |
ערך ברירת המחדל. ללא שוליים. |
STROKE |
מתווה. |
לחצן
לחצן של טקסט, סמל או טקסט וסמל שהמשתמשים יכולים ללחוץ עליו. מידע לדוגמה באפליקציות של Google Chat מופיע במאמר הוספת לחצן.
כדי להפוך תמונה ללחצן שניתן ללחוץ עליו, צריך לציין
(לא Image
) ולהגדיר את הפעולה ImageComponent
onClick
.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
text |
הטקסט שמוצג בתוך הלחצן. |
icon |
סמל שמוצג בתוך הלחצן. אם גם |
color |
זה שינוי אופציונלי. הצבע של הלחצן. אם המדיניות מוגדרת, הלחצן כדי להגדיר את צבע הלחצן, צריך לציין ערך בשדות לדוגמה, הדוגמה הבאה מגדירה את הצבע לאדום בעוצמה המקסימלית:
השדה |
on_click |
חובה. הפעולה לביצוע כשמשתמש לוחץ על הלחצן, למשל פתיחת היפר-קישור או הפעלת פונקציה מותאמת אישית. |
disabled |
אם הערך שלו הוא |
alt_text |
הטקסט החלופי שמשמש לצורכי נגישות. מגדירים טקסט תיאורי שמאפשר למשתמשים לדעת מה הלחצן עושה. לדוגמה, אם לחצן פותח היפר-קישור, יכול להיות שתכתבו: "פתיחה של כרטיסייה חדשה בדפדפן ונכנסים למסמכי התיעוד למפתחים של Google Chat בכתובת https://developers.google.com/workspace/chat" |
type |
זה שינוי אופציונלי. סוג הלחצן. אם המדיניות לא מוגדרת, סוג הלחצן מוגדר כברירת מחדל בתור זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
סוג
זה שינוי אופציונלי. הסוג של הלחצן. אם מוגדר השדה color
, הערך type
מאולץ להיות FILLED
.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
OUTLINED |
לחצנים מודגשים הם לחצנים עם הדגשה בינונית. בדרך כלל הן כוללות פעולות חשובות, אבל הן לא הפעולה הראשית באפליקציית Chat או בתוסף. |
FILLED |
לחצן שמולא מכיל מיכל בצבע אחיד. היא הכי בולטת מבחינה חזותית, ומומלצת לפעולה החשובה והראשית באפליקציית Chat או בתוסף. |
FILLED_TONAL |
לחצן טונלי מלא הוא אזור אמצעי חלופי בין לחצנים מלאים וקוויים. כדאי להשתמש בהן בהקשרים שבהם לחצן בעדיפות נמוכה דורש הדגשה מעט יותר מאשר לחצן קווי מתאר. |
BORDERLESS |
אין גורם מכיל בלתי נראה של לחצן במצב ברירת המחדל שלו. בדרך כלל משתמשים בה גם לפעולות בעדיפות נמוכה ביותר, במיוחד כשמציגים מספר אפשרויות. |
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 מופיע במאמר הגדרת קטע בכרטיס. |
section_divider_style |
סגנון המחיצה בין קטעים. |
card_actions[] |
הפעולות של הכרטיס. הפעולות מתווספות לתפריט סרגל הכלים של הכרטיס. זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. לדוגמה, קובץ ה-JSON הבא יוצר תפריט פעולות בכרטיס עם האפשרויות
|
name |
שם הכרטיס. משמש כמזהה הכרטיס בניווט בין כרטיסים. זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. |
fixed_footer |
הכותרת התחתונה הקבועה מוצגת בתחתית הכרטיס הזה. הגדרת זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
display_style |
בתוספים ל-Google Workspace, המדיניות הזו מגדירה את מאפייני התצוגה של זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. |
peek_card_header |
כשמציגים תוכן לפי הקשר, הכותרת של כרטיס ההצצה משמשת כ-placeholder כדי שהמשתמש יוכל לנווט קדימה בין הכרטיסים בדף הבית לבין הכרטיסים לפי ההקשר. זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. |
CardAction
פעולה בכרטיס היא הפעולה שמשויכת לכרטיס. לדוגמה, כרטיס חשבונית עשוי לכלול פעולות כמו מחיקת חשבונית, שליחת חשבונית באימייל או פתיחת החשבונית בדפדפן.
זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat.
שדות | |
---|---|
action_label |
התווית שמוצגת כאפשרות בתפריט הפעולות. |
on_click |
הפעולה |
CardHeader
מייצג את כותרת הכרטיס. מידע נוסף על אפליקציות ב-Google Chat מופיע במאמר הוספת כותרת.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
title |
חובה. הכותרת של כותרת הכרטיס. לכותרת יש גובה קבוע: אם מציינים גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את הכותרת, היא תופסת את שתי השורות. |
subtitle |
כותרת המשנה של כותרת הכרטיס. אם הפרמטר הזה מוגדר, הוא יופיע בשורה נפרדת מתחת ל- |
image_type |
הצורה שבה התמונה חתוכה. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
image_url |
כתובת ה-URL מסוג HTTPS של התמונה בכותרת הכרטיס. |
image_alt_text |
הטקסט החלופי של התמונה הזו המשמש לנגישות. |
DisplayStyle
בתוספים ל-Google Workspace, ההגדרה קובעת איך הכרטיס יוצג.
התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.
טיפוסים בני מנייה (enum) | |
---|---|
DISPLAY_STYLE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
PEEK |
הכותרת של הכרטיס מופיעה בתחתית סרגל הצד, ומכסה חלקית את הכרטיס העליון הנוכחי בערימה. לחיצה על הכותרת קופצת את הכרטיס לערימת הכרטיסים. אם לכרטיס אין כותרת, המערכת תשתמש בכותרת שנוצרה. |
REPLACE |
ערך ברירת המחדל. כדי להציג את הכרטיס, החלפת התצוגה של הכרטיס העליון בערימת הכרטיסים. |
DividerStyle
סגנון המחיצה של כרטיס. משמש כרגע רק למחיצות בין קטעי כרטיסים.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
DIVIDER_STYLE_UNSPECIFIED |
אין להשתמש. לא צוין. |
SOLID_DIVIDER |
אפשרות ברירת מחדל. יוצרים קו מפריד יציב. |
NO_DIVIDER |
אם האפשרות הזו מוגדרת, לא יתבצע רינדור של מפריד. הסגנון הזה מסיר לחלוטין את המחיצה מהפריסה. התוצאה זהה לאי-הוספת קו מפריד בכלל. |
קטע
קטע מכיל אוסף של ווידג'טים שמעובדים אנכית לפי הסדר שבו צוינו.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
header |
טקסט שמופיע בחלק העליון של הקטע הרצוי. תומכת בטקסט פשוט בפורמט HTML. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. |
widgets[] |
כל הווידג'טים בקטע. צריך לכלול לפחות ווידג'ט אחד. |
collapsible |
בעמודה הזו מציינים אם הקטע הזה ניתן לכיווץ. קטעים שאפשר לכווץ מסתירים חלק מהווידג'טים או את כולם, אבל המשתמשים יכולים להרחיב את הקטע כדי לחשוף את הווידג'טים המוסתרים על ידי לחיצה על עוד. המשתמשים יכולים להסתיר שוב את הווידג'טים בלחיצה על הצגת פחות. כדי לקבוע אילו ווידג'טים מוסתרים, צריך לציין |
uncollapsible_widgets_count |
מספר הווידג'טים שאינם ניתנים לכיווץ שנשארים גלויים גם כשקטע מסוים מכווץ. לדוגמה, כשקטע מכיל חמישה ווידג'טים והשדה |
collapse_control |
זה שינוי אופציונלי. מגדירים את לחצן ההרחבה והכיווץ של הקטע. הלחצן הזה יוצג רק אם הקטע ניתן לכיווץ. אם השדה הזה לא מוגדר, המערכת תשתמש בלחצן ברירת המחדל. זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
צ'יפ
צ'יפ של טקסט, סמל או טקסט וסמל שהמשתמשים יכולים ללחוץ עליו.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
icon |
תמונת הסמל. אם הוגדרו גם |
label |
הטקסט שמוצג בתוך הצ'יפ. |
on_click |
זה שינוי אופציונלי. הפעולה שתתבצע כשמשתמש לוחץ על הצ'יפ, למשל פתיחת היפר-קישור או הפעלת פונקציה מותאמת אישית. |
enabled |
האם הצ'יפ במצב פעיל ומגיב לפעולות של המשתמש. ברירת המחדל היא |
disabled |
אם הצ'יפ נמצא במצב לא פעיל ומתעלם מפעולות של משתמשים. ברירת המחדל היא |
alt_text |
הטקסט החלופי המשמש לנגישות. מגדירים טקסט תיאורי שמאפשר למשתמשים לדעת מה הצ'יפ עושה. לדוגמה, אם צ'יפ פותח היפר-קישור, כותבים: "פתיחת כרטיסייה חדשה בדפדפן וניווט למסמכי התיעוד למפתחים של Google Chat בכתובת https://developers.google.com/workspace/chat". |
ChipList
רשימה של צ'יפים בפריסה לרוחב, שאפשר לגלול לרוחב או לגלול לשורה הבאה.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
layout |
הפריסה של רשימת הצ'יפים שצוינה. |
chips[] |
מערך של צ'יפים. |
פריסה
הפריסה של רשימת הצ'יפים.
טיפוסים בני מנייה (enum) | |
---|---|
LAYOUT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
WRAPPED |
ערך ברירת המחדל. אם אין מספיק שטח אופקי, רשימת הצ'יפים מתחילה לשורה הבאה. |
HORIZONTAL_SCROLLABLE |
אם הצ'יפים לא מתאימים לשטח הזמין, הם גוללים לרוחב. |
CollapseControl
ייצוג של פקד הרחבה וכיווץ. זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
horizontal_alignment |
היישור האופקי של לחצן ההרחבה והכיווץ. |
expand_button |
זה שינוי אופציונלי. ניתן להגדיר לחצן מותאם אישית כדי להרחיב את הקטע. יש להגדיר גם את השדה Extend_button וגם את השדה כווץ_button. רק קבוצת שדות אחת לא תיכנס לתוקף. אם השדה הזה לא מוגדר, המערכת תשתמש בלחצן ברירת המחדל. |
collapse_button |
זה שינוי אופציונלי. מגדירים לחצן בהתאמה אישית כדי לכווץ את הקטע. צריך להגדיר את השדות expand_button ו-collapse_button. רק קבוצת שדות אחת לא תיכנס לתוקף. אם השדה הזה לא מוגדר, המערכת תשתמש בלחצן ברירת המחדל. |
עמודות
בווידג'ט Columns
מוצגות עד 2 עמודות בכרטיס או בתיבת דו-שיח. ניתן להוסיף ווידג'טים לכל עמודה; הווידג'טים מופיעים לפי הסדר שבו הם צוינו. דוגמה לאפליקציות ל-Google Chat מופיעה במאמר הצגת כרטיסים ותיבות דו-שיח בעמודות.
הגובה של כל עמודה נקבע על סמך העמודה הגבוהה יותר. לדוגמה, אם העמודה הראשונה גבוהה מהעמודה השנייה, שתי העמודות יהיו בגובה של העמודה הראשונה. מכיוון שכל עמודה יכולה להכיל מספר שונה של ווידג'טים, אי אפשר להגדיר שורות או ליישר ווידג'טים בין העמודות.
העמודות מוצגות זו לצד זו. אפשר להתאים אישית את הרוחב של כל עמודה באמצעות השדה HorizontalSizeStyle
. אם רוחב המסך של המשתמש צר מדי, העמודה השנייה תופיע מתחת לעמודה הראשונה:
- באינטרנט, העמודה השנייה גולשת אם רוחב המסך קטן מ-480 פיקסלים או שווה לו.
- במכשירי iOS, העמודה השנייה מנותבת אם רוחב המסך קטן מ-300pt או שווה לו.
- במכשירי Android, העמודה השנייה גולשת אם רוחב המסך קטן מ-320dp או שווה לו.
כדי לכלול יותר מ-2 עמודות, או כדי להשתמש בשורות, צריך להשתמש בווידג'ט
.Grid
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. ממשקי המשתמש של התוספים שתומכים בעמודות כוללים:
- תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מתבנית של אימייל.
- תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מהתפריט הוספת קובץ מצורף באירוע ביומן Google.
שדות | |
---|---|
column_items[] |
מערך של עמודות. אפשר לכלול עד 2 עמודות בכרטיס או בתיבת דו-שיח. |
עמודה
עמודה.
שדות | |
---|---|
horizontal_size_style |
מציינת איך עמודה ממלאת את רוחב הכרטיס. |
horizontal_alignment |
קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה. |
vertical_alignment |
קובעת אם הווידג'טים מיושרים לחלק העליון, התחתון או למרכז של עמודה. |
widgets[] |
מערך של ווידג'טים שכלולים בעמודה. הווידג'טים מופיעים לפי הסדר שבו צוינו. |
HorizontalSizeStyle
מציינת איך עמודה ממלאת את רוחב הכרטיס. הרוחב של כל עמודה תלוי ב-HorizontalSizeStyle
וברוחב של הווידג'טים בתוך העמודה.
טיפוסים בני מנייה (enum) | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
FILL_AVAILABLE_SPACE |
ערך ברירת המחדל. עמודה ממלאת את השטח הזמין, עד 70% מרוחב הכרטיס. אם הגדרת את שתי העמודות היא FILL_AVAILABLE_SPACE , כל עמודה תמלא 50% מהשטח. |
FILL_MINIMUM_SPACE |
העמודה ממלאת את השטח הקטן ביותר האפשרי ולא יותר מ-30% מרוחב הכרטיס. |
VerticalAlignment
קובעת אם הווידג'טים ייטוו לחלק העליון, התחתון או המרכז של העמודה.
טיפוסים בני מנייה (enum) | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
CENTER |
ערך ברירת המחדל. מיישר ווידג'טים למרכז עמודה. |
TOP |
מיישר את הווידג'טים לחלק העליון של עמודה. |
BOTTOM |
הווידג'טים יוצגו בתחתית העמודה. |
ווידג'טים
הווידג'טים הנתמכים שאפשר לכלול בעמודה.
שדות | |
---|---|
שדה איחוד
|
|
text_paragraph |
ווידג'ט |
image |
ווידג'ט |
decorated_text |
ווידג'ט |
button_list |
ווידג'ט |
text_input |
ווידג'ט |
selection_input |
ווידג'ט |
date_time_picker |
ווידג'ט |
chip_list |
ווידג'ט |
DateTimePicker
מאפשרת למשתמשים להזין תאריך, שעה או גם תאריך וגם שעה. דוגמה לאפליקציות של Google Chat מופיעה במאמר איך מאפשרים למשתמש לבחור תאריך ושעה.
המשתמשים יכולים להזין טקסט או להשתמש בבורר כדי לבחור תאריכים ושעות. אם המשתמשים מזינים תאריך או שעה לא תקינים, בבורר מופיעה הודעת שגיאה שמבקשת מהמשתמשים להזין את המידע בצורה נכונה.
התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace.
שדות | |
---|---|
name |
השם שלפיו ניתן לזהות את מידע נוסף על עבודה עם קלט טפסים זמין במאמר קבלת נתוני טפסים. |
label |
הטקסט שמפנה למשתמשים להזין תאריך, שעה או תאריך ושעה. לדוגמה, אם המשתמשים קובעים פגישה, צריך להשתמש בתווית כמו |
type |
האם הווידג'ט תומך בהזנת תאריך, שעה או תאריך ושעה. |
value_ms_epoch |
ערך ברירת המחדל שמוצג בווידג'ט, באלפיות השנייה מאז ראשית זמן יוניקס (Unix epoch). ציון הערך על סמך סוג הבורר (
|
timezone_offset_date |
המספר שמייצג את הפרש אזור הזמן משעון UTC, בדקות. אם ההגדרה מוגדרת, הערך של |
on_change_action |
מופעל כשמשתמש לוחץ על שמירה או על ניקוי בממשק של |
validation |
זה שינוי אופציונלי. מציינים את האימות הנדרש לבורר התאריך והשעה האלה. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
DateTimePickerType
הפורמט של התאריך והשעה בווידג'ט DateTimePicker
. קובעת אם המשתמשים יכולים להזין תאריך, שעה או גם תאריך וגם שעה.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
DATE_AND_TIME |
המשתמשים מזינים תאריך ושעה. |
DATE_ONLY |
משתמשים מזינים תאריך. |
TIME_ONLY |
משתמשים מזינים שעה. |
DecoratedText
ווידג'ט שמציג טקסט עם קישוטים אופציונליים, כמו תווית מעל הטקסט או מתחתיו, סמל לפני הטקסט, ווידג'ט בחירה או לחצן אחרי הטקסט. מידע נוסף לדוגמה באפליקציות של Google Chat מופיע במאמר הצגת טקסט עם טקסט דקורטיבי.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
icon |
הוצאו משימוש לטובת |
start_icon |
הסמל שמוצג לפני הטקסט. |
top_label |
הטקסט שמופיע מעל |
text |
חובה. הטקסט הראשי. יש תמיכה בעיצוב פשוט. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. |
wrap_text |
ההגדרה של גלישת טקסט. אם הערך הוא חל רק על |
bottom_label |
הטקסט שמופיע מתחת לשורה |
on_click |
הפעולה הזו מופעלת כשמשתמשים לוחצים על |
שדה איחוד control . לחצן, מתג, תיבת סימון או תמונה שמופיעים בצד ימין של הטקסט בווידג'ט decoratedText . control יכול להיות רק אחת מהאפשרויות הבאות: |
|
button |
לחצן שהמשתמש יכול ללחוץ עליו כדי להפעיל פעולה. |
switch_control |
ווידג'ט מתג שהמשתמש יכול ללחוץ עליו כדי לשנות את המצב שלו ולהפעיל פעולה. |
end_icon |
סמל שמוצג אחרי הטקסט. יש תמיכה בסמלים מובנים ובסמלים מותאמים אישית. |
SwitchControl
מתג בסגנון החלפת מצב או תיבת סימון בתוך הווידג'ט decoratedText
.
התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace.
התכונה נתמכת רק בווידג'ט decoratedText
.
שדות | |
---|---|
name |
השם שבאמצעותו מזוהה ווידג'ט ההחלפה באירוע של קלט הטופס. מידע נוסף על עבודה עם קלט טפסים זמין במאמר קבלת נתוני טפסים. |
value |
הערך שהמשתמש הזין, שהוחזר כחלק מאירוע של קלט טופס. פרטים על עבודה עם קלט של טפסים זמינים במאמר קבלת נתוני טפסים. |
selected |
כשהמתג |
on_change_action |
הפעולה שצריך לבצע כשמצב המתג משתנה, למשל איזו פונקציה לרוץ. |
control_type |
איך המתג מופיע בממשק המשתמש. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
ControlType
איך המתג מופיע בממשק המשתמש.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
SWITCH |
מתג בסגנון החלפת מצב. |
CHECKBOX |
הוצאו משימוש לטובת CHECK_BOX . |
CHECK_BOX |
תיבת סימון. |
קו מפריד
אין שדות בסוג הזה.
מציג קו מפריד בין ווידג'טים כקו אופקי. דוגמה לאפליקציות של Google Chat מופיעה במאמר הוספת מפריד אופקי בין ווידג'טים.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:
"divider": {}
תצוגת רשת
הצגת רשת עם אוסף פריטים. הפריטים יכולים לכלול רק טקסט או תמונות. כדי ליצור עמודות רספונסיביות או כדי לכלול יותר מטקסט או תמונות, משתמשים ב-
. דוגמה לאפליקציות ב-Google Chat מופיעה במאמר הצגת רשת עם אוסף של פריטים.Columns
רשת תומכת בכל מספר של עמודות ופריטים. מספר השורות נקבע לפי פריטים חלקי העמודות. ברשת עם 10 פריטים ו-2 עמודות יש 5 שורות. ברשת עם 11 פריטים ו-2 עמודות יש 6 שורות.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
לדוגמה, קובץ ה-JSON הבא יוצר רשת של 2 עמודות עם פריט אחד:
"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[] |
הפריטים שיוצגו במשבצות. |
border_style |
סגנון המסגרת שיחול על כל פריט ברשת. |
column_count |
מספר העמודות שיוצגו בתצוגה. המערכת תשתמש בערך ברירת מחדל אם השדה הזה לא צוין, וערך ברירת המחדל יהיה שונה בהתאם למיקום שבו מוצגת הרשת (תיבת דו-שיח לעומת מודעה נלווית). |
on_click |
כל פריט בתצוגת רשת יחיד עושה שימוש חוזר בקריאה חוזרת (callback), אבל המזהה והאינדקס של הפריט מופיעים ברשימת הפריטים שנוספו לפרמטרים של הקריאה החוזרת. |
GridItem
מייצג פריט בפריסת רשת. הפריטים יכולים להכיל טקסט, תמונה או גם טקסט וגם תמונה.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
id |
מזהה שהוגדר על ידי המשתמש לפריט ברשת. המזהה הזה מוחזר בפרמטרים של קריאה חוזרת |
image |
התמונה שמופיעה בפריט. |
title |
שם הפריט ברשת. |
subtitle |
כותרת המשנה של הפריט ברשת. |
layout |
הפריסה שבה צריך להשתמש לפריט ברשת. |
GridItemLayout
מייצג את אפשרויות הפריסה השונות שזמינות לפריט ברשת.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
TEXT_BELOW |
הכותרת וכותרת המשנה מוצגות מתחת לתמונה של הפריט ברשת. |
TEXT_ABOVE |
הכותרת וכותרת המשנה מוצגות מעל לתמונה של הפריט ברשת. |
סמל
סמל שמוצג בווידג'ט בכרטיס. מידע נוסף על אפליקציות ב-Google Chat מופיע במאמר הוספת סמל.
יש תמיכה בסמלים מובנים ובסמלים מותאמים אישית.
התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace.
שדות | |
---|---|
alt_text |
זה שינוי אופציונלי. תיאור של הסמל שמשמש לנגישות. אם לא צוין ערך, צוין ערך ברירת המחדל אם הסמל מוגדר ב- |
image_type |
סגנון החיתוך שהוחל על התמונה. במקרים מסוימים, החלת חיתוך |
שדה איחוד icons . הסמל שמוצג בווידג'ט בכרטיס. הערך של icons יכול להיות רק אחת מהאפשרויות הבאות: |
|
known_icon |
הצגת אחד מהסמלים המובנים של Google Workspace. לדוגמה, כדי להציג סמל של מטוס, מציינים לרשימה המלאה של הסמלים הנתמכים, ראו סמלים מובנים. |
icon_url |
הצגת סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS. לדוגמה:
סוגי הקבצים הנתמכים הם |
material_icon |
הצגת אחד מסמלי החומר של Google. לדוגמה, כדי להציג סמל תיבת סימון, משתמשים ב-
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
תמונה
תמונה שמוגדרת באמצעות כתובת URL ושיכולה לכלול בה פעולת onClick
. דוגמה מפורטת זמינה במאמר הוספת תמונה.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
image_url |
כתובת ה-URL מסוג HTTPS שמארחת את התמונה. לדוגמה:
|
on_click |
כשמשתמש לוחץ על התמונה, הקליק מפעיל את הפעולה הזאת. |
alt_text |
הטקסט החלופי של התמונה הזו המשמש לנגישות. |
ImageComponent
התמונה מייצגת תמונה.
התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace.
שדות | |
---|---|
image_uri |
כתובת ה-URL של התמונה. |
alt_text |
תווית הנגישות של התמונה. |
crop_style |
סגנון החיתוך שיחול על התמונה. |
border_style |
סגנון הגבול שיש להחיל על התמונה. |
ImageCropStyle
סגנון החיתוך שהוחל על התמונה.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
לדוגמה, כך מחילים יחס גובה-רוחב של 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
שדות | |
---|---|
type |
סוג החיתוך. |
aspect_ratio |
יחס הגובה-רוחב שבו צריך להשתמש אם סוג החיתוך הוא לדוגמה, כך מגדירים יחס גובה-רוחב של 16:9:
|
ImageCropType
מייצג את סגנון החיתוך שהוחל על תמונה.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
SQUARE |
ערך ברירת המחדל. החלת חיתוך ריבוע. |
CIRCLE |
החלת חיתוך מעגלי. |
RECTANGLE_CUSTOM |
המערכת תחיל חיתוך מלבני עם יחס גובה-רוחב מותאם אישית. הגדרת יחס גובה-רוחב מותאם אישית עם aspectRatio . |
RECTANGLE_4_3 |
החלת חיתוך מלבני ביחס גובה-רוחב של 4:3. |
MaterialIcon
סמל לעיצוב חדשני תלת-ממדי של Google, שכולל יותר מ-2,500 אפשרויות.
לדוגמה, כדי להציג סמל תיבת סימון עם משקל ומתן ציון מותאמים אישית, כותבים את הטקסט הבא:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
זמין באפליקציות של Google Chat ולא זמין בתוספים של Google Workspace.
שדות | |
---|---|
name |
שם הסמל שמוגדר בסמל החומר של Google, לדוגמה, |
fill |
האם הסמל מוצג כמלא. ערך ברירת המחדל הוא False. כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל סמלי הגופנים של Google ומשנים את ההגדרות בקטע התאמה אישית. |
weight |
עובי הקו של הסמל. אפשר לבחור מבין האפשרויות {100, 200, 300, 400, 500, 600, 700}. אם השדה חסר, ערך ברירת המחדל הוא 400. אם תציינו ערך אחר, נשתמש בערך ברירת המחדל. כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל סמלי גופן Google ומשנים את ההגדרות בקטע התאמה אישית. |
grade |
משקל ודרגה משפיעים על העובי של הסמל. התאמות בציון מפורטות יותר מאשר התאמות במשקל, שיש להן השפעה קטנה על גודל הסמל. אפשר לבחור מבין {-25, 0, 200}. אם השדה חסר, ערך ברירת המחדל הוא 0. אם תציינו ערך אחר, נשתמש בערך ברירת המחדל. כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל סמלי הגופנים של Google ומשנים את ההגדרות בקטע התאמה אישית. |
OnClick
מייצג איך להשיב כשמשתמשים לוחצים על אלמנט אינטראקטיבי בכרטיס, כמו לחצן.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
שדה איחוד
|
|
action |
אם השדה הזה מוגדר, פעולה תופעל על ידי |
open_link |
אם צוין, |
open_dynamic_link_action |
תוסף מפעיל את הפעולה הזו כשצריך לפתוח קישור לפעולה. ההבדל בין האפשרות הזו לבין האפשרות זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. |
card |
אם מופיע כרטיס חדש, הוא יידחף לערימת הכרטיסים אחרי הלחיצה. התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat. |
overflow_menu |
אם השדה הזה מוגדר, |
OpenLink
מייצג אירוע onClick
שפותח היפר-קישור.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
url |
כתובת ה-URL לפתיחה. |
open_as |
איך פותחים קישור התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat. |
on_close |
האם הלקוח שוכח מקישור אחרי שפתח אותו, או צופה בו עד שהחלון נסגר. זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. |
OnClose
מה הלקוח עושה כשקישור שנפתח על ידי פעולת OnClick
נסגר.
ההטמעה תלויה ביכולות של הפלטפורמה של הלקוח. לדוגמה, דפדפן אינטרנט עשוי לפתוח קישור בחלון קופץ עם handler של OnClose
.
אם מוגדרים handlers של OnOpen
וגם OnClose
, ופלטפורמת הלקוח לא יכולה לתמוך בשני הערכים, OnClose
מקבל עדיפות.
זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat.
טיפוסים בני מנייה (enum) | |
---|---|
NOTHING |
ערך ברירת המחדל. הכרטיס לא נטען מחדש. כלום לא קורה, |
RELOAD |
הכרטיס ייטען מחדש אחרי שחלון הצאצא ייסגר. אם משתמשים בו בשילוב עם |
OpenAs
כשפעולה מסוג OnClick
פותחת קישור, הלקוח יכול לפתוח אותו כחלון בגודל מלא (אם זה המסגרת שבה הלקוח משתמש) או כשכבת-על (למשל חלון קופץ). ההטמעה תלויה ביכולות של פלטפורמת הלקוח, ויכול להיות שהמערכת תתעלם מהערך שנבחר אם הלקוח לא תומך בו. כל הלקוחות תומכים ב-FULL_SIZE
.
זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat.
טיפוסים בני מנייה (enum) | |
---|---|
FULL_SIZE |
הקישור נפתח כחלון בגודל מלא (אם זה המסגרת שבה הלקוח משתמש). |
OVERLAY |
הקישור נפתח כשכבת-על, למשל כחלון קופץ. |
OverflowMenu
ווידג'ט שמציג תפריט קופץ עם פעולה אחת או יותר שמשתמשים יכולים להפעיל. לדוגמה, הצגת פעולות שאינן ראשיות בכרטיס. אפשר להשתמש בווידג'ט הזה כשהפעולות לא מתאימות לשטח הזמין. כדי להשתמש בווידג'ט הזה, צריך לציין אותו בפעולה OnClick
של הווידג'טים שתומכים בו. לדוגמה, ב-Button
.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
items[] |
חובה. רשימת האפשרויות בתפריט. |
OverflowMenuItem
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
start_icon |
הסמל שמוצג לפני הטקסט. |
text |
חובה. הטקסט שמזהה את הפריט או מתאר אותו למשתמשים. |
on_click |
חובה. הפעולה שמופעלת כשבוחרים אפשרות בתפריט. ה- |
disabled |
האם האפשרות בתפריט מושבתת. ברירת המחדל היא False. |
SelectionInput
ווידג'ט שיוצר פריט אחד או יותר בממשק המשתמש שהמשתמשים יכולים לבחור. לדוגמה, תפריט נפתח או תיבות סימון. אפשר להשתמש בווידג'ט הזה כדי לאסוף נתונים שאפשר לחזות או לספור. דוגמה לאפליקציות של Google Chat מופיעה בקטע הוספת רכיבי ממשק משתמש שניתן לבחור בהם.
אפליקציות צ'אט יכולות לעבד את הערך של פריטים שהמשתמשים בוחרים או מזינים. פרטים על עבודה עם קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
כדי לאסוף נתונים לא מוגדרים או מופשטים מהמשתמשים, אפשר להשתמש בווידג'ט TextInput
.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
name |
חובה. השם שמשמש לזיהוי קלט הבחירה באירוע של קלט טופס. מידע נוסף על עבודה עם קלט טפסים זמין במאמר קבלת נתוני טפסים. |
label |
הטקסט שמופיע מעל שדה הקלט של הבחירה בממשק המשתמש. מציינים טקסט שיעזור למשתמש להזין את המידע הנדרש לאפליקציה. לדוגמה, אם משתמשים בוחרים בדחיפות של כרטיס עבודה בתפריט נפתח, התווית יכולה להיות 'דחיפות'. או "בחירת דחיפות". |
type |
סוג הפריטים שמוצגים למשתמשים בווידג'ט |
items[] |
מערך של פריטים שאפשר לבחור. לדוגמה, מערך של לחצני בחירה או תיבות סימון. יש תמיכה בעד 100 פריטים. |
on_change_action |
אם צוין, הטופס יישלח כשהבחירה תשתנה. אם לא צוין אחרת, יש לציין לחצן נפרד לשליחת הטופס. פרטים על עבודה עם קלט של טפסים זמינים במאמר קבלת נתוני טפסים. |
multi_select_max_selected_items |
בתפריטים עם ריבוי אפשרויות בחירה, זהו מספר הפריטים המקסימלי שהמשתמש יכול לבחור. הערך המינימלי הוא פריט אחד. אם לא צויין ערך, ברירת המחדל תהיה 3 פריטים. |
multi_select_min_query_length |
בתפריטים עם ריבוי אפשרויות בחירה, זהו מספר תווי הטקסט שהמשתמש הזין לפני ההשלמה האוטומטית של שאילתה באפליקציה, שמציג הצעות לפריטים בתפריט. אם לא צוין אחרת, ברירת המחדל היא 0 תווים במקורות נתונים סטטיים ו-3 תווים במקורות נתונים חיצוניים. |
validation |
בתפריטים נפתחים, האימות של השדה הזה להזנת קלט הבחירה. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
שדה איחוד זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
|
external_data_source |
מקור נתונים חיצוני, כמו בסיס נתונים יחסי. |
platform_data_source |
מקור נתונים מ-Google Workspace. |
PlatformDataSource
לווידג'ט של
שנעשה בו שימוש בתפריט עם בחירה מרובה, מקור נתונים מ-Google Workspace. משמש לאכלוס פריטים בתפריט של בחירה מרובה.SelectionInput
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
שדות | |
---|---|
שדה איחוד data_source . מקור הנתונים. data_source יכול להיות רק אחת מהאפשרויות הבאות: |
|
common_data_source |
מקור נתונים שמשותף לכל האפליקציות של Google Workspace, כמו משתמשים בארגון ב-Google Workspace. |
host_app_data_source |
מקור נתונים שהוא ייחודי לאפליקציה מארחת של Google Workspace, כמו מרחבים ב-Google Chat. השדה הזה תומך בספריות הלקוח של Google API, אבל הוא לא זמין בספריות הלקוח ב-Cloud. מידע נוסף זמין במאמר התקנת ספריות הלקוח. |
CommonDataSource
מקור נתונים שמשותף לכל אפליקציות Google Workspace.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
UNKNOWN |
ערך ברירת המחדל. אין להשתמש בו. |
USER |
משתמשי Google Workspace המשתמשים יכולים רק לראות ולבחור משתמשים מהארגון שלהם ב-Google Workspace. |
SelectionItem
פריט שהמשתמשים יכולים לבחור באפשרות להזנת בחירה, כמו תיבת סימון או מתג.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
text |
הטקסט שמזהה את הפריט או מתאר אותו למשתמשים. |
value |
הערך שמשויך לפריט הזה. הלקוח צריך להשתמש בערך הזה בתור ערך קלט בטופס. מידע נוסף על עבודה עם קלט טפסים זמין במאמר קבלת נתוני טפסים. |
selected |
האם הפריט נבחר כברירת מחדל. אם קלט הבחירה מקבל רק ערך אחד (למשל, לחצני בחירה או תפריט נפתח), צריך להגדיר את השדה הזה רק לפריט אחד. |
start_icon_uri |
בתפריטים לבחירה מרובה, כתובת ה-URL של הסמל שמוצג לצד השדה |
bottom_text |
לתפריטים עם ריבוי בחירה, תיאור טקסט או תווית שמוצגים מתחת לשדה |
SelectionType
הפורמט של הפריטים שהמשתמשים יכולים לבחור. אפשרויות שונות תומכות בסוגים שונים של אינטראקציות. לדוגמה, משתמשים יכולים לבחור כמה תיבות סימון, אבל לבחור רק פריט אחד מתפריט נפתח.
כל קלט של בחירה תומך בסוג אחד של בחירה. לדוגמה, לא ניתן לשלב תיבות סימון ומתגים.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
CHECK_BOX |
קבוצה של תיבות סימון. המשתמשים יכולים לסמן תיבת סימון אחת או יותר. |
RADIO_BUTTON |
קבוצה של לחצני בחירה. המשתמשים יכולים לבחור לחצן בחירה אחד. |
SWITCH |
קבוצת מתגים. המשתמשים יכולים להפעיל מתג אחד או יותר. |
DROPDOWN |
תפריט נפתח. המשתמשים יכולים לבחור פריט אחד מהתפריט. |
MULTI_SELECT |
תפריט לבחירת פריטים מרובים לנתונים סטטיים או דינמיים. בסרגל התפריטים, המשתמשים בוחרים פריט אחד או יותר. המשתמשים יכולים גם להזין ערכים כדי לאכלס נתונים דינמיים. לדוגמה, המשתמשים יכולים להתחיל להקליד שם של מרחב ב-Google Chat, והווידג'ט מציע את המרחב באופן אוטומטי. כדי לאכלס פריטים בתפריט של בחירה מרובה, אפשר להשתמש באחד מהסוגים הבאים של מקורות נתונים:
במאמר הוספה של תפריט עם אפשרויות בחירה מרובות מופיעות דוגמאות לאופן השימוש בתפריטים עם ריבוי בחירה. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
הצעות
ערכים מוצעים שהמשתמשים יכולים להזין. הערכים האלה מופיעים כשמשתמשים לוחצים בתוך השדה להזנת טקסט. בזמן שהמשתמשים מקלידים, הערכים המוצעים מסוננים באופן דינמי כך שיתאימו לטקסט שהמשתמשים מקלידים.
לדוגמה, שדה להזנת טקסט בשפת תכנות עשוי להציע לכם 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 |
הטקסט שמופיע מעל השדה להזנת טקסט בממשק המשתמש. מציינים טקסט שעוזר למשתמש להזין את המידע שהאפליקציה צריכה. לדוגמה, אם אתם שואלים את השם של מישהו, אבל אתם צריכים במיוחד את שם המשפחה שלו, עליכם לכתוב חובה אם לא צוין |
hint_text |
טקסט שמופיע מתחת לשדה להזנת טקסט, שנועד לעזור למשתמשים על ידי הנחיה להזין ערך מסוים. הטקסט הזה תמיד גלוי. חובה אם לא צוין |
value |
הערך שהמשתמש הזין, שהוחזר כחלק מאירוע של קלט טופס. מידע נוסף על עבודה עם קלט טפסים זמין במאמר קבלת נתוני טפסים. |
type |
האופן שבו מופיע שדה של קלט טקסט בממשק המשתמש. לדוגמה, אם השדה הוא שורה אחת או כמה שורות. |
on_change_action |
מה עושים כשמתבצע שינוי בשדה הקלט של הטקסט. לדוגמה, משתמש שמוסיף לשדה או מחק טקסט. דוגמאות לפעולות שאפשר לבצע הן הפעלת פונקציה מותאמת אישית או פתיחת תיבת דו-שיח ב-Google Chat. |
initial_suggestions |
ערכים מוצעים שהמשתמשים יכולים להזין. הערכים האלה מופיעים כשמשתמשים לוחצים בתוך השדה להזנת טקסט. בזמן שהמשתמשים מקלידים, הערכים המוצעים מסוננים באופן דינמי כך שיתאימו לטקסט שהמשתמשים מקלידים. לדוגמה, בשדה קלט טקסט של שפת תכנות יכולות להופיע הצעות לשפות Java, JavaScript, Python ו-C++. כשמשתמשים מתחילים להקליד ההצעות לערכים עוזרות להנחות את המשתמשים להזין ערכים שהאפליקציה יכולה להבין. בהתייחס ל-JavaScript, חלק מהמשתמשים עשויים להזין אם הערך הזה מוגדר, הערך של זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
auto_complete_action |
זה שינוי אופציונלי. מציינים איזו פעולה תתבצע כששדה הקלט של הטקסט יציג הצעות למשתמשים שמקיימים איתו אינטראקציה. אם לא צוין אחרת, ההצעות מוגדרות על ידי אם צוין, האפליקציה תנקוט את הפעולה שצוינה כאן, כמו הפעלת פונקציה מותאמת אישית. זמין לתוספים ל-Google Workspace ולא זמין לאפליקציות ל-Google Chat. |
validation |
מציינים את האימות שנחוץ לשדה הזה להזנת קלט טקסט. התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace. |
placeholder_text |
טקסט שמופיע בשדה של קלט הטקסט כשהשדה ריק. אפשר להשתמש בטקסט הזה כדי לבקש מהמשתמשים להזין ערך. לדוגמה, זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
סוג
איך שדה להזנת טקסט מופיע בממשק המשתמש. לדוגמה, בשדה להזנת קלט של שורה אחת או בקלט מרובה שורות. אם מציינים את initialSuggestions
, הערך של type
הוא תמיד SINGLE_LINE
, גם אם הוא מוגדר ל-MULTIPLE_LINE
.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
SINGLE_LINE |
לשדה להזנת הטקסט יש גובה קבוע של שורה אחת. |
MULTIPLE_LINE |
לשדה להזנת הטקסט יש גובה קבוע של כמה שורות. |
TextParagraph
פסקת טקסט שתומכת בעיצוב. דוגמה לאפליקציות של Google Chat מופיעה במאמר הוספת פסקה של טקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
text |
הטקסט שמוצג בווידג'ט. |
max_lines |
מספר השורות המקסימלי של הטקסט שמוצג בווידג'ט. אם הטקסט חורג ממספר השורות המקסימלי שצוין, התוכן העודף מוסתר מאחורי הלחצן הצגת עוד. אם הטקסט שווה למספר השורות המקסימלי שצוין או קצר ממנו, לא יוצג לחצן הצגת עוד. ערך ברירת המחדל הוא 0, במקרה כזה יוצג כל ההקשר. המערכת מתעלמת מערכים שליליים. זמין באפליקציות של Google Chat ולא זמין בתוספים של Google Workspace. |
אימות
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
שדות | |
---|---|
character_limit |
התכונה זמינה באפליקציות של Google Chat ובתוספים ל-Google Workspace. |
input_type |
לציין את הסוג של ווידג'טים לקלט. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. |
InputType
הסוג של ווידג'ט הקלט.
טיפוסים בני מנייה (enum) | |
---|---|
INPUT_TYPE_UNSPECIFIED |
הסוג לא צוין. אין להשתמש בו. |
TEXT |
טקסט רגיל שמקבל את כל התווים. |
INTEGER |
ערך של מספר שלם. |
FLOAT |
ערך מסוג מספר ממשי (float). |
EMAIL |
כתובת אימייל. |
EMOJI_PICKER |
נבחר אמוג'י מתוך בורר האמוג'י שסופק על ידי המערכת. |
ווידג'ט
כל כרטיס מורכב מווידג'טים.
ווידג'ט הוא אובייקט מורכב שיכול לייצג טקסט, תמונות, לחצנים וסוגי אובייקטים אחרים.
שדות | |
---|---|
horizontal_alignment |
קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה. |
שדה איחוד data . ווידג'ט יכול לכלול רק אחד מהפריטים הבאים. ניתן להשתמש במספר שדות של ווידג'טים כדי להציג יותר פריטים. הערך של data יכול להיות רק אחת מהאפשרויות הבאות: |
|
text_paragraph |
הצגת פסקה של טקסט. תומכת בטקסט פשוט בפורמט HTML. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. לדוגמה, קובץ ה-JSON הבא יוצר טקסט מודגש:
|
image |
מציגה תמונה. לדוגמה, קובץ ה-JSON הבא יוצר תמונה עם טקסט חלופי:
|
decorated_text |
מציגה פריט טקסט מעוצב. לדוגמה, הקוד הבא יוצר ווידג'ט טקסט מעוטר שמוצגת בו כתובת אימייל:
|
button_list |
רשימת לחצנים. לדוגמה, הקוד הבא ב-JSON יוצר שני לחצנים. הלחצן הראשון הוא לחצן טקסט כחול והשני הוא לחצן תמונה שפותח קישור:
|
text_input |
מוצגת תיבת טקסט שהמשתמשים יכולים להקליד בה. לדוגמה, ה-JSON הבא יוצר קלט טקסט לכתובת אימייל:
דוגמה נוספת: קובץ ה-JSON הבא יוצר קלט טקסט לשפת תכנות עם הצעות סטטיות:
|
selection_input |
מציגה פקד בחירה שמאפשר למשתמשים לבחור פריטים. פקדי בחירה יכולים להיות תיבות סימון, לחצני בחירה, מתגים או תפריטים נפתחים. לדוגמה, קובץ ה-JSON הבא יוצר תפריט נפתח שמאפשר למשתמשים לבחור גודל:
|
date_time_picker |
מציג ווידג'ט שמאפשר למשתמשים להזין תאריך, שעה או תאריך ושעה. לדוגמה, הקוד הבא ב-JSON יוצר בורר תאריך ושעה לקביעת פגישה:
|
divider |
מציג קו אופקי בין ווידג'טים. לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:
|
grid |
תצוגת רשת עם אוסף של פריטים. רשת תומכת בכל מספר של עמודות ופריטים. מספר השורות נקבע על ידי הגבול העליון של מספר הפריטים, חלקי מספר העמודות. ברשת עם 10 פריטים ו-2 עמודות יש 5 שורות. ברשת עם 11 פריטים ו-2 עמודות יש 6 שורות. זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. לדוגמה, קובץ ה-JSON הבא יוצר רשת של 2 עמודות עם פריט אחד:
|
columns |
מוצגות עד 2 עמודות. כדי לכלול יותר מ-2 עמודות או להשתמש בשורות, משתמשים בווידג'ט לדוגמה, בקובץ ה-JSON הבא נוצר 2 עמודות שכל אחת מהן מכילה פסקאות טקסט:
|
chip_list |
רשימת צ'יפים. לדוגמה, קובץ ה-JSON הבא יוצר שני צ'יפים. הראשון הוא צ'יפ טקסט והשני הוא צ'יפ סמל שפותח קישור:
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace. |
HorizontalAlignment
קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה.
זמין באפליקציות ל-Google Chat ולא זמין לתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED |
אין להשתמש בו. לא צוין. |
START |
ערך ברירת המחדל. התאמת הווידג'טים למיקום ההתחלה של העמודה. בפריסות משמאל לימין, מיושר לשמאל. לפריסות מימין לשמאל, יישור לימין. |
CENTER |
מיישר את הווידג'טים למרכז העמודה. |
END |
התאמת הווידג'טים למיקום הסיום של העמודה. בפריסות מימין לשמאל, הווידג'טים ממורכזים בצד ימין. לפריסות מימין לשמאל, יישור ווידג'טים לשמאל. |
ImageType
הצורה שמשמשת לחיתוך התמונה.
זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
טיפוסים בני מנייה (enum) | |
---|---|
SQUARE |
ערך ברירת המחדל. הפעלת מסכה ריבועית על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לתמונה בגודל 3x3. |
CIRCLE |
החלת מסכה מעוגלת על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לעיגול בקוטר 3. |