การ์ด
การ์ดคือองค์ประกอบ UI ที่มีวิดเจ็ต UI เช่น ข้อความและรูปภาพ
การแสดง JSON |
---|
{ "header": { object ( |
ช่อง | |
---|---|
header
|
ส่วนหัวของการ์ด ส่วนหัวมักมีชื่อและรูปภาพ |
sections[]
|
ส่วนต่างๆ จะคั่นด้วยเส้นแบ่ง |
cardActions[]
|
การดำเนินการของการ์ดนี้ |
name
|
ชื่อบัตร |
CardHeader
การแสดง JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
ช่อง | |
---|---|
title
|
ต้องระบุชื่อ ส่วนหัวมีความสูงคงที่ หากมีการระบุทั้งชื่อเรื่องและชื่อเรื่องรอง แต่ละบรรทัดจะกินพื้นที่ 1 บรรทัด หากระบุเฉพาะชื่อไว้ ระบบจะใช้ทั้ง 2 บรรทัด |
subtitle
|
ชื่อรองของส่วนหัวของการ์ด |
imageStyle
|
ประเภทรูปภาพ (เช่น เส้นขอบสี่เหลี่ยมจัตุรัสหรือเส้นขอบวงกลม) |
imageUrl
|
URL ของรูปภาพในส่วนหัวของการ์ด |
ImageStyle
Enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
เส้นขอบสี่เหลี่ยมจัตุรัส |
AVATAR
|
เส้นขอบวงกลม |
ส่วน
ส่วนจะมีคอลเล็กชันวิดเจ็ตที่แสดงผล (แนวตั้ง) ตามลำดับที่ระบุไว้ ในทุกแพลตฟอร์ม การ์ดจะมีความกว้างคงที่แบบแคบ จึงไม่จำเป็นต้องใช้พร็อพเพอร์ตี้ของเลย์เอาต์ (เช่น ทศนิยม) ในขณะนี้
การแสดง JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
ช่อง | |
---|---|
header
|
ส่วนหัวของส่วน ระบบรองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
widgets[]
|
ส่วนต้องมีวิดเจ็ตอย่างน้อยหนึ่งรายการ |
WidgetMarkup
วิดเจ็ตคือองค์ประกอบ UI ที่แสดงข้อความและรูปภาพ
การแสดง JSON |
---|
{ "buttons": [ { object ( |
ช่อง | |
---|---|
buttons[]
|
รายการปุ่ม ปุ่มต่างๆ ยังเป็น |
ช่องการรวม data WidgetMarkup มีรายการต่อไปนี้ได้เพียง 1 รายการเท่านั้น คุณใช้ช่อง WidgetMarkup หลายช่องเพื่อแสดงรายการเพิ่มเติมได้
data
ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
|
|
textParagraph
|
แสดงย่อหน้าข้อความในวิดเจ็ตนี้ |
image
|
แสดงรูปภาพในวิดเจ็ตนี้ |
keyValue
|
แสดงรายการคีย์-ค่าในวิดเจ็ตนี้ |
TextParagraph
ย่อหน้าของข้อความ รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
การแสดง JSON |
---|
{ "text": string } |
ช่อง | |
---|---|
text
|
|
รูปภาพ
รูปภาพที่ระบุโดย URL และมีการดำเนินการ onclick
ได้
การแสดง JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
ช่อง | |
---|---|
imageUrl
|
URL ของรูปภาพ |
onClick
|
การดำเนินการ |
aspectRatio
|
สัดส่วนภาพ (ความกว้างและความสูง) ของรูปภาพนี้ ฟิลด์นี้ทำให้คุณสามารถสงวนความสูงที่เหมาะสมสำหรับรูปภาพในขณะที่รอให้ภาพโหลด แต่ไม่ได้มีไว้เพื่อลบล้างสัดส่วนภาพในตัวของรูปภาพ หากไม่ได้ตั้งค่า เซิร์ฟเวอร์จะเติมเนื้อหาโดยการดึงข้อมูลรูปภาพล่วงหน้า |
OnClick
การดำเนินการ onclick
(เช่น เปิดลิงก์)
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ช่องการรวม
|
|
action
|
การทํางานของแบบฟอร์มจะทริกเกอร์โดยการดําเนินการ |
openLink
|
การดำเนินการ |
FormAction
การทำงานของแบบฟอร์มจะอธิบายลักษณะการทำงานเมื่อมีการส่งแบบฟอร์ม ตัวอย่างเช่น คุณสามารถเรียกใช้ Apps Script เพื่อจัดการกับแบบฟอร์ม
การแสดง JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
ช่อง | |
---|---|
actionMethodName
|
ชื่อเมธอดจะใช้เพื่อระบุว่าแบบฟอร์มส่วนใดที่ทำให้การส่งแบบฟอร์ม ข้อมูลนี้จะถูกสะท้อนกลับไปยังแอป Chat เป็นส่วนหนึ่งของกิจกรรมการคลิกการ์ด คุณใช้ชื่อวิธีการเดียวกันสำหรับองค์ประกอบหลายรายการที่ทริกเกอร์ลักษณะการทำงานทั่วไปได้ |
parameters[]
|
รายการพารามิเตอร์การดำเนินการ |
ActionParameter
รายการพารามิเตอร์สตริงที่จะใส่เมื่อมีการเรียกใช้เมธอดการดำเนินการ ตัวอย่างเช่น ลองใช้ปุ่มเลื่อนการแจ้งเตือน 3 ปุ่ม ได้แก่ ปิดเสียงเตือนชั่วคราวตอนนี้ ปิดเสียงเตือนชั่วคราว 1 วัน หรือปิดเสียงเตือนชั่วคราวในสัปดาห์หน้า คุณอาจใช้ action method = snooze()
เพื่อส่งประเภทการเลื่อนการแจ้งเตือนและเวลาเลื่อนการแจ้งเตือนในรายการพารามิเตอร์สตริง
การแสดง JSON |
---|
{ "key": string, "value": string } |
ช่อง | |
---|---|
key
|
ชื่อพารามิเตอร์สำหรับสคริปต์การดำเนินการ |
value
|
ค่าของพารามิเตอร์ |
OpenLink
ลิงก์ที่เปิดหน้าต่างใหม่
การแสดง JSON |
---|
{ "url": string } |
ช่อง | |
---|---|
url
|
URL ที่จะเปิด |
KeyValue
องค์ประกอบ UI ประกอบด้วยคีย์ (ป้ายกำกับ) และค่า (เนื้อหา) องค์ประกอบนี้ยังมีการทำงานบางอย่างได้ เช่น ปุ่ม onclick
การแสดง JSON |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
ช่อง | |
---|---|
topLabel
|
ข้อความของป้ายกำกับด้านบน รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
content
|
ข้อความของเนื้อหา รองรับข้อความที่จัดรูปแบบและต้องระบุเสมอ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
contentMultiline
|
กรณีที่เนื้อหาควรเป็นหลายบรรทัด |
bottomLabel
|
ข้อความของป้ายกำกับด้านล่าง รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
onClick
|
การดำเนินการ |
ช่องการรวม icons ต้องกำหนดไอคอนอย่างน้อย 1 รายการ ต้องกำหนด top_label และ bottom_label
icons
ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
|
|
icon
|
ค่า enum ที่ Chat API แทนที่ด้วยรูปภาพไอคอนที่เกี่ยวข้อง |
iconUrl
|
ไอคอนที่ระบุโดย URL |
ช่องการรวม control วิดเจ็ตควบคุม คุณจะตั้งค่า button หรือ switch_widget ก็ได้ แต่ตั้งค่าทั้ง 2 รายการไม่ได้
control
ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
|
|
button
|
ปุ่มที่คลิกเพื่อทริกเกอร์การทำงานได้ |
Icon
ชุดไอคอนที่รองรับ
Enum | |
---|---|
ICON_UNSPECIFIED
|
|
AIRPLANE
|
|
BOOKMARK
|
|
BUS
|
|
CAR
|
|
CLOCK
|
|
CONFIRMATION_NUMBER_ICON
|
|
DOLLAR
|
|
DESCRIPTION
|
|
EMAIL
|
|
EVENT_PERFORMER
|
|
EVENT_SEAT
|
|
FLIGHT_ARRIVAL
|
|
FLIGHT_DEPARTURE
|
|
HOTEL
|
|
HOTEL_ROOM_TYPE
|
|
INVITE
|
|
MAP_PIN
|
|
MEMBERSHIP
|
|
MULTIPLE_PEOPLE
|
|
OFFER
|
|
PERSON
|
|
PHONE
|
|
RESTAURANT_ICON
|
|
SHOPPING_CART
|
|
STAR
|
|
STORE
|
|
TICKET
|
|
TRAIN
|
|
VIDEO_CAMERA
|
|
VIDEO_PLAY
|
ปุ่ม
ปุ่ม โดยอาจเป็นปุ่มข้อความหรือปุ่มรูปภาพ
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ช่องการรวม
|
|
textButton
|
ปุ่มที่มีข้อความและ
|
imageButton
|
ปุ่มที่มีรูปภาพและการทำงาน
|
TextButton
ปุ่มที่มีข้อความและ
onclick
การดำเนินการ
การแสดง JSON |
---|
{
"text": string,
"onClick": {
object (
|
ช่อง | |
---|---|
text
|
ข้อความของปุ่ม |
onClick
|
การดำเนินการ |
ImageButton
ปุ่มรูปภาพที่มีการดำเนินการ
onclick
การแสดง JSON |
---|
{ "onClick": { object ( |
ช่อง | |
---|---|
onClick
|
การดำเนินการ |
name
|
ชื่อของ |
ช่องการรวม icons สามารถระบุไอคอนด้วย Icon
enum หรือ URL
icons
ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น
|
|
icon
|
ไอคอนที่ระบุโดย |
iconUrl
|
ไอคอนที่ระบุโดย URL |
CardAction
การดำเนินการของการ์ดคือการดำเนินการที่เชื่อมโยงกับการ์ด สำหรับการ์ดใบแจ้งหนี้ การดำเนินการทั่วไปได้แก่ ลบใบแจ้งหนี้ ส่งใบแจ้งหนี้ทางอีเมล หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์
ไม่รองรับในแอป Google Chat
การแสดง JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
ช่อง | |
---|---|
actionLabel
|
ป้ายกำกับที่ใช้แสดงในรายการเมนูการทำงาน |
onClick
|
การดำเนินการ click สำหรับรายการการดำเนินการนี้ |