คลาสพื้นฐานสำหรับปุ่มทั้งหมด
พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat
เมธอด
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
setAuthorizationAction(action) | Button | ตั้งค่าการดําเนินการให้สิทธิ์ที่จะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ |
setComposeAction(action, composedEmailType) | Button | ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ |
setOnClickAction(action) | Button | ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ |
setOnClickOpenLinkAction(action) | Button | ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ |
setOpenLink(openLink) | Button | ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ |
setOverflowMenu(menu) | Button | ตั้งค่าให้เมนูป๊อปอัปเปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ |
เอกสารประกอบโดยละเอียด
setAuthorizationAction(action)
ตั้งค่าการดําเนินการให้สิทธิ์ที่จะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ ซึ่งจะเป็นการเปิด URL ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามขั้นตอนการให้สิทธิ์เสร็จสิ้นและกลับไปที่แอปพลิเคชันแล้ว ส่วนเสริมจะโหลดซ้ำ
ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือ setComposeAction(action, composedEmailType)
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
action | AuthorizationAction | ออบเจ็กต์ที่ระบุการดำเนินการให้สิทธิ์ที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Button
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
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 | ออบเจ็กต์ที่ระบุการดำเนินการเขียนที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
composedEmailType | ComposedEmailType | ค่า Enum ที่ระบุว่าฉบับร่างที่เขียนขึ้นเป็นฉบับร่างแบบสแตนด์อโลนหรือฉบับร่างการตอบ |
รีเทิร์น
Button
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
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 | การดำเนินการที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Button
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
setOnClickOpenLinkAction(action)
ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อต้องสร้าง URL หรือเมื่อต้องดําเนินการอื่นๆ นอกเหนือจากการสร้างออบเจ็กต์ OpenLink
ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก 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 | ออบเจ็กต์ที่ระบุการดำเนินการเปิดลิงก์ที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Button
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
setOpenLink(openLink)
ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้วและต้องการเปิดเท่านั้น ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
หรือsetComposeAction(action, composedEmailType)
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
openLink | OpenLink | ออบเจ็กต์ OpenLink ที่อธิบาย URL ที่จะเปิด |
รีเทิร์น
Button
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
setOverflowMenu(menu)
ตั้งค่าให้เมนูป๊อปอัปเปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ แต่ละรายการในเมนูสามารถระบุการดำเนินการที่จะทริกเกอร์เมื่อมีการคลิก ระบบไม่รองรับเมนูที่ซ้อนกัน การดำเนินการสำหรับรายการในเมนูไม่ควรระบุเมนูรายการเพิ่มเติม
ใช้ได้กับแอป Google Chat เท่านั้น ไม่พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com')); const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
menu | OverflowMenu | ออบเจ็กต์ที่ระบุเมนูรายการเพิ่มเติมที่จะแสดงเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Button
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม