Cards v1

קלפים

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

ייצוג ב-JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
שדות
header

object (CardHeader)

הכותרת של הכרטיס. בדרך כלל כותרת מכילה שם ותמונה.

sections[]

object (Section)

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

cardActions[]

object (CardAction)

הפעולות של הכרטיס הזה.

name

string

שם הכרטיס.

CardHeader

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

string

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

subtitle

string

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

imageStyle

enum (ImageStyle)

סוג התמונה (לדוגמה, מסגרת ריבועית או מסגרת עגולה).

imageUrl

string

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

ImageStyle

טיפוסים בני מנייה (enum)
IMAGE_STYLE_UNSPECIFIED
IMAGE גבול מרובע.
AVATAR גבול עגול.

קטע

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

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

string

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

widgets[]

object (WidgetMarkup)

כל קטע חייב להכיל לפחות ווידג'ט אחד.

WidgetMarkup

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

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

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

object (Button)

רשימת לחצנים. Buttons הוא גם oneof data, וצריך להגדיר רק אחד מהשדות האלה.

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

object (TextParagraph)

הצגת פסקה של טקסט בווידג'ט הזה.

image

object (Image)

הצגת תמונה בווידג'ט הזה.

keyValue

object (KeyValue)

הצגת פריט של ערך מפתח בווידג'ט הזה.

TextParagraph

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

ייצוג ב-JSON 
{
  "text": string
}
שדות
text

string

תמונה

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

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

string

כתובת האתר של התמונה.

onClick

object (OnClick)

הפעולה onclick.

aspectRatio

number

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

OnClick

פעולה של onclick (לדוגמה, פתיחת קישור).

ייצוג ב-JSON 
{

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

שדה האיחוד data.

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

action

object (FormAction)

הפעולה הזו onclick מפעילה פעולת טופס, אם היא צוינה.

FormAction

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

ייצוג ב-JSON 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
שדות
actionMethodName

string

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

parameters[]

object (ActionParameter)

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

ActionParameter

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

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

string

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

value

string

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

KeyValue

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

ייצוג ב-JSON 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
שדות
topLabel

string

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

content

string

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

contentMultiline

boolean

אם התוכן צריך להיות בכמה שורות.

bottomLabel

string

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

onClick

object (OnClick)

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

שדה האיחוד icons. צריך להגדיר לפחות אחד מהסמלים top_label ו-bottom_label. icons יכול להיות רק אחד מהערכים הבאים:
icon

enum (Icon)

ערך enum שמוחליף על ידי Chat API בתמונה המתאימה של הסמל.

iconUrl

string

הסמל שצוין באמצעות כתובת URL.

שדה האיחוד control. ווידג'ט בקרה. אפשר להגדיר את הערך button או את הערך switch_widget, אבל לא את שניהם. control יכול להיות רק אחת מהאפשרויות הבאות:
button

object (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 type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
שדות

שדה האיחוד type.

type יכול להיות רק אחת מהאפשרויות הבאות:

textButton

object (TextButton)

לחצן עם טקסט ופעולה onclick.

imageButton

object (ImageButton)

כפתור עם תמונה ופעולה onclick.

TextButton

לחצן עם טקסט ופעולה onclick.

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

string

הטקסט של הלחצן.

onClick

object (OnClick)

הפעולה של הלחצן onclick.

ImageButton

כפתור תמונה עם פעולה onclick.

ייצוג ב-JSON 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
שדות
onClick

object (OnClick)

הפעולה onclick.

name

string

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

שדה האיחוד icons. אפשר לציין את הסמל באמצעות Icon enum או כתובת URL. icons יכול להיות רק אחד מהערכים הבאים:
icon

enum (Icon)

הסמל שצוין על ידי enum שמצביע על סמל שסופק על ידי Chat API.

iconUrl

string

הסמל שצוין באמצעות כתובת URL.

CardAction

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

לא נתמכת באפליקציות של Google Chat.

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

string

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

onClick

object (OnClick)

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