Package google.apps.card.v1

אינדקס

פעולה

פעולה שמתארת את ההתנהגות כששולחים את הטופס. לדוגמה, אפשר להפעיל סקריפט של Apps Script כדי לטפל בטופס. אם הפעולה מופעלת, ערכי הטופס נשלחים לשרת.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
function

string

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

דוגמאות לשימוש זמינות במאמר קריאת נתוני טפסים.
parameters[]

ActionParameter

רשימת הפרמטרים של הפעולה.
load_indicator

LoadIndicator

מציין את אינדיקטור הטעינה שיוצג בזמן הקריאה לפעולה.
persist_values

bool

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

אם הערך הוא true, ערכי הטופס נשארים אחרי שהפעולה מופעלת. כדי לאפשר למשתמש לבצע שינויים בזמן העיבוד של הפעולה, מגדירים את LoadIndicator לערך NONE. בהודעות בכרטיס באפליקציות Chat, צריך גם להגדיר את ResponseType של הפעולה כ-UPDATE_MESSAGE ולהשתמש באותו card_id מהכרטיס שהכיל את הפעולה.

אם הערך הוא false, ערכי הטופס יימחקו כשהפעולה מופעלת. כדי למנוע מהמשתמש לבצע שינויים בזמן העיבוד של הפעולה, מגדירים את LoadIndicator לערך SPINNER.
interaction

Interaction

אופציונלי. חובה כשפותחים תיבת דו-שיח.

מה לעשות בתגובה לאינטראקציה עם משתמש, למשל אם משתמש לוחץ על לחצן בהודעה בכרטיס.

אם לא מציינים אירוע, האפליקציה מגיבה על ידי ביצוע אירוע action – כמו פתיחת קישור או הפעלת פונקציה – כרגיל.

כשמציינים interaction, האפליקציה יכולה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את interaction כ-OPEN_DIALOG, האפליקציה יכולה לפתוח תיבת דו-שיח. כשהאפשרות הזו מוגדרת, אינדיקטור הטעינה לא מוצג. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג דבר בלקוח.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.
required_widgets[]

string

אופציונלי. ממלאים את הרשימה הזו בשמות של הווידג'טים שנדרשים לפעולה הזו כדי לשלוח אותה בצורה תקינה.

אם לווידג'טים שמפורטים כאן אין ערך כשהפעולה הזו מופעלת, שליחת הטופס מבוטלת.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.
all_widgets_are_required

bool

אופציונלי. אם הערך הזה נכון, כל הווידג'טים נחשבים כנדרשים לפעולה הזו.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

ActionParameter

רשימת פרמטרים של מחרוזות שצריך לספק כשמפעילים את שיטת הפעולה. לדוגמה, אפשר להציג שלושה לחצני השהיה: השהיה עכשיו, השהיה ליום אחד או השהיה לשבוע הבא. אפשר להשתמש ב-action method = snooze(), ולהעביר את סוג ההשהיה ואת משך ההשהיה ברשימה של פרמטרים של מחרוזות.

מידע נוסף זמין במאמר CommonEventObject.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
key

string

שם הפרמטר של סקריפט הפעולה.
value

string

הערך של הפרמטר.

אינטראקציה

אופציונלי. חובה כשפותחים תיבת דו-שיח.

מה לעשות בתגובה לאינטראקציה עם משתמש, למשל אם משתמש לוחץ על לחצן בהודעה בכרטיס.

אם לא מציינים אירוע, האפליקציה מגיבה על ידי ביצוע אירוע 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

BorderType

סוג הגבול.
stroke_color

Color

הצבעים שישמשו כשהסוג הוא BORDER_TYPE_STROKE.

כדי להגדיר את צבע הקו, מציינים ערך בשדות red,‏ green ו-blue. הערך חייב להיות מספר שרירותי (float) בין 0 ל-1 על סמך ערך הצבע RGB, כאשר 0 (0/255) מייצג את היעדר הצבע ו-1 (255/255) מייצג את העוצמה המקסימלית של הצבע.

לדוגמה, הקוד הבא מגדיר את הצבע לאדום בעוצמה המקסימלית שלו:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

השדה alpha לא זמין לצבע הקו. אם השדה הזה צוין, המערכת תתעלם ממנו.
corner_radius

int32

רדיוס הפינה של הגבול.

BorderType

מייצג את סוגי השוליים שחלים על ווידג'טים.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
BORDER_TYPE_UNSPECIFIED אין להשתמש בו. לא צוין.
NO_BORDER ללא שוליים.
STROKE ערך ברירת המחדל. קווי מתאר.

לחצן

טקסט, סמל או לחצן עם טקסט וסמל שהמשתמשים יכולים ללחוץ עליו. לדוגמה באפליקציות של Google Chat, ראו הוספת לחצן.

כדי להפוך תמונה ללחצן שניתן ללחוץ עליו, מציינים Image (לא ImageComponent) ומגדירים פעולה onClick.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
text

string

הטקסט שמוצג בתוך הכפתור.
icon

Icon

סמל שמוצג בתוך הלחצן. אם גם icon וגם text מוגדרים, הסמל מופיע לפני הטקסט.
color

Color

אופציונלי. הצבע של הלחצן. אם הערך מוגדר, הכפתור type מוגדר ל-FILLED והצבע של השדות text ו-icon מוגדר לצבע מנוגד לשיפור הקריאוּת. לדוגמה, אם צבע הלחצן מוגדר ככחול, כל הטקסט או הסמלים בלחצן מוגדרים כלבנים.

כדי להגדיר את צבע הכפתור, מציינים ערך בשדות red,‏ green ו-blue. הערך חייב להיות מספר שרירותי (float) בין 0 ל-1 על סמך ערך הצבע RGB, כאשר 0 (0/255) מייצג את היעדר הצבע ו-1 (255/255) מייצג את העוצמה המקסימלית של הצבע.

לדוגמה, הקוד הבא מגדיר את הצבע לאדום בעוצמה המקסימלית שלו:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

השדה alpha לא זמין לצבע הכפתור. אם השדה הזה צוין, המערכת תתעלם ממנו.
on_click

OnClick

חובה. הפעולה שתתבצע כשמשתמש ילחץ על הכפתור, למשל פתיחת היפר-קישור או הפעלת פונקציה בהתאמה אישית.
disabled

bool

אם הערך הוא true, הלחצן מוצג במצב לא פעיל ולא מגיב לפעולות של המשתמשים.
alt_text

string

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

מגדירים טקסט תיאורי שמאפשר למשתמשים לדעת מה הלחצן עושה. לדוגמה, אם לחיצה על לחצן פותחת היפר-קישור, אפשר לכתוב: "הלחצן פותח כרטיסייה חדשה בדפדפן ומנווט למסמכי התיעוד למפתחים של Google Chat בכתובת https://developers.google.com/workspace/chat".
type

Type

אופציונלי. סוג הלחצן. אם לא תגדירו את סוג הלחצן, ברירת המחדל שלו תהיה OUTLINED. אם השדה color מוגדר, סוג הלחצן מוגדר באופן אוטומטי ל-FILLED והמערכת מתעלמת מכל ערך שמוגדר בשדה הזה.

סוג

אופציונלי. הסוג של הלחצן. אם השדה 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[]

