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 והמערכת מתעלמת מכל ערך שהוגדר לשדה הזה.

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

סוג

זה שינוי אופציונלי. type של הלחצן. אם מוגדר השדה 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.

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

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

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

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

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

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

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

קטע

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

זמין לאפליקציות ל-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

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

צ'יפ

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

זמין באפליקציות ל-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. זמין באפליקציות של Google Chat ולא זמין בתוספים של Google Workspace.

DateTimePicker

מאפשר למשתמשים להזין תאריך, שעה או תאריך ושעה. דוגמה לאפליקציות של 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.
validation

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
(deprecated)

Icon

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

Icon

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

string

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

string

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

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

bool

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

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

string

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

לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:

"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

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

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

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

Validation

בתפריטים נפתחים, האימות של שדה הקלט הזה לבחירה.

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

שדה האיחוד 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

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

string

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

string

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

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

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

אימות

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

זמין לאפליקציות ל-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"
          }
        }
      ]
    }
  ]
}
chip_list

ChipList

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

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

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

זמין באפליקציות ל-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.