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. הערך חייב להיות מספר שרירותי (float) בין 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:

"card_actions": [
  {
    "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

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

זמין לתוספים ל-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

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

Button

זה שינוי אופציונלי. מגדירים לחצן בהתאמה אישית כדי לכווץ את הקטע. צריך להגדיר את השדות expand_button ו-collapse_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.

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

מזהה שהמשתמש מציין לפריט הזה בתצוגת הרשת. המזהה הזה מוחזר בפרמטרים של קריאה חוזרת (callback) 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 לעיצוב חדשני תלת-ממדי.

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

"material_icon": {
  "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

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

bool

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

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

int32

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

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

int32

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

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

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.

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 של הפריט.

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

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

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

"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

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

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

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