Button

מערך של לחצנים.

קלפים

ממשק כרטיס שמוצג בהודעה ב-Google Chat או בתוסף של Google Workspace.

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

בעזרת הכלי ליצירת כרטיסים תוכלו לעצב כרטיסים ולראות תצוגה מקדימה שלהם.

פתיחת הכלי ליצירת כרטיסים

במאמרים הבאים מוסבר איך יוצרים כרטיסים:

הערה: אפשר להוסיף עד 100 ווידג'טים לכל כרטיס. המערכת תתעלם מווידג'טים שמעבר למגבלה הזו. המגבלה הזו חלה גם על הודעות בכרטיסים וגם על תיבת דו-שיח בכרטיסים באפליקציות של 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

CardHeader

הכותרת של הכרטיס. כותרת בדרך כלל מכילה תמונה וכותרת. הכותרות תמיד מופיעות בחלק העליון של הכרטיס.
sections[]

Section

מכיל אוסף של ווידג'טים. לכל קטע יש כותרת אופציונלית משלו. החלקים מופרדים באופן חזותי באמצעות קו מפריד. דוגמה לאפליקציות של Google Chat מופיעה בקטע הגדרת קטע בכרטיס.
section_divider_style

DividerStyle

סגנון המחיצה בין הכותרת, הקטעים והכותרת התחתונה.
card_actions[]

CardAction

הפעולות של הכרטיס. הפעולות מתווספות לתפריט של סרגל הכלים של הכרטיס.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.

לדוגמה, ה-JSON הבא יוצר תפריט פעולות של כרטיס עם האפשרויות Settings ו-Send Feedback:

"card_actions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

שם הכרטיס. משמש כמזהה כרטיס בניווט בכרטיסים.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.
display_style

DisplayStyle

בתוספים ל-Google Workspace, מגדיר את מאפייני התצוגה של peekCardHeader.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.
peek_card_header

CardHeader

כשמוצג תוכן לפי הקשר, הכותרת של כרטיס הצצה משמשת כסמל עזר כדי שהמשתמש יוכל לנווט בין כרטיסי דף הבית לכרטיסי התוכן לפי הקשר.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.

CardAction

פעולת כרטיס היא הפעולה שמשויכת לכרטיס. לדוגמה, כרטיס חשבונית יכול לכלול פעולות כמו מחיקה של חשבונית, שליחת חשבונית באימייל או פתיחת החשבונית בדפדפן.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.

שדות
action_label

string

התווית שמוצגת כפריט בתפריט הפעולות.
on_click

OnClick

הפעולה onClick של פריט הפעולה הזה.

CardFixedFooter

כותרת תחתונה קבועה (דביקה) שמופיעה בחלק התחתון של הכרטיס.

הגדרת fixedFooter בלי לציין primaryButton או secondaryButton גורמת לשגיאה.

באפליקציות Chat, אפשר להשתמש בכותרות תחתונות קבועות בתיבות דו-שיח, אבל לא בהודעות בכרטיס. דוגמה לאפליקציות של Google Chat מופיעה בקטע הוספת כותרת תחתונה קבועה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
primary_button

Button

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

Button

הלחצן המשני של הכותרת התחתונה הקבועה. הכפתור חייב להיות כפתור טקסט עם טקסט וצבע מוגדרים. אם הערך של secondaryButton מוגדר, צריך להגדיר גם את primaryButton.

CardHeader

מייצגת כותרת של כרטיס. לדוגמה באפליקציות של Google Chat, ראו הוספת כותרת.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
title

string

חובה. הכותרת של כותרת הכרטיס. לגובה הכותרת יש ערך קבוע: אם מציינים גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את השם, הוא תופס את שתי השורות.
subtitle

string

כותרת המשנה של כותרת הכרטיס. אם מצוין, מופיע בשורה משלו מתחת ל-title.
image_type

ImageType

הצורה שבה התמונה נחתכה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.
image_url

string

כתובת ה-URL מסוג HTTPS של התמונה בכותרת הכרטיס.
image_alt_text

string

הטקסט החלופי של התמונה הזו, שמשמש לצורכי נגישות.

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

NestedWidget

רשימה של ווידג'טים שאפשר להציג בפריסה מכילת, כמו CarouselCard. התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות

שדה האיחוד data.

הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
text_paragraph

TextParagraph

ווידג'ט של פסקה טקסט.
button_list

ButtonList

ווידג'ט של רשימת לחצנים.
image

Image

ווידג'ט תמונה.

קטע

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

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
header

string

טקסט שמופיע בחלק העליון של קטע. יש תמיכה בטקסט פשוט בפורמט HTML. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
widgets[]

Widget

כל הווידג'טים בקטע. צריך לכלול לפחות ווידג'ט אחד.
collapsible

bool

מציין אם ניתן לכווץ את הקטע הזה.

בקטעים שניתן לכווץ, חלק מהווידג'טים או כולם מוסתרים, אבל המשתמשים יכולים להרחיב את הקטע כדי לחשוף את הווידג'טים המוסתרים בלחיצה על הצגת עוד. המשתמשים יכולים להסתיר שוב את הווידג'טים בלחיצה על הצגת פחות.

כדי לקבוע אילו ווידג'טים יוסתרו, מציינים uncollapsibleWidgetsCount.
uncollapsible_widgets_count

int32

מספר הווידג'טים שלא ניתן לכווץ, שנותרו גלויים גם כשמקפלים קטע.

לדוגמה, אם קטע מכיל חמישה ווידג'טים והערך של uncollapsibleWidgetsCount מוגדר כ-2, שני הווידג'טים הראשונים מוצגים תמיד והשלושה האחרונים מכווצים כברירת מחדל. הערך של uncollapsibleWidgetsCount נלקח בחשבון רק כאשר הערך של collapsible הוא true.
collapse_control

CollapseControl

אופציונלי. מגדירים את הלחצן להרחבה ולכיווץ של הקטע. הלחצן הזה יוצג רק אם אפשר לכווץ את הקטע. אם השדה הזה לא מוגדר, המערכת תשתמש בלחצן ברירת המחדל.

קרוסלה, שנקראת גם פס גלילה, מסתובבת ומציגה רשימה של ווידג'טים בפורמט של גלריה, עם לחצנים לנווט לווידג'ט הקודם או הבא.

לדוגמה, זוהי ייצוג JSON של קרוסלה שמכילה שלושה ווידג'טים של פסקאות טקסט.

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות
carousel_cards[]

CarouselCard

רשימה של כרטיסים שכלולים בקרוסלה.

CarouselCard

כרטיס שאפשר להציג כפריט בקרוסלה. התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות
widgets[]

NestedWidget

רשימה של ווידג'טים שמוצגים בכרטיס הקרוסלה. הווידג'טים מוצגים בסדר שבו הם צוינו.
footer_widgets[]

NestedWidget

רשימה של ווידג'טים שמוצגת בחלק התחתון של כרטיס הקרוסלה. הווידג'טים מוצגים בסדר שבו הם צוינו.

צ'יפ

צ'יפ של טקסט, סמל או טקסט וסמל שעליהם המשתמשים יכולים ללחוץ.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
icon

Icon

