Package google.apps.card.v1

ดัชนี

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

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

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

ช่อง
function

string

ฟังก์ชันที่กำหนดเองที่จะเรียกใช้เมื่อมีการคลิกหรือเปิดใช้งานองค์ประกอบที่ประกอบ

ดูตัวอย่างการใช้งานได้ที่อ่านข้อมูลแบบฟอร์ม
parameters[]

ActionParameter

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

LoadIndicator

ระบุตัวบ่งชี้การโหลดที่การดำเนินการแสดงขณะทำการเรียกไปยังการดำเนินการ
persist_values

bool

ระบุว่าค่าแบบฟอร์มจะยังคงอยู่หลังจากการดำเนินการหรือไม่ ค่าเริ่มต้นคือ false

หากเป็น true ค่าแบบฟอร์มจะยังคงอยู่หลังจากทริกเกอร์การดำเนินการ หากต้องการให้ผู้ใช้ทำการเปลี่ยนแปลงในขณะที่ระบบกำลังประมวลผลการดำเนินการ ให้ตั้งค่า LoadIndicator เป็น NONE สำหรับข้อความการ์ดในแอปแชท คุณต้องตั้งค่า ResponseType ของการดำเนินการเป็น UPDATE_MESSAGE และใช้ card_id เดียวกันจากการ์ดที่มีการดำเนินการ

หากเป็น false ระบบจะล้างค่าแบบฟอร์มเมื่อทริกเกอร์การดำเนินการ หากต้องการป้องกันไม่ให้ผู้ใช้ทำการเปลี่ยนแปลงขณะที่ระบบกำลังประมวลผลการดำเนินการ ให้ตั้งค่า LoadIndicator เป็น SPINNER
interaction

Interaction

ไม่บังคับ ต้องระบุเมื่อเปิดกล่องโต้ตอบ

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

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

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

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

string

ไม่บังคับ กรอกชื่อวิดเจ็ตที่การดำเนินการนี้ต้องการสำหรับการส่งที่ถูกต้องในรายการนี้

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

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

bool

ไม่บังคับ หากเป็นจริง การดำเนินการนี้จะถือว่าวิดเจ็ตทั้งหมดเป็นวิดเจ็ตที่จำเป็น

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

ActionParameter

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

ดูข้อมูลเพิ่มเติมได้ที่ CommonEventObject

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

ช่อง
key

string

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

string

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

การโต้ตอบ

ไม่บังคับ ต้องระบุเมื่อเปิดกล่องโต้ตอบ

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

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

การระบุ interaction จะช่วยให้แอปตอบสนองด้วยวิธีพิเศษแบบอินเทอร์แอกทีฟได้ เช่น การตั้งค่า interaction เป็น OPEN_DIALOG จะทำให้แอปเปิดกล่องโต้ตอบได้

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

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

Enum
INTERACTION_UNSPECIFIED ค่าเริ่มต้น action จะทำงานตามปกติ
OPEN_DIALOG

เปิดกล่องโต้ตอบ ซึ่งเป็นอินเทอร์เฟซแบบการ์ดในหน้าต่างที่แอป Chat ใช้เพื่อโต้ตอบกับผู้ใช้

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

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

LoadIndicator

ระบุตัวบ่งชี้การโหลดที่การดำเนินการแสดงขณะทำการเรียกไปยังการดำเนินการ

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

Enum
SPINNER แสดงวงกลมหมุนเพื่อระบุว่าระบบกำลังโหลดเนื้อหา
NONE ไม่มีอะไรแสดง

BorderStyle

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

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

ช่อง
type

BorderType

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

Color

สีที่จะใช้เมื่อประเภทเป็น BORDER_TYPE_STROKE

หากต้องการตั้งค่าสีเส้นขอบ ให้ระบุค่าสำหรับช่อง red, green และ blue ค่าต้องเป็นจำนวนทศนิยมระหว่าง 0 ถึง 1 โดยอิงตามค่าสี RGB ซึ่ง 0 (0/255) แสดงถึงไม่มีสี และ 1 (255/255) แสดงถึงความเข้มสูงสุดของสี

ตัวอย่างเช่น โค้ดต่อไปนี้จะตั้งค่าสีเป็นสีแดงที่ความเข้มสูงสุด

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

ฟิลด์ alpha ไม่พร้อมใช้งานสำหรับสีของเส้น หากระบุ ระบบจะไม่สนใจช่องนี้
corner_radius

int32

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

BorderType

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

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

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

