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

טיפוסים בני מנייה (enums)
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)

לחצן שניתן ללחוץ עליו כדי להפעיל פעולה.

סמל

קבוצת הסמלים הנתמכים.

טיפוסים בני מנייה (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 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)

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