Package google.apps.card.v1

אינדקס

פעולה

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

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

שדות
function

string

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

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

parameters[]

ActionParameter

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

loadIndicator

LoadIndicator

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

persistValues

bool

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

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

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

interaction

Interaction

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

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

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

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

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

requiredWidgets[]

string

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

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

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

allWidgetsAreRequired

bool

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

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

ActionParameter

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

מידע נוסף זמין בכתובת CommonEventObject.

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

שדות
key

string

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

value

string

ערך הפרמטר.

אינטראקציה

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

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

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

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

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

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

טיפוסים בני מנייה (enum)
INTERACTION_UNSPECIFIED ערך ברירת המחדל. action פועל כרגיל.
OPEN_DIALOG

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

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

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

LoadIndicator

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

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

טיפוסים בני מנייה (enum)
SPINNER מציג סימן גרפי שמצביע על כך שהתוכן נטען.
NONE לא מוצג שום דבר.

BorderStyle

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

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

שדות
type

BorderType

סוג הגבולות.

strokeColor

Color

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

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

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

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

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

cornerRadius

int32

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

BorderType

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

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

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

לחצן

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

כדי להפוך תמונה ללחצן שניתן ללחוץ עליו, צריך לציין Image (לא ImageComponent) ולהגדיר את הפעולה onClick.

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

שדות
text

string

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

icon

Icon

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

color

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

onClick

OnClick

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

disabled

bool

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

altText

string

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

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

type

Type

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

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

סוג

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

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

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED אין להשתמש בו. לא צוין.
OUTLINED לחצנים קוויים הם לחצנים עם הדגשה בינונית. בדרך כלל הן כוללות פעולות חשובות, אבל הן לא הפעולה הראשית באפליקציית Chat או בתוסף.
FILLED לחצן שמולא מכיל מיכל בצבע אחיד. הפעולה הזו מועילה ביותר מבחינה ויזואלית, והיא מומלצת לפעולה הראשית והחשובה באפליקציית Chat או בתוסף.
FILLED_TONAL לחצן טונלי מלא הוא אזור אמצעי חלופי בין לחצנים מלאים וקוויים. כדאי להשתמש בהן בהקשרים שבהם לחצן בעדיפות נמוכה דורש הדגשה מעט יותר מאשר לחצן קווי מתאר.
BORDERLESS אין גורם מכיל בלתי נראה של לחצן במצב ברירת המחדל שלו. בדרך כלל משתמשים בה גם לפעולות בעדיפות נמוכה ביותר, במיוחד כשמציגים מספר אפשרויות.

ButtonList

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

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

שדות
buttons[]

Button

מערך לחצנים.

קלפים

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

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

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

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

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

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

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

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

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
שדות
header

CardHeader

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

sections[]

Section

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

sectionDividerStyle

DividerStyle

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

cardActions[]

CardAction

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

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

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

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

string

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

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

fixedFooter

CardFixedFooter

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

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

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

displayStyle

DisplayStyle

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

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

peekCardHeader

CardHeader

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

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

CardAction

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

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

שדות
actionLabel

string

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

onClick

OnClick

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

CardFixedFooter

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

הגדרה של fixedFooter בלי לציין primaryButton או secondaryButton גורמת לשגיאה.

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

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

שדות
primaryButton

Button

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

secondaryButton

Button

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

CardHeader

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

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

שדות
title

string

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

subtitle

string

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

imageType

ImageType

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

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

imageUrl

string

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

imageAltText

string

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

DisplayStyle

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

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

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

DividerStyle

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

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

טיפוסים בני מנייה (enum)
DIVIDER_STYLE_UNSPECIFIED אין להשתמש בו. לא צוין.
SOLID_DIVIDER אפשרות ברירת מחדל. יוצרים קו מפריד יציב.
NO_DIVIDER אם המדיניות מוגדרת, לא יוצג קו מפריד. הסגנון הזה מסיר לחלוטין את המחיצה מהפריסה. התוצאה זהה לאי-הוספת קו מפריד בכלל.

קטע

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

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

שדות
header

string

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

widgets[]

Widget

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

