Cards v2

כרטיס

ממשק של כרטיס שמוצג בהודעה ב-Google Chat או בתוסף של Google Workspace.

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

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

לפתיחת הכלי ליצירת כרטיסים

כדי ללמוד איך ליצור כרטיסים, אפשר להיעזר במסמכים הבאים:

דוגמה: הודעה בכרטיס לאפליקציה של Google Chat

דוגמה לכרטיס איש קשר

כדי ליצור את ההודעה לדוגמה עם הכרטיס ב-Google Chat, צריך להשתמש בקובץ ה-JSON הבא:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
ייצוג JSON
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}
שדות
header

object (CardHeader)

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

sections[]

object (Section)

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

sectionDividerStyle

enum (DividerStyle)

סגנון ההפרדה בין הקטעים.

cardActions[]

object (CardAction)

הפעולות בכרטיס. הפעולות מתווספות לתפריט סרגל הכלים של הכרטיס.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

לדוגמה, קובץ ה-JSON הבא בונה תפריט פעולות בכרטיסים עם האפשרויות Settings ו-Send Feedback:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

שם הכרטיס. משמש כמזהה כרטיס בניווט כרטיסים.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

displayStyle

enum (DisplayStyle)

בתוספים ל-Google Workspace, מגדירה את מאפייני התצוגה של peekCardHeader.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

peekCardHeader

object (CardHeader)

כשמציגים תוכן לפי הקשר, הכותרת של כרטיס ההצצה משמשת כ-placeholder, כדי שהמשתמש יוכל לנווט קדימה בין הכרטיסים בדף הבית לבין הכרטיסים לפי ההקשר.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

CardHeader

מייצג את כותרת הכרטיס. ראו דוגמה באפליקציות של Google Chat בכותרת הכרטיס.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
שדות
title

string

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

subtitle

string

כותרת המשנה של כותרת הכרטיס. אם השדה הזה צוין, הוא יופיע בשורה נפרדת מתחת title.

imageType

enum (ImageType)

הצורה שמשמשת לחיתוך התמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

imageUrl

string

כתובת ה-URL מסוג HTTPS של התמונה בכותרת הכרטיס.

imageAltText

string

הטקסט החלופי של התמונה הזו שמשמש לנגישות.

ImageType

הצורה שמשמשת לחיתוך התמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
SQUARE ערך ברירת המחדל. החלת מסכה ריבועית על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת ל-3x3.
CIRCLE החלת מסכה מעוגלת על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לעיגול בקוטר 3.

קטע

מקטע מכיל אוסף של ווידג'טים שעברו רינדור אנכי, לפי הסדר שבו הם צוינו.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer
}
שדות
header

string

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

widgets[]

object (Widget)

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

collapsible

boolean

השדה הזה מציין אם ניתן לכווץ את הקטע הזה.

קטעים מתכווצים מסתירים חלק מהווידג'טים או את כולם, אבל המשתמשים יכולים להרחיב את הקטע כדי לחשוף את הווידג'טים המוסתרים על ידי לחיצה על הצג עוד. כדי להסתיר את הווידג'טים, המשתמשים יכולים ללחוץ על להציג פחות.

כדי לקבוע אילו ווידג'טים מוסתרים, מציינים את uncollapsibleWidgetsCount.

uncollapsibleWidgetsCount

integer

מספר הווידג'טים שאינם ניתנים לכיווץ שנשארים גלויים גם כאשר קטע מכווץ.

לדוגמה, כאשר קטע מכיל חמישה ווידג'טים כאשר uncollapsibleWidgetsCount מוגדר לערך 2, שני הווידג'טים הראשונים מוצגים תמיד ושלושת האחרונים מכווצים כברירת מחדל. הערך uncollapsibleWidgetsCount נלקח בחשבון רק כאשר הערך של collapsible הוא true.

ווידג'ט

כל כרטיס מורכב מווידג'טים.

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

ייצוג JSON
{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  }
  // End of list of possible types for union field data.
}
שדות
horizontalAlignment

enum (HorizontalAlignment)

ההגדרה קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה.

שדה איחוד data. ווידג'ט יכול לכלול רק אחד מהפריטים הבאים. אפשר להשתמש בכמה שדות בווידג'ט כדי להציג יותר פריטים. data יכול להיות רק אחד מהבאים:
textParagraph

object (TextParagraph)

הצגת פסקה של טקסט. תומך בטקסט פשוט בפורמט HTML. למידע נוסף על עיצוב טקסט, אפשר לקרוא את המאמרים עיצוב הטקסט באפליקציות Google Chat ועיצוב הטקסט בתוספים ל-Google Workspace.

לדוגמה, קובץ ה-JSON הבא יוצר טקסט מודגש:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

object (Image)

מוצגת תמונה.

לדוגמה, קובץ ה-JSON הבא יוצר תמונה עם טקסט חלופי:

"image": {
  "imageUrl":
  "https://developers.google.com/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

object (DecoratedText)

מציג פריט טקסט מקושט.

לדוגמה, קובץ ה-JSON הבא יוצר ווידג'ט טקסט מעוצב שמציג את כתובת האימייל:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

object (ButtonList)

רשימת לחצנים.

לדוגמה, קובץ ה-JSON הבא יוצר שני לחצנים. הראשון הוא לחצן טקסט כחול והשני הוא לחצן תמונה שפותח קישור:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
        "alpha": 1
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

object (TextInput)

הצגת תיבת טקסט שהמשתמשים יכולים להקליד בה.

לדוגמה, קובץ ה-JSON הבא יוצר קלט טקסט לכתובת אימייל:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

כדוגמה נוספת, קובץ ה-JSON הבא יוצר קלט טקסט עבור שפת תכנות עם הצעות סטטיות:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

object (SelectionInput)

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

לדוגמה, קובץ ה-JSON הבא יוצר תפריט נפתח שמאפשר למשתמשים לבחור גודל:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

object (DateTimePicker)

מציג ווידג'ט שמאפשר למשתמשים להזין תאריך, שעה או תאריך ושעה.

לדוגמה, קובץ ה-JSON הבא יוצר חלונית לבחירת תאריך ושעה כדי לקבוע פגישה:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}
divider

