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)

רשימת לחצנים. גם הלחצנים 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)

הפעולה 'לחיצה' על הפעולה הזו.