Card

อินเทอร์เฟซการ์ดที่แสดงในข้อความแชทของ Google Chat หรือส่วนเสริมของ Google Workspace

การ์ดรองรับเลย์เอาต์ที่กำหนดไว้ องค์ประกอบ UI แบบอินเทอร์แอกทีฟ เช่น ปุ่ม และริชมีเดีย เช่น รูปภาพ ใช้การ์ดเพื่อแสดงข้อมูลโดยละเอียด รวบรวมข้อมูลจากผู้ใช้ และแนะนำผู้ใช้ให้ดำเนินการในขั้นตอนถัดไป

ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด

ดูวิธีสร้างการ์ดได้ที่เอกสารประกอบต่อไปนี้

หมายเหตุ: คุณเพิ่มวิดเจ็ตได้สูงสุด 100 รายการต่อการ์ด 1 ใบ หากวิดเจ็ตของส่วนหนึ่งทำให้จำนวนรวมเกิน 100 ระบบจะไม่สนใจทั้งส่วนนั้นและส่วนต่อๆ ไปทั้งหมด ขีดจำกัดนี้มีผลกับทั้งข้อความการ์ดและกล่องโต้ตอบในแอป 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
การแสดง JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  },
  "expressionData": [
    {
      object (ExpressionData)
    }
  ]
}
ช่อง
header

object (CardHeader)

ส่วนหัวของการ์ด โดยปกติแล้ว ส่วนหัวจะมีรูปภาพหลักและชื่อ ส่วนหัวจะปรากฏที่ด้านบนของการ์ดเสมอ
sections[]

object (Section)

มีคอลเล็กชันวิดเจ็ต แต่ละส่วนจะมีส่วนหัวที่ไม่บังคับของตัวเอง ส่วนต่างๆ จะแยกออกจากกันอย่างชัดเจนด้วยเส้นแบ่ง ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อกำหนดส่วนของการ์ด
sectionDividerStyle

enum (DividerStyle)

รูปแบบตัวแบ่งระหว่างส่วนหัว ส่วนต่างๆ และส่วนท้าย
cardActions[]

object (CardAction)

การดำเนินการของการ์ด ระบบจะเพิ่มการดำเนินการลงในเมนูแถบเครื่องมือของการ์ด รองรับรายการ CardAction สูงสุด 10 รายการ

ใช้ได้กับส่วนเสริม 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
displayStyle

enum (DisplayStyle)

ในส่วนเสริมของ Google Workspace ให้ตั้งค่าพร็อพเพอร์ตี้การแสดงผลของ peekCardHeader

ใช้ได้กับส่วนเสริม Google Workspace และใช้ไม่ได้กับแอป Google Chat
peekCardHeader

object (CardHeader)

เมื่อแสดงเนื้อหาตามบริบท ส่วนหัวของการ์ดข้อมูลสรุปจะทำหน้าที่เป็นตัวยึดตำแหน่งเพื่อให้ผู้ใช้ไปยังส่วนต่างๆ ระหว่างการ์ดในหน้าแรกและการ์ดตามบริบทได้

ใช้ได้กับส่วนเสริม Google Workspace และใช้ไม่ได้กับแอป Google Chat
expressionData[]

object (ExpressionData)

ข้อมูลนิพจน์สำหรับการ์ด

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

CardHeader

แสดงส่วนหัวของการ์ด ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อเพิ่มส่วนหัว

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
ช่อง
title

string

ต้องระบุ ชื่อของส่วนหัวของการ์ด ส่วนหัวมีความสูงคงที่ โดยหากระบุทั้งชื่อและคำบรรยาย แต่ละรายการจะใช้พื้นที่ 1 บรรทัด หากระบุเฉพาะชื่อ ชื่อจะใช้ทั้ง 2 บรรทัด
subtitle

string

คำบรรยายของส่วนหัวของการ์ด หากระบุไว้ จะปรากฏในบรรทัดของตัวเองใต้ title
imageType

enum (ImageType)

รูปร่างที่ใช้ครอบตัดรูปภาพ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace
imageUrl

string

HTTPS URL ของรูปภาพในส่วนหัวของการ์ด
imageAltText

string

ข้อความแสดงแทนของรูปภาพนี้ที่ใช้สำหรับการช่วยเหลือพิเศษ

ส่วน

ส่วนประกอบด้วยคอลเล็กชันวิดเจ็ตที่แสดงผลในแนวตั้งตามลำดับที่ระบุไว้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "id": string,
  "collapseControl": {
    object (CollapseControl)
  }
}
ช่อง
header

string

ข้อความที่ปรากฏที่ด้านบนของส่วน รองรับข้อความที่จัดรูปแบบ HTML แบบง่าย ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริม Google Workspace
widgets[]

object (Widget)

วิดเจ็ตทั้งหมดในส่วนนี้ ต้องมีวิดเจ็ตอย่างน้อย 1 รายการ การ์ดรองรับวิดเจ็ตได้สูงสุด 100 รายการในทุกส่วน
collapsible

boolean

ระบุว่าส่วนนี้ยุบได้หรือไม่

ส่วนที่ยุบได้จะซ่อนวิดเจ็ตบางส่วนหรือทั้งหมด แต่ผู้ใช้สามารถขยายส่วนเพื่อแสดงวิดเจ็ตที่ซ่อนอยู่ได้โดยคลิกแสดงเพิ่มเติม ผู้ใช้สามารถซ่อนวิดเจ็ตอีกครั้งได้โดยคลิกแสดงน้อยลง

หากต้องการระบุวิดเจ็ตที่ซ่อนอยู่ ให้ระบุ uncollapsibleWidgetsCount
uncollapsibleWidgetsCount

integer

จำนวนวิดเจ็ตที่ยุบไม่ได้ซึ่งยังคงมองเห็นได้แม้ว่าจะยุบส่วนแล้วก็ตาม

ตัวอย่างเช่น เมื่อส่วนหนึ่งมีวิดเจ็ต 5 รายการและตั้งค่า uncollapsibleWidgetsCount เป็น 2 ระบบจะแสดงวิดเจ็ต 2 รายการแรกเสมอ และยุบวิดเจ็ต 3 รายการสุดท้ายโดยค่าเริ่มต้น ระบบจะพิจารณา uncollapsibleWidgetsCount ก็ต่อเมื่อ collapsible เป็น true เท่านั้น
id

string

รหัสที่ไม่ซ้ำกันซึ่งกำหนดให้กับส่วนที่ใช้ระบุส่วนที่จะเปลี่ยนแปลง รหัสมีจำนวนอักขระสูงสุด 64 ตัวและควรอยู่ในรูปแบบ [a-zA-Z0-9-]+

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
collapseControl

object (CollapseControl)

ไม่บังคับ กำหนดปุ่มขยายและยุบของส่วน ปุ่มนี้จะแสดงก็ต่อเมื่อส่วนนั้นยุบได้เท่านั้น หากไม่ได้ตั้งค่าช่องนี้ ระบบจะใช้ปุ่มเริ่มต้น

วิดเจ็ต

การ์ดแต่ละใบประกอบด้วยวิดเจ็ต

วิดเจ็ตคือออบเจ็กต์แบบผสมที่สามารถแสดงข้อความ รูปภาพ ปุ่ม และออบเจ็กต์ประเภทอื่นๆ ได้

