Image
ที่มีรูปภาพแสดงอยู่
พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat
const imageButton = CardService.newImageButton() .setAltText('An image button with an airplane icon.') .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));
เมธอด
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
set | Image | ตั้งค่าข้อความแสดงแทนของปุ่มสำหรับการช่วยเหลือพิเศษ |
set | Image | ตั้งค่าการดำเนินการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ |
set | Image | ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ |
set | Image | ตั้งค่า Icon ที่กําหนดไว้ล่วงหน้าให้แสดงบนปุ่ม |
set | Image | ตั้งค่า URL ของรูปภาพที่จะใช้เป็นไอคอนของปุ่มนี้ |
set | Image | ตั้งค่าสไตล์ปุ่ม |
set | Image | ตั้งค่าไอคอน Material Design |
set | Image | ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ |
set | Image | ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ |
set | Image | ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ |
set | Image | ตั้งค่าให้เมนูป๊อปอัปเปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ |
เอกสารประกอบโดยละเอียด
set Alt Text(altText)
ตั้งค่าข้อความแสดงแทนของปุ่มสำหรับการช่วยเหลือพิเศษ ต้องระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
alt | String | ข้อความแสดงแทนที่จะกำหนดให้กับปุ่มนี้ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
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 | ออบเจ็กต์ที่ระบุการดำเนินการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
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 ที่ระบุว่าข้อความร่างที่เขียนขึ้นเป็นข้อความร่างแบบสแตนด์อโลนหรือแบบตอบ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Icon(icon)
ตั้งค่า Icon
ที่กําหนดไว้ล่วงหน้าให้แสดงบนปุ่ม ต้องใช้ค่านี้หรือ set
เพื่อกำหนดรูปภาพปุ่ม
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
icon | Icon | ค่า Icon ที่กําหนดไว้ล่วงหน้าค่าใดค่าหนึ่ง |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Icon Url(url)
ตั้งค่า URL ของรูปภาพที่จะใช้เป็นไอคอนของปุ่มนี้ ต้องใช้ค่านี้หรือ set
เพื่อกำหนดรูปภาพปุ่ม
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
url | String | ที่อยู่ URL ของรูปภาพที่โฮสต์ไว้เพื่อใช้เป็นไอคอนของปุ่มนี้ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Image Button Style(imageButtonStyle)
ตั้งค่าสไตล์ปุ่ม หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ปุ่ม Image
เป็นค่าเริ่มต้น
ใช้ได้กับแอป Google Chat เท่านั้น ไม่พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
image | Image | รูปแบบของปุ่ม |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Material Icon(icon)
ตั้งค่าไอคอน Material Design
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
icon | Material | ไอคอนการออกแบบ Material |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
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 | การดำเนินการที่จะทำเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
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 | ออบเจ็กต์ที่ระบุการดำเนินการเปิดลิงก์ที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Open Link(openLink)
ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้วและต้องการเปิดเท่านั้น ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก set
,
set
, set
, set
หรือset
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
open | Open | ออบเจ็กต์ Open ที่อธิบาย URL ที่จะเปิด |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม
set Overflow Menu(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 | Overflow | ออบเจ็กต์ที่ระบุเมนูรายการเพิ่มเติมที่จะแสดงเมื่อมีการคลิกองค์ประกอบนี้ |
รีเทิร์น
Image
— ออบเจ็กต์นี้สําหรับการต่อเชื่อม