Cards v2

קלפים

ממשק כרטיסים שמוצג בהודעה ב-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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
ייצוג ב-JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}
שדות
header

object (CardHeader)

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

sections[]

object (Section)

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

sectionDividerStyle

enum (DividerStyle)

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

cardActions[]

object (CardAction)

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

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

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

"cardActions": [
  {
    "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.

displayStyle

enum (DisplayStyle)

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

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

peekCardHeader

object (CardHeader)

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

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

CardHeader

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

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

ייצוג ב-JSON 
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
שדות
title

string

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

subtitle

string

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

imageType

enum (ImageType)

הצורה שמשמשת לחיתוך התמונה.

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

imageUrl

string

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

imageAltText

string

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

ImageType

הצורה שמשמשת לחיתוך התמונה.

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

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

קטע

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

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

ייצוג ב-JSON 
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}
שדות
header

string

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

widgets[]

object (Widget)

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

collapsible

boolean

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

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

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

uncollapsibleWidgetsCount

integer

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

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

collapseControl

object (CollapseControl)

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

ווידג'ט

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

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

ייצוג ב-JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}
שדות
horizontalAlignment

enum (HorizontalAlignment)

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

שדה איחוד data. ווידג'ט יכול להכיל רק אחד מהפריטים הבאים. אתם יכולים להשתמש בכמה שדות של ווידג'טים כדי להציג יותר פריטים. ‫data יכול להיות רק אחד מהערכים הבאים:
textParagraph

object (TextParagraph)

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

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

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

object (Image)

התג הזה מציג תמונה.

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

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

object (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"
  }
}
buttonList

object (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"
        }
      }
    }
  ]
}
textInput

object (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"
      }
    ]
  }
}
selectionInput

object (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
    }
  ]
}
dateTimePicker

object (DateTimePicker)

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

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

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

object (Divider)

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

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

"divider": {
}
grid

object (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

object (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

object (Carousel)

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

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

object (ChipList)

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

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

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

TextParagraph

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

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

ייצוג ב-JSON 
{
  "text": string,
  "maxLines": integer,
  "textSyntax": enum (TextSyntax)
}
שדות
text

string

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

maxLines

integer

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

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

textSyntax

enum (TextSyntax)

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

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

TextSyntax

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

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

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

תמונה

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

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

ייצוג ב-JSON 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}
שדות
imageUrl

string

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

לדוגמה: 

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

object (OnClick)

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

altText

string

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

OnClick

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

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

ייצוג ב-JSON 
{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}
שדות

שדה איחוד data.

‫data יכול להיות רק אחד מהבאים:

action

object (Action)

אם מציינים פעולה, היא מופעלת על ידי onClick.

card

object (Card)

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

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

overflowMenu

object (OverflowMenu)

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

פעולה

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

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

ייצוג ב-JSON 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
שדות
function

string

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

דוגמאות לשימוש מופיעות במאמר בנושא קריאת נתוני טופס.

parameters[]

object (ActionParameter)

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

loadIndicator

enum (LoadIndicator)

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

persistValues

boolean

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

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

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

interaction

enum (Interaction)

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

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

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

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

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

requiredWidgets[]

string

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

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

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

allWidgetsAreRequired

boolean

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

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

ActionParameter

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

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

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

ייצוג ב-JSON 
{
  "key": string,
  "value": string
}
שדות
key

string

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

value

string

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

LoadIndicator

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

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

טיפוסים בני מנייה (enum)
SPINNER הצגת אנימציית טעינה כדי לציין שהתוכן נטען.
NONE לא מוצג כלום.

אינטראקציה

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

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

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

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

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

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

טיפוסים בני מנייה (enum)
INTERACTION_UNSPECIFIED ערך ברירת המחדל. התגית action פועלת כרגיל.
OPEN_DIALOG

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

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

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

OpenAs

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

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

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

OnClose

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

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

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

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

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

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

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

OverflowMenu

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

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

ייצוג ב-JSON 
{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}
שדות
items[]

object (OverflowMenuItem)

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

OverflowMenuItem

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

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

ייצוג ב-JSON 
{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}
שדות
startIcon

object (Icon)

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

text

string

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

onClick

object (OnClick)

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

disabled

boolean

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

סמל

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

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

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

ייצוג ב-JSON 
{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}
שדות
altText

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 בסמל.

imageType

enum (ImageType)

סגנון החיתוך שהוחל על התמונה. במקרים מסוימים, חיתוך של תמונה גורם להצגת התמונה בגודל גדול יותר מסמל מובנה.CIRCLE

שדה איחוד icons. הסמל שמוצג בווידג'ט בכרטיס. ‫icons יכול להיות רק אחד מהערכים הבאים:
knownIcon

string

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

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

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

iconUrl

string

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

לדוגמה: 

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

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

materialIcon

object (MaterialIcon)

הצגת אחד מהסמלים של Google Material.

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

"materialIcon": {
  "name": "check_box"
}

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

MaterialIcon

‫A Google Material Icon, שכולל יותר מ-2,500 אפשרויות.

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

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

ייצוג ב-JSON 
{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}
שדות
name

string

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

fill

boolean

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

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

weight

integer

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

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

grade

integer

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

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

DecoratedText

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

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

ייצוג ב-JSON 
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}
שדות
icon
(deprecated)

