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 וצריך להגדיר רק אחד מהשדות האלה.

‫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)

הפעולה onclick של הפעולה לביצוע הזו.