Card

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

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

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

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

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

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

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

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

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

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/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)
  },
  "expressionData": [
    {
      object (ExpressionData)
    }
  ]
}
שדות
header

object (CardHeader)

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

object (Section)

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

enum (DividerStyle)

סגנון הקו המפריד בין הכותרת העליונה, החלקים והכותרת התחתונה.
cardActions[]

object (CardAction)

הפעולות בכרטיס. הפעולות נוספות לתפריט סרגל הכלים של הכרטיס. אפשר להוסיף עד 10 פריטים מסוג 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)

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

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

object (ExpressionData)

נתוני הביטוי של הכרטיס.

זמין לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio. לא זמין לאפליקציות ל-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

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

קטע

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

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

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

string

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

object (Widget)

כל הווידג'טים בקטע. חייב להכיל לפחות ווידג'ט אחד. כרטיס יכול להכיל עד 100 ווידג'טים בכל החלקים.
collapsible

boolean

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

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

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

integer

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

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

string

מזהה ייחודי שמוקצה לקטע ומשמש לזיהוי הקטע שרוצים לשנות. מגבלת התווים של המזהה היא 64 תווים, והוא צריך להיות בפורמט [a-zA-Z0-9-]+.

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

object (CollapseControl)

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

ווידג'ט

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

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

ייצוג ב-JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "id": string,
  "visibility": enum (Visibility),
  "eventActions": [
    {
      object (EventAction)
    }
  ],

  "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)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
}
שדות
horizontalAlignment

enum (HorizontalAlignment)

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

string

מזהה ייחודי שמוקצה לווידג'ט ומשמש לזיהוי הווידג'ט שרוצים לשנות. מגבלת התווים של המזהה היא 64 תווים, והוא צריך להיות בפורמט [a-zA-Z0-9-]+.

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

enum (Visibility)

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

זמין לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio. לא זמין לאפליקציות ל-Google Chat.
eventActions[]

object (EventAction)

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

זמין לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio. לא זמין לאפליקציות ל-Google Chat.
לווידג'ט יכול להיות רק אחד מהפריטים הבאים. אפשר להשתמש בכמה שדות של ווידג'טים כדי להציג יותר פריטים. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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/workspace/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,
      },
      "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 הבא יוצר רשת של 2 עמודות עם פריט אחד:

"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"
          }
        }
      ]
    }
  ]
}
carousel

object (Carousel)

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

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in the carousel."
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in the carousel."
          }
        }
      ]
    }
  ]
}
chipList

object (ChipList)

רשימה של צ'יפים.

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