collapsible

bool

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

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

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

uncollapsibleWidgetsCount

int32

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

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

collapseControl

CollapseControl

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

צ'יפ

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

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

שדות
icon

Icon

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

label

string

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

onClick

OnClick

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

enabled
(deprecated)

bool

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

disabled

bool

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

altText

string

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

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

ChipList

רשימה של צ'יפים בפריסה לרוחב, שאפשר לגלול לרוחב או לגלול לשורה הבאה.

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

שדות
layout

Layout

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

chips[]

Chip

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

פריסה

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

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

CollapseControl

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

שדות
horizontalAlignment

HorizontalAlignment

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

expandButton

Button

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

collapseButton

Button

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

עמודות

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

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

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

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

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

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

שדות
columnItems[]

Column

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

עמודה

עמודה.

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

שדות
horizontalSizeStyle

HorizontalSizeStyle

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

horizontalAlignment

HorizontalAlignment

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

verticalAlignment

VerticalAlignment

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

widgets[]

Widgets

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

HorizontalSizeStyle

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

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

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

VerticalAlignment

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

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

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

ווידג'טים

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

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

שדות

שדה איחוד data.

data יכול להיות רק אחת מהאפשרויות הבאות:

textParagraph

TextParagraph

ווידג'ט ‏TextParagraph.

image

Image

ווידג'ט ‏Image.

decoratedText

DecoratedText

ווידג'ט ‏DecoratedText.

buttonList

ButtonList

ווידג'ט ‏ButtonList.

textInput

TextInput

ווידג'ט ‏TextInput.

selectionInput

SelectionInput

ווידג'ט ‏SelectionInput.

dateTimePicker

DateTimePicker

ווידג'ט ‏DateTimePicker.

chipList

ChipList

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

DateTimePicker

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

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

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

שדות
name

string

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

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

label

string

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

type

DateTimePickerType

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

valueMsEpoch

int64

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

ציון הערך על סמך סוג הבורר (DateTimePickerType):

  • DATE_AND_TIME: תאריך ושעה קלנדריים לפי שעון UTC. לדוגמה, כדי לייצג את התאריך 1 בינואר 2023 בשעה 12:00 לפי שעון UTC, משתמשים ב-1672574400000.
  • DATE_ONLY: תאריך קלנדרי בשעה 00:00:00 (שעון UTC). לדוגמה, כדי לייצג את ה-1 בינואר 2023, צריך להשתמש ב-1672531200000.
  • TIME_ONLY: השעה לפי שעון UTC. לדוגמה, כדי לייצג את השעה 12:00, השתמשו ב-43200000 (או ב-12 * 60 * 60 * 1000).
timezoneOffsetDate

int32

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

onChangeAction

Action

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

validation

Validation

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

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

DateTimePickerType

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

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

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

DecoratedText

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

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

שדות
icon
(deprecated)

Icon

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

startIcon

Icon

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

topLabel

string

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

text

string

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

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

wrapText

bool

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

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

bottomLabel

string

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

onClick

OnClick

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

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

Button

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

switchControl

SwitchControl

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

endIcon

Icon

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

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

SwitchControl

מתג בסגנון החלפת מצב או תיבת סימון בתוך הווידג'ט decoratedText.

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

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

שדות
name

string

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

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

value

string

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

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

selected

bool

כשהמתג true נבחר.

onChangeAction

Action

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

controlType

ControlType

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

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

ControlType

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

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

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

קו מפריד

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

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

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

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

"divider": {}

EndNavigation

פעולה בתהליך תיבת הדו-שיח.

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

שדות
action

Action

פעולת העיבוד של הלקוח כדי לסיים תהליך של תיבת דו-שיח.

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

פעולה

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

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

טיפוסים בני מנייה (enum)
ACTION_UNSPECIFIED לא צוינה פעולה.
CLOSE_DIALOG סגירת התהליך של תיבת הדו-שיח.
CLOSE_DIALOG_AND_EXECUTE סוגרים את תהליך הדו-שיח ומרעננים את הכרטיס שפותח את תהליך הדו-שיח.

