Package google.apps.card.v1

string

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

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

ActionParameter

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

LoadIndicator

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

bool

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

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

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

Interaction

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

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

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

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

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

string

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

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

bool

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

string

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

string

ערך הפרמטר.

BorderType

סוג הגבולות.

Color

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

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

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

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

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

int32

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

string

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

Icon

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

Color

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

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

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

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

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

OnClick

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

bool

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

string

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

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

Type

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

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

Button

מערך לחצנים.

CardHeader

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

Section

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

DividerStyle

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

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.

CardFixedFooter

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

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

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

DisplayStyle

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

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

CardHeader

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

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

string

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

OnClick

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

Button

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

Button

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

string

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

string

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

ImageType

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

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

string

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

string

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

string

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

Widget

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

bool

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

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

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

int32

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

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

CollapseControl

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

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

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

Layout

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

Chip

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

HorizontalAlignment

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

Button

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

Button

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

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

ווידג'ט ‏TextParagraph.

Image

ווידג'ט ‏Image.

DecoratedText

ווידג'ט ‏DecoratedText.

ButtonList

ווידג'ט ‏ButtonList.

TextInput

ווידג'ט ‏TextInput.

SelectionInput

ווידג'ט ‏SelectionInput.

DateTimePicker

ווידג'ט ‏DateTimePicker.

ChipList

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

string

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

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

string

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

DateTimePickerType

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

int64

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

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

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

int32

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

Action

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

Validation

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

Icon

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

Icon

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

string

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

string

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

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

bool

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

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

string

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

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

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

Action

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

ControlType

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

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

Action

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

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

Suggestions

string

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

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

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

ImageComponent

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

string

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

string

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

GridItemLayout

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

string

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

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

ImageType

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

string

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

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

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

string

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

לדוגמה:

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

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

MaterialIcon

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

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

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

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

string

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

לדוגמה:

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

OnClick

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

string

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

string

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

string

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

ImageCropStyle

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

BorderStyle

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

ImageCropType

סוג החיתוך.

double

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

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

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

string

כתובת ה-URL של הקישור לחזרה לתוסף.

string

שם הקישור לחזרה לתוסף.

Card

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

string

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

string

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

string

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

bool

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

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

int32

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

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

int32

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

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

bool

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

bool

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

string

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

Card

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

Card

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

EndNavigation

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

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

string

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

Action

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

OpenLink

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

Action

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

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

Card

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

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

OverflowMenu

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

string

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

OpenAs

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

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

OnClose

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

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

OverflowMenuItem

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

Icon

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

string

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

OnClick

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

bool

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

Action

HostAppActionMarkup

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

string

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

Navigation

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

OpenLink

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

Notification

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

LinkPreview

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

Link

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

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

int32

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

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

Validation

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

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

Action

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

PlatformDataSource

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

CommonDataSource

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

HostAppDataSourceMarkup

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

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

string

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

string

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

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

bool

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

string

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

string

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

RenderActions

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

bool

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

string

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

SuggestionItem

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

string

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

string

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

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

string

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

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

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

string

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

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

string

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

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

Type

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

Action

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

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

Suggestions

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

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

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

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

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

Action

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

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

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

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

Validation

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

string

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

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

string

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

int32

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

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

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

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

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

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

Image

מציגה תמונה.

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

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

DecoratedText

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

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

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

ButtonList

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

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

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

TextInput

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

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

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

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

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

SelectionInput

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

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

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

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}

Grid

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

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

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

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

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

Columns

מוצגות עד 2 עמודות.

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

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

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

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.