การแสดง JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "id": string,
  "visibility": enum (Visibility),
  "eventActions": [
    {
      object (EventAction)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
}
ช่อง
horizontalAlignment

enum (HorizontalAlignment)

ระบุว่าวิดเจ็ตจะจัดชิดซ้าย ชิดขวา หรือกึ่งกลางของคอลัมน์
id

string

รหัสที่ไม่ซ้ำกันซึ่งกำหนดให้กับวิดเจ็ตที่ใช้ระบุวิดเจ็ตที่จะเปลี่ยนแปลง รหัสมีจำนวนอักขระสูงสุด 64 ตัวและควรอยู่ในรูปแบบ [a-zA-Z0-9-]+

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
visibility

enum (Visibility)

ระบุว่าจะแสดงหรือซ่อนวิดเจ็ต ค่าเริ่มต้นคือ VISIBLE

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
eventActions[]

object (EventAction)

ระบุการดำเนินการกับเหตุการณ์ที่ทำได้ในวิดเจ็ต

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
วิดเจ็ตมีรายการต่อไปนี้ได้เพียงรายการเดียวเท่านั้น คุณสามารถใช้ช่องวิดเจ็ตหลายช่องเพื่อแสดงรายการเพิ่มเติมได้ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
textParagraph

object (TextParagraph)

แสดงย่อหน้าข้อความ รองรับข้อความที่จัดรูปแบบ HTML แบบง่าย ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริม Google Workspace

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างข้อความตัวหนา

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

object (Image)

แสดงรูปภาพ

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างรูปภาพที่มีข้อความสำรอง

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

object (DecoratedText)

แสดงรายการข้อความที่ตกแต่งแล้ว

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างวิดเจ็ตข้อความที่ตกแต่งแล้วซึ่งแสดงอีเมล

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

object (ButtonList)

รายการปุ่ม

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างปุ่ม 2 ปุ่ม ปุ่มแรกคือปุ่มข้อความสีน้ำเงิน และปุ่มที่ 2 คือปุ่มรูปภาพที่เปิดลิงก์

"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

object (TextInput)

แสดงกล่องข้อความที่ผู้ใช้พิมพ์ได้

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างการป้อนข้อความสำหรับอีเมล

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

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างการป้อนข้อความสำหรับภาษาโปรแกรมที่มีคำแนะนำแบบคงที่

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

object (SelectionInput)

แสดงตัวควบคุมการเลือกที่ให้ผู้ใช้เลือกรายการ การควบคุมการเลือกอาจเป็นช่องทำเครื่องหมาย ปุ่มตัวเลือก สวิตช์ หรือเมนูแบบเลื่อนลง

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างเมนูแบบเลื่อนลงที่ให้ผู้ใช้เลือกขนาดได้

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

object (DateTimePicker)

แสดงวิดเจ็ตที่ให้ผู้ใช้ป้อนวันที่ เวลา หรือวันที่และเวลา

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างเครื่องมือเลือกวันที่และเวลาเพื่อกำหนดเวลานัดหมาย

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

object (Divider)

แสดงเส้นแบ่งแนวนอนระหว่างวิดเจ็ต

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างเส้นแบ่ง

"divider": {
}
grid

object (Grid)

แสดงตารางกริดที่มีคอลเล็กชันของรายการต่างๆ

ตารางกริดรองรับคอลัมน์และรายการจำนวนเท่าใดก็ได้ จำนวนแถวจะกำหนดโดยขอบเขตบนของจำนวนสินค้าหารด้วยจำนวนคอลัมน์ ตารางกริดที่มี 10 รายการและ 2 คอลัมน์จะมี 5 แถว ตารางกริดที่มี 11 รายการและ 2 คอลัมน์จะมี 6 แถว

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างตารางกริด 2 คอลัมน์ที่มีรายการเดียว

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

object (Columns)

แสดงได้สูงสุด 2 คอลัมน์

หากต้องการรวมคอลัมน์มากกว่า 2 คอลัมน์หรือใช้แถว ให้ใช้วิดเจ็ต Grid

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้าง 2 คอลัมน์ที่มีข้อความย่อหน้า

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

object (Carousel)

มีคอลเล็กชันของรายการ CarouselCard ซึ่งแต่ละรายการมีวิดเจ็ตที่ฝังอยู่ ตัวอย่างเช่น ต่อไปนี้คือการแสดง JSON ของภาพสไลด์ที่มีการ์ดภาพสไลด์ 2 ใบ โดยแต่ละใบมีข้อความ 1 ย่อหน้า

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

object (ChipList)

รายการชิป

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างชิป 2 รายการ โดยชิปแรกเป็นชิปข้อความ และชิปที่ 2 เป็นชิปไอคอนที่เปิดลิงก์

"chipList": {
  "chips": [
    {
      "label": "Edit",
      "disabled": true
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
สิ้นสุดฟิลด์ที่แยกกัน

TextParagraph

ย่อหน้าของข้อความที่รองรับการจัดรูปแบบ ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อเพิ่มย่อหน้าของข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริม Google Workspace

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "text": string,
  "maxLines": integer,
  "textSyntax": enum (TextSyntax)
}
ช่อง
text

string

ข้อความที่แสดงในวิดเจ็ต
maxLines

integer

จำนวนบรรทัดสูงสุดของข้อความที่แสดงในวิดเจ็ต หากข้อความเกินจำนวนบรรทัดสูงสุดที่ระบุ เนื้อหาที่เกินมาจะซ่อนอยู่หลังปุ่มแสดงเพิ่มเติม หากข้อความมีจำนวนบรรทัดเท่ากับหรือน้อยกว่าจำนวนบรรทัดสูงสุดที่ระบุ ปุ่มแสดงเพิ่มเติมจะไม่แสดง

ค่าเริ่มต้นคือ 0 ซึ่งในกรณีนี้ระบบจะแสดงบริบททั้งหมด ระบบจะไม่สนใจค่าที่เป็นลบ
textSyntax

enum (TextSyntax)

ไวยากรณ์ของข้อความ หากไม่ได้ตั้งค่า ระบบจะแสดงผลข้อความเป็น HTML

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

TextSyntax

ไวยากรณ์ที่ใช้ในการจัดรูปแบบข้อความ

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

Enum
TEXT_SYNTAX_UNSPECIFIED ระบบจะแสดงผลข้อความเป็น HTML หากไม่ได้ระบุ
HTML ข้อความจะแสดงผลเป็น HTML นี่คือค่าเริ่มต้น
MARKDOWN ข้อความจะแสดงผลเป็นมาร์กดาวน์

รูปภาพ

รูปภาพที่ระบุโดย URL และมีการดำเนินการ onClick ได้ ดูตัวอย่างได้ที่หัวข้อเพิ่มรูปภาพ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}
ช่อง
imageUrl

string

HTTPS URL ที่โฮสต์รูปภาพ

เช่น

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

object (OnClick)

เมื่อผู้ใช้คลิกรูปภาพ การคลิกจะทริกเกอร์การดำเนินการนี้
altText

string

ข้อความแสดงแทนของรูปภาพนี้ที่ใช้สำหรับการช่วยเหลือพิเศษ

DecoratedText

วิดเจ็ตที่แสดงข้อความพร้อมการตกแต่งที่ไม่บังคับ เช่น ป้ายกำกับด้านบนหรือด้านล่างข้อความ ไอคอนด้านหน้าข้อความ วิดเจ็ตการเลือก หรือปุ่มหลังข้อความ ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อแสดงข้อความพร้อมข้อความตกแต่ง

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
}
ช่อง
icon
(deprecated)

object (Icon)

เลิกใช้งานแล้วเพื่อใช้ startIcon แทน
startIcon

object (Icon)

ไอคอนที่แสดงด้านหน้าข้อความ
startIconVerticalAlignment

enum (VerticalAlignment)

ไม่บังคับ การจัดแนวตั้งของไอคอนเริ่มต้น หากไม่ได้ตั้งค่า ไอคอนจะอยู่ตรงกลางในแนวตั้ง

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace
topLabel

string

ข้อความที่ปรากฏเหนือ text ตัดทอนเสมอ
topLabelText

object (TextParagraph)

TextParagraph เทียบเท่ากับ topLabel ตัดทอนเสมอ ช่วยให้จัดรูปแบบได้ซับซ้อนกว่า topLabel

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace
text

string

ต้องระบุ ข้อความหลัก

รองรับการจัดรูปแบบอย่างง่าย ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
contentText

object (TextParagraph)

TextParagraph เทียบเท่ากับ text ช่วยให้จัดรูปแบบได้ซับซ้อนกว่า text

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace
wrapText

boolean

การตั้งค่าการตัดข้อความขึ้นบรรทัดใหม่ หากเป็น true ข้อความจะตัดขึ้นบรรทัดใหม่และแสดงหลายบรรทัด ไม่เช่นนั้น ข้อความจะถูกตัดให้สั้นลง

มีผลกับ text เท่านั้น ไม่มีผลกับ topLabel และ bottomLabel
bottomLabel

string

ข้อความที่ปรากฏใต้ text ตัดขึ้นบรรทัดใหม่เสมอ
bottomLabelText

object (TextParagraph)

TextParagraph เทียบเท่ากับ bottomLabel ตัดขึ้นบรรทัดใหม่เสมอ ช่วยให้จัดรูปแบบได้ซับซ้อนกว่า bottomLabel

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace
onClick

object (OnClick)

ระบบจะเรียกใช้การดำเนินการนี้เมื่อผู้ใช้คลิกที่ใดก็ได้ในวิดเจ็ต DecoratedText (รวมถึง text, topLabel, bottomLabel และไอคอน) ยกเว้นเมื่อคลิกการควบคุมแบบอินเทอร์แอกทีฟแยกต่างหาก (button หรือ switchControl)
ปุ่ม สวิตช์ ช่องทำเครื่องหมาย หรือรูปภาพที่ปรากฏทางด้านขวาของข้อความในวิดเจ็ต decoratedText ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
button

object (Button)

ปุ่มที่ผู้ใช้คลิกเพื่อเรียกให้ดำเนินการได้
switchControl

object (SwitchControl)

วิดเจ็ตสวิตช์ที่ผู้ใช้คลิกเพื่อเปลี่ยนสถานะและทริกเกอร์การดำเนินการได้
endIcon

object (Icon)

ไอคอนที่แสดงหลังข้อความ

รองรับไอคอนในตัวและไอคอนที่กำหนดเอง
สิ้นสุดฟิลด์ที่แยกกัน

VerticalAlignment

แสดงแอตทริบิวต์การจัดแนวตั้ง

Enum
VERTICAL_ALIGNMENT_UNSPECIFIED ประเภทที่ไม่ได้ระบุ โปรดอย่าใช้
TOP การจัดแนวไปที่ตำแหน่งด้านบน
MIDDLE การจัดแนวไปที่ตำแหน่งตรงกลาง
BOTTOM จัดแนวไปที่ตำแหน่งด้านล่าง

SwitchControl

สวิตช์แบบเปิด/ปิดหรือช่องทำเครื่องหมายภายในวิดเจ็ต decoratedText

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

รองรับเฉพาะในวิดเจ็ต decoratedText

การแสดง JSON 
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
ช่อง
name

string

ชื่อที่ใช้ระบุวิดเจ็ตสวิตช์ในเหตุการณ์การป้อนข้อมูลในแบบฟอร์ม (เป็นคีย์ใน CommonEventObject.form_inputs)

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
value

string

ค่าที่แสดงใน CommonEventObject.form_inputs[name].string_inputs เมื่อเลือกสวิตช์ (selected คือ true) หาก selected คือ true และไม่ได้ตั้งค่า value ระบบจะแสดงสตริงว่าง ("") ใน stringInputs.value เมื่อ selected เป็น false ระบบจะไม่รวมค่านี้จาก stringInputs.value

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
selected

boolean

เมื่อtrue สวิตช์จะถูกเลือก และvalueจะรวมอยู่ในCommonEventObject.form_inputs[name].string_inputs.value
onChangeAction

object (Action)

การดำเนินการที่จะทำเมื่อสถานะสวิตช์เปลี่ยนไป เช่น ฟังก์ชันที่จะเรียกใช้
controlType

enum (ControlType)

ลักษณะของสวิตช์ในอินเทอร์เฟซผู้ใช้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

ControlType

ลักษณะของสวิตช์ในอินเทอร์เฟซผู้ใช้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
SWITCH สวิตช์แบบเปิด/ปิด
CHECKBOX เลิกใช้งานแล้วเพื่อใช้ CHECK_BOX แทน
CHECK_BOX ช่องทำเครื่องหมาย

TextInput

ช่องที่ผู้ใช้ป้อนข้อความได้ รองรับคำแนะนำและการดำเนินการเมื่อมีการเปลี่ยนแปลง รองรับการตรวจสอบการส่งแบบฟอร์ม เมื่อตั้งค่า Action.all_widgets_are_required เป็น true หรือมีการระบุวิดเจ็ตนี้ใน Action.required_widgets ระบบจะบล็อกการดำเนินการส่งข้อมูล เว้นแต่จะมีการป้อนค่า ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อเพิ่มช่องที่ผู้ใช้ป้อนข้อความได้

แอปใน Chat จะรับและประมวลผลค่าของข้อความที่ป้อนระหว่างเหตุการณ์การป้อนข้อมูลในแบบฟอร์มได้ ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม

เมื่อต้องการรวบรวมข้อมูลที่ไม่ได้กำหนดหรือข้อมูลนามธรรมจากผู้ใช้ ให้ใช้อินพุตข้อความ หากต้องการรวบรวมข้อมูลที่กำหนดหรือแจกแจงจากผู้ใช้ ให้ใช้วิดเจ็ต SelectionInput

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string,

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
ช่อง
name

string

ชื่อที่ใช้ระบุการป้อนข้อความในเหตุการณ์การป้อนข้อมูลในแบบฟอร์ม

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
label

string

ข้อความที่ปรากฏเหนือช่องป้อนข้อความในอินเทอร์เฟซผู้ใช้

ระบุข้อความที่ช่วยให้ผู้ใช้ป้อนข้อมูลที่แอปต้องการ ตัวอย่างเช่น หากคุณถามชื่อของบุคคลหนึ่ง แต่ต้องการนามสกุลโดยเฉพาะ ให้เขียน surname แทน name

ต้องระบุหากไม่ได้ระบุ hintText ไม่เช่นนั้น ไม่บังคับ
hintText

string

ข้อความที่ปรากฏใต้ช่องป้อนข้อความซึ่งมีไว้เพื่อช่วยเหลือผู้ใช้โดยแจ้งให้ป้อนค่าบางอย่าง ข้อความนี้จะปรากฏอยู่เสมอ

ต้องระบุหากไม่ได้ระบุ label ไม่เช่นนั้น ไม่บังคับ
value

string

ค่าที่ผู้ใช้ป้อน ซึ่งแสดงผลเป็นส่วนหนึ่งของเหตุการณ์การป้อนข้อมูลในแบบฟอร์ม

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
type

enum (Type)

ลักษณะของช่องป้อนข้อความในอินเทอร์เฟซผู้ใช้ เช่น ช่องเป็นแบบบรรทัดเดียวหรือหลายบรรทัด
onChangeAction

object (Action)

สิ่งที่ต้องทำเมื่อมีการเปลี่ยนแปลงในช่องป้อนข้อความ เช่น ผู้ใช้เพิ่มข้อความลงในช่องหรือลบข้อความ

ตัวอย่างการดำเนินการที่ทำได้ ได้แก่ การเรียกใช้ฟังก์ชันที่กำหนดเองหรือการเปิดกล่องโต้ตอบใน Google Chat
initialSuggestions

object (Suggestions)

ค่าที่แนะนำซึ่งผู้ใช้ป้อนได้ ค่าเหล่านี้จะปรากฏขึ้นเมื่อผู้ใช้คลิกภายในช่องป้อนข้อความ ขณะที่ผู้ใช้พิมพ์ ค่าที่แนะนำจะกรองแบบไดนามิกเพื่อให้ตรงกับสิ่งที่ผู้ใช้พิมพ์

ตัวอย่างเช่น ช่องป้อนข้อความสำหรับภาษาโปรแกรมอาจแนะนำ Java, JavaScript, Python และ C++ เมื่อผู้ใช้เริ่มพิมพ์ Jav รายการคำแนะนำจะกรองเพื่อแสดงเฉพาะ Java และ JavaScript

ค่าที่แนะนำจะช่วยแนะนำผู้ใช้ให้ป้อนค่าที่แอปของคุณเข้าใจได้ เมื่อพูดถึง JavaScript ผู้ใช้บางรายอาจป้อน javascript และบางรายอาจป้อน java script การแนะนำ JavaScript จะช่วยกำหนดมาตรฐานวิธีที่ผู้ใช้โต้ตอบกับแอปของคุณได้

เมื่อระบุ TextInput.type จะเป็น SINGLE_LINE เสมอ แม้ว่าจะตั้งค่าเป็น MULTIPLE_LINE ก็ตาม

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace
autoCompleteAction

object (Action)

ไม่บังคับ ระบุการดำเนินการที่จะทำเมื่อช่องป้อนข้อความแสดงคำแนะนำแก่ผู้ใช้ที่โต้ตอบกับช่องดังกล่าว

หากไม่ได้ระบุไว้ initialSuggestions จะเป็นผู้ตั้งค่าคำแนะนำและไคลเอ็นต์จะเป็นผู้ประมวลผล

หากระบุไว้ แอปจะดำเนินการตามที่ระบุไว้ที่นี่ เช่น เรียกใช้ฟังก์ชันที่กำหนดเอง

ใช้ได้กับส่วนเสริม Google Workspace และใช้ไม่ได้กับแอป Google Chat
validation

object (Validation)

ระบุการตรวจสอบความถูกต้องของรูปแบบอินพุตที่จำเป็นสำหรับช่องข้อความนี้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace
placeholderText

string

ข้อความที่ปรากฏในช่องป้อนข้อความเมื่อช่องว่างเปล่า ใช้ข้อความนี้เพื่อแจ้งให้ผู้ใช้ป้อนค่า เช่น Enter a number from 0 to 100

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace
ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
hostAppDataSource

object (HostAppDataSourceMarkup)

แหล่งข้อมูลที่ไม่ซ้ำกันสำหรับแอปพลิเคชันแบบโฮสต์ของ Google Workspace เช่น อีเมล Gmail, กิจกรรมใน Google ปฏิทิน หรือข้อความแชท Google Chat

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
สิ้นสุดฟิลด์ที่แยกกัน

ประเภท

ลักษณะของช่องป้อนข้อความในอินเทอร์เฟซผู้ใช้ เช่น เป็นช่องป้อนข้อมูลบรรทัดเดียวหรือหลายบรรทัด หากระบุ initialSuggestions ไว้ type จะเป็น SINGLE_LINE เสมอ แม้ว่าจะตั้งค่าเป็น MULTIPLE_LINE ก็ตาม

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
SINGLE_LINE ช่องป้อนข้อความมีความสูงคงที่ 1 บรรทัด
MULTIPLE_LINE ช่องป้อนข้อความมีความสูงคงที่หลายบรรทัด

RenderActions

ชุดคำสั่งการแสดงผลที่บอกให้การ์ดดำเนินการ หรือบอกให้แอปโฮสต์ของส่วนเสริมหรือแอป Chat ดำเนินการเฉพาะแอป

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

ช่อง
action

Action

การดำเนินการ

ช่อง
navigations[]

Navigation

พุช ป๊อป หรืออัปเดตการ์ด

ส่วนเสริมใน Google Chat

เพิ่มการ์ดใหม่ลงในกอง (เลื่อนไปข้างหน้า) สำหรับแอปใน Chat จะใช้ได้กับหน้าแรกของแอปเท่านั้น

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

navigations: {
  pushCard: CARD
}

แทนที่การ์ดด้านบนด้วยการ์ดใหม่ สำหรับแอปใน Chat จะใช้ได้กับหน้าแรกของแอปเท่านั้น

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

navigations: {
  updateCard: CARD
}

คำแนะนำ

ค่าที่แนะนำซึ่งผู้ใช้ป้อนได้ ค่าเหล่านี้จะปรากฏขึ้นเมื่อผู้ใช้คลิกภายในช่องป้อนข้อความ ขณะที่ผู้ใช้พิมพ์ ค่าที่แนะนำจะกรองแบบไดนามิกเพื่อให้ตรงกับสิ่งที่ผู้ใช้พิมพ์

ตัวอย่างเช่น ช่องป้อนข้อความสำหรับภาษาโปรแกรมอาจแนะนำ Java, JavaScript, Python และ C++ เมื่อผู้ใช้เริ่มพิมพ์ Jav รายการคำแนะนำจะกรองเพื่อแสดง Java และ JavaScript

ค่าที่แนะนำจะช่วยแนะนำผู้ใช้ให้ป้อนค่าที่แอปของคุณเข้าใจได้ เมื่อพูดถึง JavaScript ผู้ใช้บางรายอาจป้อน javascript และบางรายอาจป้อน java script การแนะนำ JavaScript จะช่วยกำหนดมาตรฐานวิธีที่ผู้ใช้โต้ตอบกับแอปของคุณได้

เมื่อระบุ TextInput.type จะเป็น SINGLE_LINE เสมอ แม้ว่าจะตั้งค่าเป็น MULTIPLE_LINE ก็ตาม

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
ช่อง
items[]

object (SuggestionItem)

รายการคำแนะนำที่ใช้สำหรับคำแนะนำการเติมข้อความอัตโนมัติในช่องป้อนข้อความ

SuggestionItem

ค่าที่แนะนำ 1 ค่าที่ผู้ใช้ป้อนในช่องป้อนข้อความได้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{

  "text": string
}
ช่อง
ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
text

string

ค่าของอินพุตที่แนะนำสำหรับช่องป้อนข้อความ ซึ่งเทียบเท่ากับสิ่งที่ผู้ใช้ป้อนเอง
สิ้นสุดฟิลด์ที่แยกกัน

การตรวจสอบความถูกต้อง

แสดงข้อมูลที่จำเป็นสำหรับการตรวจสอบวิดเจ็ตที่แนบมาด้วย

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
ช่อง
characterLimit

integer

ระบุจำนวนอักขระสูงสุดสำหรับวิดเจ็ตการป้อนข้อความ โปรดทราบว่าระบบจะใช้ค่านี้สำหรับการป้อนข้อความเท่านั้น และจะละเว้นสำหรับวิดเจ็ตอื่นๆ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace
inputType

enum (InputType)

ระบุประเภทของวิดเจ็ตอินพุต

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

InputType

ประเภทของวิดเจ็ตอินพุต

Enum
INPUT_TYPE_UNSPECIFIED ประเภทที่ไม่ได้ระบุ โปรดอย่าใช้
TEXT ข้อความปกติที่ยอมรับอักขระทั้งหมด
INTEGER ค่าจำนวนเต็ม
FLOAT ค่าจำนวนลอยตัว
EMAIL อีเมล
EMOJI_PICKER อีโมจิที่เลือกจากเครื่องมือเลือกอีโมจิที่ระบบมีให้

HostAppDataSourceMarkup

แหล่งข้อมูลจากแอปพลิเคชัน Google Workspace แหล่งข้อมูลจะป้อนข้อมูลรายการที่พร้อมใช้งานสำหรับวิดเจ็ต

การแสดง JSON 
{

  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  },
  "workflowDataSource": {
    object (WorkflowDataSourceMarkup)
  }
}
ช่อง
แอปพลิเคชัน Google Workspace ที่สร้างรายการที่พร้อมใช้งานสำหรับวิดเจ็ต ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
chatDataSource