תמונת הסמל. אם גם icon וגם text מוגדרים, הסמל מופיע לפני הטקסט.
label

string

הטקסט שמוצג בתוך הצ'יפ.
on_click

OnClick

אופציונלי. הפעולה שתתבצע כשמשתמש לוחץ על הצ'יפ, למשל פתיחת היפר-קישור או הפעלת פונקציה מותאמת אישית.
enabled
(deprecated)

bool

אם הצ'יפ במצב פעיל ומגיב לפעולות של המשתמשים. ברירת המחדל היא true. הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-disabled.
disabled

bool

אם הצ'יפ נמצא במצב לא פעיל ומתעלם מפעולות של משתמשים. ברירת המחדל היא false.
alt_text

string

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

מגדירים טקסט תיאורי שמאפשר למשתמשים לדעת מה הצ'יפ עושה. לדוגמה, אם צ'יפ פותח היפר-קישור, כותבים: "פתיחת כרטיסייה חדשה בדפדפן וניווט למסמכי התיעוד למפתחים של Google Chat בכתובת https://developers.google.com/workspace/chat".

ChipList

רשימה של צ'יפים שממוקמים אופקית, ואפשר לגלול בה אופקית או להעביר את הצ'יפים לשורה הבאה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
layout

Layout

פריסת רשימת הצ'יפים שצוינה.
chips[]

Chip

מערך של צ'יפים.

פריסה

פריסת רשימת הצ'יפים.

טיפוסים בני מנייה (enum)
LAYOUT_UNSPECIFIED אין להשתמש. לא צוין.
WRAPPED ערך ברירת המחדל. אם אין מספיק מקום אופקי, רשימת הצ'יפים תעבור לשורה הבאה.
HORIZONTAL_SCROLLABLE אם הצ'יפים לא נכנסים למרחב הזמין, הם גוללים אופקית.

CollapseControl

מייצגים פקדים להרחבה ולכיווץ.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
horizontal_alignment

HorizontalAlignment

היישור האנכי של כפתור ההרחבה והכיווץ.
expand_button

Button

אופציונלי. מגדירים כפתור בהתאמה אישית להרחבת הקטע. צריך להגדיר גם את השדה expand_button וגם את השדה collapse_button. רק קבוצת שדות אחת לא תכנס לתוקף. אם השדה הזה לא מוגדר, המערכת תשתמש בלחצן ברירת המחדל.
collapse_button

Button

אופציונלי. מגדירים כפתור מותאם אישית כדי לכווץ את הקטע. צריך להגדיר גם את השדה expand_button וגם את השדה collapse_button. רק קבוצת שדות אחת לא תכנס לתוקף. אם השדה הזה לא מוגדר, המערכת תשתמש בלחצן ברירת המחדל.

עמודות

בווידג'ט Columns מוצגות עד 2 עמודות בכרטיס או בתיבת דו-שיח. אפשר להוסיף ווידג'טים לכל עמודה. הווידג'טים יופיעו בסדר שבו הם צוינו. דוגמה לאפליקציות של Google Chat מופיעה בקטע הצגת כרטיסים ותיבות דו-שיח בעמודות.

הגובה של כל עמודה נקבע לפי העמודה הגבוהה ביותר. לדוגמה, אם העמודה הראשונה גבוהה יותר מהעמודה השנייה, שתי העמודות יהיו בגובה של העמודה הראשונה. כל עמודה יכולה להכיל מספר שונה של ווידג'טים, ולכן אי אפשר להגדיר שורות או ליישר ווידג'טים בין העמודות.

העמודות מוצגות זו לצד זו. אפשר להתאים אישית את הרוחב של כל עמודה באמצעות השדה HorizontalSizeStyle. אם רוחב המסך של המשתמש צר מדי, העמודה השנייה תופיע מתחת לעמודה הראשונה:

  • באינטרנט, העמודה השנייה מתבצעת אם רוחב המסך הוא 480 פיקסלים או פחות.
  • במכשירי iOS, העמודה השנייה מנותבת אם רוחב המסך קטן מ-300pt או שווה לו.
  • במכשירי Android, העמודה השנייה מתבצעת אם רוחב המסך הוא 320dp או פחות.

כדי לכלול יותר משתי עמודות או להשתמש בשורות, צריך להשתמש בווידג'ט Grid.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace. ממשקי המשתמש של התוספים שתומכים בעמודות כוללים:

  • תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מתבנית של אימייל.
  • תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מהתפריט הוספת קובץ באירוע ביומן Google.
שדות
column_items[]

Column

מערך של עמודות. אפשר לכלול עד 2 עמודות בכרטיס או בתיבת דו-שיח.

עמודה

עמודה.

תוספים ל-Google Workspace ואפליקציות של Chat

שדות
horizontal_size_style

HorizontalSizeStyle

מציין את האופן שבו עמודה ממלאת את רוחב הכרטיס.
horizontal_alignment

HorizontalAlignment

קובע אם הווידג'טים ייטו לשמאל, לימין או למרכז העמודה.
vertical_alignment

VerticalAlignment

קובעת אם הווידג'טים ייטוו לחלק העליון, התחתון או המרכז של העמודה.
widgets[]

Widgets

מערך של ווידג'טים שכלולים בעמודה. הווידג'טים מופיעים בסדר שבו הם צוינו.

HorizontalSizeStyle

מציין את האופן שבו עמודה ממלאת את רוחב הכרטיס. רוחב כל עמודה תלוי ב-HorizontalSizeStyle וברוחב הווידג'טים בעמודה.

תוספים ל-Google Workspace ואפליקציות של Chat

טיפוסים בני מנייה (enum)
HORIZONTAL_SIZE_STYLE_UNSPECIFIED אין להשתמש. לא צוין.
FILL_AVAILABLE_SPACE ערך ברירת המחדל. העמודה ממלאת את כל המרחב הזמין, עד 70% מרוח הכרטיס. אם שתי העמודות מוגדרות ל-FILL_AVAILABLE_SPACE, כל עמודה ממלאת 50% מהמרחב.
FILL_MINIMUM_SPACE העמודה ממלאת את שטח המסך במינימום האפשרי, ולא יותר מ-30% מרוחב הכרטיס.

VerticalAlignment

קובעת אם הווידג'טים ייטוו לחלק העליון, התחתון או המרכז של העמודה.

תוספים ל-Google Workspace ואפליקציות של Chat

טיפוסים בני מנייה (enum)
VERTICAL_ALIGNMENT_UNSPECIFIED אין להשתמש. לא צוין.
CENTER ערך ברירת המחדל. הווידג'טים יוצגו במרכז העמודה.
TOP יישור ווידג'טים לחלק העליון של עמודה.
BOTTOM התאמת הווידג'טים לתחתית העמודה.

ווידג'טים

הווידג'טים הנתמכים שאפשר לכלול בעמודה.

תוספים ל-Google Workspace ואפליקציות של Chat

שדות

שדה האיחוד data.

הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
text_paragraph

TextParagraph

ווידג'ט ‏TextParagraph.
image

Image

ווידג'ט ‏Image.
decorated_text

DecoratedText

ווידג'ט ‏DecoratedText.
button_list

ButtonList

ווידג'ט ‏ButtonList.
text_input

TextInput

