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)

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

ฟิลด์ Union 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

CANNOT TRANSLATE 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.
}
ช่อง

ฟิลด์ Union 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 การดำเนินการ เฉพาะป้ายกำกับด้านบน ป้ายกำกับด้านล่าง และขอบเขตของเนื้อหาเท่านั้นที่คลิกได้

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

enum (Icon)

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

iconUrl

string

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

ฟิลด์ Union 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.
}
ช่อง

ฟิลด์ Union 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 ซึ่งใช้สำหรับการเข้าถึง ระบบจะระบุค่าเริ่มต้นหากไม่มีการระบุชื่อนี้

ฟิลด์ Union 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 สำหรับรายการการทำงานนี้