Class TextButton

ข้อความปุ่ม

TextButton ที่มีป้ายกำกับข้อความ คุณสามารถตั้งค่าสีพื้นหลังและปิดใช้งานปุ่มได้เมื่อต้องการ

พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
setAltText(altText)	TextButton	ตั้งค่าข้อความแสดงแทนของปุ่มสำหรับการช่วยเหลือพิเศษ
setAuthorizationAction(action)	TextButton	ตั้งค่าการดำเนินการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์
setBackgroundColor(backgroundColor)	TextButton	กำหนดสีพื้นหลังสำหรับปุ่ม TextButtonStyle.FILLED
setComposeAction(action, composedEmailType)	TextButton	ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ
setDisabled(disabled)	TextButton	ตั้งค่าว่าจะปิดใช้ปุ่มหรือไม่
setIcon(icon)	TextButton	ตั้งค่า Icon ที่กําหนดไว้ล่วงหน้าให้แสดงบนปุ่ม
setIconUrl(url)	TextButton	ตั้งค่า URL ของรูปภาพที่จะใช้เป็นไอคอนของปุ่มนี้
setMaterialIcon(icon)	TextButton	ตั้งค่าไอคอน Material Design
setOnClickAction(action)	TextButton	ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ
setOnClickOpenLinkAction(action)	TextButton	ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์
setOpenLink(openLink)	TextButton	ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์
setOverflowMenu(menu)	TextButton	ตั้งค่าให้เมนูป๊อปอัปเปิดขึ้นเมื่อมีการคลิกออบเจ็กต์
setText(text)	TextButton	ตั้งค่าข้อความที่แสดงบนปุ่ม
setTextButtonStyle(textButtonStyle)	TextButton	ตั้งค่าสไตล์ปุ่ม

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

setAltText(altText)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setBackgroundColor(backgroundColor)

กำหนดสีพื้นหลังสำหรับปุ่ม TextButtonStyle.FILLED หากไม่ได้ตั้งค่าสำหรับปุ่ม TextButtonStyle.FILLED ปุ่มจะใช้สีรองที่กําหนดไว้ใน manifest ของส่วนเสริม วิธีนี้ใช้ไม่ได้กับปุ่ม TextButtonStyle.OUTLINED

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
backgroundColor	String	สีในรูปแบบ #rgb

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setDisabled(disabled)

ตั้งค่าว่าจะปิดใช้ปุ่มหรือไม่ ปุ่มที่ปิดใช้จะเป็นสีเทาและคลิกไม่ได้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
disabled	Boolean	สถานะปิดใช้

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setIcon(icon)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setIconUrl(url)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setMaterialIcon(icon)

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

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
icon	MaterialIcon	ไอคอนการออกแบบ Material

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setOpenLink(openLink)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setText(text)

ตั้งค่าข้อความที่แสดงบนปุ่ม

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
text	String	ข้อความที่ปรากฏบนปุ่ม

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setTextButtonStyle(textButtonStyle)

ตั้งค่าสไตล์ปุ่ม หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ปุ่ม TextButtonStyle.OUTLINED เป็นค่าเริ่มต้น

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สําหรับการต่อเชื่อม