ווידג'ט ‏TextInput.
selection_input

SelectionInput

ווידג'ט ‏SelectionInput.
date_time_picker

DateTimePicker

ווידג'ט ‏DateTimePicker.
chip_list

ChipList

ווידג'ט ‏ChipList.

DateTimePicker

מאפשר למשתמשים להזין תאריך, שעה או תאריך ושעה. תמיכה באימות שליחת טפסים. כשהאפשרות Action.all_widgets_are_required מוגדרת כ-true או שהווידג'ט הזה צוין ב-Action.required_widgets, פעולת השליחה חסומה אלא אם בוחרים ערך. לדוגמה באפליקציות של Google Chat, ראו איך מאפשרים למשתמש לבחור תאריך ושעה.

המשתמשים יכולים להזין טקסט או להשתמש בבורר כדי לבחור תאריכים ושעות. אם המשתמשים מזינים תאריך או שעה לא תקינים, בבורר מופיעה הודעת שגיאה שמבקשת מהמשתמשים להזין את המידע בצורה נכונה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
name

string

השם שבו מזוהה השדה DateTimePicker באירוע של קלט בטופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
label

string

הטקסט שמופיע כדי לבקש מהמשתמשים להזין תאריך, שעה או תאריך ושעה. לדוגמה, אם המשתמשים מתזמנים פגישה, אפשר להשתמש בתווית כמו Appointment date או Appointment date and time.
type

DateTimePickerType

האם הווידג'ט תומך בהזנת תאריך, שעה או תאריך ושעה.
value_ms_epoch

int64

ערך ברירת המחדל שמוצג בווידג'ט, באלפיות שנייה מאז ראשית זמן יוניקס (Unix epoch).

מציינים את הערך בהתאם לסוג הבורר (DateTimePickerType):

  • DATE_AND_TIME: תאריך ושעה ביומן לפי שעון UTC. לדוגמה, כדי לייצג את התאריך 1 בינואר 2023 בשעה 12:00 (שעון UTC), צריך להשתמש ב-1672574400000.
  • DATE_ONLY: תאריך קלנדרי בשעה 00:00:00 (UTC). לדוגמה, כדי לייצג את התאריך 1 בינואר 2023, משתמשים ב-1672531200000.
  • TIME_ONLY: שעה לפי שעון UTC. לדוגמה, כדי לייצג את השעה 12:00, משתמשים ב-43200000 (או ב-12 * 60 * 60 * 1000).
timezone_offset_date

int32

המספר שמייצג את הסטייה של אזור הזמן משעון UTC, בדקות. אם השדה מוגדר, value_ms_epoch יוצג באזור הזמן שצוין. אם לא תגדירו ערך, הערך שמוגדר כברירת מחדל הוא הגדרת אזור הזמן של המשתמש.
on_change_action

Action

האירוע מופעל כשהמשתמש לוחץ על שמירה או על ניקוי בממשק DateTimePicker.

DateTimePickerType

הפורמט של התאריך והשעה בווידג'ט DateTimePicker. קובעת אם המשתמשים יכולים להזין תאריך, שעה או תאריך ושעה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
DATE_AND_TIME המשתמשים מזינים תאריך ושעה.
DATE_ONLY המשתמשים מזינים תאריך.
TIME_ONLY המשתמשים מזינים שעה.

DecoratedText

ווידג'ט שמוצג בו טקסט עם קישוטים אופציונליים, כמו תווית מעל או מתחת לטקסט, סמל לפני הטקסט, ווידג'ט בחירה או לחצן אחרי הטקסט. דוגמה לאפליקציות של Google Chat זמינה במאמר הצגת טקסט עם טקסט דקורטיבי.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
icon
(deprecated)

Icon

הוצא משימוש לטובת startIcon.
start_icon

Icon

הסמל שמוצג לפני הטקסט.
start_icon_vertical_alignment

VerticalAlignment

אופציונלי. יישור אנכי של סמל ההתחלה. אם לא תגדירו את הערך, הסמל יוצג במרכז האנכי.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.
top_label

string

הטקסט שמופיע מעל text. תמיד חותכים.
top_label_text

TextParagraph

המקבילה של top_label ב-TextParagraph. תמיד חותכים. מאפשרת עיצוב מורכב יותר מ-top_label.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.
text

string

חובה. הטקסט הראשי.

יש תמיכה בעיצוב פשוט. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
content_text

TextParagraph

המקבילה של text ב-TextParagraph. מאפשרת עיצוב מורכב יותר מ-text.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.
wrap_text

bool

הגדרת גלישת הטקסט. אם הערך הוא true, הטקסט יתגובה ויוצג בכמה שורות. אחרת, הטקסט נחתך.

ההגדרה חלה רק על text, ולא על topLabel ו-bottomLabel.
bottom_label

string

הטקסט שמופיע מתחת ל-text. תמיד מתבצעת גלישת פסקה.
bottom_label_text

TextParagraph

המקבילה של bottom_label ב-TextParagraph. תמיד מתבצעת גלישת פסקה. מאפשרת עיצוב מורכב יותר מ-bottom_label.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.
on_click

OnClick

הפעולה הזו מופעלת כשמשתמשים לוחצים על topLabel או על bottomLabel.
שדה האיחוד control. כפתור, מתג, תיבת סימון או תמונה שמופיעים בצד שמאל של הטקסט בווידג'ט decoratedText. הערך של control יכול להיות רק אחת מהאפשרויות הבאות:
button

Button

כפתור שמשתמשים יכולים ללחוץ עליו כדי להפעיל פעולה.
switch_control

SwitchControl

ווידג'ט של מתג שהמשתמשים יכולים ללחוץ עליו כדי לשנות את המצב שלו ולהפעיל פעולה.
end_icon

Icon

סמל שמוצג אחרי הטקסט.

תמיכה בסמלים מובנים ומותאמים אישית.

SwitchControl

מתג הפעלה/השבתה או תיבת סימון בתוך ווידג'ט decoratedText.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

התכונה הזו נתמכת רק בווידג'ט decoratedText.

שדות
name

string

השם שבו מזוהה הווידג'ט של המתג באירוע של קלט טופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
value

string

הערך שהמשתמש הזין, מוחזר כחלק מאירוע קלט בטופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
selected

bool

כשהערך הוא true, המתג מסומן.
on_change_action

Action

הפעולה שתתבצע כשמצב המתג ישתנה, למשל איזו פונקציה להריץ.
control_type

ControlType

איך המתג מופיע בממשק המשתמש.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

ControlType

איך המתג מופיע בממשק המשתמש.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
SWITCH מתג בסגנון החלפת מצב.
CHECKBOX הוצא משימוש לטובת CHECK_BOX.
CHECK_BOX תיבת סימון.

קו מפריד

אין שדות לסוג הזה.

הצגת קו אופקי כמפריד בין ווידג'טים. לדוגמה באפליקציות של Google Chat, ראו הוספת מפריד אופקי בין ווידג'טים.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

לדוגמה, הקוד הבא יוצר מפריד:

"divider": {}

תצוגת רשת

רשת עם אוסף פריטים. הפריטים יכולים לכלול רק טקסט או תמונות. כדי ליצור עמודות רספונסיביות או כדי לכלול יותר מטקסט או תמונות, משתמשים ב-Columns. דוגמה לאפליקציות של Google Chat מופיעה בקטע הצגת רשת עם אוסף פריטים.

