Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

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

object (Section)

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

enum (DividerStyle)

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

object (CardAction)

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

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

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

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

string

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

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

object (CardFixedFooter)

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

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

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

enum (DisplayStyle)

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

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

object (CardHeader)

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

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

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

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

string

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

enum (ImageType)

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

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

string

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

string

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

string

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

object (Widget)

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

boolean

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

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

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

integer

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

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

object (CollapseControl)

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

{
  "horizontalAlignment": enum (HorizontalAlignment),

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

enum (HorizontalAlignment)

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

object (TextParagraph)

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

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

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

object (Image)

מציגה תמונה.

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

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

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

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

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

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

object (DateTimePicker)

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

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

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

object (Divider)

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

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

"divider": {
}

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

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

object (ChipList)

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

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

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

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

{
  "text": string,
  "maxLines": integer
}

string

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

integer

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

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

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

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

לדוגמה:

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

object (OnClick)

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

string

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

{

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

object (Action)

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

object (OpenLink)

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

object (Action)

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

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

object (Card)

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

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

object (OverflowMenu)

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

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

string

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

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

object (ActionParameter)

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

enum (LoadIndicator)

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

boolean

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

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

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

enum (Interaction)

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

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

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

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

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

string

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

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

boolean

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

{
  "key": string,
  "value": string
}

string

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

string

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

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

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

enum (OpenAs)

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

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

enum (OnClose)

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

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

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

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

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

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

string

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

object (OnClick)

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

boolean

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

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

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 המערכת מתעלמת ממנו.

enum (ImageType)

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

string

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

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

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

string

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

לדוגמה:

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

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

object (MaterialIcon)

הצגה של אחד סמלי החומר של Google.

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

"materialIcon": {
  "name": "check_box"
}

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

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

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

boolean

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

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

integer

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

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

integer

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

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

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

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

object (Icon)

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

object (Icon)

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

string

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

string

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

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

boolean

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

חל רק על text, לא topLabel וגם bottomLabel.

string

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

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

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

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

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

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

object (Icon)

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

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

object (OnClick)

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

boolean

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

string

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

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

enum (Type)

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

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

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

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

number

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

number

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

number

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

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

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

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

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

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

string

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

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

boolean

מתי true, המתג נבחר.

object (Action)

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

enum (ControlType)

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

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

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

{
  "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
}

string

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

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

string

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

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

נדרש אם hintText לא צוינה. אחרת, אופציונלי.

string

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

נדרש אם label לא צוינה. אחרת, אופציונלי.

string

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

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

enum (Type)

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

object (Action)

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

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

object (Suggestions)

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

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

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

כשמצוין, TextInput.type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר MULTIPLE_LINE.

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

object (Action)

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

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

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

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

object (Validation)

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

string

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

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

Action

Navigation

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

Card

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

Card

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

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

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

string

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

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

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

enum (InputType)

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

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

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

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

integer

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

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

object (Validation)

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

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

object (Action)

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

object (PlatformDataSource)

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

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

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

string

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

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

boolean

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

string

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

string

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

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

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

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

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

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

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

{
  "defaultToCurrentSpace": boolean
}

boolean

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

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

string

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

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

string

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

enum (DateTimePickerType)

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

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

integer

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

object (Action)

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

object (Validation)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (GridItem)

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

object (BorderStyle)

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

integer

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

object (OnClick)

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

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

מזהה שהמשתמש מציין לפריט הזה בתצוגת הרשת. המזהה הזה מוחזר בפרמטר ה-callback‏ onClick של רשת ההורה.

object (ImageComponent)

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

string

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

string

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

enum (GridItemLayout)

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

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

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

string

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

object (ImageCropStyle)

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

object (BorderStyle)

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

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

סוג החיתוך.

number

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

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

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

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

סוג הגבולות.

object (Color)

הצבעים שבהם נעשה שימוש כשהסוג הוא BORDER_TYPE_STROKE

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

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

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

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

integer

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

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

{

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

object (TextParagraph)

ווידג'ט TextParagraph.

object (Image)

ווידג'ט Image.

object (DecoratedText)

DecoratedText לווידג'ט הזה.

object (ButtonList)

ButtonList לווידג'ט הזה.

object (TextInput)

ווידג'ט TextInput.

object (SelectionInput)

SelectionInput לווידג'ט הזה.

object (DateTimePicker)

DateTimePicker לווידג'ט הזה.

object (ChipList)

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

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

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

object (Chip)

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

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

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

string

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

object (OnClick)

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

boolean

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

boolean

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

string

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

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

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

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

object (Button)

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

object (Button)

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

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (OnClick)

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

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

object (Button)

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