object (ChatClientDataSourceMarkup)

แหล่งข้อมูลจาก Google Chat
workflowDataSource

object (WorkflowDataSourceMarkup)

แหล่งข้อมูลจาก Google Workflow
สิ้นสุดฟิลด์ที่แยกกัน

ChatClientDataSourceMarkup

สำหรับวิดเจ็ต SelectionInput ที่ใช้เมนูแบบเลือกได้หลายรายการ แหล่งข้อมูลจาก Google Chat แหล่งข้อมูลจะป้อนข้อมูลรายการที่เลือกสำหรับเมนูแบบหลายตัวเลือก เช่น ผู้ใช้สามารถเลือกพื้นที่ทำงานใน Google Chat ที่ตนเป็นสมาชิกอยู่ได้

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

การแสดง JSON 
{

  "spaceDataSource": {
    object (SpaceDataSource)
  }
}
ช่อง
แหล่งข้อมูล Google Chat ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
spaceDataSource

object (SpaceDataSource)

พื้นที่ทำงานใน Google Chat ที่ผู้ใช้เป็นสมาชิก
สิ้นสุดฟิลด์ที่แยกกัน

SpaceDataSource

แหล่งข้อมูลที่ป้อนข้อมูลพื้นที่ทำงาน Google Chat เป็นรายการที่เลือกสำหรับเมนูแบบเลือกได้หลายรายการ แสดงเฉพาะพื้นที่ทำงานที่ผู้ใช้เป็นสมาชิกเท่านั้น

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

