วิดเจ็ตที่แสดงข้อความพร้อมการตกแต่งที่ไม่บังคับ คีย์ที่เป็นไปได้ ได้แก่ ไอคอน ป้ายกำกับด้านบน และป้ายกำกับด้านล่าง การตั้งค่าเนื้อหาข้อความและคีย์ใดคีย์หนึ่งต้องใช้ set
และ Decorated
, Decorated
, set
หรือ set
ชั้นเรียนนี้มีไว้เพื่อแทนที่ Key
พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat
const decoratedText = CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel'); const multilineDecoratedText = CardService.newDecoratedText() .setText('Text') .setTopLabel('TopLabel') .setWrapText(true) .setBottomLabel('BottomLabel');
เมธอด
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
set | Decorated | ตั้งค่าการดำเนินการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ |
set | Decorated | ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงใต้เนื้อหาข้อความ |
set | Decorated | ตั้งค่า Button ที่แสดงทางด้านขวาของข้อความ |
set | Decorated | ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ |
set | Decorated | ตั้งค่า Icon ที่ไม่บังคับซึ่งจะแสดงทางด้านขวาของเนื้อหา |
set | Decorated | ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ |
set | Decorated | ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ |
set | Decorated | ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ |
set | Decorated | ตั้งค่า Icon (ไม่บังคับ) เพื่อแสดงก่อนเนื้อหาข้อความ |
set | Decorated | ตั้งค่า Switch ที่แสดงทางด้านขวาของเนื้อหา |
set | Decorated | ตั้งค่าข้อความที่จะใช้เป็นค่า |
set | Decorated | ตั้งค่าข้อความป้ายกำกับเพื่อใช้เป็นคีย์และแสดงเหนือเนื้อหาข้อความ |
set | Decorated | ตั้งค่าว่าควรแสดงข้อความค่าในบรรทัดเดียวหรือหลายบรรทัด |
เอกสารประกอบโดยละเอียด
set Authorization Action(action)
ตั้งค่าการดำเนินการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ ซึ่งจะเป็นการเปิด URL ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามขั้นตอนการให้สิทธิ์จนเสร็จสิ้นและกลับไปที่แอปพลิเคชันแล้ว ส่วนเสริมจะโหลดซ้ำ
ออบเจ็กต์ UI หนึ่งๆ มีการกําหนดค่าได้เพียง set
, set
, set
, set
หรือ set
เท่านั้น
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | Authorization | ออบเจ็กต์ที่ระบุการดำเนินการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Bottom Label(text)
ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงใต้เนื้อหาข้อความ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
text | String | ข้อความป้ายกำกับ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Button(button)
ตั้งค่า Button
ที่แสดงทางด้านขวาของข้อความ Decorated
รองรับปุ่มหรือสวิตช์ได้เพียง 1 ตัวเท่านั้น
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
button | Button | ปุ่มเพิ่ม |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Compose Action(action, composedEmailType)
ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ ออบเจ็กต์ UI หนึ่งๆ ตั้งค่าได้เพียง set
, set
, set
, set
หรือ set
เท่านั้น
พารามิเตอร์ Action
ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ Compose
ที่กําหนดค่าโดยใช้ Compose
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | Action | ออบเจ็กต์ที่ระบุการดำเนินการเขียนที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
composed | Composed | ค่า Enum ที่ระบุว่าข้อความร่างที่เขียนขึ้นเป็นข้อความร่างแบบสแตนด์อโลนหรือแบบตอบ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set End Icon(endIcon)
ตั้งค่า Icon
ที่ไม่บังคับซึ่งจะแสดงทางด้านขวาของเนื้อหา Decorated
รองรับปุ่ม สวิตช์ หรือไอคอนได้เพียงรายการเดียว
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
end | Icon | ไอคอนที่จะเพิ่ม |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set On Click Action(action)
ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ ออบเจ็กต์ UI หนึ่งๆ มีการกําหนดค่าได้เพียงค่าเดียวจาก set
, set
, set
, set
หรือ set
พารามิเตอร์ Action
ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ Action
// ... const action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton() .setText('Create notification') .setOnClickAction(action); // ... function notificationCallback() { return CardService.newActionResponseBuilder() .setNotification( CardService.newNotification().setText('Some info to display to user'), ) .build(); }
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | Action | การดำเนินการที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set On Click Open Link Action(action)
ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อต้องสร้าง URL หรือเมื่อต้องดําเนินการอื่นๆ นอกเหนือจากการสร้างออบเจ็กต์ Open
ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก set
, set
, set
, set
หรือ set
พารามิเตอร์ Action
ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ Action
ที่กําหนดค่าโดยใช้ Action
// ... const action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton() .setText('Open Link') .setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')) .build(); }
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | Action | ออบเจ็กต์ที่ระบุการดำเนินการเปิดลิงก์ที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Open Link(openLink)
ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้วและต้องการเปิดเท่านั้น ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก set
,
set
, set
, set
หรือset
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
open | Open | ออบเจ็กต์ Open ที่อธิบาย URL ที่จะเปิด |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Start Icon(startIcon)
ตั้งค่า Icon
(ไม่บังคับ) เพื่อแสดงก่อนเนื้อหาข้อความ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
start | Icon | ไอคอนที่จะแสดง |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Switch Control(switchToSet)
ตั้งค่า Switch
ที่แสดงทางด้านขวาของเนื้อหา Decorated
รองรับปุ่มหรือสวิตช์ได้เพียงรายการเดียว
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
switch | Switch | สวิตช์เพื่อเพิ่ม |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Text(text)
ตั้งค่าข้อความที่จะใช้เป็นค่า รองรับการจัดรูปแบบ HTML พื้นฐาน ต้องระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
text | String | เนื้อหาข้อความสําหรับวิดเจ็ตนี้ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Top Label(text)
ตั้งค่าข้อความป้ายกำกับเพื่อใช้เป็นคีย์และแสดงเหนือเนื้อหาข้อความ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
text | String | ข้อความป้ายกำกับ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Wrap Text(wrapText)
ตั้งค่าว่าควรแสดงข้อความค่าในบรรทัดเดียวหรือหลายบรรทัด
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
wrap | Boolean | หากเป็น true ระบบจะตัดข้อความและแสดงหลายบรรทัด มิฉะนั้น ระบบจะตัดข้อความ |
รีเทิร์น
Decorated
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม