หน้านี้ได้รับการแปลโดย Cloud Translation API

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

รีเทิร์น

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() {
  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

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 จะมีการตั้งค่าได้เพียง 1 รายการจาก 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) ได้เพียง 1 รายการเท่านั้น

พารามิเตอร์

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

รีเทิร์น

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

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

รีเทิร์น

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