การแสดง JSON 
{
  "defaultToCurrentSpace": boolean
}
ช่อง
defaultToCurrentSpace

boolean

หากตั้งค่าเป็น true เมนูแบบเลือกหลายรายการจะเลือกพื้นที่ใน Google Chat ปัจจุบันเป็นรายการโดยค่าเริ่มต้น

WorkflowDataSourceMarkup

* รองรับเฉพาะ Google Workspace Workflow แต่ไม่รองรับแอป Google Chat หรือส่วนเสริม Google Workspace

ในวิดเจ็ต TextInput หรือ SelectionInput ที่มีประเภท MULTI_SELECT หรือ DateTimePicker ให้ระบุแหล่งข้อมูลจาก Google

การแสดง JSON 
{
  "includeVariables": boolean,
  "type": enum (Type)
}
ช่อง
includeVariables

boolean

ระบุว่าจะรวมตัวแปรจากขั้นตอนก่อนหน้าในแหล่งข้อมูลหรือไม่
type

enum (Type)

ประเภทของแหล่งข้อมูล

ประเภท

Enum ที่แสดงประเภทแหล่งข้อมูลของเวิร์กโฟลว์

Enum
UNKNOWN ค่าเริ่มต้น ไม่ใช้
USER ผู้ใช้ Google Workspace ผู้ใช้จะดูและเลือกผู้ใช้จากองค์กร Google Workspace ของตนเองได้เท่านั้น
SPACE พื้นที่ทำงานใน Google Chat ที่ผู้ใช้เป็นสมาชิก
USER_WITH_FREE_FORM ผู้ใช้สามารถเลือกดูและเลือกสมาชิกที่มีอยู่จากองค์กร Google Workspace หรือป้อนอีเมลหรือโดเมนที่ถูกต้องด้วยตนเองได้

SelectionInput

วิดเจ็ตที่สร้างรายการ UI อย่างน้อย 1 รายการที่ผู้ใช้เลือกได้ รองรับการตรวจสอบการส่งแบบฟอร์มสำหรับเมนู dropdown และ multiselect เท่านั้น เมื่อตั้งค่า Action.all_widgets_are_required เป็น true หรือมีการระบุวิดเจ็ตนี้ใน Action.required_widgets ระบบจะบล็อกการดำเนินการส่งข้อมูล เว้นแต่จะมีการเลือกค่าไว้ เช่น เมนูแบบเลื่อนลงหรือช่องทำเครื่องหมาย คุณสามารถใช้วิดเจ็ตนี้เพื่อรวบรวมข้อมูลที่คาดการณ์หรือระบุได้ ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อเพิ่มองค์ประกอบ UI ที่เลือกได้

แอปใน Chat สามารถประมวลผลค่าของรายการที่ผู้ใช้เลือกหรือป้อนได้ ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม

หากต้องการรวบรวมข้อมูลที่ไม่ได้กำหนดหรือข้อมูลนามธรรมจากผู้ใช้ ให้ใช้วิดเจ็ต TextInput

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMinQueryLength": integer,
  "dataSourceConfigs": [
    {
      object (DataSourceConfig)
    }
  ],
  "multiSelectMaxSelectedItems": integer,
  "hintText": string,

  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
}
ช่อง
name

string

ต้องระบุ ชื่อที่ระบุอินพุตการเลือกในเหตุการณ์อินพุตของแบบฟอร์ม

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
label

string

ข้อความที่ปรากฏเหนือช่องป้อนข้อมูลการเลือกในอินเทอร์เฟซผู้ใช้

ระบุข้อความที่ช่วยให้ผู้ใช้ป้อนข้อมูลที่แอปต้องการ เช่น หากผู้ใช้เลือกความเร่งด่วนของตั๋วงานจากเมนูแบบเลื่อนลง ป้ายกำกับอาจเป็น "ความเร่งด่วน" หรือ "เลือกความเร่งด่วน"
type

enum (SelectionType)

ประเภทของรายการที่แสดงต่อผู้ใช้ในวิดเจ็ต SelectionInput ประเภทการเลือกจะรองรับการโต้ตอบประเภทต่างๆ เช่น ผู้ใช้สามารถเลือกช่องทำเครื่องหมายได้หลายช่อง แต่จะเลือกค่าจากเมนูแบบเลื่อนลงได้เพียงค่าเดียว
items[]

object (SelectionItem)

อาร์เรย์ของรายการที่เลือกได้ เช่น อาร์เรย์ของปุ่มตัวเลือกหรือช่องทำเครื่องหมาย รองรับได้สูงสุด 100 รายการ
onChangeAction

object (Action)

หากระบุ ระบบจะส่งแบบฟอร์มเมื่อการเลือกมีการเปลี่ยนแปลง หากไม่ได้ระบุ คุณต้องระบุปุ่มแยกต่างหากที่ส่งแบบฟอร์ม

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
multiSelectMinQueryLength

integer