ปุ่ม

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

หากต้องการเปลี่ยนรูปภาพให้เป็นปุ่มที่คลิกได้ ให้ระบุ Image (ไม่ใช่ ImageComponent) และตั้งค่าการดำเนินการ onClick

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

ช่อง
text

string

ข้อความที่แสดงภายในปุ่ม
icon

Icon

ไอคอนที่แสดงภายในปุ่ม หากตั้งค่าทั้ง icon และ text ไอคอนจะปรากฏก่อนข้อความ
color

Color

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

หากต้องการตั้งค่าสีปุ่ม ให้ระบุค่าสำหรับช่อง red, green และ blue ค่าต้องเป็นจำนวนทศนิยมระหว่าง 0 ถึง 1 โดยอิงตามค่าสี RGB ซึ่ง 0 (0/255) แสดงถึงไม่มีสี และ 1 (255/255) แสดงถึงความเข้มสูงสุดของสี

ตัวอย่างเช่น โค้ดต่อไปนี้จะตั้งค่าสีเป็นสีแดงที่ความเข้มสูงสุด

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

ฟิลด์ alpha ใช้กับสีปุ่มไม่ได้ หากระบุ ระบบจะไม่สนใจช่องนี้
on_click

OnClick

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

bool

หาก true ปุ่มจะแสดงในสถานะไม่ได้ใช้งานและไม่ตอบสนองต่อการกระทำของผู้ใช้
alt_text

string

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

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

Type

ไม่บังคับ ประเภทของปุ่ม หากไม่ได้ตั้งค่าไว้ ประเภทปุ่มจะมีค่าเริ่มต้นเป็น OUTLINED หากตั้งค่าฟิลด์ color ระบบจะบังคับให้ประเภทปุ่มเป็น FILLED และจะไม่สนใจค่าใดๆ ที่ตั้งไว้สำหรับฟิลด์นี้

ประเภท

ไม่บังคับ ประเภทของปุ่ม หากตั้งค่าช่อง color ระบบจะบังคับให้ type เป็น FILLED

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

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

ButtonList

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

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

ช่อง
buttons[]

Button

อาร์เรย์ของปุ่ม

การ์ด

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

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

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

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

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

หมายเหตุ: คุณเพิ่มวิดเจ็ตได้สูงสุด 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
ช่อง
header

CardHeader

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

Section

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

DividerStyle

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

CardAction

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

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

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

