קלפים
כרטיס הוא רכיב בממשק המשתמש שיכול להכיל ווידג'טים של ממשק המשתמש, כמו טקסט ותמונות.
ייצוג JSON |
---|
{ "header": { object ( |
שדות | |
---|---|
header
|
הכותרת של הכרטיס. כותרת מכילה בדרך כלל כותרת ותמונה. |
sections[]
|
קטעים מופרדים באמצעות קו מפריד. |
cardActions[]
|
הפעולות בכרטיס הזה. |
name
|
שם הכרטיס. |
CardHeader
ייצוג JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
שדות | |
---|---|
title
|
יש לציין את הכותרת. לכותרת יש גובה קבוע: אם מצוינות גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את הכותרת, היא תיכלל בשתי השורות. |
subtitle
|
כותרת המשנה של כותרת הכרטיס. |
imageStyle
|
סוג התמונה (לדוגמה, גבול מרובע או גבול מעוגל). |
imageUrl
|
כתובת ה-URL של התמונה בכותרת של הכרטיס. |
ImageStyle
טיפוסים בני מנייה (enums) | |
---|---|
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
|
לחצן שניתן ללחוץ עליו כדי להפעיל פעולה. |
סמל
קבוצת הסמלים הנתמכים.
טיפוסים בני מנייה (enums) | |
---|---|
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
|
פעולת הלחיצה על הפעולה הזו. |