สำหรับเมนูแบบเลือกได้หลายรายการ จำนวนอักขระข้อความที่ผู้ใช้ป้อนก่อนที่เมนูจะแสดงรายการตัวเลือกที่แนะนำ

หากไม่ได้ตั้งค่า เมนูแบบเลือกได้หลายรายการจะใช้ค่าเริ่มต้นต่อไปนี้

  • หากเมนูใช้อาร์เรย์แบบคงที่ของรายการ SelectionInput รายการ ระบบจะใช้ค่าเริ่มต้นเป็น 0 อักขระและป้อนข้อมูลรายการจากอาร์เรย์ทันที
  • หากเมนูใช้แหล่งข้อมูลแบบไดนามิก (multi_select_data_source) ระบบจะใช้ค่าเริ่มต้นเป็น 3 อักขระก่อนค้นหาแหล่งข้อมูลเพื่อแสดงรายการที่แนะนำ
dataSourceConfigs[]

object (DataSourceConfig)

ไม่บังคับ การกำหนดค่าแหล่งข้อมูลสำหรับการควบคุมการเลือก ช่องนี้ช่วยให้ควบคุมแหล่งข้อมูลได้ละเอียดยิ่งขึ้น

หากระบุ ระบบจะไม่สนใจช่อง multiSelectMaxSelectedItems, ช่อง multiSelectMinQueryLength, ช่อง externalDataSource และช่อง platformDataSource

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio

พร้อมใช้งานสำหรับแอป Dropdown widget ใน Google Chat สำหรับวิดเจ็ต Dropdown ในแอป Google Chat ระบบจะรองรับ DataSourceConfig เพียงรายการเดียวเท่านั้น หากตั้งค่า DataSourceConfig ไว้หลายรายการ ระบบจะใช้เฉพาะรายการแรกเท่านั้น
multiSelectMaxSelectedItems

integer

สำหรับเมนูแบบเลือกได้หลายรายการ จำนวนรายการสูงสุดที่ผู้ใช้เลือกได้ ค่าต่ำสุดคือ 1 รายการ หากไม่ได้ระบุไว้ ค่าเริ่มต้นจะเป็น 3 รายการ
hintText

string

ไม่บังคับ ข้อความที่ปรากฏใต้ช่องป้อนข้อมูลการเลือกซึ่งมีไว้เพื่อช่วยเหลือผู้ใช้โดยแจ้งให้ป้อนค่าบางอย่าง ข้อความนี้จะปรากฏอยู่เสมอ

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

สำหรับเมนูแบบเลือกได้หลายรายการ แหล่งข้อมูลที่สร้างรายการที่เลือกแบบไดนามิก

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
externalDataSource

object (Action)

แหล่งข้อมูลภายนอก เช่น ฐานข้อมูลเชิงสัมพันธ์
platformDataSource

object (PlatformDataSource)

แหล่งข้อมูลจาก Google Workspace
สิ้นสุดฟิลด์ที่แยกกัน

SelectionType

รูปแบบของรายการที่ผู้ใช้เลือกได้ ตัวเลือกต่างๆ รองรับการโต้ตอบประเภทต่างๆ เช่น ผู้ใช้สามารถเลือกช่องทำเครื่องหมายได้หลายช่อง แต่เลือกได้เพียงรายการเดียวจากเมนูแบบเลื่อนลง

อินพุตการเลือกแต่ละรายการรองรับการเลือก 1 ประเภท เช่น ไม่รองรับการใช้ช่องทำเครื่องหมายและสวิตช์ร่วมกัน

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
CHECK_BOX ชุดช่องทำเครื่องหมาย ผู้ใช้เลือกช่องทำเครื่องหมายได้มากกว่า 1 ช่อง
RADIO_BUTTON ชุดปุ่มตัวเลือก ผู้ใช้เลือกปุ่มตัวเลือกได้ 1 ปุ่ม
SWITCH ชุดสวิตช์ ผู้ใช้สามารถเปิดสวิตช์อย่างน้อย 1 รายการ
DROPDOWN

เมนูแบบเลื่อนลง ผู้ใช้เลือกได้ 1 รายการจากเมนู

สำหรับแอป Google Chat คุณสามารถป้อนข้อมูลรายการโดยใช้แหล่งข้อมูลแบบไดนามิกและแนะนำรายการโดยอัตโนมัติเมื่อผู้ใช้พิมพ์ในเมนู เช่น ผู้ใช้สามารถเริ่มพิมพ์ชื่อพื้นที่ทำงานใน Google Chat แล้ววิดเจ็ตจะแนะนำพื้นที่ทำงานโดยอัตโนมัติ หากต้องการป้อนข้อมูลรายการสำหรับเมนูแบบเลื่อนลงแบบไดนามิก ให้ใช้แหล่งข้อมูลประเภทใดประเภทหนึ่งต่อไปนี้

  • ข้อมูล Google Workspace: ระบบจะป้อนข้อมูลรายการโดยใช้ข้อมูลจาก Google Workspace เช่น ผู้ใช้ Google Workspace หรือพื้นที่ทำงานใน Google Chat
  • ข้อมูลภายนอก: รายการจะป้อนข้อมูลจากแหล่งข้อมูลภายนอก Google Workspace

ดูตัวอย่างวิธีใช้เมนูแบบเลื่อนลงสำหรับแอปใน Chat ได้ที่หัวข้อเพิ่มเมนูแบบเลื่อนลงและสร้างเมนูแบบเลื่อนลงแบบไดนามิก

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace
MULTI_SELECT

เมนูที่มีกล่องข้อความ ผู้ใช้สามารถพิมพ์และเลือกรายการอย่างน้อย 1 รายการ สำหรับส่วนเสริมของ Google Workspace คุณต้องป้อนข้อมูลรายการโดยใช้อาร์เรย์แบบคงที่ของออบเจ็กต์ SelectionItem

สำหรับแอป Google Chat คุณยังป้อนข้อมูลรายการโดยใช้แหล่งข้อมูลแบบไดนามิกและรายการแนะนำอัตโนมัติเมื่อผู้ใช้พิมพ์ในเมนูได้ด้วย เช่น ผู้ใช้สามารถเริ่มพิมพ์ชื่อพื้นที่ทำงานใน Google Chat แล้ววิดเจ็ตจะแนะนำพื้นที่ทำงานโดยอัตโนมัติ หากต้องการสร้างรายการสำหรับเมนูแบบเลือกหลายรายการแบบไดนามิก ให้ใช้แหล่งข้อมูลประเภทใดประเภทหนึ่งต่อไปนี้

  • ข้อมูล Google Workspace: ระบบจะป้อนข้อมูลรายการโดยใช้ข้อมูลจาก Google Workspace เช่น ผู้ใช้ Google Workspace หรือพื้นที่ทำงานใน Google Chat
  • ข้อมูลภายนอก: รายการจะป้อนข้อมูลจากแหล่งข้อมูลภายนอก Google Workspace

ดูตัวอย่างวิธีใช้เมนูแบบหลายตัวเลือกสำหรับแอปใน Chat ได้ที่หัวข้อเพิ่มเมนูแบบหลายตัวเลือก

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

PlatformDataSource

สำหรับวิดเจ็ต SelectionInput ที่ใช้เมนูแบบเลือกได้หลายรายการ แหล่งข้อมูลจาก Google Workspace ใช้เพื่อป้อนข้อมูลรายการในเมนูแบบเลือกได้หลายรายการ

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