GetAutocompletionResponse

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

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

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
שדות
autoComplete

Suggestions

schema

string

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

תצוגת רשת

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

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

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

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

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
שדות
title

string

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

items[]

GridItem

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

borderStyle

BorderStyle

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

columnCount

int32

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

onClick

OnClick

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

GridItem

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

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

שדות
id

string

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

image

ImageComponent

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

title

string

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

subtitle

string

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

layout

GridItemLayout

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

GridItemLayout

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

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

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

סמל

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

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

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

שדות
altText

string

זה שינוי אופציונלי. תיאור של הסמל שמשמש לנגישות. אם לא צוין ערך, צוין ערך ברירת המחדל Button. מומלץ להגדיר תיאור מועיל לגבי מה שהסמל מוצג, והסבר לגבי מה שהוא עושה במקרים רלוונטיים. לדוגמה, A user's account portrait או Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

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

imageType

ImageType

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

שדה איחוד icons. הסמל שמוצג בווידג'ט בכרטיס. icons יכול להיות רק אחת מהאפשרויות הבאות:
knownIcon

string

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

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

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

iconUrl

string

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

לדוגמה:

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

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

materialIcon

MaterialIcon

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

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

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

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

תמונה

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

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

שדות
imageUrl

string

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

לדוגמה:

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

OnClick

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

altText

string

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

ImageComponent

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

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

שדות
imageUri

string

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

altText

string

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

cropStyle

ImageCropStyle

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

borderStyle

BorderStyle

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

ImageCropStyle

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

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

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
שדות
type

ImageCropType

סוג החיתוך.

aspectRatio

double

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

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

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

ImageCropType

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

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

טיפוסים בני מנייה (enum)
IMAGE_CROP_TYPE_UNSPECIFIED אין להשתמש בו. לא צוין.
SQUARE ערך ברירת המחדל. החלת חיתוך ריבועי.
CIRCLE החלת חיתוך מעגלי.
RECTANGLE_CUSTOM המערכת תחיל חיתוך מלבני עם יחס גובה-רוחב מותאם אישית. הגדרת יחס גובה-רוחב מותאם אישית עם aspectRatio.
RECTANGLE_4_3 המערכת משתמשת בחיתוך מלבני עם יחס גובה-רוחב של 4:3.

LinkPreview

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

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

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

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

הדוגמה מחזירה את התצוגה המקדימה הבאה של הקישור:

תצוגה מקדימה של קישור לדוגמה

שדות
previewCard

Card

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

title

string

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

linkPreviewTitle

string

הכותרת שמוצגת בתצוגה המקדימה של הקישור. אם המדיניות לא מוגדרת, בתצוגה המקדימה של הקישור תוצג הכותרת של preview_card.

MaterialIcon

סמל של חומר הלימוד של Google, שכולל יותר מ-2,500 אפשרויות.

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

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

שדות
name

string

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

fill

bool

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

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

weight

int32

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

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

grade

int32

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

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

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

לדוגמה:

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

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

 navigations : {
    pushCard : CARD
  }

2) מעדכנים את הכרטיס מעל הערימה (כלומר מעדכנים את הכרטיס).

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

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) חזרה שלב אחד אחורה בלי לעדכן.

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

  navigations : {
    popCard : true,
  }

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

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

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) חוזרים כמה שלבים אל CARD_NAME מוגדר.

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

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) חוזרים לשורש ומעדכנים את הכרטיס.

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

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) קופצים אל הכרטיס שצוין ומפוצצים גם את הכרטיס הזה.

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

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

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

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

  navigations : {
    updateCard : CARD
  }
שדות

שדה איחוד navigate_action.

navigate_action יכול להיות רק אחת מהאפשרויות הבאות:

popToRoot

bool

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

pop

bool

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

popToCard

string

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

pushCard

Card

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

updateCard

Card

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

endNavigation

EndNavigation

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

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

התראה

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

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

שדות
text

string

טקסט פשוט להצגה עבור ההתראה, ללא תגי HTML.

OnClick

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

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

שדות

שדה איחוד data.

data יכול להיות רק אחת מהאפשרויות הבאות:

action

Action

