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)

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

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": "[email protected]",
  "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 (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.

string

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

integer

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

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

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

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.

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 ומשנים את ההגדרות בקטע Customize (התאמה אישית).

integer

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

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

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. הערך חייב להיות מספר צף בין 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.

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

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

Card

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

Card

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

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

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

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

object (Validation)

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

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

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.

object (Validation)

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

string

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

object (GridItem)

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

object (BorderStyle)

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

integer

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

object (OnClick)

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

string

מזהה שהוגדר על ידי המשתמש לפריט ברשת. המזהה הזה מוחזר בפרמטרים של הקריאה החוזרת 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. האפשרות זמינה באפליקציות ל-Google Chat ולא זמינה לתוספים ל-Google Workspace.

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

enum (HorizontalAlignment)

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

object (Button)

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

object (Button)

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

string

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

object (OnClick)

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

object (Button)

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

object (Button)

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