การแสดง JSON 
{

  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
ช่อง
แหล่งข้อมูล ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
commonDataSource

enum (CommonDataSource)

แหล่งข้อมูลที่แอปพลิเคชัน Google Workspace ทั้งหมดใช้ร่วมกัน เช่น ผู้ใช้ในองค์กร Google Workspace
hostAppDataSource

object (HostAppDataSourceMarkup)

แหล่งข้อมูลที่ไม่ซ้ำกันสำหรับแอปพลิเคชันแบบโฮสต์ของ Google Workspace เช่น พื้นที่ทำงานใน Google Chat

ช่องนี้รองรับไลบรารีของไคลเอ็นต์ Google API แต่ไม่พร้อมใช้งานในไลบรารีของไคลเอ็นต์ระบบคลาวด์ ดูข้อมูลเพิ่มเติมได้ที่ติดตั้งไลบรารีของไคลเอ็นต์
สิ้นสุดฟิลด์ที่แยกกัน

CommonDataSource

แหล่งข้อมูลที่แชร์โดยแอปพลิเคชัน Google Workspace ทั้งหมด

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

Enum
UNKNOWN ค่าเริ่มต้น ไม่ใช้
USER ผู้ใช้ Google Workspace ผู้ใช้จะดูและเลือกผู้ใช้จากองค์กร Google Workspace ของตนเองได้เท่านั้น

DataSourceConfig

ออบเจ็กต์การกำหนดค่าที่ช่วยกำหนดค่าแหล่งข้อมูลสำหรับวิดเจ็ต

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio

การแสดง JSON 
{

  "remoteDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  "minCharactersTrigger": integer
}
ช่อง
แหล่งข้อมูล ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
remoteDataSource

object (Action)

ข้อมูลมาจากผู้ให้บริการข้อมูลระยะไกล
platformDataSource

object (PlatformDataSource)

ข้อมูลมาจากแอปพลิเคชัน Google Workspace
สิ้นสุดฟิลด์ที่แยกกัน
minCharactersTrigger

integer

จำนวนอักขระขั้นต่ำที่ผู้ใช้ต้องป้อนก่อนที่ผู้ให้บริการข้อมูลนี้จะถูกเรียกให้แสดงผล (เช่น ก่อนที่จะเริ่มแสดงผลลัพธ์)

DateTimePicker

อนุญาตให้ผู้ใช้ป้อนวันที่ เวลา หรือทั้งวันที่และเวลา รองรับการตรวจสอบการส่งแบบฟอร์ม เมื่อตั้งค่า Action.all_widgets_are_required เป็น true หรือมีการระบุวิดเจ็ตนี้ใน Action.required_widgets ระบบจะบล็อกการดำเนินการส่งข้อมูล เว้นแต่จะมีการเลือกค่าไว้ ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้ออนุญาตให้ผู้ใช้เลือกวันที่และเวลา

ผู้ใช้สามารถป้อนข้อความหรือใช้เครื่องมือเลือกเพื่อเลือกวันที่และเวลาได้ หากผู้ใช้ป้อนวันที่หรือเวลาที่ไม่ถูกต้อง เครื่องมือเลือกจะแสดงข้อผิดพลาดที่แจ้งให้ผู้ใช้ป้อนข้อมูลให้ถูกต้อง

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
ช่อง
name

string

ชื่อที่ใช้ระบุ DateTimePicker ในเหตุการณ์การป้อนข้อมูลในแบบฟอร์ม

ดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตของแบบฟอร์มได้ที่หัวข้อรับข้อมูลแบบฟอร์ม
label

string

ข้อความที่แจ้งให้ผู้ใช้ป้อนวันที่ เวลา หรือวันที่และเวลา เช่น หากผู้ใช้กำลังนัดหมาย ให้ใช้ป้ายกำกับ เช่น Appointment date หรือ Appointment date and time
type

enum (DateTimePickerType)

ระบุว่าวิดเจ็ตรองรับการป้อนวันที่ เวลา หรือวันที่และเวลาหรือไม่
valueMsEpoch

string (int64 format)

ค่าเริ่มต้นที่แสดงในวิดเจ็ตในหน่วยมิลลิวินาทีนับตั้งแต่เวลา 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

integer

ตัวเลขที่แสดงถึงค่าชดเชยเขตเวลาจาก UTC เป็นนาที หากตั้งค่าไว้ valueMsEpoch จะแสดงในเขตเวลาที่ระบุ หากไม่ได้ตั้งค่าไว้ ค่าเริ่มต้นจะเป็นการตั้งค่าเขตเวลาของผู้ใช้

หมายเหตุ: ช่องนี้มีหน่วยเป็นนาที ในขณะที่เพย์โหลดเหตุการณ์การโต้ตอบของผู้ใช้มักจะระบุการชดเชยเขตเวลาเป็นมิลลิวินาที (หารด้วย 60000 เพื่อแปลง)
onChangeAction

object (Action)

ทริกเกอร์เมื่อผู้ใช้คลิกบันทึกหรือล้างจากอินเทอร์เฟซ DateTimePicker
แหล่งข้อมูลที่ระบุเพื่อแสดงวันที่และเวลา ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
hostAppDataSource

object (HostAppDataSourceMarkup)

แหล่งข้อมูลที่ไม่ซ้ำกันสำหรับแอปพลิเคชันแบบโฮสต์ของ Google Workspace เช่น อีเมล Gmail, กิจกรรมใน Google ปฏิทิน หรือข้อความแชท Google Chat

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
สิ้นสุดฟิลด์ที่แยกกัน

DateTimePickerType

รูปแบบวันที่และเวลาในวิดเจ็ต DateTimePicker กำหนดว่าผู้ใช้จะป้อนวันที่ เวลา หรือทั้งวันที่และเวลาได้หรือไม่

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
DATE_AND_TIME ผู้ใช้ป้อนวันที่และเวลา
DATE_ONLY ผู้ใช้ป้อนวันที่
TIME_ONLY ผู้ใช้ป้อนเวลา

ตัวแบ่ง

ประเภทนี้ไม่มีฟิลด์

แสดงตัวแบ่งระหว่างวิดเจ็ตเป็นเส้นแนวนอน ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อเพิ่มตัวแบ่งแนวนอนระหว่างวิดเจ็ต

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

ตัวอย่างเช่น JSON ต่อไปนี้จะสร้างเส้นแบ่ง

"divider": {}

GRid

แสดงตารางกริดที่มีคอลเล็กชันของรายการต่างๆ รายการมีได้เฉพาะข้อความหรือรูปภาพเท่านั้น สำหรับคอลัมน์ที่ปรับเปลี่ยนตามอุปกรณ์ หรือหากต้องการรวมมากกว่าข้อความหรือรูปภาพ ให้ใช้ 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"
    }
  }
}
การแสดง JSON 
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
ช่อง
title

string

ข้อความที่แสดงในส่วนหัวของตารางกริด
items[]

object (GridItem)

รายการที่จะแสดงในตารางกริด
borderStyle

object (BorderStyle)

รูปแบบเส้นขอบที่จะใช้กับรายการตารางกริดแต่ละรายการ
columnCount

integer

จำนวนคอลัมน์ที่จะแสดงในตารางกริด ระบบจะใช้ค่าเริ่มต้นหากไม่ได้ระบุช่องนี้ และค่าเริ่มต้นนั้นจะแตกต่างกันไปตามตำแหน่งที่แสดงตารางกริด (กล่องโต้ตอบเทียบกับโฆษณาที่แสดงร่วม)
onClick

object (OnClick)

รายการตารางกริดแต่ละรายการจะใช้ Callback นี้ซ้ำ แต่จะเพิ่มตัวระบุของรายการลงในพารามิเตอร์ของ Callback (ภายใต้คีย์ "grid_item_identifier")

GridItem

แสดงรายการในเลย์เอาต์ตารางกริด รายการอาจมีข้อความ รูปภาพ หรือทั้งข้อความและรูปภาพ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
ช่อง
id

string

ตัวระบุที่ผู้ใช้ระบุสำหรับรายการตารางกริดนี้ ระบบจะแสดงผลตัวระบุนี้ในพารามิเตอร์ Callback onClick ของตารางกริดหลัก
image

object (ImageComponent)

รูปภาพที่แสดงในรายการตารางกริด
title

string

ชื่อของรายการในตารางกริด
subtitle

string

ชื่อรองของรายการตารางกริด
layout

enum (GridItemLayout)

เลย์เอาต์ที่จะใช้สำหรับรายการตารางกริด

ImageComponent

แสดงรูปภาพ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
ช่อง
imageUri

string

URL ของรูปภาพ
altText

string

ป้ายกำกับสำหรับการช่วยเหลือพิเศษของรูปภาพ
cropStyle

object (ImageCropStyle)

รูปแบบการครอบตัดที่จะใช้กับรูปภาพ
borderStyle

object (BorderStyle)

รูปแบบเส้นขอบที่จะใช้กับรูปภาพ

ImageCropStyle

แสดงถึงรูปแบบการครอบตัดที่ใช้กับรูปภาพ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

ตัวอย่างวิธีใช้สัดส่วนภาพ 16:9 มีดังนี้

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
การแสดง JSON 
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
ช่อง
type

enum (ImageCropType)

ประเภทพืชผล
aspectRatio

number

สัดส่วนภาพที่จะใช้หากประเภทการครอบตัดคือ 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

BorderStyle

ตัวเลือกรูปแบบสำหรับเส้นขอบของการ์ดหรือวิดเจ็ต ซึ่งรวมถึงประเภทและสีของเส้นขอบ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
ช่อง
type

enum (BorderType)

ประเภทเส้นขอบ
strokeColor