object (Icon)

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

startIcon

object (Icon)

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

startIconVerticalAlignment

enum (VerticalAlignment)

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

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

topLabel

string

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

topLabelText

object (TextParagraph)

‫TextParagraph שווה ערך ל- topLabel. תמיד נחתך. מאפשר עיצוב מורכב יותר מאשר topLabel.

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

text

string

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

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

contentText

object (TextParagraph)

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

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

wrapText

boolean

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

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

bottomLabel

string

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

bottomLabelText

object (TextParagraph)

‫TextParagraph שווה ערך ל- bottomLabel. הטקסט תמיד מוצג בשורות נפרדות. מאפשר עיצוב מורכב יותר מאשר bottomLabel.

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

onClick

object (OnClick)

הפעולה הזו מופעלת כשמשתמשים לוחצים על topLabel או על bottomLabel.

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

object (Button)

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

switchControl

object (SwitchControl)

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

endIcon

object (Icon)

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

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

VerticalAlignment

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

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

לחצן

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

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

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

ייצוג ב-JSON 
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}
שדות
text

string

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

icon

object (Icon)

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

color

object (Color)

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

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

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

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

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

onClick

object (OnClick)

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

disabled

boolean

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

altText

string

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

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

type

enum (Type)

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

צבע

מייצג צבע במרחב הצבעים RGBA. הייצוג הזה נועד לפשט את ההמרה לייצוגי צבעים ובחזרה מהם בשפות שונות, ולא להתמקד בדחיסה. לדוגמה, אפשר לספק את השדות של הייצוג הזה בקלות לבונה של java.awt.Color ב-Java. אפשר גם לספק אותם בקלות לשיטה +colorWithRed:green:blue:alpha של UIColor ב-iOS. בנוסף, אפשר לעצב אותם בקלות למחרוזת rgba() של CSS ב-JavaScript, עם קצת עבודה.

בדף ההפניה הזה אין מידע על מרחב הצבעים המוחלט שצריך להשתמש בו כדי לפרש את ערך ה-RGB – למשל, sRGB,‏ Adobe RGB,‏ DCI-P3 ו-BT.2020. כברירת מחדל, האפליקציות צריכות להניח שמרחב הצבעים הוא sRGB.

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

דוגמה (Java): 

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

דוגמה (iOS / Obj-C): 

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

דוגמה (JavaScript): 

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
ייצוג ב-JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
שדות
red

number

כמות האדום בצבע כערך במרווח [0, 1].

green

number

כמות הירוק בצבע כערך במרווח [0, 1].

blue

number

כמות הכחול בצבע כערך בטווח [0, 1].

alpha

number

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

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

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

סוג

אופציונלי. ‫type של לחצן. אם השדה color מוגדר, השדה type מוגדר בכפייה ל-FILLED.

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

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED אין להשתמש. לא צוין.
OUTLINED לחצנים מודגשים הם לחצנים עם הדגשה בינונית. הם בדרך כלל מכילים פעולות שחשובות, אבל לא הפעולה העיקרית באפליקציה או בתוסף ל-Chat.
FILLED כפתור מלא הוא כפתור עם קונטיינר בצבע אחיד. הוא משפיע הכי הרבה על המראה, ומומלץ להשתמש בו לפעולה החשובה והעיקרית באפליקציית Chat או בתוסף.
FILLED_TONAL כפתור מלא עם גוון הוא פתרון ביניים בין כפתורים מלאים לכפתורים עם קו מתאר. הם שימושיים בהקשרים שבהם נדרש דגש קצת יותר חזק ללחצן עם עדיפות נמוכה יותר מאשר ללחצן עם קו מתאר.
BORDERLESS ללחצן אין מאגר בלתי נראה במצב ברירת המחדל שלו. הוא משמש לעיתים קרובות לפעולות בעדיפות הנמוכה ביותר, במיוחד כשמוצגות כמה אפשרויות.

SwitchControl

מתג בסגנון החלפה או תיבת סימון בתוך ווידג'ט decoratedText.

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

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

ייצוג ב-JSON 
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
שדות
name

string

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

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

value

string

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

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

selected

boolean