"card_actions": [
  {
    "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
display_style

DisplayStyle

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

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

CardHeader

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

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

ExpressionData

ข้อมูลการแสดงผลสำหรับการ์ด

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

CardAction

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

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

ช่อง
action_label

string

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

OnClick

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

CardFixedFooter

ส่วนท้ายแบบคงที่ (Sticky) ที่ปรากฏที่ด้านล่างของการ์ด

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

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

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

ช่อง
primary_button

Button

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

Button

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

CardHeader

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

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

ช่อง
title

string

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

string

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

ImageType

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

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

string

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

string

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

DisplayStyle

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

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

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

DividerStyle

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

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

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

NestedWidget

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

ช่อง

ฟิลด์ Union data

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

TextParagraph

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

ButtonList

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

Image

วิดเจ็ตรูปภาพ

ส่วน

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

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

ช่อง
header

string

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

Widget

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

bool

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

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

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

int32

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

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

string

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

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

CollapseControl

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

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

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

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

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

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

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

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

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

ช่อง
carousel_cards[]

CarouselCard

รายการการ์ดที่รวมอยู่ในภาพสไลด์

CarouselCard

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

ช่อง
widgets[]

NestedWidget

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

NestedWidget

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

ชิป

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

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

ช่อง
icon

Icon

รูปไอคอน หากตั้งค่าทั้ง icon และ text ไอคอนจะปรากฏก่อนข้อความ
label

string

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

OnClick

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

bool

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

bool

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

string

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

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

ChipList

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

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

ช่อง
layout

Layout

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

Chip

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

เลย์เอาต์

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

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

CollapseControl

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

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

ช่อง
horizontal_alignment

HorizontalAlignment

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

Button

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

Button

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

คอลัมน์

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 ปฏิทิน
ช่อง
column_items[]

Column

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

คอลัมน์

คอลัมน์

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

ช่อง
horizontal_size_style

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

HorizontalSizeStyle

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

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

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

VerticalAlignment

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

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

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

วิดเจ็ต

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

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

ช่อง

ฟิลด์ Union data

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

TextParagraph

วิดเจ็ต TextParagraph
image

Image

วิดเจ็ต Image
decorated_text

DecoratedText

วิดเจ็ต DecoratedText
button_list

ButtonList

วิดเจ็ต ButtonList
text_input

TextInput

วิดเจ็ต TextInput
selection_input

SelectionInput

วิดเจ็ต SelectionInput
date_time_picker

DateTimePicker

วิดเจ็ต DateTimePicker
chip_list

ChipList

วิดเจ็ต ChipList

เงื่อนไข

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

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

ช่อง
action_rule_id

string

ตัวระบุที่ไม่ซ้ำกันของ ActionRule
ฟิลด์ Union condition สภาพ condition ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
expression_data_condition

ExpressionDataCondition

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

ExpressionDataCondition

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

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

ช่อง
condition_type

ConditionType

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

ConditionType

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

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

DataSourceConfig

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

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

ช่อง
ฟิลด์ Union data_source แหล่งข้อมูล data_source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
remote_data_source

Action

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

PlatformDataSource

ข้อมูลมาจากแอปพลิเคชัน Google Workspace

DateTimePicker

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

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

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

ช่อง
name

string

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
label

string

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

DateTimePickerType

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

int64

ค่าเริ่มต้นที่แสดงในวิดเจ็ตเป็นมิลลิวินาทีตั้งแต่เวลา Epoch ของ Unix

ระบุค่าตามประเภทเครื่องมือเลือก (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 PM ให้ใช้ 43200000 (หรือ 12 * 60 * 60 * 1000)
timezone_offset_date

int32

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

Action

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

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 ผู้ใช้ป้อนเวลา

DecoratedText

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

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

ช่อง
icon
(deprecated)

Icon

เลิกใช้งานแล้วและแนะนำให้ใช้ startIcon แทน
start_icon

Icon

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

VerticalAlignment

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

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

string

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

TextParagraph

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

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

string

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

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

TextParagraph

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

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

bool

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

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

string

ข้อความที่ปรากฏด้านล่าง text ตัดคำเสมอ
bottom_label_text

TextParagraph

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

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

OnClick

ระบบจะทริกเกอร์การดำเนินการนี้เมื่อผู้ใช้คลิก topLabel หรือ bottomLabel
ฟิลด์ Union control ปุ่ม สวิตช์ ช่องทำเครื่องหมาย หรือรูปภาพที่ปรากฏทางด้านขวาของข้อความในdecoratedTextวิดเจ็ต control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
button

Button

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

SwitchControl

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

Icon

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

รองรับไอคอนในตัวและที่กำหนดเอง

SwitchControl

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

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

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

ช่อง
name

string

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
value

string

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
selected

bool

เมื่อเลือก true สวิตช์
on_change_action

Action

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

ControlType

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

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

ControlType

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

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

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

ตัวแบ่ง

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

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

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

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

"divider": {}

EventAction

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

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

ช่อง
action_rule_id

string

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

Trigger

รายการทริกเกอร์ที่จะทริกเกอร์หลังจากดำเนินการ EventAction
ฟิลด์ Union action การดำเนินการที่จะทำ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
common_widget_action

CommonWidgetAction

การทำงานของวิดเจ็ตทั่วไป

CommonWidgetAction

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

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

ช่อง
ฟิลด์ Union action การดำเนินการที่จะทำ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
update_visibility_action

UpdateVisibilityAction

การดำเนินการเพื่ออัปเดตระดับการมองเห็นของวิดเจ็ต

UpdateVisibilityAction

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

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

ช่อง
visibility

Visibility

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

ExpressionData

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

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

ช่อง
id

string

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

string

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

Condition

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

EventAction

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

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"
    }
  }
}
ช่อง
title

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

โดยแต่ละรายการในตารางกริดจะใช้แฮนเดิลนี้ซ้ำ แต่จะมีการเพิ่มตัวระบุและดัชนีของรายการในรายการสินค้าลงในพารามิเตอร์ของแฮนเดิล

GridItem

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

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

ช่อง
id

string

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

ImageComponent

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

string

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

string

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

GridItemLayout

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

GridItemLayout

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

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

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

Icon

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

รองรับไอคอนในตัวและที่กำหนดเอง

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

ช่อง
alt_text

string