object (Divider)

מציג קו אופקי בין ווידג'טים.

לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:

"divider": {
}
grid

object (Grid)

הצגת רשת עם אוסף של פריטים.

רשת תומכת בכל מספר של עמודות ופריטים. מספר השורות נקבע לפי הגבול העליון של מספר הפריטים, חלקי מספר העמודות. רשת שמכילה 10 פריטים ו-2 עמודות מכילה 5 שורות. רשת שמכילה 11 פריטים ו-2 עמודות מכילה 6 שורות.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

לדוגמה, קובץ ה-JSON הבא יוצר רשת של שתי עמודות עם פריט אחד:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

object (Columns)

הצגה של עד 2 עמודות.

כדי לכלול יותר מ-2 עמודות או להשתמש בשורות, צריך להשתמש בווידג'ט Grid.

לדוגמה, קובץ ה-JSON הבא יוצר 2 עמודות שכל אחת מהן מכילה פסקאות טקסט:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

TextParagraph

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "text": string
}
שדות
text

string

הטקסט המוצג בווידג'ט.

תמונה

תמונה שמצוינת באמצעות כתובת URL ויכולה לכלול פעולה מסוג onClick. לדוגמה: ראו תמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

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

string

כתובת ה-URL מסוג HTTPS שמארחת את התמונה.

למשל:

https://developers.google.com/chat/images/quickstart-app-avatar.png
onClick

object (OnClick)

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

altText

string

הטקסט החלופי של התמונה הזו שמשמש לנגישות.

OnClick

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  }
  // End of list of possible types for union field data.
}
שדות

שדה איחוד data.

data יכול להיות רק אחד מהבאים:

action

object (Action)

אם צוין, פעולה מסוימת תופעל על ידי onClick.

card

object (Card)

כרטיס חדש יידחף לערימת הכרטיסים לאחר לחיצה, אם צוין.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

פעולה

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction)
}
שדות
function

string

פונקציה מותאמת אישית להפעלה כשמשתמש לוחץ על הרכיב שמכיל או מופעל בכל פעם.

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

parameters[]

object (ActionParameter)

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

loadIndicator

enum (LoadIndicator)

מציין את אינדיקטור הטעינה שהפעולה מוצגת בזמן ביצוע הקריאה לפעולה.

persistValues

boolean

מציין אם ערכי הטופס נשארים אחרי הפעולה. ערך ברירת המחדל הוא false.

אם הערך הוא true, ערכי הטופס יישארו לאחר ביצוע הפעולה. כדי לאפשר למשתמש לבצע שינויים בזמן שהפעולה מתבצעת, צריך להגדיר בשדה LoadIndicator את הערך NONE. לגבי הודעות בכרטיס באפליקציות Chat, צריך גם להגדיר את ResponseType של הפעולה לערך UPDATE_MESSAGE ולהשתמש באותו cardId מהכרטיס שכולל את הפעולה.

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

interaction

enum (Interaction)

זה שינוי אופציונלי. חובה כשפותחים תיבת דו-שיח.

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

אם לא צוין אחרת, האפליקציה מגיבה באמצעות action – כמו פתיחת קישור או הפעלת פונקציה – כרגיל.

אם מציינים interaction, האפליקציה יכולה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את הערך של interaction לערך OPEN_DIALOG, האפליקציה יכולה לפתוח תיבת דו-שיח. אם המדיניות מוגדרת, לא יוצג אינדיקטור לטעינה. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג שום דבר אצל הלקוח.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ActionParameter

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

למידע נוסף: CommonEventObject.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

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

string

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

value

string

ערך הפרמטר.

LoadIndicator

מציין את אינדיקטור הטעינה שהפעולה מוצגת בזמן ביצוע הקריאה לפעולה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
SPINNER הצגת סימן גרפי שמסמן שהתוכן נטען.
NONE שום דבר לא מוצג.

אינטראקציה

זה שינוי אופציונלי. חובה כשפותחים תיבת דו-שיח.

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

אם לא צוין אחרת, האפליקציה מגיבה באמצעות action – כמו פתיחת קישור או הפעלת פונקציה – כרגיל.

אם מציינים interaction, האפליקציה יכולה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את הערך של interaction לערך OPEN_DIALOG, האפליקציה יכולה לפתוח תיבת דו-שיח.

אם המדיניות מוגדרת, לא יוצג אינדיקטור לטעינה. אם צוין עבור תוסף, הכרטיס כולו יוסר ולא יוצג שום דבר אצל הלקוח.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

טיפוסים בני מנייה (enums)
INTERACTION_UNSPECIFIED ערך ברירת המחדל. השדה action פועל כרגיל.
OPEN_DIALOG

פתיחת תיבת דו-שיח, ממשק מבוסס-חלונות עם חלון שמשמש אפליקציות צ'אט לאינטראקציה עם משתמשים.

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

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

OpenAs

כשפעולה OnClick פותחת קישור, הלקוח יכול לפתוח אותו כחלון בגודל מלא (אם זו המסגרת שבה משתמש הלקוח), או כשכבת-על (כמו חלון קופץ). ההטמעה תלויה ביכולות של פלטפורמת הלקוח, ויכול להיות שהמערכת תתעלם מהערך שנבחר אם הלקוח לא תומך בה. כל הלקוחות תומכים ב-FULL_SIZE.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