אפשר להוסיף לרשת כל מספר של עמודות ופריטים. מספר השורות נקבע לפי חלוקת הפריטים במספר העמודות. לרשת עם 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

string

הטקסט שמוצג בכותרת של התצוגה.
items[]

GridItem

הפריטים שיוצגו בתצוגת הרשת.
border_style

BorderStyle

סגנון המסגרת שיחול על כל פריט ברשת.
column_count

int32

מספר העמודות שיוצגו בתצוגה. אם לא מציינים ערך בשדה הזה, המערכת משתמשת בערך ברירת המחדל. ערך ברירת המחדל משתנה בהתאם למיקום שבו התצוגה של הרשת מוצגת (בחלון שיחה או בחלון נלווה).
on_click

OnClick

כל פריט בנפרד ברשימה משתמש שוב ב-callback הזה, אבל המזהה והאינדקס של הפריט ברשימת הפריטים מתווספים לפרמטרים של ה-callback.

GridItem

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

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
id

string

מזהה שהמשתמש מציין לפריט הזה בתצוגת הרשת. המזהה הזה מוחזר בפרמטרים של פונקציית ה-callback onClick של רשת ההורה.
image

ImageComponent

התמונה שמוצגת בפריט ברשת.
title

string

השם של פריט התצוגה.
subtitle

string

כותרת המשנה של פריט הרשת.
layout

GridItemLayout

הפריסה שבה יש להשתמש בפריט הרשת.

GridItemLayout

מייצג את אפשרויות הפריסה השונות הזמינות לפריט ברשימה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
GRID_ITEM_LAYOUT_UNSPECIFIED אין להשתמש בו. לא צוין.
TEXT_BELOW הכותרת והכותרת המשנה מוצגות מתחת לתמונה של פריט התצוגה.
TEXT_ABOVE הכותרת והכותרת המשנה מוצגות מעל לתמונה של פריט התצוגה.

סמל

סמל שמוצג בווידג'ט בכרטיס. לדוגמה, ב-Google Chat, אפשר לעיין במאמר הוספת סמל.

תמיכה בסמלים מובנים ומותאמים אישית.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
alt_text

string

אופציונלי. תיאור הסמל המשמש לנגישות. אם לא מציינים ערך, המערכת מספקת את ערך ברירת המחדל Button. מומלץ להגדיר תיאור מועיל של מה שמוצג בסמל, ואם רלוונטי, מה הוא עושה. לדוגמה, A user's account portrait או Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

אם הסמל מוגדר ב-Button, ה-altText מופיע כטקסט עזרה כשהמשתמש מעביר את סמן העכבר מעל הלחצן. עם זאת, אם הלחצן מגדיר גם את text, המערכת תתעלם מ-altText של הסמל.
image_type

ImageType

סגנון החיתוך שהוחל על התמונה. במקרים מסוימים, כשחוסמים את התמונה באמצעות CIRCLE, היא מוצגת גדולה יותר מסמל מובנה.
שדה האיחוד icons. הסמל שמוצג בווידג'ט בכרטיס. הערך של icons יכול להיות רק אחת מהאפשרויות הבאות:
known_icon

string

הצגת אחד מהסמלים המובנים של Google Workspace.

לדוגמה, כדי להציג סמל של מטוס, מציינים AIRPLANE. באוטובוס, מציינים BUS.

סמלים מובנים – רשימה מלאה של הסמלים הנתמכים.
icon_url

string

הצגת סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS.

לדוגמה:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

סוגי הקבצים הנתמכים כוללים .png ו-.jpg.
material_icon

MaterialIcon

להציג אחד מסמלי Google לעיצוב חדשני תלת-ממדי.

לדוגמה, כדי להציג סמל של תיבת סימון, משתמשים ב-

"material_icon": {
  "name": "check_box"
}

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

תמונה

תמונה שצוינה באמצעות כתובת URL ויכולה לכלול פעולה מסוג onClick. דוגמה מפורטת זמינה במאמר הוספת תמונה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
image_url

string

כתובת ה-URL מסוג HTTPS שמארחת את התמונה.

לדוגמה:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
on_click

OnClick

כשמשתמש לוחץ על התמונה, הקליק מפעיל את הפעולה הזו.
alt_text

string

הטקסט החלופי של התמונה הזו, שמשמש לצורכי נגישות.

ImageComponent

מייצג תמונה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
image_uri

string

כתובת ה-URL של התמונה.
alt_text

string

תווית הנגישות של התמונה.
crop_style

ImageCropStyle

סגנון החיתוך שיחול על התמונה.
border_style

BorderStyle

סגנון הגבול שיחול על התמונה.

ImageCropStyle

מייצג את סגנון החיתוך שהוחל על תמונה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

לדוגמה, כך מחילים יחס גובה-רוחב של 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
שדות
type

ImageCropType

סוג החיתוך.
aspect_ratio

double

יחס הגובה-רוחב שבו יש להשתמש אם סוג החיתוך הוא RECTANGLE_CUSTOM.

לדוגמה, כך מחילים יחס גובה-רוחב של 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 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

string

שם הסמל שמוגדר בסמל לעיצוב חדשני תלת-ממדי של Google, לדוגמה check_box. שמות לא חוקיים לא נשמרים והם מוחלפים במחרוזת ריקה, וכתוצאה מכך אי אפשר להציג את הסמל.
fill

bool

האם הסמל מוצג כסמל מלא. ערך ברירת המחדל הוא false.

כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל סמלי גופן Google ומשנים את ההגדרות בקטע התאמה אישית.
weight

int32

עובי הקו של הסמל. בוחרים מתוך {100, 200, 300, 400, 500, 600, 700}. אם השדה לא קיים, ערך ברירת המחדל הוא 400. אם יצוין ערך אחר, המערכת תשתמש בערך ברירת המחדל.

כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל סמלי גופן Google ומשנים את ההגדרות בקטע התאמה אישית.
grade

int32

העובי של הסמל מושפע מהמשקל והדרגה. שינויים בציון הם מפורטים יותר משינויים במשקל, והם משפיעים במידה קטנה על גודל הסמל. בוחרים מתוך {-25, 0, 200}. אם הערך חסר, ערך ברירת המחדל הוא 0. אם יצוין ערך אחר, המערכת תשתמש בערך ברירת המחדל.

כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל סמלי גופן Google ומשנים את ההגדרות בקטע התאמה אישית.

OnClick

הקוד הזה מייצג את התגובה שלכם כשמשתמשים לוחצים על רכיב אינטראקטיבי בכרטיס, כמו לחצן.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות

שדה האיחוד data.

הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
action

Action

אם צוין, הפעולה הזו תגרום להפעלת onClick.
card

Card

כרטיס חדש נדחף לערימה אחרי לחיצה, אם צוין כך.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.
overflow_menu

OverflowMenu

אם מציינים את האפשרות הזו, onClick פותח תפריט אפשרויות נוסף.

OnClose

מה הלקוח עושה כשקישור שנפתח על ידי פעולת OnClick נסגר.