כשבוחרים במתג true.

onChangeAction

object (Action)

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

controlType

enum (ControlType)

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

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

ControlType

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

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

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

ButtonList

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

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

ייצוג ב-JSON 
{
  "buttons": [
    {
      object (Button)
    }
  ]
}
שדות
buttons[]

object (Button)

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

TextInput

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

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

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

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

ייצוג ב-JSON 
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}
שדות
name

string

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

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

label

string

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

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

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

hintText

string

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

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

value

string

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

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

type

enum (Type)

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

onChangeAction

object (Action)

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

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

initialSuggestions

object (Suggestions)

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

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

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

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

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

autoCompleteAction

object (Action)

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

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

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

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

validation

object (Validation)

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

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

placeholderText

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

RenderActions

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

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

שדות
action

Action

פעולה

שדות
navigations[]

Navigation

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

תוספים ב-Google Chat

הוספת כרטיס חדש לחפיסה (ניווט קדימה). באפליקציות ל-Chat, האפשרות הזו זמינה רק בדף הבית של האפליקציה.

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

navigations: {
  pushCard: CARD
}

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

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

navigations: {
  updateCard: CARD
}

הצעות

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

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

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

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

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

ייצוג ב-JSON 
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
שדות
items[]

object (SuggestionItem)

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

SuggestionItem

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

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

ייצוג ב-JSON 
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
שדות

שדה איחוד content.

‫content יכול להיות רק אחד מהבאים:

text

string

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

אימות

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

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

ייצוג ב-JSON 
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
שדות
characterLimit

integer

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

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

inputType

enum (InputType)

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

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

InputType

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

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

SelectionInput

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

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

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

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

ייצוג ב-JSON 
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}
שדות
name

string

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

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

label

string

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

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

type

enum (SelectionType)

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

items[]

object (SelectionItem)

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

onChangeAction

object (Action)

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

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

multiSelectMaxSelectedItems

integer

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

multiSelectMinQueryLength

integer

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

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

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

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

זמין לאפליקציות של Google Chat ולא זמין לתוספים של Google Workspace. ‫multi_select_data_source יכול להיות רק אחד מהבאים:

externalDataSource

object (Action)

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

platformDataSource

object (PlatformDataSource)

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

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.

SelectionItem

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

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

ייצוג ב-JSON 
{
  "text": string,
  "value": string,
  "selected": boolean,
  "bottomText": string,

  // Union field start_icon can be only one of the following:
  "startIconUri": string
  // End of list of possible types for union field start_icon.
}
שדות
text

string

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

value

string

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

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

selected

boolean

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

bottomText

string

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

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

string

PlatformDataSource

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

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

ייצוג ב-JSON 
{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
שדות
שדה איחוד data_source. מקור הנתונים. ‫data_source יכול להיות רק אחד מהערכים הבאים:
commonDataSource

enum (CommonDataSource)

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

hostAppDataSource

object (HostAppDataSourceMarkup)

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

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

CommonDataSource

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

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

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

HostAppDataSourceMarkup

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

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

ייצוג ב-JSON 
{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
שדות
שדה איחוד data_source. אפליקציית Google Workspace שמאכלסת פריטים בתפריט בחירה מרובה. ‫data_source יכול להיות רק אחד מהערכים הבאים:
chatDataSource

object (ChatClientDataSourceMarkup)

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

ChatClientDataSourceMarkup

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

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

ייצוג ב-JSON 
{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}
שדות
שדה איחוד source. מקור הנתונים של Google Chat. ‫source יכול להיות רק אחד מהערכים הבאים:
spaceDataSource

object (SpaceDataSource)

מרחבים ב-Google Chat שהמשתמש חבר בהם.

SpaceDataSource

מקור נתונים שמאכלס מרחבים ב-Google Chat כפריטים לבחירה בתפריט בחירה מרובה. רק מרחבים שהמשתמש חבר בהם.

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

ייצוג ב-JSON 
{
  "defaultToCurrentSpace": boolean
}
שדות
defaultToCurrentSpace

boolean

אם הערך מוגדר ל- true, בתפריט הבחירה מרובת האפשרויות נבחר כברירת מחדל המרחב הנוכחי ב-Google Chat.

DateTimePicker

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

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

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

ייצוג ב-JSON 
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": int64,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  }
}
שדות
name

string

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

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

label

string

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

type

enum (DateTimePickerType)

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

valueMsEpoch

int64

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

מציינים את הערך בהתאם לסוג הכלי לבחירת תאריכים ( 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).
timezoneOffsetDate

integer

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

onChangeAction

object (Action)

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

DateTimePickerType

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

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

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

קו מפריד

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

מציג קו אופקי כמפריד בין הווידג'טים. לדוגמה, באפליקציות ל-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"
    }
  }
}
ייצוג ב-JSON 
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
שדות
title