object (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

integer

รัศมีมุมของเส้นขอบ

BorderType

แสดงประเภทเส้นขอบที่ใช้กับวิดเจ็ต

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
BORDER_TYPE_UNSPECIFIED ไม่ใช้ ไม่ระบุ
NO_BORDER ไม่มีเส้นขอบ
STROKE ค่าเริ่มต้น Outline

GridItemLayout

แสดงตัวเลือกเลย์เอาต์ต่างๆ ที่ใช้ได้สำหรับรายการตารางกริด

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
GRID_ITEM_LAYOUT_UNSPECIFIED ไม่ใช้ ไม่ระบุ
TEXT_BELOW ชื่อและคำบรรยายจะแสดงอยู่ใต้รูปภาพของรายการในตารางกริด
TEXT_ABOVE ชื่อและคำบรรยายจะแสดงเหนือรูปภาพของรายการในตารางกริด

คอลัมน์

วิดเจ็ต Columns จะแสดงคอลัมน์ได้สูงสุด 2 คอลัมน์ในการ์ดหรือกล่องโต้ตอบ คุณสามารถเพิ่มวิดเจ็ตลงในแต่ละคอลัมน์ได้ โดยวิดเจ็ตจะปรากฏตามลำดับที่ระบุไว้ ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อแสดงการ์ดและกล่องโต้ตอบในคอลัมน์

ความสูงของแต่ละคอลัมน์จะกำหนดโดยคอลัมน์ที่สูงกว่า เช่น หากคอลัมน์แรกสูงกว่าคอลัมน์ที่ 2 ทั้ง 2 คอลัมน์จะมีความสูงเท่ากับคอลัมน์แรก เนื่องจากแต่ละคอลัมน์มีวิดเจ็ตได้หลายรายการ คุณจึงกำหนดแถวหรือจัดแนววิดเจ็ตระหว่างคอลัมน์ไม่ได้

คอลัมน์จะแสดงเคียงข้างกัน คุณปรับแต่งความกว้างของแต่ละคอลัมน์ได้โดยใช้ช่อง HorizontalSizeStyle หากหน้าจอของผู้ใช้แคบเกินไป คอลัมน์ที่ 2 จะตัดขึ้นบรรทัดใหม่ใต้คอลัมน์แรก ดังนี้

  • ในเว็บ คอลัมน์ที่ 2 จะตัดขึ้นบรรทัดใหม่หากความกว้างของหน้าจอน้อยกว่าหรือเท่ากับ 480 พิกเซล
  • ในอุปกรณ์ iOS คอลัมน์ที่ 2 จะตัดขึ้นบรรทัดใหม่หากความกว้างของหน้าจอน้อยกว่าหรือเท่ากับ 300 pt
  • ในอุปกรณ์ Android คอลัมน์ที่ 2 จะตัดขึ้นบรรทัดใหม่หากความกว้างของหน้าจอน้อยกว่าหรือเท่ากับ 320 dp

หากต้องการรวมคอลัมน์มากกว่า 2 คอลัมน์หรือใช้แถว ให้ใช้วิดเจ็ต Grid

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace UI ของส่วนเสริมที่รองรับคอลัมน์มีดังนี้

  • กล่องโต้ตอบที่แสดงเมื่อผู้ใช้เปิดส่วนเสริมจากอีเมลฉบับร่าง
  • กล่องโต้ตอบที่แสดงเมื่อผู้ใช้เปิดส่วนเสริมจากเมนูเพิ่มไฟล์แนบในกิจกรรมใน Google ปฏิทิน
การแสดง JSON 
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
ช่อง
columnItems[]

object (Column)

อาร์เรย์ของคอลัมน์ คุณใส่คอลัมน์ในการ์ดหรือกล่องโต้ตอบได้สูงสุด 2 คอลัมน์

คอลัมน์

คอลัมน์

ส่วนเสริมของ Google Workspace และแอปใน Chat

การแสดง JSON 
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
ช่อง
horizontalSizeStyle

enum (HorizontalSizeStyle)

ระบุวิธีที่คอลัมน์จะเติมความกว้างของการ์ด
horizontalAlignment

enum (HorizontalAlignment)

ระบุว่าวิดเจ็ตจะจัดชิดซ้าย ชิดขวา หรือกึ่งกลางของคอลัมน์
verticalAlignment

enum (VerticalAlignment)

ระบุว่าวิดเจ็ตจะจัดชิดด้านบน ด้านล่าง หรือกึ่งกลางของคอลัมน์
widgets[]

object (Widgets)

อาร์เรย์ของวิดเจ็ตที่รวมอยู่ในคอลัมน์ วิดเจ็ตจะปรากฏตามลำดับที่ระบุไว้

HorizontalSizeStyle

ระบุวิธีที่คอลัมน์จะเติมความกว้างของการ์ด ความกว้างของแต่ละคอลัมน์จะขึ้นอยู่กับทั้ง HorizontalSizeStyle และความกว้างของวิดเจ็ตภายในคอลัมน์

ส่วนเสริมของ Google Workspace และแอปใน Chat

Enum
HORIZONTAL_SIZE_STYLE_UNSPECIFIED ไม่ใช้ ไม่ระบุ
FILL_AVAILABLE_SPACE ค่าเริ่มต้น คอลัมน์จะเติมพื้นที่ที่ใช้ได้สูงสุด 70% ของความกว้างของการ์ด หากตั้งค่าทั้ง 2 คอลัมน์เป็น FILL_AVAILABLE_SPACE แต่ละคอลัมน์จะใช้พื้นที่ 50%
FILL_MINIMUM_SPACE คอลัมน์จะใช้พื้นที่น้อยที่สุดเท่าที่จะเป็นไปได้ และไม่เกิน 30% ของความกว้างของการ์ด

HorizontalAlignment

ระบุว่าวิดเจ็ตจะจัดชิดซ้าย ชิดขวา หรือกึ่งกลางของคอลัมน์

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

Enum
HORIZONTAL_ALIGNMENT_UNSPECIFIED ไม่ใช้ ไม่ระบุ
START ค่าเริ่มต้น จัดแนววิดเจ็ตให้อยู่ที่ตำแหน่งเริ่มต้นของคอลัมน์ สำหรับเลย์เอาต์จากซ้ายไปขวา ให้จัดชิดซ้าย สำหรับเลย์เอาต์จากขวาไปซ้าย ให้จัดชิดขวา
CENTER จัดแนววิดเจ็ตให้อยู่ตรงกลางคอลัมน์
END จัดแนววิดเจ็ตให้อยู่ที่ตำแหน่งท้ายสุดของคอลัมน์ สำหรับเลย์เอาต์จากซ้ายไปขวา ให้จัดแนววิดเจ็ตไปทางขวา สำหรับเลย์เอาต์จากขวาไปซ้าย ให้จัดแนววิดเจ็ตไปทางซ้าย

VerticalAlignment

ระบุว่าวิดเจ็ตจะจัดชิดด้านบน ด้านล่าง หรือกึ่งกลางของคอลัมน์

ส่วนเสริมของ Google Workspace และแอปใน Chat

Enum
VERTICAL_ALIGNMENT_UNSPECIFIED ไม่ใช้ ไม่ระบุ
CENTER ค่าเริ่มต้น จัดแนววิดเจ็ตให้อยู่ตรงกลางคอลัมน์
TOP จัดแนววิดเจ็ตให้อยู่ด้านบนของคอลัมน์
BOTTOM จัดแนววิดเจ็ตให้อยู่ด้านล่างของคอลัมน์

วิดเจ็ต

วิดเจ็ตที่รองรับซึ่งคุณรวมไว้ในคอลัมน์ได้

ส่วนเสริมของ Google Workspace และแอปใน Chat

การแสดง JSON 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
}
ช่อง
ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
textParagraph

object (TextParagraph)

วิดเจ็ต TextParagraph
image

object (Image)

วิดเจ็ต Image
decoratedText

object (DecoratedText)

วิดเจ็ต DecoratedText
buttonList

object (ButtonList)

วิดเจ็ต ButtonList
textInput

object (TextInput)

วิดเจ็ต TextInput
selectionInput

object (SelectionInput)

วิดเจ็ต SelectionInput
dateTimePicker

object (DateTimePicker)

วิดเจ็ต DateTimePicker
chipList

object (ChipList)

วิดเจ็ต ChipList
สิ้นสุดฟิลด์ที่แยกกัน

ChipList

รายการชิปที่จัดวางในแนวนอน ซึ่งสามารถเลื่อนในแนวนอนหรือตัดขึ้นบรรทัดใหม่ก็ได้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
ช่อง
layout

enum (Layout)

เลย์เอาต์แบบรายการชิปที่ระบุ
chips[]

object (Chip)

อาร์เรย์ของชิป

เลย์เอาต์

เลย์เอาต์แบบรายการชิป

Enum
LAYOUT_UNSPECIFIED ไม่ใช้ ไม่ระบุ
WRAPPED ค่าเริ่มต้น รายการชิปจะตัดขึ้นบรรทัดใหม่หากมีพื้นที่แนวนอนไม่เพียงพอ
HORIZONTAL_SCROLLABLE ชิปจะเลื่อนในแนวนอนหากไม่พอดีกับพื้นที่ที่มีอยู่

ชิป

ชิปข้อความ ไอคอน หรือข้อความและไอคอนที่ผู้ใช้คลิกได้

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
ช่อง
icon

object (Icon)

รูปภาพไอคอน หากตั้งค่าทั้ง icon และ label ไอคอนจะปรากฏก่อนป้ายกำกับ
label

string

ข้อความที่แสดงภายในชิป
onClick

object (OnClick)

ไม่บังคับ การดำเนินการที่จะทำเมื่อผู้ใช้คลิกชิป เช่น การเปิดไฮเปอร์ลิงก์หรือการเรียกใช้ฟังก์ชันที่กำหนดเอง
enabled
(deprecated)

boolean

เลิกใช้งานแล้ว: โปรดใช้ disabled แทน

ชิปอยู่ในสถานะใช้งานอยู่และตอบสนองต่อการดำเนินการของผู้ใช้หรือไม่
disabled

boolean

ชิปอยู่ในสถานะไม่ทำงานและไม่สนใจการดำเนินการของผู้ใช้หรือไม่ ค่าเริ่มต้นคือ false
altText

string

ข้อความสำรองที่ใช้สำหรับการช่วยเหลือพิเศษ

ตั้งค่าข้อความอธิบายที่ช่วยให้ผู้ใช้ทราบว่าชิปทำอะไรได้บ้าง เช่น หากชิปเปิดไฮเปอร์ลิงก์ ให้เขียนว่า "เปิดแท็บเบราว์เซอร์ใหม่และไปยังเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ Google Chat ที่ https://developers.google.com/workspace/chat"

CarouselCard

การ์ดที่แสดงเป็นรายการภาพสไลด์ได้ ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

การแสดง JSON 
{
  "widgets": [
    {
      object (NestedWidget)
    }
  ],
  "footerWidgets": [
    {
      object (NestedWidget)
    }
  ]
}
ช่อง
widgets[]

object (NestedWidget)

รายการวิดเจ็ตที่แสดงในการ์ดภาพสไลด์ วิดเจ็ตจะแสดงตามลำดับที่ระบุไว้
footerWidgets[]