טיפוסים בני מנייה (enums)
FULL_SIZE הקישור נפתח כחלון בגודל מלא (אם זו המסגרת שהלקוח משתמש בה).
OVERLAY הקישור נפתח כשכבת-על, כמו חלון קופץ.

OnClose

מה הלקוח עושה כשקישור שנפתח על ידי פעולה OnClick נסגר.

ההטמעה תלויה ביכולות הפלטפורמה של הלקוח. לדוגמה, דפדפן אינטרנט יכול לפתוח קישור בחלון קופץ עם handler של OnClose.

אם הוגדרו גם OnOpen וגם מטפלים של OnClose, ופלטפורמת הלקוח לא יכולה לתמוך בשני הערכים, OnClose מקבלת עדיפות.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

טיפוסים בני מנייה (enums)
NOTHING ערך ברירת המחדל. הכרטיס לא נטען מחדש. לא קורה כלום.
RELOAD

טעינת הכרטיס מחדש אחרי שחלון הצאצא נסגר.

אם משתמשים בו בשילוב עם OpenAs.OVERLAY, חלון הצאצא משמש כחלון מודאלי וכרטיס ההורה ייחסם עד שחלון הצאצא ייסגר.

DecoratedText

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}
שדות
icon
(deprecated)

object (Icon)

הוצא משימוש לטובת startIcon.

startIcon

object (Icon)

הסמל שמוצג לפני הטקסט.

topLabel

string

הטקסט שמופיע מעל text. תמיד חתוך.

text

string

חובה. הטקסט הראשי.

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

wrapText

boolean

ההגדרה של גלישת הטקסט. אם הערך הוא true, הטקסט גולש ומוצג במספר שורות. אחרת, הטקסט ייחתך.

רלוונטי רק עבור text, לא topLabel ו-bottomLabel.

bottomLabel

string

הטקסט שמופיע מתחת text. תמיד גולש.

onClick

object (OnClick)

הפעולה הזו מופעלת כשמשתמשים לוחצים על topLabel או על bottomLabel.

שדה איחוד control. לחצן, מתג, תיבת סימון או תמונה שמופיעים בצד שמאל של הטקסט בווידג'ט decoratedText. control יכול להיות רק אחד מהבאים:
button

object (Button)

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

switchControl

object (SwitchControl)

ווידג'ט מתג שהמשתמש יכול ללחוץ עליו כדי לשנות את המצב שלו ולהפעיל פעולה.

endIcon

object (Icon)

סמל שמוצג אחרי הטקסט.

תומך בסמלים מובְנים ובסמלים מותאמים אישית.

סמל

סמל שמוצג בווידג'ט בכרטיס. ראו דוגמה בסמל של אפליקציית Google Chat.

תומך בסמלים מובְנים ובסמלים מותאמים אישית.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string
  // End of list of possible types for union field icons.
}
שדות
altText

string

זה שינוי אופציונלי. תיאור של הסמל שמשמש לנגישות. אם לא צוין ערך, ברירת המחדל היא Button. השיטה המומלצת היא להגדיר תיאור מועיל לגבי מה שמוצג בסמל, ואם רלוונטי, תיאור מועיל. לדוגמה, A user's account portrait או Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat.

אם הסמל מוגדר ב- Button, altText יופיע כטקסט מסייע כשהמשתמש מעביר את העכבר מעל הלחצן. עם זאת, אם הלחצן מגדיר גם את text, המערכת תתעלם מה-altText של הסמל.

imageType

enum (ImageType)

סגנון החיתוך שהוחל על התמונה. במקרים מסוימים, החלת חיתוך CIRCLE גורמת לתמונה להיות גדולה יותר מסמל מובנה.

שדה איחוד icons. הסמל שמוצג בווידג'ט בכרטיס. icons יכול להיות רק אחד מהבאים:
knownIcon

string

להציג את אחד מהסמלים המובנים של Google Workspace.

לדוגמה, כדי להציג סמל מטוס, צריך לציין AIRPLANE. בשדה של אוטובוס, מציינים את הערך BUS.

הסמלים המובנים מפורטים ברשימה המלאה של הסמלים הנתמכים.

iconUrl

string

הצגה של סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS.

למשל:

"iconUrl":
"https://developers.google.com/chat/images/quickstart-app-avatar.png"

סוגי הקבצים שנתמכים כוללים .png ו-.jpg.

לחצן

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

כדי להפוך תמונה ללחצן קליקבילי, צריך לציין Image (לא ImageComponent) ולהגדיר את הפעולה onClick.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string
}
שדות
text

string

הטקסט שמוצג בתוך הלחצן.

icon

object (Icon)

תמונת הסמל. אם icon וגם text מוגדרים, הסמל מופיע לפני הטקסט.

color

object (Color)

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

אם המדיניות לא מוגדרת, רקע התמונה יהיה לבן וצבע הגופן הוא כחול.

באדום, בירוק ובכחול, הערך של כל שדה הוא מספר float שאפשר לבטא בשתי דרכים: כמספר בין 0 ל-255 לחלק ל-255 (153/255), או כערך בין 0 ל-1 (0.6). הערך 0 מציין שאין צבע ו-1 או 255/255 מייצג את הנוכחות המלאה של הצבע הזה בסולם ה-RGB.

אפשר להגדיר את alpha, שקובע את רמת השקיפות באמצעות המשוואה הבאה:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

עבור alpha, הערך 1 תואם לצבע מלא, והערך 0 תואם לצבע שקוף לחלוטין.

לדוגמה, הצבע הבא מייצג חצי אדום שקוף:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}
onClick

object (OnClick)

חובה. הפעולה שצריך לבצע כשמשתמש לוחץ על הלחצן, כמו פתיחת היפר-קישור או הפעלת פונקציה מותאמת אישית.

