วิดเจ็ตที่แสดงข้อความพร้อมการตกแต่งที่ไม่บังคับ คีย์ที่เป็นไปได้ประกอบด้วยไอคอน ป้ายกำกับด้านบน และป้ายกำกับด้านล่าง จำเป็นต้องตั้งค่าเนื้อหาข้อความและคีย์ใดคีย์หนึ่งโดยใช้ setText(text)
และ DecoratedText
, DecoratedText
, setTopLabel(text)
หรือ setBottomLabel(text)
อย่างใดอย่างหนึ่ง คลาสนี้มีไว้เพื่อแทนที่ KeyValue
ใช้ได้กับส่วนเสริมของ Google Workspace และแอป Google Chat
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var multilineDecoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel") .setWrapText(true) .setBottomLabel("BottomLabel");
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
setAuthorizationAction(action) | DecoratedText | ตั้งค่าการดำเนินการการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ |
setBottomLabel(text) | DecoratedText | ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงอยู่ใต้เนื้อหาข้อความ |
setButton(button) | DecoratedText | ตั้งค่า Button ที่ปรากฏทางด้านขวาของข้อความ |
setComposeAction(action, composedEmailType) | DecoratedText | ตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ |
setEndIcon(endIcon) | DecoratedText | ตั้งค่า IconImage ที่ไม่บังคับ ซึ่งจะแสดงทางด้านขวาของเนื้อหา |
setOnClickAction(action) | DecoratedText | ตั้งค่าการทำงานที่จะดำเนินการเมื่อมีการคลิกออบเจ็กต์ |
setOnClickOpenLinkAction(action) | DecoratedText | ตั้งค่าการดำเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ |
setOpenLink(openLink) | DecoratedText | ตั้งค่า URL ที่จะเปิดเมื่อมีการคลิกออบเจ็กต์ |
setStartIcon(startIcon) | DecoratedText | ตั้งค่า IconImage ที่ไม่บังคับให้แสดงก่อนเนื้อหาข้อความ |
setSwitchControl(switchToSet) | DecoratedText | ตั้งค่า Switch ที่แสดงทางด้านขวาของเนื้อหา |
setText(text) | DecoratedText | ตั้งค่าข้อความที่จะใช้เป็นค่า |
setTopLabel(text) | DecoratedText | ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงอยู่เหนือเนื้อหาข้อความ |
setWrapText(wrapText) | DecoratedText | ตั้งค่าว่าข้อความของค่าควรแสดงในบรรทัดเดียวหรือหลายบรรทัด |
เอกสารโดยละเอียด
setAuthorizationAction(action)
ตั้งค่าการดำเนินการการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ การดำเนินการนี้จะเปิด URL ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามขั้นตอนการให้สิทธิ์เสร็จสิ้นและกลับไปที่แอปพลิเคชันแล้ว ส่วนเสริมจะโหลดซ้ำ
ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | AuthorizationAction | ออบเจ็กต์ที่ระบุการดำเนินการการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setBottomLabel(text)
ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงอยู่ใต้เนื้อหาข้อความ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
text | String | ข้อความป้ายกำกับ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setButton(button)
ตั้งค่า Button
ที่ปรากฏทางด้านขวาของข้อความ DecoratedText
รองรับปุ่มได้เพียงปุ่มเดียวหรือสวิตช์ 1 ตัวเท่านั้น
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
button | Button | ปุ่มที่จะเพิ่ม |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setComposeAction(action, composedEmailType)
ตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
อย่างใดอย่างหนึ่งเท่านั้น
พารามิเตอร์ Action
ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ ComposeActionResponse
ที่กำหนดค่าโดยใช้ ComposeActionResponseBuilder.setGmailDraft(draft)
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | Action | ออบเจ็กต์ที่ระบุการดำเนินการเขียนที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
composedEmailType | ComposedEmailType | ค่า enum ที่ระบุว่าฉบับร่างที่เขียนเป็นฉบับร่างแบบสแตนด์อโลนหรือฉบับร่างของการตอบกลับ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setEndIcon(endIcon)
ตั้งค่า IconImage
ที่ไม่บังคับ ซึ่งจะแสดงทางด้านขวาของเนื้อหา DecoratedText
รองรับได้เพียงปุ่มเดียว สวิตช์ 1 รายการ หรือไอคอน 1 รายการเท่านั้น
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
endIcon | IconImage | ไอคอนที่จะเพิ่ม |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setOnClickAction(action)
ตั้งค่าการทำงานที่จะดำเนินการเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น
พารามิเตอร์ Action
ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ ActionResponse
// ... var 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 | การดำเนินการที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setOnClickOpenLinkAction(action)
ตั้งค่าการดำเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อจำเป็นต้องสร้าง URL หรือเมื่อคุณต้องดำเนินการอื่นๆ ในโปรแกรมเพิ่มเติมเพื่อสร้างออบเจ็กต์ OpenLink
ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น
พารามิเตอร์ Action
ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ ActionResponse
ที่กำหนดค่าโดยใช้ ActionResponseBuilder.setOpenLink(openLink)
// ... var 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 | ออบเจ็กต์ที่ระบุการทำงานของลิงก์แบบเปิดที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setOpenLink(openLink)
ตั้งค่า URL ที่จะเปิดเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้ว
และจำเป็นต้องเปิดเท่านั้น ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
openLink | OpenLink | ออบเจ็กต์ OpenLink ที่อธิบาย URL ที่จะเปิด |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setStartIcon(startIcon)
ตั้งค่า IconImage
ที่ไม่บังคับให้แสดงก่อนเนื้อหาข้อความ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
startIcon | IconImage | ไอคอนที่จะแสดง |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setSwitchControl(switchToSet)
ตั้งค่า Switch
ที่แสดงทางด้านขวาของเนื้อหา DecoratedText
รองรับปุ่มได้เพียงปุ่มเดียวหรือสวิตช์ 1 ตัวเท่านั้น
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
switchToSet | Switch | สวิตช์ที่จะเพิ่ม |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setText(text)
ตั้งค่าข้อความที่จะใช้เป็นค่า รองรับการจัดรูปแบบ HTML พื้นฐาน ต้องระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
text | String | เนื้อหาข้อความสำหรับวิดเจ็ตนี้ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setTopLabel(text)
ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงอยู่เหนือเนื้อหาข้อความ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
text | String | ข้อความป้ายกำกับ |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน
setWrapText(wrapText)
ตั้งค่าว่าข้อความของค่าควรแสดงในบรรทัดเดียวหรือหลายบรรทัด
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
wrapText | Boolean | หากเป็น true ข้อความจะถูกตัดออกและแสดงเป็นหลายบรรทัด มิเช่นนั้น ระบบจะตัดข้อความให้สั้นลง |
รีเทิร์น
DecoratedText
— ออบเจ็กต์นี้สำหรับการทำเชน