Package google.apps.card.v1

string

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

ตัวอย่างการใช้งาน โปรดดูหัวข้ออ่านข้อมูลแบบฟอร์ม

ActionParameter

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

LoadIndicator

ระบุสัญญาณบอกสถานะการโหลดที่การดำเนินการจะแสดงขณะเรียกการดำเนินการ

bool

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

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

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

Interaction

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

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

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

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

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

string

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

string

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

BorderType

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

Color

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

int32

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

string

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

Icon

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

Color

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

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

สำหรับสีแดง เขียว และน้ำเงิน ค่าของแต่ละฟิลด์เป็นตัวเลข float ที่คุณแสดงได้ 2 วิธี ได้แก่ เป็นตัวเลขระหว่าง 0 ถึง 255 หารด้วย 255 (153/255) หรือเป็นค่าระหว่าง 0 ถึง 1 (0.6) 0 หมายถึงไม่มีสี และ 1 หรือ 255/255 หมายถึงมีสีนั้นอย่างเต็มรูปแบบในสเกล RGB

เลือกตั้งค่า alpha ซึ่งตั้งค่าระดับความโปร่งใสโดยใช้สมการนี้

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

สำหรับ alpha ค่า 1 จะสอดคล้องกับสีทึบ และค่า 0 จะสอดคล้องกับสีที่โปร่งใสโดยสมบูรณ์

ตัวอย่างเช่น สีต่อไปนี้แทนสีแดงโปร่งแสงครึ่งหนึ่ง

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

OnClick

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

bool

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

string

ข้อความสำรองที่ใช้สำหรับการเข้าถึง

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

Button

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

CardHeader

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

Section

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

DividerStyle

รูปแบบตัวแบ่งระหว่างส่วนต่างๆ

CardAction

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

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

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

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

ชื่อบัตร ใช้เป็นตัวระบุการ์ดในการนำทางการ์ด

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

CardFixedFooter

ส่วนท้ายแบบคงที่ซึ่งแสดงที่ด้านล่างของการ์ดนี้

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

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

DisplayStyle

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

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

CardHeader

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

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

string

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

OnClick

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

Button

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

Button

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

string

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

string

ชื่อรองของส่วนหัวของการ์ด หากระบุ จะปรากฏบรรทัดเดียวใต้ title

ImageType

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

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

string

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

string

ข้อความสำรองของรูปภาพนี้ที่ใช้สำหรับการเข้าถึง

string

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

Widget

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

bool

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

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

หากต้องการพิจารณาว่าวิดเจ็ตใดซ่อนอยู่ ให้ระบุ uncollapsibleWidgetsCount

int32

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

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

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

วิดเจ็ต TextParagraph

Image

วิดเจ็ต Image

DecoratedText

วิดเจ็ต DecoratedText

ButtonList

วิดเจ็ต ButtonList

TextInput

วิดเจ็ต TextInput

SelectionInput

วิดเจ็ต SelectionInput

DateTimePicker

วิดเจ็ต DateTimePicker

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

string

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

DateTimePickerType

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

int64

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

ระบุค่าตามประเภทของเครื่องมือเลือก (DateTimePickerType) ดังนี้

• DATE_AND_TIME: วันที่และเวลาในปฏิทินตามเขตเวลา UTC เช่น ใช้ 1672574400000 เพื่อแสดงวันที่ 1 มกราคม 2023 เวลา 12:00 น. UTC
• DATE_ONLY: วันที่ในปฏิทินเวลา 00:00:00 น. ตามเขตเวลา UTC เช่น ใช้ 1672531200000 เพื่อแสดงในวันที่ 1 มกราคม 2023
• TIME_ONLY: เวลาในเขตเวลา UTC เช่น หากต้องการแสดงเวลา 12:00 น. ให้ใช้ 43200000 (หรือ 12 * 60 * 60 * 1000)

int32

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

Action

ทริกเกอร์เมื่อผู้ใช้คลิกบันทึกหรือล้างจากอินเทอร์เฟซ DateTimePicker

Icon

เลิกใช้งานเพื่อใช้ startIcon แทน

Icon

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

string

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

string

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

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

bool

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

ใช้เฉพาะกับ text เท่านั้น ไม่ใช่ topLabel และ bottomLabel

string

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

OnClick

ระบบจะทริกเกอร์การดำเนินการนี้เมื่อผู้ใช้คลิก topLabel หรือ bottomLabel

Button

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

SwitchControl

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

Icon

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

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

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

bool

เมื่อtrue ระบบจะเลือกสวิตช์

Action

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

ControlType

ลักษณะที่สวิตช์ปรากฏในอินเทอร์เฟซผู้ใช้

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

Action

การดำเนินการแสดงผลสำหรับไคลเอ็นต์เพื่อสิ้นสุดการทำงานของกล่องโต้ตอบ

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

Suggestions

string

นี่เป็นช่องสคีมาที่ไม่มีการดำเนินการซึ่งอาจแสดงอยู่ในมาร์กอัปเพื่อตรวจสอบไวยากรณ์

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

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

ImageComponent

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

string

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

string

คำบรรยายของรายการในตาราง

GridItemLayout

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

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 ของไอคอน

ImageType

รูปแบบการครอบตัดที่ใช้กับรูปภาพ ในบางกรณี การใช้การครอบตัด CIRCLE จะทำให้วาดรูปภาพมีขนาดใหญ่กว่าไอคอนในตัว

string

แสดงไอคอนในตัวของ Google Workspace

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

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

string

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

เช่น

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

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

MaterialIcon

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

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

"materialIcon": {
  "name": "check_box"
}

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

string

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

เช่น

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

OnClick

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

string

ข้อความสำรองของรูปภาพนี้ที่ใช้สำหรับการเข้าถึง

string

URL รูปภาพ

string

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

ImageCropStyle

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

BorderStyle

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

ImageCropType

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

double

สัดส่วนภาพที่จะใช้หากประเภทการครอบตัดคือ RECTANGLE_CUSTOM

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

URL ของลิงก์ที่จะกลับไปที่ส่วนเสริม

string

ชื่อของลิงก์ที่จะกลับไปยังส่วนเสริม

Card

การ์ดที่แสดงข้อมูลเกี่ยวกับลิงก์จากบริการของบุคคลที่สาม

string

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

string

ชื่อที่แสดงในตัวอย่างลิงก์ หากไม่ได้ตั้งค่า ตัวอย่างลิงก์จะแสดงส่วนหัวของ preview_card

string

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

bool

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

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

int32

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

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

int32

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

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

bool

สแต็กการ์ดจะเปิดการ์ดทั้งหมดออกมา ยกเว้นการ์ดรูท

bool

ชุดการ์ดเปิดการ์ดปิด 1 ใบ

string

ชุดการ์ดจะแสดงการ์ดทั้งหมดเหนือการ์ดที่ระบุพร้อมด้วยชื่อการ์ดที่ระบุ

Card

ชุดการ์ดจะพุชการ์ดเข้าไปในชุดการ์ด

Card

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

EndNavigation

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

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

string

ข้อความธรรมดาที่จะแสดงสำหรับการแจ้งเตือน โดยไม่มีแท็ก HTML

Action

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

OpenLink

หากระบุ onClick นี้จะทริกเกอร์การดำเนินการลิงก์แบบเปิด

Action

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

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

Card

การ์ดใหม่จะพุชไปยังชุดการ์ดหลังจากคลิกแล้ว (หากระบุไว้)

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

string

URL ที่จะเปิด

OpenAs

วิธีเปิดลิงก์

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

OnClose

ไม่ว่าลูกค้าจะลืมลิงก์ใดๆ หลังจากเปิดลิงก์แล้ว หรือเฝ้าสังเกตลิงก์จนกว่าหน้าต่างจะปิดลง

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

Action

HostAppActionMarkup

การดำเนินการที่จัดการโดยแอปโฮสต์แต่ละแอป

string

นี่เป็นช่องสคีมาที่ไม่มีการดำเนินการซึ่งอาจแสดงอยู่ในมาร์กอัปเพื่อตรวจสอบไวยากรณ์

Navigation

ดัน ดึง หรืออัปเดตการ์ดที่แสดง

OpenLink

เปิดลิงก์เป้าหมายในแท็บใหม่หรือป๊อปอัปทันที

Notification

แสดงการแจ้งเตือนแก่ผู้ใช้ปลายทาง

LinkPreview

แสดงตัวอย่างลิงก์แก่ผู้ใช้ปลายทาง

Link

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

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

string

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

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

SelectionType

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

SelectionItem

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

Action

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

int32

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

int32

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

หากไม่ระบุ ค่าเริ่มต้นจะเป็น 0 อักขระสำหรับแหล่งข้อมูลแบบคงที่ และ 3 อักขระสำหรับแหล่งข้อมูลภายนอก

Action

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

PlatformDataSource

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

CommonDataSource

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

HostAppDataSourceMarkup

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

string

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

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

bool

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

string

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

string

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

RenderActions

ชุดวิธีการในการแสดงผลซึ่งบอกให้การ์ดดำเนินการและ/หรือบอกให้แอปโฮสต์ของส่วนเสริมให้ดำเนินการเฉพาะแอป

bool

สถานะของการ์ดมีการเปลี่ยนแปลงและข้อมูลในการ์ดที่มีอยู่ไม่มีอัปเดตหรือไม่

string

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

SuggestionItem

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

string

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

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

string

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

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

ต้องระบุหากไม่ได้ระบุ hintText หรือไม่บังคับ

string

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

ต้องระบุหากไม่ได้ระบุ label หรือไม่บังคับ

string

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

โปรดดูรายละเอียดเกี่ยวกับการทำงานกับอินพุตแบบฟอร์มที่หัวข้อรับข้อมูลแบบฟอร์ม

Type

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

Action

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

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

Suggestions

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

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

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

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

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

Action

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

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

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

พร้อมใช้งานในส่วนเสริมของ Google Workspace และไม่พร้อมใช้งานในแอป Google Chat

string

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

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

string

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

HorizontalAlignment

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

TextParagraph

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

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

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

Image

แสดงรูปภาพ

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

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

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

ButtonList

รายการปุ่ม

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

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
        "alpha": 1
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

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

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}

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

แสดงได้สูงสุด 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"
          }
        }
      ]
    }
  ]
}