ההטמעה תלויה ביכולות של פלטפורמת הלקוח. לדוגמה, דפדפן אינטרנט עשוי לפתוח קישור בחלון קופץ עם טיפול OnClose.

אם מוגדרים גם הטיפולים OnOpen וגם OnClose, ופלטפורמת הלקוח לא יכולה לתמוך בשני הערכים, הערך OnClose מקבל עדיפות.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.

טיפוסים בני מנייה (enum)
NOTHING ערך ברירת המחדל. הכרטיס לא נטען מחדש, כלום לא קורה.
RELOAD

טעינת הכרטיס מחדש אחרי שחלון הילדים נסגר.

אם משתמשים ב-OpenAs.OVERLAY, חלון הצאצא פועל כתיבת דו-שיח של חלון עזר והכרטיס הראשי נחסם עד שחלון הצאצא נסגר.

OpenAs

כשפעולה מסוג OnClick פותחת קישור, הלקוח יכול לפתוח אותו כחלון בגודל מלא (אם זה המסגרת שבה הלקוח משתמש) או כשכבת-על (למשל חלון קופץ). ההטמעה תלויה ביכולות של פלטפורמת הלקוח, ויכול להיות שהערך שנבחר יתעלם אם הלקוח לא תומך בו. כל הלקוחות תומכים ב-FULL_SIZE.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.

טיפוסים בני מנייה (enum)
FULL_SIZE הקישור נפתח כחלון בגודל מלא (אם זה המסגרת שבה הלקוח משתמש).
OVERLAY הקישור נפתח כשכבת-על, למשל חלון קופץ.

OverflowMenu

ווידג'ט שמציג תפריט קופץ עם פעולה אחת או יותר שהמשתמשים יכולים להפעיל. לדוגמה, הצגת פעולות לא ראשיות בכרטיס. אפשר להשתמש בווידג'ט הזה כשהפעולות לא נכנסות למרחב הזמין. כדי להשתמש בו, מציינים את הווידג'ט הזה בפעולה OnClick של הווידג'טים שתומכים בו. לדוגמה, ב-Button.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
items[]

OverflowMenuItem

חובה. רשימת האפשרויות בתפריט.

OverflowMenuItem

אפשרות שהמשתמשים יכולים להפעיל בתפריט האפשרויות הנוספות.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
start_icon

Icon

הסמל שמוצג לפני הטקסט.
text

string

חובה. הטקסט שמזהה או מתאר את הפריט למשתמשים.
on_click

OnClick

חובה. הפעולה שמתבצעת כשבוחרים אפשרות בתפריט. ה-OnClick הזה לא יכול להכיל OverflowMenu, כל OverflowMenu שצוין יושלך ופריט התפריט יושבת.
disabled

bool

אם אפשרות התפריט מושבתת. ברירת המחדל היא false.

SelectionInput

ווידג'ט שיוצר פריט אחד או יותר בממשק המשתמש שהמשתמשים יכולים לבחור. תמיכה באימות שליחת טפסים בתפריטים dropdown ו-multiselect בלבד. כשהאפשרות Action.all_widgets_are_required מוגדרת כ-true או שהווידג'ט הזה צוין ב-Action.required_widgets, פעולת השליחה חסומה אלא אם בוחרים ערך. לדוגמה, תפריט נפתח או תיבות סימון. אפשר להשתמש בווידג'ט הזה כדי לאסוף נתונים שאפשר לחזות או לספור. דוגמה לאפליקציות של Google Chat מופיעה בקטע הוספת רכיבי ממשק משתמש שניתן לבחור בהם.

אפליקציות צ'אט יכולות לעבד את הערך של פריטים שהמשתמשים בוחרים או מזינים. פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.

כדי לאסוף ממשתמשים נתונים לא מוגדרים או מופשטים, משתמשים בווידג'ט TextInput.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
name

string

חובה. השם שמזהה את הקלט של הבחירה באירוע קלט של טופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
label

string

הטקסט שמופיע מעל שדה הקלט של הבחירה בממשק המשתמש.

מציינים טקסט שיעזור למשתמש להזין את המידע הנדרש לאפליקציה. לדוגמה, אם המשתמשים בוחרים את מידת הדחיפות של כרטיס עבודה מתפריט נפתח, התווית עשויה להיות 'דחיפות' או 'בחירת דחיפות'.
type

SelectionType

סוג הפריטים שמוצגים למשתמשים בווידג'ט SelectionInput. סוגי הבחירה תומכים בסוגים שונים של אינטראקציות. לדוגמה, משתמשים יכולים לסמן תיבה אחת או יותר, אבל הם יכולים לבחור רק ערך אחד מתפריט נפתח.
items[]

SelectionItem

מערך של פריטים שאפשר לבחור. לדוגמה, מערך של כפתורי בחירה או תיבות סימון. יש תמיכה בעד 100 פריטים.
on_change_action

Action

אם יצוין, הטופס יישלח כשהבחירה תשתנה. אם לא צוין, צריך לציין לחצן נפרד לשליחת הטופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
multi_select_max_selected_items

int32

בתפריטים עם אפשרות לבחירת מספר פריטים, מספר הפריטים המקסימלי שהמשתמש יכול לבחור. הערך המינימלי הוא פריט אחד. אם לא צוין ערך, ברירת המחדל היא 3 פריטים.
multi_select_min_query_length

int32

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

אם לא תגדירו את הפרמטר, תתבצע שימוש בערכי ברירת המחדל הבאים בתפריט הבחירה בכמה פריטים:

  • אם התפריט משתמש במערך סטטי של פריטים מסוג SelectionInput, הערך שמוגדר כברירת מחדל הוא 0 תווים והפריטים מהמערך מאוכלסים באופן מיידי.
  • אם התפריט משתמש במקור נתונים דינמי (multi_select_data_source), ברירת המחדל היא 3 תווים לפני שליחת שאילתה למקור הנתונים כדי להציג הצעות לפריטים.

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

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace. הערך של multi_select_data_source יכול להיות רק אחת מהאפשרויות הבאות:
external_data_source

Action

מקור נתונים חיצוני, כמו מסד נתונים יחסי.
platform_data_source

PlatformDataSource

מקור נתונים מ-Google Workspace.

PlatformDataSource

בווידג'ט SelectionInput שמשתמש בתפריט לבחירת מספר פריטים, מקור נתונים מ-Google Workspace. משמש לאכלוס פריטים בתפריט עם אפשרות לבחירת כמה פריטים.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות
שדה האיחוד data_source. מקור הנתונים. הערך של data_source יכול להיות רק אחת מהאפשרויות הבאות:
common_data_source

CommonDataSource

מקור נתונים שמשותף לכל האפליקציות של Google Workspace, כמו משתמשים בארגון ב-Google Workspace.
host_app_data_source

HostAppDataSourceMarkup

מקור נתונים ייחודי לאפליקציית מארח ב-Google Workspace, כמו מרחבים משותפים ב-Google Chat.

השדה הזה תומך בספריות הלקוח של Google API, אבל הוא לא זמין בספריות הלקוח ב-Cloud. מידע נוסף זמין במאמר התקנת ספריות הלקוח.

CommonDataSource

מקור נתונים שמשותף לכל אפליקציות Google Workspace.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