ไม่บังคับ คำอธิบายของไอคอนที่ใช้สำหรับการช่วยเหลือพิเศษ หากไม่ได้ระบุ ระบบจะระบุค่าเริ่มต้น Button แนวทางปฏิบัติแนะนำคือคุณควรกำหนดคำอธิบายที่เป็นประโยชน์สำหรับสิ่งที่ไอคอนแสดง และสิ่งที่ไอคอนทำ (หากมี) เช่น A user's account portrait หรือ Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat

หากตั้งค่าไอคอนใน Button altText จะปรากฏเป็นข้อความช่วยเหลือเมื่อผู้ใช้วางเมาส์เหนือปุ่ม อย่างไรก็ตาม หากปุ่มตั้งค่า text ด้วย ระบบจะไม่สนใจ altText ของไอคอน
image_type

ImageType

รูปแบบการครอบตัดที่ใช้กับรูปภาพ ในบางกรณี การครอบตัด CIRCLE จะทำให้รูปภาพมีขนาดใหญ่กว่าไอคอนในตัว
ฟิลด์ Union icons ไอคอนที่แสดงในวิดเจ็ตบนการ์ด icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
known_icon

string

แสดงไอคอนในตัวที่ Google Workspace มีให้

เช่น หากต้องการแสดงไอคอนเครื่องบิน ให้ระบุ AIRPLANE สำหรับรถประจำทาง ให้ระบุ BUS

ดูรายการไอคอนที่รองรับทั้งหมดได้ที่ไอคอนในตัว
icon_url

string

แสดงไอคอนที่กำหนดเองซึ่งโฮสต์ที่ HTTPS URL

เช่น

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

ประเภทไฟล์ที่รองรับ ได้แก่ .png และ .jpg
material_icon

MaterialIcon

แสดงไอคอน Material ของ Google อย่างใดอย่างหนึ่ง

เช่น หากต้องการแสดงไอคอนช่องทําเครื่องหมาย ให้ใช้

"material_icon": {
  "name": "check_box"
}

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

รูปภาพ

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

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

ช่อง
image_url

string

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

เช่น

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

OnClick

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

string

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

ImageComponent

แสดงรูปภาพ

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

ช่อง
image_uri

string

URL ของรูปภาพ
alt_text

string

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

ImageCropStyle

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

BorderStyle

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

ImageCropStyle

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

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

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
ช่อง
type

ImageCropType

ประเภทการครอบตัด
aspect_ratio

double

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

MaterialIcon

ไอคอน Material ของ Google ซึ่งมีตัวเลือกมากกว่า 2, 500 รายการ

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

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

ช่อง
name

string

ชื่อไอคอนที่กำหนดไว้ใน Google Material Icon เช่น check_box ระบบจะทิ้งชื่อที่ไม่ถูกต้องและแทนที่ด้วยสตริงว่าง ซึ่งจะทำให้ไอคอนแสดงผลไม่สำเร็จ
fill

bool

ไอคอนแสดงผลเป็นแบบทึบไหม ค่าเริ่มต้นคือ false

หากต้องการดูตัวอย่างการตั้งค่าไอคอนต่างๆ ให้ไปที่ Google Font Icons แล้วปรับการตั้งค่าในส่วนปรับแต่ง
weight

int32

น้ำหนักของเส้นไอคอน เลือกจาก {100, 200, 300, 400, 500, 600, 700} หากไม่มี ค่าเริ่มต้นคือ 400 หากระบุค่าอื่น ระบบจะใช้ค่าเริ่มต้น

หากต้องการดูตัวอย่างการตั้งค่าไอคอนต่างๆ ให้ไปที่ Google Font Icons แล้วปรับการตั้งค่าในส่วนปรับแต่ง
grade

int32

น้ำหนักและเกรดจะส่งผลต่อความหนาของสัญลักษณ์ การปรับคะแนนจะละเอียดกว่าการปรับน้ำหนัก และมีผลต่อขนาดของสัญลักษณ์เพียงเล็กน้อย เลือกจาก {-25, 0, 200} หากไม่มี ค่าเริ่มต้นจะเป็น 0 หากระบุค่าอื่น ระบบจะใช้ค่าเริ่มต้น

หากต้องการดูตัวอย่างการตั้งค่าไอคอนต่างๆ ให้ไปที่ Google Font Icons แล้วปรับการตั้งค่าในส่วนปรับแต่ง

OnClick

แสดงวิธีตอบกลับเมื่อผู้ใช้คลิกองค์ประกอบแบบอินเทอร์แอกทีฟในการ์ด เช่น ปุ่ม

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

ช่อง

ฟิลด์ Union data

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

Action

หากระบุไว้ onClick นี้จะทริกเกอร์การดำเนินการ
card