"chipList": {
  "chips": [
    {
      "label": "Edit",
      "disabled": true
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
סוף השדות שמוציאים זה את זה.

TextParagraph

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

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

ייצוג ב-JSON 
{
  "text": string,
  "maxLines": integer,
  "textSyntax": enum (TextSyntax)
}
שדות
text

string

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

integer

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

ערך ברירת המחדל הוא 0, ובמקרה כזה כל ההקשר מוצג. המערכת מתעלמת מערכים שליליים.
textSyntax

enum (TextSyntax)

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

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

TextSyntax

תחביר לעיצוב טקסט.

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

טיפוסים בני מנייה (enum)
TEXT_SYNTAX_UNSPECIFIED אם לא מציינים ערך, הטקסט מוצג כ-HTML.
HTML הטקסט מוצג כ-HTML. זהו ערך ברירת המחדל.
MARKDOWN הטקסט מוצג כ-Markdown.

תמונה

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

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

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

string

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

לדוגמה:

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

object (OnClick)

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

string

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

DecoratedText

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

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

ייצוג ב-JSON 
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
}
שדות
icon
(deprecated)

object (Icon)

הוצא משימוש והוחלף ב-startIcon.
startIcon

object (Icon)

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

enum (VerticalAlignment)

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

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

string

הטקסט שמופיע מעל text. תמיד מקצר.
topLabelText

object (TextParagraph)

TextParagraph שווה ערך ל-topLabel. תמיד מקצר. מאפשר עיצוב מורכב יותר מאשר topLabel.

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

string

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

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

object (TextParagraph)

‫TextParagraph שווה ערך ל-text. מאפשר עיצוב מורכב יותר מאשר text.

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

boolean

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

ההגדרה חלה רק על text, ולא על topLabel ו-bottomLabel.
bottomLabel

string

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

object (TextParagraph)

TextParagraph שווה ערך ל-bottomLabel. תמיד מופיע בתוך תיבה. מאפשר עיצוב מורכב יותר מאשר bottomLabel.

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

object (OnClick)

הפעולה הזו מופעלת כשמשתמשים לוחצים במקום כלשהו בווידג'ט של DecoratedText (כולל text,‏ topLabel,‏ bottomLabel וסמלים), חוץ ממקרים שבהם הם לוחצים על פקד אינטראקטיבי נפרד (button או switchControl).
כפתור, מתג, תיבת סימון או תמונה שמופיעים בצד שמאל של הטקסט בווידג'ט decoratedText. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
button

object (Button)

כפתור שהמשתמש יכול ללחוץ עליו כדי להפעיל פעולה.
switchControl

object (SwitchControl)

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

object (Icon)

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

תמיכה בסמלים מובְנים ומותאמים אישית.
סוף השדות שמוציאים זה את זה.

VerticalAlignment

מייצג מאפיין של יישור אנכי.

טיפוסים בני מנייה (enum)
VERTICAL_ALIGNMENT_UNSPECIFIED סוג לא מזוהה. אין להשתמש בו.
TOP יישור לחלק העליון.
MIDDLE יישור למרכז.
BOTTOM יישור לתחתית.

SwitchControl

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

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

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

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

string

השם שלפיו מזוהה הווידג'ט של המתג באירוע קלט של טופס (כמפתח ב-CommonEventObject.form_inputs).

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

string

הערך שמוחזר ב-CommonEventObject.form_inputs[name].string_inputs כשהמתג נבחר (selected הוא true). אם selected הוא true ו-value לא מוגדר, מחרוזת ריקה ("") מוחזרת ב-stringInputs.value. כשהערך של selected הוא false, הערך הזה מושמט מ-stringInputs.value.

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

boolean

כאשר true, המתג נבחר, וה-value שלו נכלל ב-CommonEventObject.form_inputs[name].string_inputs.value.
onChangeAction

object (Action)

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

enum (ControlType)

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

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

ControlType

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

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

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

TextInput

שדה שבו המשתמשים יכולים להזין טקסט. תמיכה בהצעות ובפעולות שמתבצעות כשמשהו משתנה. תומך באימות של שליחת טפסים. כשהמדיניות Action.all_widgets_are_required מוגדרת כ-true או שהווידג'ט הזה מצוין במדיניות Action.required_widgets, פעולת השליחה נחסמת אלא אם הוזן ערך. דוגמה לאפליקציות ל-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)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string,

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
שדות
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.
validation

object (Validation)

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

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

string

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

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

object (HostAppDataSourceMarkup)

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

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

סוג

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

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

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

RenderActions

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

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

שדות
action

Action

פעולה

שדות
navigations[]

Navigation

הוספה, הסרה או עדכון של כרטיס.

תוספים ב-Google Chat

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

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

navigations: {
  pushCard: CARD
}

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

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

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 
{

  "text": string
}
שדות
ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
text

string

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

אימות

מייצג את הנתונים שנדרשים כדי לאמת את הווידג'ט שאליו הוא מצורף.

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

ייצוג ב-JSON 
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
שדות
characterLimit

integer

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

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

enum (InputType)

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

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

InputType

סוג הווידג'ט של הקלט.

טיפוסים בני מנייה (enum)
INPUT_TYPE_UNSPECIFIED סוג לא מזוהה. אין להשתמש בו.
TEXT טקסט רגיל שכולל את כל התווים.
INTEGER ערך של מספר שלם.
FLOAT ערך מספרי.
EMAIL כתובת אימייל.
EMOJI_PICKER אמוג'י שנבחר מהחלונית לבחירת אמוג'י שסופקה על ידי המערכת.

HostAppDataSourceMarkup

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

ייצוג ב-JSON 
{

  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  },
  "workflowDataSource": {
    object (WorkflowDataSourceMarkup)
  }
}
שדות
אפליקציית Google Workspace שמאכלסת את הפריטים הזמינים לווידג'ט. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
chatDataSource

object (ChatClientDataSourceMarkup)

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

object (WorkflowDataSourceMarkup)

מקור נתונים מ-Google Workflow.
סוף השדות שמוציאים זה את זה.

ChatClientDataSourceMarkup

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

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

ייצוג ב-JSON 
{

  "spaceDataSource": {
    object (SpaceDataSource)
  }
}
שדות
מקור הנתונים של Google Chat. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
spaceDataSource

object (SpaceDataSource)

מרחבים משותפים ב-Google Chat שהמשתמש חבר בהם.
סוף השדות שמוציאים זה את זה.

SpaceDataSource

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

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

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

boolean

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

WorkflowDataSourceMarkup

‫* נתמך רק על ידי Google Workspace Workflow, ולא על ידי אפליקציות ל-Google Chat או תוספים ל-Google Workspace.

בווידג'ט TextInput או SelectionInput מסוג MULTI_SELECT או בווידג'ט DateTimePicker, צריך לספק מקור נתונים מ-Google.

ייצוג ב-JSON 
{
  "includeVariables": boolean,
  "type": enum (Type)
}
שדות
includeVariables

boolean

אם לכלול משתנים מהשלב הקודם במקור הנתונים.
type

enum (Type)

סוג מקור הנתונים.

סוג

‫enum שמייצג את הסוג של מקור הנתונים של תהליך העבודה.

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

SelectionInput

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

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

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

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

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

  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
}
שדות
name

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

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

  • אם התפריט משתמש במערך סטטי של פריטי SelectionInput, ברירת המחדל היא 0 תווים והפריטים מהמערך מאוכלסים באופן מיידי.
  • אם התפריט משתמש במקור נתונים דינמי (multi_select_data_source), ברירת המחדל היא 3 תווים לפני שליחת שאילתה למקור הנתונים כדי להחזיר פריטים מוצעים.
