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)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
שדות
buttons[]

object (Button)

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

התג A WidgetMarkup יכול להכיל רק אחד מהפריטים הבאים. אתם יכולים להשתמש בכמה שדות WidgetMarkup כדי להציג יותר פריטים. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
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 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
שדות
בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
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)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
שדות
topLabel

string

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

content

string

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

contentMultiline

boolean

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

bottomLabel

string

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

onClick

object (OnClick)

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

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

enum (Icon)

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

iconUrl

string

הסמל שמוגדר על ידי כתובת URL.

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

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
שדות
בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
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,

  "icon": enum (Icon),
  "iconUrl": string
}
שדות
onClick

object (OnClick)

הפעולה onclick.

name

string

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

אפשר לציין את הסמל באמצעות תגית Icon enum או כתובת URL. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
icon

enum (Icon)

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

iconUrl

string

הסמל שמוגדר על ידי כתובת URL.

סוף השדות הבלעדיים.

CardAction

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

לא נתמך באפליקציות ל-Google Chat.

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

string

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

onClick

object (OnClick)

הפעולה שמתבצעת כשלוחצים על הפעולה לביצוע.