Chip ที่มีไอคอนและป้ายกำกับแบบข้อความ คุณปิดใช้งานชิปได้เมื่อต้องการ
ใช้ได้กับแอป Google Chat ในรุ่นตัวอย่างสำหรับนักพัฒนาแอปของส่วนเสริม Google Workspace
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
เมธอด
| วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
|---|---|---|
set | Chip | ตั้งค่าข้อความแสดงแทนของชิปเพื่อการช่วยเหลือพิเศษ |
set | Chip | ตั้งค่าการดำเนินการให้สิทธิ์ที่จะเปิด URL ไปยังโฟลว์การให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ |
set | Chip | ตั้งค่าการดำเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ |
set | Chip | ตั้งค่าว่าจะปิดใช้ชิปหรือไม่ |
set | Chip | ตั้งค่าไอคอนที่จะใช้เป็นชิป |
set | Chip | ตั้งชื่อชิป |
set | Chip | ตั้งค่าการดำเนินการที่จะเรียกใช้เมื่อมีการคลิกออบเจ็กต์ |
set | Chip | ตั้งค่าการดำเนินการที่จะเปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ |
set | Chip | ตั้งค่า URL ที่จะเปิดเมื่อคลิกออบเจ็กต์ |
เอกสารโดยละเอียด
setAltText(altText)
ตั้งค่าข้อความแสดงแทนของชิปเพื่อการช่วยเหลือพิเศษ หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ค่าเริ่มต้นเป็นข้อความที่ แสดงในชิป
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
alt | String | ข้อความแสดงแทนที่จะกำหนดให้กับชิปนี้ |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setAuthorizationAction(action)
ตั้งค่าการดำเนินการให้สิทธิ์ที่จะเปิด URL ไปยังโฟลว์การให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ ซึ่งจะเป็นการเปิด URL ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามโฟลว์การให้สิทธิ์เสร็จสิ้นและ กลับไปที่แอปพลิเคชัน ส่วนเสริมจะโหลดซ้ำ
ออบเจ็กต์ UI จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action | Authorization | ออบเจ็กต์ที่ระบุการดำเนินการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setComposeAction(action, composedEmailType)
ตั้งค่าการดำเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI จะมีได้เพียงค่าใดค่าหนึ่งจาก setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) เท่านั้น
พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ ComposeActionResponse ที่กำหนดค่าโดยใช้ ComposeActionResponseBuilder.setGmailDraft(draft)
// ... 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 ที่ระบุว่าฉบับร่างที่เขียนขึ้นเป็นฉบับร่างแบบ สแตนด์อโลนหรือฉบับร่างการตอบกลับ |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setDisabled(disabled)
ตั้งค่าว่าจะปิดใช้ชิปหรือไม่ ชิปที่ปิดใช้จะเป็นสีเทาและคลิกไม่ได้
const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
disabled | Boolean | สถานะปิดใช้ |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setIcon(icon)
ตั้งค่าไอคอนที่จะใช้เป็นชิป
const chip = CardService.newChip().setIcon( CardService.newIconImage().setMaterialIcon( CardService.newMaterialIcon().setName('bug_report'), ), );
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
icon | Icon | ค่าใดค่าหนึ่งจากค่า Icon ที่กำหนดไว้ล่วงหน้า |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setLabel(label)
ตั้งชื่อชิป ต้องระบุ
const chip = CardService.newChip().setLabel('bug Report');
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
label | String | ข้อความที่จะแสดง |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setOnClickAction(action)
ตั้งค่าการดำเนินการที่จะเรียกใช้เมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง
setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)
พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ ActionResponse
// ... 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 | การดำเนินการที่จะทำเมื่อคลิกองค์ประกอบนี้ |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setOnClickOpenLinkAction(action)
ตั้งค่าการดำเนินการที่จะเปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อต้องสร้าง URL หรือเมื่อต้องดำเนินการอื่นๆ นอกเหนือจากการสร้างออบเจ็กต์ OpenLink ออบเจ็กต์ UI จะมีได้เพียงค่าใดค่าหนึ่งจาก setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)
พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ ActionResponse ที่กำหนดค่าโดยใช้ ActionResponseBuilder.setOpenLink(openLink)
// ... 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 | ออบเจ็กต์ที่ระบุการดำเนินการเปิดลิงก์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง
setOpenLink(openLink)
ตั้งค่า URL ที่จะเปิดเมื่อคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้วและต้องการเปิดเท่านั้น ออบเจ็กต์ UI จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง setOpenLink(openLink),
setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
open | Open | ออบเจ็กต์ Open ที่อธิบาย URL ที่จะเปิด |
รีเทิร์น
Chip — ออบเจ็กต์นี้สำหรับการเชื่อมโยง