object (NestedWidget)

รายการวิดเจ็ตที่แสดงที่ด้านล่างของการ์ดภาพสไลด์ วิดเจ็ตจะแสดงตามลำดับที่ระบุไว้

NestedWidget

รายการวิดเจ็ตที่แสดงได้ในเลย์เอาต์ที่มี เช่น CarouselCard ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

การแสดง JSON 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
}
ช่อง
ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
textParagraph

object (TextParagraph)

วิดเจ็ตย่อหน้าข้อความ
buttonList

object (ButtonList)

วิดเจ็ตรายการปุ่ม
image

object (Image)

วิดเจ็ตรูปภาพ
สิ้นสุดฟิลด์ที่แยกกัน

ระดับการแชร์

ระบุว่าองค์ประกอบ UI แสดงหรือซ่อนอยู่

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

Enum
VISIBILITY_UNSPECIFIED ระดับการเข้าถึงที่ไม่ได้ระบุ โปรดอย่าใช้
VISIBLE องค์ประกอบ UI จะปรากฏขึ้น
HIDDEN องค์ประกอบ UI ถูกซ่อนอยู่

EventAction

แสดงการดำเนินการที่ทำได้ในองค์ประกอบ UI

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "actionRuleId": string,
  "postEventTriggers": [
    {
      object (Trigger)
    }
  ],

  "commonWidgetAction": {
    object (CommonWidgetAction)
  }
}
ช่อง
actionRuleId

string

ตัวระบุที่ไม่ซ้ำกันของ ActionRule
postEventTriggers[]

object (Trigger)

รายการทริกเกอร์ที่จะทริกเกอร์หลังจากเรียกใช้ EventAction
การดำเนินการที่ต้องการทำ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
commonWidgetAction

object (CommonWidgetAction)

การดำเนินการทั่วไปของวิดเจ็ต
สิ้นสุดฟิลด์ที่แยกกัน

ทริกเกอร์

แสดงถึงทริกเกอร์

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "actionRuleId": string
}
ช่อง
actionRuleId

string

ตัวระบุที่ไม่ซ้ำกันของ ActionRule

CommonWidgetAction

แสดงถึงการดำเนินการที่ไม่ได้เจาะจงวิดเจ็ต

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{

  "updateVisibilityAction": {
    object (UpdateVisibilityAction)
  }
}
ช่อง
การดำเนินการที่ต้องการทำ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
updateVisibilityAction

object (UpdateVisibilityAction)

การดำเนินการเพื่ออัปเดตระดับการเข้าถึงของวิดเจ็ต
สิ้นสุดฟิลด์ที่แยกกัน

UpdateVisibilityAction

แสดงการดำเนินการที่อัปเดตระดับการเข้าถึงของวิดเจ็ต

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "visibility": enum (Visibility)
}
ช่อง
visibility

enum (Visibility)

ระดับการเข้าถึงใหม่

CollapseControl

แสดงการควบคุมการขยายและยุบ

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
ช่อง
horizontalAlignment

enum (HorizontalAlignment)

การจัดแนวแนวนอนของปุ่มขยายและยุบ
expandButton

object (Button)

ไม่บังคับ กำหนดปุ่มที่ปรับแต่งได้เพื่อขยายส่วนดังกล่าว ต้องตั้งค่าทั้งช่อง expandButton และ collapseButton การตั้งค่าเพียงช่องเดียวจะไม่มีผล หากไม่ได้ตั้งค่าช่องนี้ ระบบจะใช้ปุ่มเริ่มต้น
collapseButton

object (Button)

ไม่บังคับ กำหนดปุ่มที่ปรับแต่งได้เพื่อยุบส่วนนี้ ต้องตั้งค่าทั้งช่อง expandButton และ collapseButton การตั้งค่าเพียงช่องเดียวจะไม่มีผล หากไม่ได้ตั้งค่าช่องนี้ ระบบจะใช้ปุ่มเริ่มต้น

DividerStyle

รูปแบบตัวแบ่งของการ์ด ปัจจุบันใช้เป็นตัวแบ่งระหว่างส่วนต่างๆ ของการ์ดเท่านั้น

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

Enum
DIVIDER_STYLE_UNSPECIFIED ไม่ใช้ ไม่ระบุ
SOLID_DIVIDER ตัวเลือกเริ่มต้น แสดงตัวแบ่งทึบ
NO_DIVIDER หากตั้งค่าไว้ ระบบจะไม่แสดงตัวแบ่ง รูปแบบนี้จะนำเส้นแบ่งออกจากเลย์เอาต์โดยสมบูรณ์ ซึ่งผลลัพธ์จะเทียบเท่ากับการไม่เพิ่มตัวแบ่งเลย

CardAction

การดำเนินการกับการ์ดคือการดำเนินการที่เชื่อมโยงกับการ์ด ตัวอย่างเช่น การ์ดใบแจ้งหนี้อาจมีการดำเนินการต่างๆ เช่น ลบใบแจ้งหนี้ ส่งใบแจ้งหนี้ทางอีเมล หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์

ใช้ได้กับส่วนเสริม Google Workspace และใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
ช่อง
actionLabel

string

ป้ายกำกับที่แสดงเป็นรายการเมนูการทำงาน
onClick

object (OnClick)

การดำเนินการ onClick สำหรับรายการการทำงานนี้

CardFixedFooter

ส่วนท้ายแบบถาวร (ติดหนึบ) ที่ปรากฏที่ด้านล่างของการ์ด

การตั้งค่า fixedFooter โดยไม่ระบุ primaryButton หรือ secondaryButton จะทำให้เกิดข้อผิดพลาด

สำหรับแอปใน Chat คุณสามารถใช้ส่วนท้ายแบบคงที่ในกล่องโต้ตอบได้ แต่จะใช้ในข้อความการ์ดไม่ได้ ดูตัวอย่างในแอป Google Chat ได้ที่หัวข้อเพิ่มส่วนท้ายแบบถาวร

พร้อมใช้งานสำหรับแอป Google Chat และส่วนเสริม Google Workspace

การแสดง JSON 
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
ช่อง
primaryButton

object (Button)

ปุ่มหลักของส่วนท้ายแบบคงที่ ปุ่มต้องเป็นปุ่มข้อความที่มีข้อความและชุดสี
secondaryButton

object (Button)

ปุ่มรองของส่วนท้ายแบบคงที่ ปุ่มต้องเป็นปุ่มข้อความที่มีการตั้งค่าข้อความและสี หากตั้งค่า secondaryButton คุณต้องตั้งค่า primaryButton ด้วย

DisplayStyle

ในส่วนเสริมของ Google Workspace จะกำหนดวิธีแสดงการ์ด

ใช้ได้กับส่วนเสริม Google Workspace และใช้ไม่ได้กับแอป Google Chat

Enum
DISPLAY_STYLE_UNSPECIFIED ไม่ใช้ ไม่ระบุ
PEEK ส่วนหัวของการ์ดจะปรากฏที่ด้านล่างของแถบด้านข้าง โดยปิดบังการ์ดด้านบนสุดของกองการ์ดไว้บางส่วน การคลิกส่วนหัวจะทำให้การ์ดปรากฏขึ้นในกองการ์ด หากการ์ดไม่มีส่วนหัว ระบบจะใช้ส่วนหัวที่สร้างขึ้นแทน
REPLACE ค่าเริ่มต้น ระบบจะแสดงการ์ดโดยแทนที่มุมมองของการ์ดด้านบนในกองการ์ด

ExpressionData

แสดงข้อมูลที่ใช้ในการประเมินนิพจน์

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "id": string,
  "expression": string,
  "conditions": [
    {
      object (Condition)
    }
  ],
  "eventActions": [
    {
      object (EventAction)
    }
  ]
}
ช่อง
id

string

ตัวระบุที่ไม่ซ้ำกันของ ExpressionData
expression

string

นิพจน์ที่ไม่ได้คอมไพล์
conditions[]

object (Condition)

รายการเงื่อนไขที่กำหนดโดยผลการประเมินนิพจน์
eventActions[]

object (EventAction)

รายการการดำเนินการที่ใช้ ExpressionData ได้

เงื่อนไข

แสดงถึงเงื่อนไขที่ใช้ทริกเกอร์การดำเนินการได้

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "actionRuleId": string,

  "expressionDataCondition": {
    object (ExpressionDataCondition)
  }
}
ช่อง
actionRuleId

string

ตัวระบุที่ไม่ซ้ำกันของ ActionRule
เงื่อนไข ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
expressionDataCondition

object (ExpressionDataCondition)

เงื่อนไขที่กำหนดโดยข้อมูลนิพจน์
สิ้นสุดฟิลด์ที่แยกกัน

ExpressionDataCondition

แสดงเงื่อนไขที่ประเมินโดยใช้ CEL

พร้อมใช้งานสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat

การแสดง JSON 
{
  "conditionType": enum (ConditionType)
}
ช่อง
conditionType

enum (ConditionType)

ประเภทของเงื่อนไข

ConditionType

ประเภทของเงื่อนไข

Enum
CONDITION_TYPE_UNSPECIFIED ประเภทเงื่อนไขที่ไม่ได้ระบุ
EXPRESSION_EVALUATION_SUCCESS ประเมินนิพจน์สำเร็จแล้ว
EXPRESSION_EVALUATION_FAILURE การประเมินนิพจน์ไม่สำเร็จ