disabled

boolean

אם true, הלחצן מוצג במצב לא פעיל ולא מגיב לפעולות המשתמש.

altText

string

הטקסט החלופי שמשמש לנגישות.

מומלץ להגדיר טקסט תיאורי שמאפשר למשתמשים לדעת מה הלחצן עושה. לדוגמה, אם לחצן פותח היפר-קישור, אפשר לכתוב: "נפתח כרטיסייה חדשה בדפדפן ועוברים לתיעוד למפתחים של Google Chat בכתובת https://developers.google.com/chat".

צבע

צבע במרחב הצבעים RGBA. הייצוג הזה נועד לפשט את ההמרה של ייצוגי צבע בשפות שונות על פני קומפקטיות. לדוגמה, אפשר לספק באופן טריוויאלי את השדות של הייצוג הזה ל-builder של java.awt.Color ב-Java. אפשר גם לספק אותם באופן טריוויאלי ל-method +colorWithRed:green:blue:alpha של UIColor ב-iOS. ועם מעט עבודה, אפשר לעצב אותם בקלות למחרוזת rgba() של CSS ב-JavaScript.

דף העזר הזה לא מכיל מידע על מרחב הצבעים המוחלט שצריך להשתמש בו כדי לפרש את ערך ה-RGB. לדוגמה, sRGB, Adobe RGB, DCI-P3 ו-BT.2020. כברירת מחדל, האפליקציות צריכות לקבל את מרחב הצבעים sRGB.

במקרים שבהם צריך לקבוע שוויון צבעים, ההטמעה של שני צבעים, אלא אם צוין אחרת, מתייחסת לשני צבעים כשווים אם כל הערכים של אדום, ירוק, כחול ואלפא נבדלים זה מזה ב-1e-5 לכל היותר.

