קלפים
כרטיס הוא רכיב בממשק המשתמש שיכול להכיל ווידג'טים של ממשק המשתמש, כמו טקסט ותמונות.
ייצוג JSON |
---|
{ "header": { object ( |
שדות | |
---|---|
header
|
כותרת הכרטיס. כותרת מכילה בדרך כלל כותרת ותמונה. |
sections[]
|
קטעים מופרדים באמצעות קו מפריד. |
cardActions[]
|
הפעולות בכרטיס הזה. |
name
|
שם הכרטיס. |
CardHeader
ייצוג JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
שדות | |
---|---|
title
|
צריך לציין כותרת. לכותרת יש גובה קבוע: אם מציינים גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את הכותרת, היא תופסת את שתי השורות. |
subtitle
|
כותרת המשנה של כותרת הכרטיס. |
imageStyle
|
סוג התמונה (לדוגמה, גבול מרובע או גבול מעגלי). |
imageUrl
|
כתובת ה-URL של התמונה בכותרת הכרטיס. |
ImageStyle
טיפוסים בני מנייה (enum) | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
גבול מרובע. |
AVATAR
|
גבול עגול. |
קטע
קטע מכיל אוסף של ווידג'טים שמעובדים (אנכי) לפי הסדר שבו צוינו. בכל הפלטפורמות, לכרטיסים יש רוחב קבוע צר, לכן אין כרגע צורך במאפייני פריסה (לדוגמה, מספר ממשי (float).
ייצוג JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
שדות | |
---|---|
header
|
הכותרת של הקטע. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט: עיצוב טקסט באפליקציות של Google Chat וגם עיצוב טקסט בתוספים של Google Workspace. |
widgets[]
|
קטע חייב להכיל לפחות ווידג'ט אחד. |
WidgetMarkup
ווידג'ט הוא רכיב בממשק המשתמש שמוצגים בו טקסט ותמונות.
ייצוג JSON |
---|
{ "buttons": [ { object ( |
שדות | |
---|---|
buttons[]
|
רשימת לחצנים. גם הלחצנים
|
שדה איחוד
data א'
WidgetMarkup
יכול להכיל רק אחד מהפריטים הבאים. אפשר להשתמש בכמה סוגים
WidgetMarkup
כדי להציג פריטים נוספים.
data
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
textParagraph
|
הצגה של פסקה טקסט בווידג'ט הזה. |
image
|
הצגת תמונה בווידג'ט הזה. |
keyValue
|
הצגה של פריט בעל ערך מרכזי בווידג'ט הזה. |
TextParagraph
פסקת טקסט. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט: עיצוב טקסט באפליקציות של Google Chat וגם עיצוב טקסט בתוספים של Google Workspace.
ייצוג JSON |
---|
{ "text": string } |
שדות | |
---|---|
text
|
|
תמונה
תמונה המצוינת על ידי כתובת URL ויכולה לכלול גם
onclick
פעולה.
ייצוג JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
שדות | |
---|---|
imageUrl
|
כתובת האתר של התמונה. |
onClick
|
|
aspectRatio
|
יחס הגובה-רוחב של התמונה הזו (רוחב וגובה). בשדה הזה אפשר לשמור את הגובה המתאים של התמונה בזמן שממתינים לטעינת התמונה. אין לשנות את יחס הגובה-רוחב המובנה של התמונה. אם המדיניות לא מוגדרת, השרת ממלא אותה על ידי אחזור מראש של התמונה. |
OnClick
onclick
הפעולה הרצויה (לדוגמה, פתיחת קישור).
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
|
|
action
|
פעולת טופס מופעלת על ידי
|
openLink
|
הזה
|
FormAction
פעולת הטופס מתארת את ההתנהגות בזמן שליחת הטופס. לדוגמה, אפשר להפעיל את Apps Script כדי לטפל בטופס.
ייצוג JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
שדות | |
---|---|
actionMethodName
|
שם השיטה משמש לזיהוי החלק בטופס שהפעיל את שליחת הטופס. המידע הזה יוחזר לאפליקציית Chat כחלק מאירוע הקליק על הכרטיס. אפשר להשתמש באותו שם שיטה למספר רכיבים שמפעילים התנהגות נפוצה. |
parameters[]
|
רשימת פרמטרים של פעולות. |
ActionParameter
רשימת הפרמטרים של המחרוזת שיש לספק כששיטת הפעולה מופעלת. לדוגמה, שימו לב לשלושה לחצני 'נודניק': 'נודניק', 'נודניק' ביום אחד, 'לטיפול בהמשך' בשבוע הבא. מומלץ להשתמש
action method = snooze()
, העברת סוג הנודניק וזמן לטיפול בהמשך ברשימת הפרמטרים למחרוזות.
ייצוג JSON |
---|
{ "key": string, "value": string } |
שדות | |
---|---|
key
|
שם הפרמטר לסקריפט הפעולה. |
value
|
ערך הפרמטר. |
OpenLink
קישור שפותח חלון חדש.
ייצוג JSON |
---|
{ "url": string } |
שדות | |
---|---|
url
|
כתובת ה-URL לפתיחה. |
KeyValue
רכיב בממשק המשתמש מכיל מפתח (תווית) וערך (תוכן). הרכיב הזה יכול גם לכלול כמה פעולות, כמו
onclick
לחצן.
ייצוג JSON |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
שדות | |
---|---|
topLabel
|
הטקסט של התווית העליונה. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט: עיצוב טקסט באפליקציות של Google Chat וגם עיצוב טקסט בתוספים של Google Workspace. |
content
|
הטקסט של התוכן. יש תמיכה בטקסט מעוצב ותמיד נדרש. למידע נוסף על עיצוב טקסט: עיצוב טקסט באפליקציות של Google Chat וגם עיצוב טקסט בתוספים של Google Workspace. |
contentMultiline
|
אם התוכן צריך להיות מרובה שורות. |
bottomLabel
|
הטקסט של התווית התחתונה. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט: עיצוב טקסט באפליקציות של Google Chat וגם עיצוב טקסט בתוספים של Google Workspace. |
onClick
|
|
שדה איחוד
icons לפחות אחד מהסמלים,
top_label
וגם
bottom_label
חייב להיות מוגדר.
icons
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
icon
|
ערך enum שמוחלף ב-Chat API עם תמונת הסמל המתאימה. |
iconUrl
|
הסמל שצוין על ידי כתובת URL. |
שדה איחוד
control ווידג'ט בקרה. אפשר להגדיר
button
או
switch_widget , אבל לא את שניהם.
control
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
button
|
לחצן שניתן ללחוץ עליו כדי להפעיל פעולה. |
סמל
קבוצת הסמלים הנתמכים.
טיפוסים בני מנייה (enum) | |
---|---|
ICON_UNSPECIFIED
|
|
AIRPLANE
|
|
BOOKMARK
|
|
BUS
|
|
CAR
|
|
CLOCK
|
|
CONFIRMATION_NUMBER_ICON
|
|
DOLLAR
|
|
DESCRIPTION
|
|
EMAIL
|
|
EVENT_PERFORMER
|
|
EVENT_SEAT
|
|
FLIGHT_ARRIVAL
|
|
FLIGHT_DEPARTURE
|
|
HOTEL
|
|
HOTEL_ROOM_TYPE
|
|
INVITE
|
|
MAP_PIN
|
|
MEMBERSHIP
|
|
MULTIPLE_PEOPLE
|
|
OFFER
|
|
PERSON
|
|
PHONE
|
|
RESTAURANT_ICON
|
|
SHOPPING_CART
|
|
STAR
|
|
STORE
|
|
TICKET
|
|
TRAIN
|
|
VIDEO_CAMERA
|
|
VIDEO_PLAY
|
לחצן
לחצן. אפשר להשתמש בלחצן טקסט או בלחצן תמונה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
|
|
textButton
|
לחצן עם טקסט ועם
|
imageButton
|
לחצן עם תמונה ועם
|
TextButton
לחצן עם טקסט ועם
onclick
פעולה.
ייצוג JSON |
---|
{
"text": string,
"onClick": {
object (
|
שדות | |
---|---|
text
|
הטקסט של הלחצן. |
onClick
|
|
ImageButton
לחצן תמונה עם סמל
onclick
פעולה.
ייצוג JSON |
---|
{ "onClick": { object ( |
שדות | |
---|---|
onClick
|
|
name
|
השם של פריט זה
|
שדה איחוד
icons אפשר לציין את הסמל באמצעות
Icon
enum
או כתובת URL.
icons
יכול להיות רק אחת מהאפשרויות הבאות:
|
|
icon
|
הסמל שצוין על ידי
|
iconUrl
|
הסמל שצוין על ידי כתובת URL. |
CardAction
פעולה בכרטיס היא הפעולה שמשויכת לכרטיס. בכרטיס חשבונית, פעולה טיפוסית היא: מחיקת חשבונית, שליחת חשבונית באימייל או פתיחת החשבונית בדפדפן.
לא נתמך באפליקציות של Google Chat.
ייצוג JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
שדות | |
---|---|
actionLabel
|
התווית הקודמת שהייתה מופיעה באפשרות של תפריט הפעולות. |
onClick
|
הפעולה 'לחיצה' על הפעולה הזו. |