string

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

items[]

object (GridItem)

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

borderStyle

object (BorderStyle)

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

columnCount

integer

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

onClick

object (OnClick)

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

GridItem

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

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

ייצוג ב-JSON 
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
שדות
id

string

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

image

object (ImageComponent)

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

title

string

השם של הפריט ברשת.

subtitle

string

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

layout

enum (GridItemLayout)

הפריסה שבה רוצים להשתמש עבור פריט הרשת.

ImageComponent

מייצג תמונה.

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

ייצוג ב-JSON 
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
שדות
imageUri

string

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

altText

string

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

cropStyle

object (ImageCropStyle)

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

borderStyle

object (BorderStyle)

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

ImageCropStyle

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

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

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
ייצוג ב-JSON 
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
שדות
type

enum (ImageCropType)

סוג החיתוך.

aspectRatio

number

יחס הגובה-רוחב שבו יש להשתמש אם סוג החיתוך הוא 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.

BorderStyle

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

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

ייצוג ב-JSON 
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
שדות
type

enum (BorderType)

סוג הגבול.

strokeColor

object (Color)

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

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

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

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

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

cornerRadius

integer

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

BorderType

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

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

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

GridItemLayout

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

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

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

עמודות

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

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

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

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

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

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

  • תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מטיוטת אימייל.
  • תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מהתפריט הוספת קובץ מצורף באירוע ביומן Google.
ייצוג ב-JSON 
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
שדות
columnItems[]

object (Column)

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

עמודה

עמודה.

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

ייצוג ב-JSON 
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
שדות
horizontalSizeStyle

enum (HorizontalSizeStyle)

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

horizontalAlignment

enum (HorizontalAlignment)

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

verticalAlignment

enum (VerticalAlignment)

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

widgets[]

object (Widgets)

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

HorizontalSizeStyle

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

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

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

HorizontalAlignment

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

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

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

VerticalAlignment

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

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

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

ווידג'טים

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

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

ייצוג ב-JSON 
{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}
שדות

שדה איחוד data.

‫data יכול להיות רק אחד מהבאים:

textParagraph

object (TextParagraph)

TextParagraph ווידג'ט.

image

object (Image)

Image ווידג'ט.

decoratedText

object (DecoratedText)

DecoratedText ווידג'ט.

buttonList

object (ButtonList)

ButtonList ווידג'ט.

textInput

object (TextInput)

TextInput ווידג'ט.

selectionInput

object (SelectionInput)

SelectionInput ווידג'ט.

dateTimePicker

object (DateTimePicker)

DateTimePicker ווידג'ט.

chipList

object (ChipList)

ChipList ווידג'ט.

ChipList

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

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

ייצוג ב-JSON 
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
שדות
layout

enum (Layout)

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

chips[]

object (Chip)

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

פריסה

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

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

צ'יפ

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

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

ייצוג ב-JSON 
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
שדות
icon

object (Icon)

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

label

string

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

onClick

object (OnClick)

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

enabled
(deprecated)

boolean

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

disabled

boolean

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

altText

string

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

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

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

לדוגמה, זוהי ייצוג 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.

ייצוג ב-JSON 
{
  "carouselCards": [
    {
      object (CarouselCard)
    }
  ]
}
שדות
carouselCards[]

object (CarouselCard)

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

CarouselCard

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

ייצוג ב-JSON 
{
  "widgets": [
    {
      object (NestedWidget)
    }
  ],
  "footerWidgets": [
    {
      object (NestedWidget)
    }
  ]
}
שדות
widgets[]

object (NestedWidget)

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

footerWidgets[]

object (NestedWidget)

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

NestedWidget

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

ייצוג ב-JSON 
{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
  // End of list of possible types for union field data.
}
שדות

שדה איחוד data.

‫data יכול להיות רק אחד מהבאים:

textParagraph

object (TextParagraph)

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

buttonList

object (ButtonList)

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

image

object (Image)

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

CollapseControl

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

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

ייצוג ב-JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
שדות
horizontalAlignment

enum (HorizontalAlignment)

היישור האופקי של לחצן ההרחבה והכיווץ.

expandButton

object (Button)

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

collapseButton

object (Button)

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

DividerStyle

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

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

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

CardAction

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

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

ייצוג ב-JSON 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
שדות
actionLabel

string

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

onClick

object (OnClick)

הפעולה שצריך לבצע לגבי הפריט הזה.onClick

CardFixedFooter

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

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

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

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

ייצוג ב-JSON 
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
שדות
primaryButton

object (Button)

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

secondaryButton

object (Button)

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

DisplayStyle

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

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

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