dataSourceConfigs[]

object (DataSourceConfig)

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

אם מציינים את השדה הזה, המערכת מתעלמת מהשדות multiSelectMaxSelectedItems, multiSelectMinQueryLength, externalDataSource ו-platformDataSource.

זמין לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio.

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

integer

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

string

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

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

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

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

object (Action)

מקור נתונים חיצוני, כמו מסד נתונים רלציוני.
platformDataSource

object (PlatformDataSource)

מקור נתונים מ-Google Workspace.
סוף השדות שמוציאים זה את זה.

SelectionType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PlatformDataSource

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

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

ייצוג ב-JSON 
{

  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
שדות
מקור הנתונים. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
commonDataSource

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

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

CommonDataSource

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

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

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

DataSourceConfig

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

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

ייצוג ב-JSON 
{

  "remoteDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  "minCharactersTrigger": integer
}
שדות
מקור הנתונים. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
remoteDataSource

object (Action)

הנתונים מגיעים מספק נתונים מרוחק.
platformDataSource

object (PlatformDataSource)

הנתונים מגיעים מאפליקציה של Google Workspace.
סוף השדות שמוציאים זה את זה.
minCharactersTrigger

integer

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

DateTimePicker

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

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

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

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

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
שדות
name

string

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

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

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

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

הערה: השדה הזה הוא בדקות, ואילו המטען הייעודי (payload) של אירועי אינטראקציה של משתמשים בדרך כלל מספק הפרשי אזורי זמן באלפיות השנייה (צריך לחלק ב-60000 כדי להמיר).
onChangeAction

object (Action)

מופעל כשהמשתמש לוחץ על שמירה או על ניקוי בממשק של DateTimePicker.
מקור הנתונים שצוין כדי לייצג תאריך ושעה. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
hostAppDataSource

object (HostAppDataSourceMarkup)

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

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

DateTimePickerType

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

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

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

קו מפריד

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

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

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

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

"divider": {}

תצוגת רשת

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

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

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

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

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

הקריאה החוזרת הזו משמשת שוב כל פריט בנפרד ברשת, אבל המזהה של הפריט מתווסף לפרמטרים של הקריאה החוזרת (מתחת למפתח "grid_item_identifier").

GridItem

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

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

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

string

מזהה שהמשתמש ציין לפריט הזה ברשת. המזהה הזה מוחזר בפרמטרים של הקריאה החוזרת (callback) של הרשת הראשית onClick.
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.

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

כדי להגדיר את צבע קו המתאר, מציינים ערך בשדות red,‏ green ו-blue. הערך חייב להיות מספר עשרוני בין 0 ל-1 על סמך ערך הצבע ב-RGB, כאשר 0 (0/255) מייצג היעדר צבע ו-1 (255/255) מייצג את העוצמה המקסימלית של הצבע.

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

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

השדה alpha לא זמין לצבע קו המתאר. אם מציינים את השדה הזה, המערכת מתעלמת ממנו.
cornerRadius

integer

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

BorderType

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

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

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

GridItemLayout

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

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

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

עמודות

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

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

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

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

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

זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace. ממשקי המשתמש של התוספים שתומכים בעמודות כוללים את:

  • תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מטיוטת אימייל.
  • תיבת הדו-שיח שמוצגת כשמשתמשים פותחים את התוסף מהתפריט הוספת קובץ מצורף באירוע ביומן Google.
ייצוג ב-JSON 
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
שדות
columnItems[]

object (Column)

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

עמודה

עמודה.

תוספים ל-Google Workspace ואפליקציות ל-Chat

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

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

HorizontalSizeStyle

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

תוספים ל-Google Workspace ואפליקציות ל-Chat

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

HorizontalAlignment

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

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

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

VerticalAlignment

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

תוספים ל-Google Workspace ואפליקציות ל-Chat

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

ווידג'טים

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

תוספים ל-Google Workspace ואפליקציות ל-Chat

ייצוג ב-JSON 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
}
שדות
ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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.
chipList