דוגמה (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

דוגמה (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

דוגמה (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
ייצוג JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
שדות
red

number

כמות הצבע האדום בצבע כערך בטווח [0, 1].

green

number

כמות הצבע הירוק כערך בערך במרווח [0, 1].

blue

number

כמות הצבע הכחול כערך בערך במרווח [0, 1].

alpha

number

החלק של הצבע שיש להחיל על הפיקסל. כלומר, צבע הפיקסל הסופי מוגדר על ידי המשוואה:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

המשמעות היא שהערך 1.0 מייצג צבע אחיד, ואילו ערך 0.0 מייצג צבע שקוף לחלוטין. אפשרות זו משתמשת בהודעת wrapper ולא בסקלרי צף פשוט, כדי שניתן יהיה להבחין בין ערך ברירת מחדל לבין הערך שלא מוגדר. אם לא צוין, אובייקט הצבע הזה מעובד כצבע מלא (כאילו לערך האלפא ניתן באופן מפורש ערך 1.0).

SwitchControl

מתג בסגנון מתג או תיבת סימון בתוך ווידג'ט decoratedText.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

התכונה נתמכת רק בווידג'ט decoratedText.

ייצוג JSON
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
שדות
name

string

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

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

value

string

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

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

selected

boolean

כשהמתג true נבחר.

onChangeAction

object (Action)

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

controlType

enum (ControlType)

איך המתג מוצג בממשק המשתמש.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ControlType

איך המתג מוצג בממשק המשתמש.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
SWITCH מתג בסגנון.
CHECKBOX הוצא משימוש לטובת CHECK_BOX.
CHECK_BOX תיבת סימון.

ButtonList

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "buttons": [
    {
      object (Button)
    }
  ]
}
שדות
buttons[]

object (Button)

מערך של לחצנים.

TextInput

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

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

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "placeholderText": string
}
שדות
name

string

השם שבאמצעותו קלט הטקסט מזוהה באירוע של קלט טופס.

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

label

string

הטקסט שמופיע מעל השדה להזנת הטקסט בממשק המשתמש.

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

חובה אם hintText לא צוין. אחרת, אופציונלי.

hintText

string

טקסט שמופיע מתחת לשדה של קלט הטקסט, ומטרתו לעזור למשתמשים להזין ערך מסוים. הטקסט הזה תמיד גלוי.

חובה אם label לא צוין. אחרת, אופציונלי.

value

string

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

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

type

enum (Type)

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

onChangeAction

object (Action)

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

לדוגמה, אפשר להריץ פונקציה בהתאמה אישית או לפתוח תיבת דו-שיח ב-Google Chat.

initialSuggestions

object (Suggestions)

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

לדוגמה, שדה להזנת קלט טקסט לשפת תכנות עשוי להציע Java , JavaScript , Python ו-C++. כשמשתמשים מתחילים להקליד Jav, רשימת ההצעות תסנן את התוצאות כדי להציג רק את Java ואת JavaScript.

ההצעות לערכים עוזרות לכוון את המשתמשים להזנת ערכים שיכולים להיות רלוונטיים לאפליקציה. כאשר מתייחסים ל-JavaScript, חלק מהמשתמשים עשויים להזין javascript ואחרים java script. ההצעה JavaScript יכולה לקבוע סטנדרט אחיד לאינטראקציה של המשתמשים עם האפליקציה.

כשהיא מוגדרת, TextInput.type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר לערך MULTIPLE_LINE.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

autoCompleteAction

object (Action)

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

אם לא צוין אחרת, ההצעות יוגדרו על ידי initialSuggestions ויעובדו על ידי הלקוח.

אם צוינה בקשה, האפליקציה תבצע את הפעולה שצוינה כאן, למשל הפעלת פונקציה מותאמת אישית.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

placeholderText

string

טקסט שמופיע בשדה להזנת קלט כאשר השדה ריק. הטקסט הזה משמש כדי לבקש מהמשתמשים להזין ערך. לדוגמה, Enter a number from 0 to 100.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

סוג

איך שדה להזנת קלט מופיע בממשק המשתמש. לדוגמה, אם מדובר בשדה להזנת קלט של שורה בודדת או אם מדובר בקלט מרובה שורות. אם initialSuggestions צוין, type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר MULTIPLE_LINE.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
SINGLE_LINE בשדה להזנת הטקסט יש גובה קבוע של שורה אחת.
MULTIPLE_LINE בשדה להזנת הטקסט יש גובה קבוע של כמה שורות.

RenderActions

קבוצה של הוראות עיבוד שמסבירות לכרטיס לבצע פעולה, או מורה לאפליקציה המארחת של התוסף או לאפליקציית Chat לבצע פעולה ספציפית לאפליקציה.

אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace.

שדות
action

Action

פעולה

שדות
navigations[]

Navigation

דחוף או עדכן את הכרטיסים המוצגים.

מוסיפים כרטיס חדש למקבץ (מנווטים קדימה).

זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.

navigations: {
  pushCard: CARD
}

מחליפים את הכרטיס העליון בכרטיס חדש.

זמין לתוספים ל-Google Workspace ולא זמין באפליקציות Google Chat.

navigations: {
  updateCard: CARD
}

הצעות

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

לדוגמה, שדה להזנת טקסט לשפת תכנות עשוי להציע Java , JavaScript , Python ו-C++. כשמשתמשים מתחילים להקליד Jav, רשימת ההצעות תסנן את התוצאות כדי להציג את Java ואת JavaScript.

ההצעות לערכים עוזרות לכוון את המשתמשים להזנת ערכים שיכולים להיות רלוונטיים לאפליקציה. כאשר מתייחסים ל-JavaScript, חלק מהמשתמשים עשויים להזין javascript ואחרים java script. ההצעה JavaScript יכולה לקבוע סטנדרט אחיד לאינטראקציה של המשתמשים עם האפליקציה.

כשהיא מוגדרת, TextInput.type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר לערך MULTIPLE_LINE.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
שדות
items[]

object (SuggestionItem)

רשימת הצעות שמשמשות להמלצות להשלמה אוטומטית בשדות להזנת טקסט.

SuggestionItem

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
שדות

שדה איחוד content.

content יכול להיות רק אחד מהבאים:

text

string

הערך של קלט מוצע בשדה להזנת טקסט. הערך הזה זהה לטקסט שהמשתמשים מזינים את עצמם.

SelectionInput

ווידג'ט שיוצר פריט אחד או יותר בממשק המשתמש שהמשתמשים יכולים לבחור. לדוגמה, תפריט נפתח או תיבות סימון. אפשר להשתמש בווידג'ט הזה כדי לאסוף נתונים שניתן לחזות או לספור. דוגמאות לאפליקציות ב-Google Chat: קלט הבחירה.

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

כדי לאסוף נתונים לא מוגדרים או מופשטים ממשתמשים, אפשר להשתמש בווידג'ט TextInput.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}
שדות
name

string

השם שמזהה את קלט הבחירה באירוע של קלט טופס.

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

label

string

הטקסט שמופיע מעל לשדה הבחירה להזנת קלט בממשק המשתמש.

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

type

enum (SelectionType)

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

items[]

object (SelectionItem)

מערך של פריטים שאפשר לבחור. לדוגמה, מערך של לחצני בחירה או תיבות סימון. תמיכה ב-100 פריטים לכל היותר.

onChangeAction

object (Action)

אם מציינים את הפרמטר הזה, הטופס נשלח כשהבחירה משתנה. אם לא, צריך לציין לחצן נפרד לשליחת הטופס.

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

multiSelectMaxSelectedItems

integer

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

multiSelectMinQueryLength

integer

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

אם לא צוין אחרת, ברירת המחדל היא 0 תווים במקורות נתונים סטטיים ו-3 תווים במקורות נתונים חיצוניים.

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

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace. multi_select_data_source יכול להיות רק אחד מהבאים:

externalDataSource

object (Action)

מקור נתונים חיצוני, כמו בסיס נתונים יחסי.

platformDataSource

object (PlatformDataSource)

מקור נתונים מ-Google Workspace.

SelectionType

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

כל קלט של בחירה תומך בסוג אחד של בחירה. לדוגמה, אין תמיכה בשילוב של תיבות סימון ומתגים.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
CHECK_BOX קבוצה של תיבות סימון. המשתמשים יכולים לבחור תיבת סימון אחת או יותר.
RADIO_BUTTON קבוצה של לחצני בחירה. המשתמשים יכולים לבחור לחצן בחירה אחד.
SWITCH קבוצת מתגים. המשתמשים יכולים להפעיל מתג אחד או יותר.
DROPDOWN תפריט נפתח. המשתמשים יכולים לבחור פריט אחד מהתפריט.
MULTI_SELECT

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

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

  • נתונים סטטיים: הפריטים מסומנים כאובייקטים מסוג SelectionItem בווידג'ט. עד 100 פריטים.
  • נתוני Google Workspace: הפריטים מאוכלסים באמצעות נתונים מ-Google Workspace, כמו משתמשי Google Workspace או מרחבים משותפים ב-Google Chat.
  • נתונים חיצוניים: הפריטים מאוכלסים ממקור נתונים חיצוני מחוץ ל-Google Workspace.

דוגמאות לאופן שבו מטמיעים תפריטים של בחירה מרובה אפשר לעיין בדף הווידג'ט של SelectionInput .

אפשר להשתמש באפליקציות של Google Chat ובתוספים של Google Workspace. קיימת אפשרות בחירה מרובה של תוספים ל-Google Workspace

SelectionItem

פריט שהמשתמשים יכולים לבחור בקלט של בחירה, כמו תיבת סימון או מתג.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}
שדות
text

