Class Button

Button

คลาสพื้นฐานสำหรับปุ่มทั้งหมด

พร้อมให้บริการสำหรับส่วนเสริมของ 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 จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง 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)

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

รีเทิร์น

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 จะมีได้เพียงค่าใดค่าหนึ่งจาก 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 จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)

พารามิเตอร์

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

รีเทิร์น

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

---

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

รีเทิร์น

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