object (ChipList)

ווידג'ט ‏ChipList.
סוף השדות שמוציאים זה את זה.

ChipList

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

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

ייצוג ב-JSON 
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
שדות
layout

enum (Layout)

פריסת רשימת הצ'יפים שצוינה.
chips[]

object (Chip)

מערך של צ'יפים.

פריסה

פריסת רשימת הצ'יפים.

טיפוסים בני מנייה (enum)
LAYOUT_UNSPECIFIED אל תשתמשו בהם. לא צוין.
WRAPPED ערך ברירת המחדל. אם אין מספיק מקום אופקי, רשימת הצ'יפים עוברת לשורה הבאה.
HORIZONTAL_SCROLLABLE אם הצ'יפים לא נכנסים בשטח הפנוי, אפשר לגלול אותם אופקית.

Chip

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

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

ייצוג ב-JSON 
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
שדות
icon

object (Icon)

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

string

הטקסט שמוצג בתוך הצ'יפ.
onClick

object (OnClick)

זה שינוי אופציונלי. הפעולה שמתבצעת כשמשתמש לוחץ על הצ'יפ, כמו פתיחת היפר-קישור או הפעלת פונקציה בהתאמה אישית.
enabled
(deprecated)

boolean

הוצא משימוש: צריך להשתמש ב-disabled במקום זאת.

אם הצ'יפ במצב פעיל ומגיב לפעולות של המשתמש.
disabled

boolean

אם הצ'יפ במצב לא פעיל ומתעלם מפעולות של המשתמש. ברירת המחדל היא false.
altText

string

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

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

CarouselCard

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

ייצוג ב-JSON 
{
  "widgets": [
    {
      object (NestedWidget)
    }
  ],
  "footerWidgets": [
    {
      object (NestedWidget)
    }
  ]
}
שדות
widgets[]

object (NestedWidget)

