דף זה תורגם על ידי Cloud Translation API.

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)` כל קטע חייב להכיל לפחות ווידג'ט אחד.

header

string

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

widgets[]

object (WidgetMarkup)

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

WidgetMarkup

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

ייצוג ב-JSON

ייצוג ב-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)
    }
  ],

  // 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` יחס הגובה-רוחב של התמונה הזו (רוחב וגובה). השדה הזה מאפשר לכם להקצות את הגובה הנכון לתמונה בזמן ההמתנה לטעינה שלה. הוא לא נועד לשנות את יחס הגובה-רוחב המובנה של התמונה. אם המדיניות לא מוגדרת, השרת ממלא אותה על ידי אחזור מראש של התמונה.

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` מפעילה פעולת טופס, אם היא מצוינה.
`openLink`	`object (OpenLink)` פעולת `onclick` הזו גורמת לפעולת קישור פתוחה, אם צוינה.

שדה האיחוד data.

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

action

object (FormAction)

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

openLink

object (OpenLink)

פעולת onclick הזו גורמת לפעולת קישור פתוחה, אם צוינה.

FormAction

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

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

שדות

שדות
`actionMethodName`	`string` שם השיטה משמש לזיהוי החלק בטופס שהפעיל את שליחת הטופס. המידע הזה מוחזר לאפליקציית Chat כחלק מאירוע הקליק על הכרטיס. אפשר להשתמש באותו שם שיטה בכמה רכיבים שמפעילים התנהגות משותפת.
`parameters[]`	`object (ActionParameter)` רשימה של פרמטרים של פעולות.

actionMethodName

string

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

parameters[]

object (ActionParameter)

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

ActionParameter

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

ייצוג JSON
{ "key": string, "value": string }

שדות

שדות
`key`	`string` שם הפרמטר של סקריפט הפעולה.
`value`	`string` הערך של הפרמטר.

key

string

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

value

string

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

OpenLink

קישור שפותח חלון חדש.

ייצוג JSON
{ "url": string }

שדות

שדות
`url`	`string` כתובת ה-URL לפתיחה.

url

string

כתובת ה-URL לפתיחה.

KeyValue

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

ייצוג ב-JSON

ייצוג ב-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,
  "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`.

שדה האיחוד type.

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

textButton

object (TextButton)

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

imageButton

object (ImageButton)

לחצן עם תמונה והפעולה onclick.

TextButton

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

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

שדות

שדות
`text`	`string` הטקסט של הלחצן.
`onClick`	`object (OnClick)` הפעולה `onclick` של הלחצן.

text

string

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

onClick

object (OnClick)

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

ImageButton

לחצן תמונה עם פעולת onclick.

ייצוג ב-JSON

ייצוג ב-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)
  },
  "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)` הפעולה שמתבצעת בלחיצה על פריט הפעולה הזה.

actionLabel

string

התווית הקודמת שהייתה מופיעה באפשרות של תפריט הפעולות.

onClick

object (OnClick)

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