Card

ระบบจะพุชการ์ดใหม่ไปยังกองการ์ดหลังจากคลิกหากมีการระบุ

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

OverflowMenu

หากระบุไว้ onClick จะเปิดเมนูรายการเพิ่มเติม

OnClose

สิ่งที่ไคลเอ็นต์ทำเมื่อปิดลิงก์ที่เปิดโดยOnClickการดำเนินการ

การติดตั้งใช้งานขึ้นอยู่กับความสามารถของแพลตฟอร์มไคลเอ็นต์ ตัวอย่างเช่น เว็บเบราว์เซอร์อาจเปิดลิงก์ในหน้าต่างป๊อปอัปที่มีแฮนเดิล OnClose

หากตั้งค่าทั้งแฮนเดิล OnOpen และ OnClose และแพลตฟอร์มไคลเอ็นต์ไม่รองรับทั้ง 2 ค่า OnClose จะมีความสำคัญเหนือกว่า

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

Enum
NOTHING ค่าเริ่มต้น บัตรไม่โหลดซ้ำและไม่มีอะไรเกิดขึ้น
RELOAD

โหลดการ์ดซ้ำหลังจากปิดหน้าต่างย่อย

หากใช้ร่วมกับ OpenAs.OVERLAY หน้าต่างย่อยจะทำหน้าที่เป็นกล่องโต้ตอบแบบโมดัลและระบบจะบล็อกการ์ดหลักจนกว่าหน้าต่างย่อยจะปิด

OpenAs

เมื่อOnClick การดำเนินการเปิดลิงก์ ไคลเอ็นต์จะเปิดเป็นหน้าต่างขนาดเต็ม (หากเป็นเฟรมที่ไคลเอ็นต์ใช้) หรือเป็นการซ้อนทับ (เช่น ป๊อปอัป) ก็ได้ การติดตั้งใช้งานจะขึ้นอยู่กับความสามารถของแพลตฟอร์มไคลเอ็นต์ และระบบอาจไม่สนใจค่าที่เลือกหากไคลเอ็นต์ไม่รองรับ ไคลเอ็นต์ทั้งหมดรองรับ FULL_SIZE

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

Enum
FULL_SIZE ลิงก์จะเปิดเป็นหน้าต่างขนาดเต็ม (หากเป็นเฟรมที่ไคลเอ็นต์ใช้)
OVERLAY ลิงก์จะเปิดเป็นภาพซ้อนทับ เช่น ป๊อปอัป

OverflowMenu

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

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

ช่อง
items[]

OverflowMenuItem

ต้องระบุ รายการตัวเลือกเมนู

OverflowMenuItem

ตัวเลือกที่ผู้ใช้เรียกใช้ได้ในเมนูรายการเพิ่มเติม

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

ช่อง
start_icon

Icon

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

string

ต้องระบุ ข้อความที่ระบุหรืออธิบายสินค้าต่อผู้ใช้
on_click

OnClick

ต้องระบุ การดำเนินการที่เรียกใช้เมื่อเลือกตัวเลือกเมนู OnClick นี้ต้องไม่มี OverflowMenu ระบบจะทิ้ง OverflowMenu ที่ระบุและปิดใช้รายการเมนู
disabled

bool

ตัวเลือกเมนูถูกปิดใช้หรือไม่ ค่าเริ่มต้นคือ false

SelectionInput

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

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

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

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

ช่อง
name

string

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
label

string

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

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

SelectionType

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

SelectionItem

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

Action

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
multi_select_min_query_length

int32

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

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

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

DataSourceConfig

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

หากระบุ ระบบจะไม่สนใจช่อง multi_select_max_selected_items, multi_select_min_query_length, external_data_source และ platform_data_source

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

int32

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

string

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

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

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

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace multi_select_data_source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
external_data_source

Action

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

PlatformDataSource

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

PlatformDataSource

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

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

ช่อง
ฟิลด์ Union data_source แหล่งข้อมูล data_source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
common_data_source

CommonDataSource

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

HostAppDataSourceMarkup

แหล่งข้อมูลที่มีเฉพาะในแอปพลิเคชันโฮสต์ของ Google Workspace เช่น พื้นที่ใน Google Chat

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

CommonDataSource

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

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

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

SelectionItem

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

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

ช่อง
text

string

ข้อความที่ระบุหรืออธิบายสินค้าต่อผู้ใช้
value

string

