Cards v2

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)

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

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

string

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

string

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

enum (ImageType)

הצורה שבה התמונה חתוכה.

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

string

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

string

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

string

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

object (Widget)

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

boolean

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

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

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

integer

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

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

object (CollapseControl)

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

enum (HorizontalAlignment)

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

object (TextParagraph)

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

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

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

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

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

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

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

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

object (ChipList)

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

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

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

string

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

integer

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

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

string

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

לדוגמה:

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

object (OnClick)

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

string

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

object (Action)

אם צוין, הפעולה הזו תגרום להפעלת onClick.

object (OpenLink)

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

object (Action)

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

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

object (Card)

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

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

object (OverflowMenu)

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

string

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

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

object (ActionParameter)

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

enum (LoadIndicator)

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

boolean

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

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

string

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

string

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

string

כתובת ה-URL שרוצים לפתוח.

enum (OpenAs)

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

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

enum (OnClose)

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

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

object (OverflowMenuItem)

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

object (Icon)

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

string

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

object (OnClick)

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

boolean

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

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.

string

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

boolean

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

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

integer

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

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

integer

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

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

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)

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

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

string

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

object (Icon)

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

object (Color)

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

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

number

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

number

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

number

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

number

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

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

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

string

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

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

string

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

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

boolean

כשהערך הוא true, המתג נבחר.

object (Action)

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

enum (ControlType)

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

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

object (Button)

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

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

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

תצוגה מקדימה למפתחים: תוספים ב-Google Chat.

Card

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

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

Card

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

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

object (SuggestionItem)

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

string

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

integer

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

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

enum (InputType)

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

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

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

integer

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

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

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

object (Action)

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

object (PlatformDataSource)

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

string

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

string

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

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

boolean

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

string

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

string

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

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

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

object (ChatClientDataSourceMarkup)

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

object (SpaceDataSource)

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

boolean

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

string

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

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

ערך ברירת המחדל שמוצג בווידג'ט, באלפיות שנייה מ-Unix epoch time.

מציינים את הערך בהתאם לסוג הבורר (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.

string

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

object (GridItem)

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

object (BorderStyle)

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

integer

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

object (OnClick)

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

string

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

object (ImageComponent)

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

string

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

string

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

enum (GridItemLayout)

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

string

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

string

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

object (ImageCropStyle)

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

object (BorderStyle)

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

enum (ImageCropType)

סוג החיתוך.

number

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

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

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

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

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

object (Column)

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

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

object (TextParagraph)

ווידג'ט TextParagraph.

object (Image)

ווידג'ט Image.

object (DecoratedText)

ווידג'ט DecoratedText.

object (ButtonList)

ווידג'ט ButtonList.

object (TextInput)

ווידג'ט TextInput.

object (SelectionInput)

ווידג'ט SelectionInput.

object (DateTimePicker)

ווידג'ט DateTimePicker.

object (ChipList)

ווידג'ט ChipList.

enum (Layout)

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

object (Chip)

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

object (Icon)

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

string

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

object (OnClick)

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

boolean

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

boolean

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

string

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

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

object (CarouselCard)

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

object (NestedWidget)

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

object (NestedWidget)

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

object (TextParagraph)

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

object (ButtonList)

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

object (Image)

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

enum (HorizontalAlignment)

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

object (Button)

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

object (Button)

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

string

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

object (OnClick)

הפעולה onClick של פריט הפעולה הזה.

object (Button)

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

object (Button)

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