string

הטקסט שמזהה או מתאר את הפריט למשתמשים.

value

string

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

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

selected

boolean

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

startIconUri

string

בתפריטים של בחירה מרובה, כתובת ה-URL של הסמל שמוצג לצד השדה text של הפריט. יש תמיכה בקובצי PNG ו-JPEG. חייבת להיות כתובת URL מסוג HTTPS. לדוגמה, https://developers.google.com/chat/images/quickstart-app-avatar.png.

bottomText

string

בתפריטים של בחירה מרובה, תיאור טקסט או תווית שמוצגים מתחת לשדה text של הפריט.

PlatformDataSource

לווידג'ט של SelectionInput שמשתמש בתפריט לבחירה מרובה, מקור נתונים מ-Google Workspace. משמש לאכלוס פריטים בתפריט בחירה מרובה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ייצוג JSON
{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
שדות
שדה איחוד data_source. מקור הנתונים. data_source יכול להיות רק אחד מהבאים:
commonDataSource

enum (CommonDataSource)

מקור נתונים שמשותף לכל האפליקציות של Google Workspace, כמו משתמשים בארגון ב-Google Workspace.

hostAppDataSource

object (HostAppDataSourceMarkup)

מקור נתונים ייחודי לאפליקציית אירוח ב-Google Workspace, כמו מרחבים משותפים ב-Google Chat.

CommonDataSource

מקור נתונים שמשותף לכל האפליקציות של Google Workspace.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

טיפוסים בני מנייה (enums)
UNKNOWN ערך ברירת המחדל. אין להשתמש בו.
USER משתמשי Google Workspace. המשתמש יכול רק להציג ולבחור משתמשים מהארגון שלהם ב-Google Workspace.

HostAppDataSourceMarkup

לווידג'ט של SelectionInput שמשתמש בתפריט עם אפשרויות בחירה מרובות, מקור נתונים מאפליקציה של Google Workspace. מקור הנתונים מאכלס את פריטי הבחירה לתפריט הבחירה מרובה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ייצוג JSON
{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
שדות
שדה איחוד data_source. אפליקציית Google Workspace שמאכלסת פריטים בתפריט לבחירה מרובה. data_source יכול להיות רק אחד מהבאים:
chatDataSource

object (ChatClientDataSourceMarkup)

מקור נתונים מ-Google Chat.

ChatClientDataSourceMarkup

לווידג'ט של SelectionInput שמשתמש בתפריט לבחירה מרובה, מקור נתונים מ-Google Chat. מקור הנתונים מאכלס את פריטי הבחירה לתפריט הבחירה מרובה. לדוגמה, משתמש יכול לבחור מרחבים משותפים ב-Google Chat שהם חברים בהם.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ייצוג JSON
{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}
שדות
שדה איחוד source. מקור הנתונים ב-Google Chat. source יכול להיות רק אחד מהבאים:
spaceDataSource

object (SpaceDataSource)

מרחבים משותפים ב-Google Chat שהמשתמש חבר בהם.

SpaceDataSource

מקור נתונים שמאכלס את המרחבים המשותפים ב-Google Chat כפריטים לבחירה בתפריט של בחירה מרובה. לאכלס רק מרחבים משותפים שהמשתמש חבר בהם.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ייצוג JSON
{
  "defaultToCurrentSpace": boolean
}
שדות
defaultToCurrentSpace

boolean

אם המדיניות מוגדרת לערך true, בתפריט הבחירה מרובה מוגדר כברירת מחדל המרחב המשותף הנוכחי ב-Google Chat כפריט.

DateTimePicker

מאפשרת למשתמשים להזין תאריך, שעה או גם תאריך וגם שעה. אפשר לראות דוגמאות באפליקציות של Google Chat במאמר חלונית לבחירת תאריך ושעה.

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  }
}
שדות
name

string

השם שבאמצעותו DateTimePicker מזוהה באירוע של קלט טופס.

למידע נוסף על עבודה עם קלט של טופס, קראו את המאמר קבלת נתוני טופס.

label

string

הטקסט שמבקש מהמשתמשים להזין תאריך, שעה או תאריך ושעה. לדוגמה, אם משתמשים קובעים פגישה, יש להשתמש בתווית כמו Appointment date או Appointment date and time.

type

enum (DateTimePickerType)

האם הווידג'ט תומך בהזנת תאריך, שעה או תאריך ושעה.

valueMsEpoch

string (int64 format)

ערך ברירת המחדל שמוצג בווידג'ט, באלפיות השנייה מאז חותמת זמן של מערכת Unix.

צריך לציין את הערך על סמך סוג הבורר ( DateTimePickerType):

  • DATE_AND_TIME : תאריך ושעה ביומן לפי שעון UTC. לדוגמה, כדי לייצג את 1 בינואר 2023 בשעה 12:00 לפי שעון UTC, משתמשים בערך 1672574400000.
  • DATE_ONLY : תאריך קלנדרי ב-00:00:00 UTC. לדוגמה, כדי לייצג את 1 בינואר 2023, משתמשים ב-1672531200000.
  • TIME_ONLY : שעה לפי שעון UTC. לדוגמה, כדי לייצג את השעה 12:00, משתמשים ב-43200000 (או ב-12 * 60 * 60 * 1000).
timezoneOffsetDate

integer

המספר שמייצג את סטיית אזור הזמן מ-UTC, בדקות. אם המדיניות מוגדרת, valueMsEpoch יוצג באזור הזמן שצוין. אם המדיניות לא מוגדרת, ערך ברירת המחדל הוא אזור הזמן שמוגדר למשתמש.

onChangeAction

object (Action)

מופעל כשהמשתמש לוחץ על Save או על Clear מממשק DateTimePicker.

