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)

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

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)

รายการปุ่ม ปุ่มต่างๆ ยังเป็น oneof data และควรตั้งค่าเพียงช่องเดียวเหล่านี้

ช่องการรวม data WidgetMarkup มีรายการต่อไปนี้ได้เพียง 1 รายการเท่านั้น คุณใช้ช่อง 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 ต้องกำหนดไอคอนอย่างน้อย 1 รายการ ต้องกำหนด top_label และ bottom_label 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)

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