אם השדה הזה מוגדר, פעולה תופעל על ידי onClick.

openDynamicLinkAction

Action

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

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

card

Card

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

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

overflowMenu

OverflowMenu

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

OnClose

מה הלקוח עושה כשקישור שנפתח על ידי פעולת OnClick נסגר.

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

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

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

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

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

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

OpenAs

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

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

טיפוסים בני מנייה (enum)
FULL_SIZE הקישור ייפתח כחלון בגודל מלא (אם זו המסגרת שבה הלקוח משתמש).
OVERLAY הקישור נפתח כשכבת-על, למשל כחלון קופץ.

OverflowMenu

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

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

שדות
items[]

OverflowMenuItem

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

OverflowMenuItem

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

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

שדות
startIcon

Icon

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

text

string

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

onClick

OnClick

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

disabled

bool

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

RenderActions

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

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

שדות
action

Action

hostAppAction

HostAppActionMarkup

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

schema

string

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

פעולה

שדות
navigations[]

Navigation

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

notification

Notification

הצגת התראה למשתמש הקצה.

linkPreview

LinkPreview

הצגת תצוגה מקדימה של קישור למשתמש הקצה.

SelectionInput

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

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

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

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

שדות
name

string

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

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

label

string

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

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

type

SelectionType

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

items[]

SelectionItem

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

onChangeAction

Action

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

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

multiSelectMaxSelectedItems

int32

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

multiSelectMinQueryLength

int32

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

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

validation

Validation

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

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

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

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

externalDataSource

Action

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

platformDataSource

PlatformDataSource

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

PlatformDataSource

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

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

שדות
שדה איחוד data_source. מקור הנתונים. data_source יכול להיות רק אחת מהאפשרויות הבאות:
commonDataSource

CommonDataSource

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

hostAppDataSource

HostAppDataSourceMarkup

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

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

CommonDataSource

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

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

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

SelectionItem

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

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

שדות
text

string

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

value

string

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

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

selected

bool

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

startIconUri

string

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

bottomText

string

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

SelectionType

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

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

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

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

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

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

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

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

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

SubmitFormResponse

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

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

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
שדות
renderActions

RenderActions

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

stateChanged

bool

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

schema

string

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

הצעות

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

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

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

אם הערך הזה מוגדר, הערך של TextInput.type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר לערך MULTIPLE_LINE.

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

שדות
items[]

SuggestionItem

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

SuggestionItem

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

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

שדות

שדה איחוד content.

content יכול להיות רק אחת מהאפשרויות הבאות:

text

string

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

TextInput

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

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

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

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

שדות
name

string

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

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

label

string

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

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

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

hintText

string

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

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

value

string

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

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

type

Type

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

onChangeAction

Action

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

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

initialSuggestions

Suggestions

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

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

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

אם הערך הזה מוגדר, הערך של TextInput.type הוא תמיד SINGLE_LINE, גם אם הוא מוגדר לערך MULTIPLE_LINE.

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

autoCompleteAction

Action

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

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

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

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

validation

Validation

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

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

placeholderText

string

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

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

סוג

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

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

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

TextParagraph

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

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

שדות
text

string

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

maxLines

int32

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

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

אימות

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

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

שדות
characterLimit

int32

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

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

inputType

InputType

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

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

InputType

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

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

ווידג'ט

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

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

שדות
horizontalAlignment

HorizontalAlignment

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

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

TextParagraph

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

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

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

Image

מציגה תמונה.

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

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

DecoratedText

מציגה פריט טקסט מעוצב.

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

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

ButtonList

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

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

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

TextInput

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

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

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

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

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

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

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

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}
grid

Grid

תצוגת רשת עם אוסף של פריטים.

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

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

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

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

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

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.

HorizontalAlignment

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

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

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

ImageType

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

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

טיפוסים בני מנייה (enum)
SQUARE ערך ברירת המחדל. הפעלת מסכה ריבועית על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת ל-3x3.
CIRCLE החלת מסכה מעוגלת על התמונה. לדוגמה, תמונה בגודל 4x3 הופכת לעיגול בקוטר של 3.