ค่าที่เชื่อมโยงกับรายการนี้ ไคลเอ็นต์ควรใช้ค่านี้เป็นค่าอินพุตของแบบฟอร์ม

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
selected

bool

มีการเลือกรายการโดยค่าเริ่มต้นหรือไม่ หากอินพุตการเลือกยอมรับค่าเดียวเท่านั้น (เช่น ปุ่มตัวเลือกหรือเมนูแบบเลื่อนลง) ให้ตั้งค่าช่องนี้สำหรับรายการเดียวเท่านั้น
bottom_text

string

สำหรับเมนูแบบเลือกหลายรายการ คำอธิบายข้อความหรือป้ายกำกับที่แสดงใต้ช่อง text ของรายการ
ฟิลด์ Union start_icon สำหรับเมนูแบบเลือกหลายรายการ URL ของไอคอนที่แสดงข้างฟิลด์ text ของรายการ รองรับไฟล์ PNG และ JPEG ต้องเป็น URL ของ HTTPS ตัวอย่างเช่น https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png start_icon ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
start_icon_uri

string

SelectionType

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

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

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

Enum
CHECK_BOX ชุดช่องทำเครื่องหมาย ผู้ใช้เลือกช่องทำเครื่องหมายได้ตั้งแต่ 1 ช่องขึ้นไป
RADIO_BUTTON ชุดปุ่มตัวเลือก ผู้ใช้เลือกปุ่มตัวเลือกได้ 1 ปุ่ม
SWITCH ชุดสวิตช์ ผู้ใช้สามารถเปิดสวิตช์อย่างน้อย 1 ตัว
DROPDOWN เมนูแบบเลื่อนลง ผู้ใช้เลือกได้ 1 รายการจากเมนู
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

คำแนะนำ

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

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

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

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

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

ช่อง
items[]

SuggestionItem

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

SuggestionItem

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

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

ช่อง

ฟิลด์ Union content

content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text

string

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

TextInput

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

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

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

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

ช่อง
name

string

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
label

string

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

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

ต้องระบุหากไม่ได้ระบุ hintText หรือจะเว้นว่างไว้ก็ได้
hint_text

string

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

ต้องระบุหากไม่ได้ระบุ label หรือจะเว้นว่างไว้ก็ได้
value

string

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

ดูรายละเอียดเกี่ยวกับการทำงานกับข้อมูลที่ป้อนในแบบฟอร์มได้ที่รับข้อมูลแบบฟอร์ม
type

Type

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

Action

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

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

Suggestions

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

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

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

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

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

Action

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

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

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

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

Validation

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

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

string

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

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

ฟิลด์ Union data_source

data_source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
host_app_data_source

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 ช่องป้อนข้อความมีความสูงคงที่หลายบรรทัด

TextParagraph

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

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

ช่อง
text

string

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

int32

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

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

TextSyntax

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

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

TextSyntax

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

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

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

ทริกเกอร์

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

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

ช่อง
action_rule_id

string

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

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

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

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

ช่อง
character_limit

int32

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

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

InputType

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

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

InputType

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

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

วิดเจ็ต

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

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

ช่อง
horizontal_alignment

HorizontalAlignment

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

string

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

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

Visibility

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

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

EventAction

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

พร้อมให้บริการสำหรับส่วนเสริมของ Google Workspace ที่ขยาย Google Workspace Studio ใช้ไม่ได้กับแอป Google Chat
ฟิลด์ Union data วิดเจ็ตมีได้เพียงรายการใดรายการหนึ่งต่อไปนี้ คุณใช้ฟิลด์วิดเจ็ตหลายรายการเพื่อแสดงรายการเพิ่มเติมได้ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text_paragraph

TextParagraph

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

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

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

Image

แสดงรูปภาพ

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

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

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"
  }
}
button_list

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"
        }
      }
    }
  ]
}
text_input

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"
      }
    ]
  }
}
selection_input

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
    }
  ]
}
date_time_picker

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}
grid

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

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

Carousel

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

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

ChipList

รายการชิป

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

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

HorizontalAlignment

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

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

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

ImageType

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

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

Enum
SQUARE ค่าเริ่มต้น ใช้มาสก์สี่เหลี่ยมจัตุรัสกับรูปภาพ เช่น รูปภาพ 4x3 จะกลายเป็น 3x3
CIRCLE ใช้มาสก์วงกลมกับรูปภาพ เช่น รูปภาพ 4x3 จะกลายเป็นวงกลมที่มีเส้นผ่านศูนย์กลาง 3

VerticalAlignment

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

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