Cards v1

การ์ด

การ์ดคือองค์ประกอบ UI ที่อาจมีวิดเจ็ต UI เช่น ข้อความและรูปภาพ

การแสดง JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
ช่อง
header

object (CardHeader)

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

sections[]

object (Section)

ส่วนต่างๆ จะคั่นด้วยตัวแบ่งบรรทัด

cardActions[]

object (CardAction)

การดำเนินการของการ์ดนี้

name

string

ชื่อของการ์ด

CardHeader

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

string

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

subtitle

string

คำบรรยายของส่วนหัวของการ์ด

imageStyle

enum (ImageStyle)

ประเภทของรูปภาพ (เช่น เส้นขอบสี่เหลี่ยมจัตุรัสหรือเส้นขอบกลม)

imageUrl

string

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

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE เส้นขอบสี่เหลี่ยมจัตุรัส
AVATAR เส้นขอบวงกลม

ส่วน

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

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

string

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

widgets[]

object (WidgetMarkup)

ส่วนต้องมีวิดเจ็ตอย่างน้อย 1 รายการ

WidgetMarkup

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

การแสดง JSON 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
ช่อง
buttons[]

object (Button)

รายการปุ่ม Buttons ก็เป็นตัวเลือกเช่นกัน oneof data และควรตั้งค่าเพียง 1 ช่องเท่านั้น

ฟิลด์สหภาพ data WidgetMarkup จะมีได้เพียงรายการใดรายการหนึ่งต่อไปนี้ คุณใช้เขตข้อมูล WidgetMarkup ได้หลายเขตเพื่อแสดงรายการเพิ่มเติม data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
textParagraph

object (TextParagraph)

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

image

object (Image)

แสดงรูปภาพในวิดเจ็ตนี้

keyValue

object (KeyValue)

แสดงรายการคีย์-ค่าในวิดเจ็ตนี้

TextParagraph

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

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

string

รูปภาพ

รูปภาพที่ระบุด้วย URL และอาจมีการดำเนินการ onclick

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

string

URL ของรูปภาพ

onClick

object (OnClick)

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

aspectRatio

number

สัดส่วนภาพของรูปภาพนี้ (ความกว้างและความสูง) ช่องนี้ช่วยให้คุณจองความสูงที่เหมาะสมสําหรับรูปภาพขณะรอให้รูปภาพโหลด แต่ไม่ได้มีไว้เพื่อลบล้างสัดส่วนภาพที่ฝังอยู่ในรูปภาพ หากไม่ได้ตั้งค่าไว้ เซิร์ฟเวอร์จะเติมค่านี้โดยการจัดเก็บรูปภาพล่วงหน้า

OnClick

การดำเนินการ (เช่น เปิดลิงก์) onclick

การแสดง JSON 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
ช่อง

ฟิลด์สหภาพ data

data ต้องมีค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

action

object (FormAction)

การดำเนินการ onclick นี้จะทริกเกอร์การดำเนินการของแบบฟอร์มหากระบุไว้

FormAction

การดำเนินการของแบบฟอร์มจะอธิบายลักษณะการทำงานเมื่อส่งแบบฟอร์ม เช่น คุณสามารถเรียกใช้ Apps Script เพื่อจัดการแบบฟอร์ม

การแสดง JSON 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
ช่อง
actionMethodName

string

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

parameters[]

object (ActionParameter)

รายการพารามิเตอร์การดําเนินการ

ActionParameter

รายการพารามิเตอร์สตริงที่จะระบุเมื่อเรียกใช้เมธอดการดําเนินการ ตัวอย่างเช่น ลองพิจารณาปุ่มเลื่อนการปลุก 3 ปุ่ม ได้แก่ เลื่อนการปลุกเลย เลื่อนการปลุก 1 วัน และเลื่อนการปลุกในสัปดาห์หน้า คุณอาจใช้ action method = snooze() โดยส่งประเภทการเลื่อนการปลุกและเวลาเลื่อนการปลุกในรายการพารามิเตอร์สตริง

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

string

ชื่อพารามิเตอร์สําหรับสคริปต์การดำเนินการ

value

string

ค่าของพารามิเตอร์

KeyValue

องค์ประกอบ UI มีคีย์ (ป้ายกำกับ) และค่า (เนื้อหา) องค์ประกอบนี้อาจมีการดำเนินการบางอย่างด้วย เช่น ปุ่ม onclick

การแสดง JSON 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
ช่อง
topLabel

string

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

content

string

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

contentMultiline

boolean

ในกรณีที่เนื้อหาควรเป็นหลายบรรทัด

bottomLabel

string

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

onClick

object (OnClick)

การดำเนินการ onclick เฉพาะป้ายกำกับด้านบน ป้ายกำกับด้านล่าง และภูมิภาคเนื้อหาเท่านั้นที่คลิกได้

ฟิลด์สหภาพ icons ต้องกำหนดไอคอน top_label และ bottom_label อย่างน้อย 1 รายการ icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
icon

enum (Icon)

ค่า Enum ที่ Chat API แทนที่ด้วยรูปภาพไอคอนที่เกี่ยวข้อง

iconUrl

string

ไอคอนที่ระบุโดย URL

ฟิลด์สหภาพ control วิดเจ็ตการควบคุม คุณจะตั้งค่า button หรือ switch_widget ก็ได้ แต่จะตั้งค่าทั้ง 2 อย่างไม่ได้ control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
button

object (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 type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
ช่อง

ฟิลด์สหภาพ type

type ต้องมีค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

textButton

object (TextButton)

ปุ่มที่มีข้อความและการดำเนินการ onclick

imageButton

object (ImageButton)

ปุ่มที่มีรูปภาพและการดำเนินการ onclick

TextButton

ปุ่มที่มีข้อความและการดำเนินการ onclick

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

string

ข้อความของปุ่ม

onClick

object (OnClick)

การดำเนินการของปุ่ม onclick

ImageButton

ปุ่มรูปภาพที่มีการดำเนินการ onclick

การแสดง JSON 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
ช่อง
onClick

object (OnClick)

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

name

string

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

ฟิลด์สหภาพ icons คุณสามารถระบุไอคอนได้โดยใช้ Icon enum หรือ URL icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
icon

enum (Icon)

ไอคอนที่ระบุโดย enum ที่ชี้ไปยังไอคอนที่ Chat API ระบุ

iconUrl

string

ไอคอนที่ระบุโดย URL

CardAction

การดําเนินการของการ์ดคือการดําเนินการที่เกี่ยวข้องกับการ์ด สําหรับการ์ดใบแจ้งหนี้ การดําเนินการทั่วไป ได้แก่ ลบใบแจ้งหนี้ ส่งใบแจ้งหนี้ทางอีเมล หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์

แอป Google Chat ไม่รองรับ

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

string

ป้ายกำกับเคยแสดงในรายการเมนูการทำงาน

onClick

object (OnClick)

การดำเนินการ onclick สำหรับรายการการดำเนินการนี้