Package google.apps.card.v1

string

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

דוגמאות לשימוש מופיעות במאמר קריאת נתוני טופס.

ActionParameter

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

LoadIndicator

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

bool

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

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

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

Interaction

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

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

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

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

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

string

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

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

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

bool

אופציונלי. אם הערך הוא True, כל הווידג'טים נחשבים כנדרשים לפעולה הזו.

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

string

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

string

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

BorderType

סוג הגבול.

Color

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

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

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

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

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

int32

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

string

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

Icon

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

Color

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

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

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

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

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

OnClick

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

bool

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

string

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

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

Type

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

Button

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

CardHeader

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

Section

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

DividerStyle

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

CardAction

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

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

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

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

string

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

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

CardFixedFooter

הכותרת התחתונה הקבועה שמוצגת בתחתית הכרטיס הזה.

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

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

DisplayStyle

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

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

CardHeader

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

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

ExpressionData

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

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

string

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

OnClick

הפעולה onClick שצריך לבצע.

Button

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

Button

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

string

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

string

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

ImageType

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

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

string

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

string

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

TextParagraph

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

ButtonList

ווידג'ט של רשימת לחצנים.

Image

ווידג'ט של תמונה.

string

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

Widget

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

bool

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

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

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

int32

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

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

string

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

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

CollapseControl

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

CarouselCard

רשימת הכרטיסים שכלולים בקרוסלה.

NestedWidget

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

NestedWidget

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

Icon

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

string

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

OnClick

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

bool

האם הצ'יפ במצב פעיל ומגיב לפעולות של המשתמש. ברירת המחדל היא true. הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-disabled.

bool

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

string

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

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

Layout

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

Chip

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

HorizontalAlignment

היישור האופקי של כפתור ההרחבה והכיווץ.

Button

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

Button

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

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

ווידג'ט ‏TextParagraph.

Image

ווידג'ט ‏Image.

DecoratedText

ווידג'ט ‏DecoratedText.

ButtonList

ווידג'ט ‏ButtonList.

TextInput

ווידג'ט ‏TextInput.

SelectionInput

ווידג'ט ‏SelectionInput.

DateTimePicker

ווידג'ט ‏DateTimePicker.

ChipList

ווידג'ט ‏ChipList.

string

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

ExpressionDataCondition

התנאי שנקבע על ידי נתוני הביטוי.

ConditionType

סוג התנאי.

Action

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

PlatformDataSource

הנתונים הם מאפליקציית Google Workspace.

string

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

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

string

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

DateTimePickerType

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

int64

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

int32

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

Action

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

HostAppDataSourceMarkup

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

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

Icon

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

Icon

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

VerticalAlignment

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

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

string

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

TextParagraph

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

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

string

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

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

TextParagraph

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

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

bool

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

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

string

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

TextParagraph

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

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

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

כשבוחרים באפשרות true.

Action

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

ControlType

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

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

string

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

Trigger

רשימת הטריגרים שיופעלו אחרי הפעלת EventAction.

CommonWidgetAction

פעולה נפוצה בווידג'ט.

UpdateVisibilityAction

הפעולה לעדכון החשיפה של ווידג'ט.

Visibility

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

string

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

string

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

Condition

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

EventAction

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

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

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

ImageComponent

התמונה שמוצגת במשבצת.

string

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

string

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

GridItemLayout

הפריסה שבה צריך להשתמש בשביל פריט הרשת.

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/workspace/chat.

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

ImageType

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

string

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

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

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

string

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

לדוגמה:

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

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

MaterialIcon

הצגת אחד מהסמלים של Google Material.

לדוגמה, כדי להציג סמל של תיבת סימון, משתמשים ב

"material_icon": {
  "name": "check_box"
}

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

string

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

לדוגמה:

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

OnClick

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

string

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

string

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

string

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

ImageCropStyle

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

BorderStyle

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

ImageCropType

סוג החיתוך.

double

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

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

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

string

שם הסמל שמוגדר בסמל Google Material, לדוגמה, check_box. שמות לא תקינים נמחקים ומוחלפים במחרוזת ריקה, וכתוצאה מכך הסמל לא מוצג.

bool

האם הסמל מוצג כמלא. ערך ברירת המחדל הוא False.

כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל Google Font Icons ומשנים את ההגדרות בקטע Customize (התאמה אישית).

int32

עובי הקו של הסמל. בוחרים מתוך {100, 200, 300, 400, 500, 600, 700}. אם לא מציינים ערך, ערך ברירת המחדל הוא 400. אם מציינים ערך אחר, המערכת משתמשת בערך ברירת המחדל.

כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל Google Font Icons ומשנים את ההגדרות בקטע Customize (התאמה אישית).

int32

המשקל והדירוג משפיעים על עובי הסמל. השינויים בציון הם יותר מדויקים מהשינויים במשקל, וההשפעה שלהם על גודל הסמל קטנה. בוחרים מתוך {-25, 0, 200}. אם לא מציינים ערך, ברירת המחדל היא 0. אם מציינים ערך אחר, המערכת משתמשת בערך ברירת המחדל.

כדי לראות תצוגה מקדימה של הגדרות שונות של סמלים, עוברים אל Google Font Icons ומשנים את ההגדרות בקטע Customize (התאמה אישית).

Action

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

OpenLink

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

Action

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

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

Card

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

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

OverflowMenu

אם מציינים את onClick, נפתח תפריט אפשרויות נוספות.

string

כתובת ה-URL לפתיחה. כתובות URL מסוג HTTP מומרות ל-HTTPS.

OpenAs

איך פותחים קישור.

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

OnClose

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

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

OverflowMenuItem

חובה. רשימת האפשרויות בתפריט.

Icon

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

string

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

OnClick

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

bool

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

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

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

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

DataSourceConfig

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

אם מציינים את השדה הזה, המערכת מתעלמת מהשדות multi_select_max_selected_items, multi_select_min_query_length, external_data_source ו-platform_data_source.

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

int32

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

string

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

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

Action

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

PlatformDataSource

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

CommonDataSource

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

HostAppDataSourceMarkup

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

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

string

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

string

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

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

bool

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

string

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

string

SuggestionItem

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

string

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

string

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

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

string

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

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

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

string

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

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

string

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

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

Type

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

Action

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

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

Suggestions

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

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

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

אם מציינים את הערך TextInput.type, הוא תמיד יהיה SINGLE_LINE, גם אם הוא מוגדר כ-MULTIPLE_LINE.

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

Action

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

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

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

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

Validation

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

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

string

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

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

HostAppDataSourceMarkup

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

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

string

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

int32

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

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

TextSyntax

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

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

string

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

int32

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

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

InputType

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

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

HorizontalAlignment

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

string

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

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

Visibility

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

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

EventAction

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

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

TextParagraph

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

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

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

Image

התג הזה מציג תמונה.

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

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

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

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

לדוגמה, קוד ה-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

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

לדוגמה, קוד ה-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

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

לדוגמה, קוד ה-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

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

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

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

Divider

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

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

"divider": {
}

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

מוצגות עד 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

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

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

ChipList

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

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

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}