טיפוסים בני מנייה (enum)
UNKNOWN ערך ברירת המחדל. אין להשתמש בו.
USER משתמשי Google Workspace. המשתמש יכול להציג ולבחור רק משתמשים מהארגון שלו ב-Google Workspace.

SelectionItem

פריט שהמשתמשים יכולים לבחור באפשרות להזנת בחירה, כמו תיבת סימון או מתג. יש תמיכה בעד 100 פריטים.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
text

string

הטקסט שמזהה או מתאר את הפריט למשתמשים.
value

string

הערך שמשויך לפריט הזה. הלקוח צריך להשתמש בו כערך קלט בטופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
selected

bool

אם הפריט מסומן כברירת מחדל. אם קלט הבחירה מקבל רק ערך אחד (למשל לחצני בחירה או תפריט נפתח), מגדירים את השדה הזה רק לפריט אחד.
bottom_text

string

בתפריטים עם אפשרות לבחירת מספר פריטים, תווית או טקסט תיאורי שמוצגים מתחת לשדה text של הפריט.
שדה האיחוד start_icon. בתפריטים עם אפשרות לבחירת מספר פריטים, כתובת ה-URL של הסמל שמוצג לצד השדה text של הפריט. יש תמיכה בקובצי PNG ו-JPEG. חייבת להיות כתובת URL מסוג HTTPS. לדוגמה, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png. הערך של start_icon יכול להיות רק אחת מהאפשרויות הבאות:
start_icon_uri

string

SelectionType

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

כל קלט של בחירה תומך בסוג אחד של בחירה. לדוגמה, אי אפשר לשלב בין תיבות סימון לבין מתגים.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
CHECK_BOX קבוצה של תיבות סימון. המשתמשים יכולים לבחור תיבה אחת או יותר.
RADIO_BUTTON קבוצה של כפתורי בחירה. המשתמשים יכולים לבחור רק כפתור בחירה אחד.
SWITCH קבוצת מתגים. המשתמשים יכולים להפעיל מתג אחד או יותר.
DROPDOWN תפריט נפתח. המשתמשים יכולים לבחור פריט אחד מהתפריט.
MULTI_SELECT

תפריט עם תיבת טקסט. המשתמשים יכולים להקליד ולבחור פריט אחד או יותר. בתוספים ל-Google Workspace, צריך לאכלס פריטים באמצעות מערך סטטי של אובייקטים מסוג SelectionItem.

באפליקציות של Google Chat, אפשר גם לאכלס פריטים באמצעות מקור נתונים דינמי ולהציע פריטים באופן אוטומטי כשהמשתמשים מקלידים בתפריט. לדוגמה, משתמשים יכולים להתחיל להקליד את השם של מרחב משותף ב-Google Chat, והווידג'ט יציע את המרחב באופן אוטומטי. כדי לאכלס באופן דינמי פריטים בתפריט לבחירת מספר פריטים, משתמשים באחד מסוגי מקורות הנתונים הבאים:

  • נתונים מ-Google Workspace: הפריטים מאוכלסים באמצעות נתונים מ-Google Workspace, כמו משתמשי Google Workspace או מרחבים משותפים ב-Google Chat.
  • נתונים חיצוניים: הפריטים מאוכלסים ממקור נתונים חיצוני מחוץ ל-Google Workspace.

דוגמאות להטמעת תפריטים לבחירת מספר פריטים באפליקציות 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

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

SuggestionItem

הצעה אחת לערך שהמשתמשים יכולים להזין בשדה קלט טקסט.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות

שדה האיחוד content.

הערך של content יכול להיות רק אחת מהאפשרויות הבאות:
text

string

הערך של הצעת קלט לשדה קלט טקסט. זהו הערך שאותו מזינים המשתמשים בעצמם.

TextInput

שדה שבו המשתמשים יכולים להזין טקסט. תמיכה בהצעות ובפעולות שמתבצעות כשמתרחש שינוי. תמיכה באימות שליחת טפסים. כשהערך של Action.all_widgets_are_required מוגדר כ-true או שהווידג'ט הזה מצוין ב-Action.required_widgets, פעולת השליחה חסומה אלא אם מזינים ערך. לדוגמה באפליקציות של Google Chat, ראו הוספת שדה שבו משתמשים יכולים להזין טקסט.

אפליקציות צ'אט מקבלות את הערך של הטקסט שהוזן במהלך אירועי קלט בטופס, ויכולות לעבד אותו. פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.

כשצריך לאסוף ממשתמשים נתונים לא מוגדרים או מופשטים, צריך להשתמש בקלט טקסט. כדי לאסוף נתונים מוגדרים או מפורטים מהמשתמשים, משתמשים בווידג'ט SelectionInput.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
name

string

השם שבו מזוהה הקלט של הטקסט באירוע של קלט טופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
label

string

הטקסט שמופיע מעל שדה הטקסט להזנה בממשק המשתמש.

מציינים טקסט שיעזור למשתמש להזין את המידע הנדרש לאפליקציה. לדוגמה, אם אתם שואלים על שם של מישהו, אבל אתם צריכים את שם המשפחה שלו באופן ספציפי, עליכם לכתוב surname במקום name.

חובה אם לא צוין hintText. אחרת, אופציונלי.
hint_text

string

טקסט שמופיע מתחת לשדה להזנת טקסט, שנועד לעזור למשתמשים על ידי הנחיה להזין ערך מסוים. הטקסט הזה תמיד גלוי.

חובה אם לא צוין label. אחרת, אופציונלי.
value

string

הערך שהמשתמש הזין, מוחזר כחלק מאירוע קלט בטופס.

פרטים על עבודה עם נתוני קלט של טפסים זמינים במאמר קבלת נתוני טפסים.
type

Type

איך שדה להזנת טקסט מופיע בממשק המשתמש. לדוגמה, אם השדה הוא שורה אחת או כמה שורות.
on_change_action

Action

מה עושים כשמתבצע שינוי בשדה הקלט של הטקסט. לדוגמה, משתמש שמוסיף לשדה או מחק טקסט.

דוגמאות לפעולות שאפשר לבצע הן הפעלת פונקציה מותאמת אישית או פתיחת תיבת דו-שיח ב-Google Chat.
initial_suggestions

Suggestions

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

לדוגמה, בשדה קלט טקסט של שפת תכנות יכולות להופיע הצעות לשפות Java,‏ JavaScript,‏ Python ו-C++‎. כשהמשתמשים מתחילים להקליד Jav, רשימת ההצעות מסוננת כך שתוצג רק Java ו-JavaScript.

הצעות לערכים עוזרות למשתמשים להזין ערכים שהאפליקציה שלכם יכולה להבין. כשמדברים על JavaScript, חלק מהמשתמשים עשויים להזין javascript וחלקם java script. הצעת JavaScript יכולה לסטנדרטיזציה את אופן האינטראקציה של המשתמשים עם האפליקציה.

כשמציינים את הערך, TextInput.type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר כ-MULTIPLE_LINE.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.
auto_complete_action

Action

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

אם לא מציינים ערך, ההצעות מוגדרות על ידי initialSuggestions ומעובדות על ידי הלקוח.

אם צוין, האפליקציה מבצעת את הפעולה שצוינה כאן, למשל הפעלת פונקציה מותאמת אישית.