DateTimePickerType

הפורמט של התאריך והשעה בווידג'ט DateTimePicker. קובעת אם המשתמשים יכולים להזין תאריך, שעה או גם תאריך ושעה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
DATE_AND_TIME המשתמשים מזינים תאריך ושעה.
DATE_ONLY המשתמשים מזינים תאריך.
TIME_ONLY המשתמשים מזינים שעה.

קו מפריד

אין שדות בסוג הזה.

מציג קו מפריד בין הווידג'טים. דוגמה באפליקציות Google Chat מופיעה בקטע מפריד.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

לדוגמה, קובץ ה-JSON הבא יוצר מחיצה:

"divider": {}

מזהה GRid

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

רשת תומכת בכל מספר של עמודות ופריטים. מספר השורות נקבע על ידי חלוקה של הפריטים במספר העמודות. רשת שמכילה 10 פריטים ו-2 עמודות מכילה 5 שורות. רשת שמכילה 11 פריטים ו-2 עמודות מכילה 6 שורות.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

לדוגמה, קובץ ה-JSON הבא יוצר רשת של שתי עמודות עם פריט אחד:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
ייצוג JSON
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
שדות
title

string

הטקסט שמוצג בכותרת הרשת.

items[]

object (GridItem)

הפריטים שיוצגו ברשת.

borderStyle

object (BorderStyle)

סגנון הגבול שיש להחיל על כל פריט ברשת.

columnCount

integer

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

onClick

object (OnClick)

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

GridItem

מייצג פריט בפריסת רשת. פריטים יכולים להכיל טקסט, תמונה או גם טקסט וגם תמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
שדות
id

string

מזהה שצוין על ידי המשתמש לפריט הרשת הזה. המזהה הזה מוחזר בפרמטרים onClick לקריאה חוזרת (callback) של רשת ההורה.

image

object (ImageComponent)

התמונה שמוצגת בפריט הרשת.

title

string

שם הפריט ברשת.

subtitle

string

כותרת המשנה של פריט הרשת.

layout

enum (GridItemLayout)

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

ImageComponent

מייצג תמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
שדות
imageUri

string

כתובת ה-URL של התמונה.

altText

string

תווית הנגישות של התמונה.

cropStyle

object (ImageCropStyle)

סגנון החיתוך שצריך להחיל על התמונה.

borderStyle

object (BorderStyle)

סגנון הגבול שיוחל על התמונה.

ImageCropStyle

מייצג את סגנון החיתוך שהוחל על תמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

לדוגמה, כך מגדירים יחס גובה-רוחב של 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
ייצוג JSON
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
שדות
type

enum (ImageCropType)

סוג החיתוך.

aspectRatio

number

יחס הגובה-רוחב שבו יש להשתמש אם סוג החיתוך הוא RECTANGLE_CUSTOM.

לדוגמה, כך מגדירים יחס גובה-רוחב של 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

ImageCropType

מייצג את סגנון החיתוך שהוחל על תמונה.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
IMAGE_CROP_TYPE_UNSPECIFIED אין להשתמש בו. לא צוין.
SQUARE ערך ברירת המחדל. מחיל חיתוך מרובע.
CIRCLE יוצר חיתוך עגול.
RECTANGLE_CUSTOM מחיל חיתוך מלבני עם יחס גובה-רוחב מותאם אישית. מגדירים את יחס הגובה-רוחב המותאם אישית באמצעות aspectRatio.
RECTANGLE_4_3 מחיל חיתוך מלבני עם יחס גובה-רוחב של 4:3.

BorderStyle

אפשרויות הסגנון של הגבול של כרטיס או ווידג'ט, כולל הסוג והצבע של הגבול.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
שדות
type

enum (BorderType)

סוג הגבול.

strokeColor

object (Color)

הצבעים שבהם יש להשתמש כשהסוג הוא BORDER_TYPE_STROKE.

cornerRadius

integer

רדיוס הפינה של הגבול.

BorderType

מייצג את סוגי הגבולות שהוחלו על ווידג'טים.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
BORDER_TYPE_UNSPECIFIED אין להשתמש בו. לא צוין.
NO_BORDER ערך ברירת המחדל. ללא גבול.
STROKE מתאר.

GridItemLayout

מייצג את אפשרויות הפריסה השונות הזמינות לפריט רשת.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
GRID_ITEM_LAYOUT_UNSPECIFIED אין להשתמש בו. לא צוין.
TEXT_BELOW הכותרת וכותרת המשנה מוצגות מתחת לתמונה של פריט הרשת.
TEXT_ABOVE הכותרת וכותרת המשנה מוצגות מעל לתמונה של פריט הרשת.

עמודות

בווידג'ט Columns מוצגות עד 2 עמודות בכרטיס או בתיבת דו-שיח. ניתן להוסיף ווידג'טים לכל עמודה. הווידג'טים מופיעים לפי הסדר שבו צוינו. ראו דוגמה באפליקציות של Google Chat בקטע עמודות.

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

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

  • באינטרנט, העמודה השנייה גולשת אם רוחב המסך קטן מ-480 פיקסלים או שווה לו.
  • במכשירי iOS, העמודה השנייה גולשת אם רוחב המסך קטן מ-300 נק' או שווה לו.
  • במכשירי Android, העמודה השנייה גולשת אם רוחב המסך קטן מ-320dp או שווה לו.

כדי לכלול יותר מ-2 עמודות או להשתמש בשורות, צריך להשתמש בווידג'ט Grid.

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace. העמודות של תוספים ל-Google Workspace מוצגות

ייצוג JSON
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
שדות
columnItems[]

object (Column)

מערך של עמודות. אפשר לכלול עד 2 עמודות בכרטיס או בתיבת דו-שיח.

