Class ImageButton

ImageButton

ImageButton ที่แสดงรูปภาพ

พร้อมให้บริการสำหรับส่วนเสริมของ 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'));

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
setAltText(altText)	ImageButton	ตั้งค่าข้อความแสดงแทนของปุ่มเพื่อการช่วยเหลือพิเศษ
setAuthorizationAction(action)	ImageButton	ตั้งค่าการดำเนินการให้สิทธิ์ที่จะเปิด URL ไปยังโฟลว์การให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์
setComposeAction(action, composedEmailType)	ImageButton	ตั้งค่าการดำเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์
setIcon(icon)	ImageButton	กำหนด Icon ที่กำหนดไว้ล่วงหน้าเพื่อแสดงบนปุ่ม
setIconUrl(url)	ImageButton	ตั้งค่า URL ของรูปภาพที่จะใช้เป็นไอคอนของปุ่มนี้
setImageButtonStyle(imageButtonStyle)	ImageButton	กำหนดรูปแบบปุ่ม
setMaterialIcon(icon)	ImageButton	ตั้งค่าไอคอน Material Design
setOnClickAction(action)	ImageButton	ตั้งค่าการดำเนินการที่จะเรียกใช้เมื่อมีการคลิกออบเจ็กต์
setOnClickOpenLinkAction(action)	ImageButton	ตั้งค่าการดำเนินการที่จะเปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์
setOpenLink(openLink)	ImageButton	ตั้งค่า URL ที่จะเปิดเมื่อคลิกออบเจ็กต์
setOverflowMenu(menu)	ImageButton	ตั้งค่าเมนูป๊อปอัปให้เปิดขึ้นเมื่อคลิกออบเจ็กต์

เอกสารโดยละเอียด

setAltText(altText)

ตั้งค่าข้อความแสดงแทนของปุ่มเพื่อการช่วยเหลือพิเศษ ต้องระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
altText	String	ข้อความแสดงแทนที่จะกำหนดให้กับปุ่มนี้

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

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	AuthorizationAction	ออบเจ็กต์ที่ระบุการดำเนินการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setComposeAction(action, composedEmailType)

ตั้งค่าการดำเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI จะมีได้เพียงค่าใดค่าหนึ่งจาก setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) เท่านั้น

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ ComposeActionResponse ที่กำหนดค่าโดยใช้ ComposeActionResponseBuilder.setGmailDraft(draft)

หมายเหตุ: เมธอดนี้ไม่ได้ตั้งค่าการดำเนินการเขียนที่ใช้เพื่อขยาย UI การเขียน แต่เมธอดนี้จะเชื่อมต่อองค์ประกอบ UI นี้กับ Action ที่เขียนข้อความร่างใน Apps Script ซึ่งจะ เปิดใน Gmail เมื่อการดำเนินการเสร็จสมบูรณ์

// ...

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 ที่ระบุว่าฉบับร่างที่เขียนขึ้นเป็นฉบับร่างแบบ สแตนด์อโลนหรือฉบับร่างการตอบกลับ

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setIcon(icon)

กำหนด Icon ที่กำหนดไว้ล่วงหน้าเพื่อแสดงบนปุ่ม ต้องใช้ตัวเลือกนี้หรือ setIconUrl(url) เพื่อกำหนดรูปภาพปุ่ม

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
icon	Icon	ค่าใดค่าหนึ่งจากค่า Icon ที่กำหนดไว้ล่วงหน้า

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setIconUrl(url)

ตั้งค่า URL ของรูปภาพที่จะใช้เป็นไอคอนของปุ่มนี้ ต้องใช้ค่านี้หรือ setIcon(icon) เพื่อกำหนดรูปภาพปุ่ม

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
url	String	ที่อยู่ URL ของรูปภาพที่โฮสต์ไว้เพื่อใช้เป็นไอคอนของปุ่มนี้

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setImageButtonStyle(imageButtonStyle)

กำหนดรูปแบบปุ่ม หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ปุ่ม ImageButtonStyle.BORDERLESS เป็นค่าเริ่มต้น

ใช้ได้กับแอป Google Chat ในรุ่นตัวอย่างสำหรับนักพัฒนาแอปของส่วนเสริม Google Workspace

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: พร้อมใช้งานเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาซอฟต์แวร์ของ Google Workspace ซึ่งให้สิทธิ์ทดลองใช้ฟีเจอร์บางอย่างก่อนเปิดตัว

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
imageButtonStyle	ImageButtonStyle	รูปแบบของปุ่ม

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setMaterialIcon(icon)

ตั้งค่าไอคอน Material Design

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
icon	MaterialIcon	ไอคอนดีไซน์ Material

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

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	การดำเนินการที่จะทำเมื่อคลิกองค์ประกอบนี้

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

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	ออบเจ็กต์ที่ระบุการดำเนินการเปิดลิงก์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setOpenLink(openLink)

ตั้งค่า URL ที่จะเปิดเมื่อคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้วและต้องการเปิดเท่านั้น ออบเจ็กต์ UI จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
openLink	OpenLink	ออบเจ็กต์ OpenLink ที่อธิบาย URL ที่จะเปิด

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง

---

setOverflowMenu(menu)

ตั้งค่าเมนูป๊อปอัปให้เปิดขึ้นเมื่อคลิกออบเจ็กต์ แต่ละรายการในเมนูสามารถระบุ การทำงานที่จะทริกเกอร์เมื่อคลิก ระบบไม่รองรับเมนูที่ซ้อนกัน และการดำเนินการสำหรับรายการในเมนู ไม่ควรกำหนดเมนูรายการเพิ่มเติม

ใช้ได้กับแอป Google Chat ในรุ่นตัวอย่างสำหรับนักพัฒนาแอปของส่วนเสริม Google Workspace

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: พร้อมใช้งานเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาซอฟต์แวร์ของ 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	ออบเจ็กต์ที่ระบุเมนูรายการเพิ่มเติมที่จะแสดงเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

ImageButton — ออบเจ็กต์นี้สำหรับการเชื่อมโยง