התכונה זמינה בתוספים של Google Workspace ולא זמינה באפליקציות של Google Chat.
validation

Validation

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

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.
placeholder_text

string

הטקסט שמופיע בשדה להזנת טקסט כשהשדה ריק. משתמשים בטקסט הזה כדי לבקש מהמשתמשים להזין ערך. לדוגמה, Enter a number from 0 to 100.

התכונה זמינה באפליקציות של 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

string

הטקסט שמוצג בווידג'ט.
max_lines

int32

מספר השורות המקסימלי של הטקסט שמוצג בווידג'ט. אם הטקסט חורג ממספר השורות המקסימלי שצוין, התוכן העודף מוסתר מאחורי הלחצן הצגת עוד. אם הטקסט שווה למספר השורות המקסימלי שצוין או קצר ממנו, לא יוצג הלחצן הצגת עוד.

ערך ברירת המחדל הוא 0, ובמקרה כזה כל ההקשר מוצג. המערכת מתעלמת מערכים שליליים.
text_syntax

TextSyntax

התחביר של הטקסט. אם לא תגדירו את הערך, הטקסט יופיע כ-HTML.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

TextSyntax

תחביר לשימוש בעיצוב טקסט.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

טיפוסים בני מנייה (enum)
TEXT_SYNTAX_UNSPECIFIED אם לא צוין אחרת, הטקסט יומר ל-HTML.
HTML הטקסט עובר עיבוד כ-HTML. זהו ערך ברירת המחדל.
MARKDOWN הטקסט מוצג כ-Markdown.

אימות

מייצג את הנתונים הנדרשים לאימות הווידג'ט שאליו הוא מצורף.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

שדות
character_limit

int32

ציון מגבלת התווים של ווידג'טים להזנת טקסט. חשוב לזכור שהאפשרות הזו משמשת רק להזנת טקסט, והיא מתעלמת מווידג'טים אחרים.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.
input_type

InputType

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

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

InputType

הסוג של ווידג'ט הקלט.

טיפוסים בני מנייה (enum)
INPUT_TYPE_UNSPECIFIED סוג לא צוין. אין להשתמש בו.
TEXT טקסט רגיל שמקבל את כל התווים.
INTEGER ערך של מספר שלם.
FLOAT ערך נקודה צפה.
EMAIL כתובת אימייל.
EMOJI_PICKER אמוג'י שנבחר מתוך הכלי לבחירת אמוג'י שסופק על ידי המערכת.

ווידג'ט

כל כרטיס מורכב מווידג'טים.

ווידג'ט הוא אובייקט מורכב שיכול לייצג טקסט, תמונות, לחצנים וסוגים אחרים של אובייקטים.

שדות
horizontal_alignment

HorizontalAlignment

קובע אם הווידג'טים ייטו לשמאל, לימין או למרכז העמודה.
שדה האיחוד data. בווידג'ט יכול להופיע רק אחד מהפריטים הבאים. אפשר להשתמש בכמה שדות של ווידג'טים כדי להציג יותר פריטים. הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
text_paragraph

TextParagraph

הצגת פסקה של טקסט. יש תמיכה בטקסט פשוט בפורמט HTML. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.

לדוגמה, הקוד הבא יוצר טקסט מודגש:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

Image

הצגת תמונה.

לדוגמה, הקוד הבא ב-JSON יוצר תמונה עם טקסט חלופי:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decorated_text

DecoratedText

הצגת פריט טקסט מעוטר.

לדוגמה, הקוד הבא ב-JSON יוצר ווידג'ט טקסט מעוטר שמוצגת בו כתובת אימייל:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
button_list

ButtonList

רשימת לחצנים.

לדוגמה, הקוד הבא ב-JSON יוצר שני לחצנים. הראשון הוא כפתור טקסט כחול והשני הוא כפתור תמונה שפותח קישור:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
text_input

TextInput

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

לדוגמה, ה-JSON הבא יוצר קלט טקסט לכתובת אימייל:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

דוגמה נוספת: ה-JSON הבא יוצר קלט טקסט לשפת תכנות עם הצעות סטטיות:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selection_input

SelectionInput

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

לדוגמה, הקוד הבא ב-JSON יוצר תפריט נפתח שמאפשר למשתמשים לבחור מידה:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
date_time_picker

DateTimePicker

הצגת ווידג'ט שמאפשר למשתמשים להזין תאריך, שעה או תאריך ושעה.

לדוגמה, הקוד הבא ב-JSON יוצר בורר תאריך ושעה לקביעת פגישה:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": 796435200000
}
divider

Divider

הצגת קו מפריד אופקי בין ווידג'טים.

לדוגמה, הקוד הבא יוצר מפריד:

"divider": {
}
grid

Grid

רשת עם אוסף פריטים.

אפשר להוסיף לרשת כל מספר של עמודות ופריטים. מספר השורות נקבע לפי המגבלות העליונות של מספר הפריטים חלקי מספר העמודות. לרשת עם 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"
    }
  }
}
columns

Columns

מוצגות עד 2 עמודות.

כדי לכלול יותר מ-2 עמודות או להשתמש בשורות, צריך להשתמש בווידג'ט Grid.

לדוגמה, ה-JSON הבא יוצר 2 עמודות שכל אחת מהן מכילה פסקאות טקסט:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
carousel

Carousel

קרוסלה מכילה אוסף של ווידג'טים בתצוגת עץ. לדוגמה, זוהי ייצוג JSON של קרוסלה שמכילה שני פסקאות טקסט.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}
chip_list

ChipList

רשימת צ'יפים.

לדוגמה, ה-JSON הבא יוצר שני צ'יפים. הראשון הוא צ'יפ טקסט והשני הוא צ'יפ סמל שפותח קישור:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

HorizontalAlignment

קובע אם הווידג'טים ייטו לשמאל, לימין או למרכז העמודה.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

טיפוסים בני מנייה (enum)
HORIZONTAL_ALIGNMENT_UNSPECIFIED אין להשתמש. לא צוין.
START ערך ברירת המחדל. התאמת הווידג'טים למיקום ההתחלה של העמודה. בפריסות מימין לשמאל, התמונה תהיה מותאמת לשמאל. בפריסות מימין לשמאל, התמונה תתמקם בצד שמאל.
CENTER הווידג'טים יוצגו במרכז העמודה.
END התאמת הווידג'טים למיקום הסוף של העמודה. בפריסות מימין לשמאל, הווידג'טים ממורכזים בצד שמאל. בפריסות מימין לשמאל, הווידג'טים ממורכזים בצד ימין.

ImageType

הצורה שבה התמונה נחתכה.

זמין באפליקציות של Google Chat ובתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
SQUARE ערך ברירת המחדל. החלת מסכה ריבועית על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לתמונה בגודל 3x3.
CIRCLE החלת מסכה עגולה על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לעיגול בקוטר 3.

VerticalAlignment

מייצג מאפיין של יישור אנכי.

טיפוסים בני מנייה (enum)
VERTICAL_ALIGNMENT_UNSPECIFIED סוג לא צוין. אין להשתמש בו.
TOP יישור למיקום העליון.
MIDDLE יישור למרכז.
BOTTOM יישור למיקום התחתון.