עמודה

עמודה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ייצוג JSON
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
שדות
horizontalSizeStyle

enum (HorizontalSizeStyle)

מציין איך עמודה ממלאת את רוחב הכרטיס.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

horizontalAlignment

enum (HorizontalAlignment)

ההגדרה קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה.

verticalAlignment

enum (VerticalAlignment)

ההגדרה קובעת אם הווידג'טים מיושרים לחלק העליון, לתחתית או למרכז העמודה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

widgets[]

object (Widgets)

מערך של ווידג'טים בעמודה. הווידג'טים מופיעים לפי הסדר שבו צוינו.

HorizontalSizeStyle

מציין איך עמודה ממלאת את רוחב הכרטיס. הרוחב של כל עמודה תלוי גם ב-HorizontalSizeStyle וגם ברוחב הווידג'טים בתוך העמודה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

טיפוסים בני מנייה (enums)
HORIZONTAL_SIZE_STYLE_UNSPECIFIED אין להשתמש בו. לא צוין.
FILL_AVAILABLE_SPACE ערך ברירת המחדל. עמודה ממלאת את השטח הזמין, עד 70% מרוחב הכרטיס. אם שתי העמודות מוגדרות לערך FILL_AVAILABLE_SPACE, כל עמודה תמלא 50% מהשטח.
FILL_MINIMUM_SPACE העמודה ממלאת את השטח המינימלי האפשרי, ולא יותר מ-30% מרוחב הכרטיס.

HorizontalAlignment

ההגדרה קובעת אם הווידג'טים מיושרים לשמאל, לימין או למרכז של עמודה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

טיפוסים בני מנייה (enums)
HORIZONTAL_ALIGNMENT_UNSPECIFIED אין להשתמש בו. לא צוין.
START ערך ברירת המחדל. יישור הווידג'טים למיקום ההתחלה של העמודה. לפריסות משמאל לימין, יישור לשמאל. בפריסות מימין לשמאל, יישור לימין.
CENTER יישור ווידג'טים למרכז העמודה.
END יישור הווידג'טים למיקום הסיום של העמודה. בפריסות משמאל לימין, יישור הווידג'טים ימינה. בפריסות מימין לשמאל, מיישר ווידג'טים לשמאל.

VerticalAlignment

ההגדרה קובעת אם הווידג'טים מיושרים לחלק העליון, לתחתית או למרכז העמודה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

טיפוסים בני מנייה (enums)
VERTICAL_ALIGNMENT_UNSPECIFIED אין להשתמש בו. לא צוין.
CENTER ערך ברירת המחדל. יישור ווידג'טים למרכז עמודה.
TOP יישור ווידג'טים לחלק העליון של עמודה.
BOTTOM יישור ווידג'טים לתחתית של עמודה.

ווידג'טים

הווידג'טים הנתמכים שניתן לכלול בעמודה.

התכונה זמינה באפליקציות Google Chat ולא זמינה בתוספים ל-Google Workspace.

ייצוג JSON
{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  }
  // End of list of possible types for union field data.
}
שדות

שדה איחוד data.

data יכול להיות רק אחד מהבאים:

textParagraph

object (TextParagraph)

הווידג'ט TextParagraph.

image

object (Image)

הווידג'ט Image.

decoratedText

object (DecoratedText)

הווידג'ט DecoratedText.

buttonList

object (ButtonList)

הווידג'ט ButtonList.

textInput

object (TextInput)

הווידג'ט TextInput.

selectionInput

object (SelectionInput)

הווידג'ט SelectionInput.

dateTimePicker

object (DateTimePicker)

הווידג'ט DateTimePicker.

DividerStyle

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

טיפוסים בני מנייה (enums)
DIVIDER_STYLE_UNSPECIFIED אין להשתמש בו. לא צוין.
SOLID_DIVIDER אפשרות ברירת המחדל. יוצרים הפרדה מלאה בין הקטעים.
NO_DIVIDER אם היא מוגדרת, לא תוצג חלוקה בין קטעים.

CardAction

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

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

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

string

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

onClick

object (OnClick)

הפעולה onClick בפעולה הזו.

CardFixedFooter

כותרת תחתונה קבועה (במיקום קבוע) שמופיעה בתחתית הכרטיס.

הגדרה של fixedFooter בלי לציין primaryButton או secondaryButton גורמת לשגיאה.

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

אפשר להשתמש רק באפליקציות Google Chat ובתוספים של Google Workspace.

ייצוג JSON
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
שדות
primaryButton

object (Button)

הלחצן הראשי בכותרת התחתונה הקבועה. הלחצן חייב להיות לחצן טקסט עם טקסט וצבעים.

secondaryButton

object (Button)

הלחצן המשני בכותרת התחתונה הקבועה. הלחצן חייב להיות לחצן טקסט עם טקסט וצבעים. אם secondaryButton מוגדר, עליכם להגדיר גם את primaryButton.

DisplayStyle

התוספים ל-Google Workspace קובעים איך הכרטיס יוצג.

התוסף זמין לתוספים ל-Google Workspace ולא זמין באפליקציות ל-Google Chat.

טיפוסים בני מנייה (enums)
DISPLAY_STYLE_UNSPECIFIED אין להשתמש בו. לא צוין.
PEEK כותרת הכרטיס מופיעה בתחתית סרגל הצד, ומכסה באופן חלקי את הכרטיס העליון של הערימה. לחיצה על הכותרת מקפיצה את הכרטיס לערימת הכרטיסים. אם אין לכרטיס כותרת, המערכת תשתמש בכותרת שנוצרה במקום זאת.
REPLACE ערך ברירת המחדל. כדי להציג את הכרטיס, צריך להחליף את תצוגת הכרטיס העליון בערימת הכרטיסים.