רשימת ווידג'טים שמוצגים בכרטיס הקרוסלה. הווידג'טים מוצגים בסדר שבו הם צוינו.
footerWidgets[]

object (NestedWidget)

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

NestedWidget

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

ייצוג ב-JSON 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
}
שדות
ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
textParagraph

object (TextParagraph)

ווידג'ט של פסקה.
buttonList

object (ButtonList)

ווידג'ט של רשימת כפתורים.
image

object (Image)

ווידג'ט של תמונה.
סוף השדות שמוציאים זה את זה.

חשיפה

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

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

טיפוסים בני מנייה (enum)
VISIBILITY_UNSPECIFIED לא צוינה הרשאת גישה. אין להשתמש בו.
VISIBLE הרכיב בממשק המשתמש גלוי.
HIDDEN הרכיב בממשק המשתמש מוסתר.

EventAction

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

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

ייצוג ב-JSON 
{
  "actionRuleId": string,
  "postEventTriggers": [
    {
      object (Trigger)
    }
  ],

  "commonWidgetAction": {
    object (CommonWidgetAction)
  }
}
שדות
actionRuleId

string

המזהה הייחודי של ActionRule.
postEventTriggers[]

object (Trigger)

רשימת הטריגרים שיופעלו אחרי ש-EventAction יופעל.
הפעולה שצריך לבצע. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
commonWidgetAction

object (CommonWidgetAction)

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

טריגר

מייצג טריגר.

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

ייצוג ב-JSON 
{
  "actionRuleId": string
}
שדות
actionRuleId

string

המזהה הייחודי של ActionRule.

CommonWidgetAction

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

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

ייצוג ב-JSON 
{

  "updateVisibilityAction": {
    object (UpdateVisibilityAction)
  }
}
שדות
הפעולה שצריך לבצע. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
updateVisibilityAction

object (UpdateVisibilityAction)

הפעולה לעדכון החשיפה של ווידג'ט.
סוף השדות שמוציאים זה את זה.

UpdateVisibilityAction

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

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

ייצוג ב-JSON 
{
  "visibility": enum (Visibility)
}
שדות
visibility

enum (Visibility)

הרשאת הגישה החדשה.

CollapseControl

מייצג פקד הרחבה וכיווץ.

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

ייצוג ב-JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
שדות
horizontalAlignment

enum (HorizontalAlignment)

היישור האופקי של לחצן ההרחבה והכיווץ.
expandButton

object (Button)

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

object (Button)

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

DividerStyle

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

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

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

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

ExpressionData

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

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

ייצוג ב-JSON 
{
  "id": string,
  "expression": string,
  "conditions": [
    {
      object (Condition)
    }
  ],
  "eventActions": [
    {
      object (EventAction)
    }
  ]
}
שדות
id

string

המזהה הייחודי של ExpressionData.
expression

string

הביטוי שלא עבר הידור.
conditions[]

object (Condition)

רשימת התנאים שנקבעים לפי תוצאת החישוב של הביטוי.
eventActions[]

object (EventAction)

רשימת הפעולות שבהן אפשר להשתמש ב-ExpressionData.

תנאי

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

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

ייצוג ב-JSON 
{
  "actionRuleId": string,

  "expressionDataCondition": {
    object (ExpressionDataCondition)
  }
}
שדות
actionRuleId

string

המזהה הייחודי של ActionRule.
המצב. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
expressionDataCondition

object (ExpressionDataCondition)

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

ExpressionDataCondition

מייצג תנאי שנבדק באמצעות CEL.

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

ייצוג ב-JSON 
{
  "conditionType": enum (ConditionType)
}
שדות
conditionType

enum (ConditionType)

סוג התנאי.

ConditionType

סוג התנאי.

טיפוסים בני מנייה (enum)
CONDITION_TYPE_UNSPECIFIED סוג התנאי לא צוין.
EXPRESSION_EVALUATION_SUCCESS הערכת הביטוי הצליחה.
EXPRESSION_EVALUATION_FAILURE הערכת הביטוי נכשלה.