Class ImageButton

ImageButton

ImageButton dengan gambar yang ditampilkan di dalamnya.

Tersedia untuk Add-on Google Workspace dan aplikasi 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'));

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAltText(altText)ImageButtonMengatur teks alternatif tombol untuk aksesibilitas.
setAuthorizationAction(action)ImageButtonMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setComposeAction(action, composedEmailType)ImageButtonMenetapkan tindakan yang menulis draf email saat objek diklik.
setIcon(icon)ImageButtonMenyetel Icon yang telah ditentukan untuk ditampilkan pada tombol.
setIconUrl(url)ImageButtonMenetapkan URL gambar yang akan digunakan sebagai ikon tombol ini.
setImageButtonStyle(imageButtonStyle)ImageButtonMenetapkan gaya tombol.
setMaterialIcon(icon)ImageButtonMenetapkan ikon desain material.
setOnClickAction(action)ImageButtonMenetapkan tindakan yang dieksekusi saat objek diklik.
setOnClickOpenLinkAction(action)ImageButtonMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)ImageButtonMenetapkan URL yang akan dibuka saat objek diklik.
setOverflowMenu(menu)ImageButtonMenyetel menu pop-up yang akan dibuka saat objek diklik.

Dokumentasi mendetail

setAltText(altText)

Mengatur teks alternatif tombol untuk aksesibilitas. Wajib.

Parameter

NamaJenisDeskripsi
altTextStringTeks alternatif yang akan ditetapkan ke tombol ini.

Pulang pergi

ImageButton — Objek ini, untuk perantaian.


setAuthorizationAction(action)

Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik. Tindakan ini akan membuka URL di jendela baru. Saat pengguna menyelesaikan alur otorisasi dan kembali ke aplikasi, add-on akan dimuat ulang.

Objek UI hanya dapat memiliki salah satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) yang ditetapkan.

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parameter

NamaJenisDeskripsi
actionAuthorizationActionObjek yang menentukan tindakan otorisasi yang akan diambil saat elemen ini diklik.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


setComposeAction(action, composedEmailType)

Menetapkan tindakan yang menulis draf email saat objek diklik. Objek UI hanya dapat memiliki salah satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) yang ditetapkan.

Parameter Action harus menentukan fungsi callback yang menampilkan objek ComposeActionResponse yang dikonfigurasi menggunakan ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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();
}

Parameter

NamaJenisDeskripsi
actionActionObjek yang menentukan tindakan penulisan yang akan dilakukan saat elemen ini diklik.
composedEmailTypeComposedEmailTypeNilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau balasan.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


setIcon(icon)

Menetapkan Icon standar untuk ditampilkan di tombol. Ini atau setIconUrl(url) harus digunakan untuk menentukan gambar tombol.

Parameter

NamaJenisDeskripsi
iconIconSalah satu nilai Icon standar.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


setIconUrl(url)

Menetapkan URL gambar yang akan digunakan sebagai ikon tombol ini. Ini atau setIcon(icon) harus digunakan untuk menentukan gambar tombol.

Parameter

NamaJenisDeskripsi
urlStringAlamat URL gambar yang dihosting untuk digunakan sebagai ikon tombol ini.

Pulang pergi

ImageButton — Objek ini, untuk perantaian.


setImageButtonStyle(imageButtonStyle)

Menetapkan gaya tombol. Jika tidak disetel, kebijakan ini akan disetel secara default ke tombol ImageButtonStyle.BORDERLESS.

Hanya tersedia untuk aplikasi Google Chat. Tidak tersedia untuk Add-on Google Workspace.

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

Parameter

NamaJenisDeskripsi
imageButtonStyleImageButtonStyleGaya tombol.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


setMaterialIcon(icon)

Menetapkan ikon desain material.

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

Parameter

NamaJenisDeskripsi
iconMaterialIconIkon desain material.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


setOnClickAction(action)

Menetapkan tindakan yang dieksekusi saat objek diklik. Objek UI hanya dapat memiliki salah satu setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) yang ditetapkan.

Parameter Action harus menentukan fungsi callback yang menampilkan objek 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();
}

Parameter

NamaJenisDeskripsi
actionActionTindakan yang akan diambil saat elemen ini diklik.

Pulang pergi

ImageButton — Objek ini, untuk perantaian.


setOnClickOpenLinkAction(action)

Menetapkan tindakan yang membuka URL di tab saat objek diklik. Gunakan fungsi ini saat URL perlu dibuat atau saat Anda perlu melakukan tindakan lain selain membuat objek OpenLink. Objek UI hanya dapat memiliki salah satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) yang ditetapkan.

Parameter Action harus menentukan fungsi callback yang menampilkan objek ActionResponse yang dikonfigurasi menggunakan 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();
}

Parameter

NamaJenisDeskripsi
actionActionObjek yang menentukan tindakan link terbuka yang akan diambil saat elemen ini diklik.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


Menetapkan URL yang akan dibuka saat objek diklik. Gunakan fungsi ini jika URL sudah diketahui dan hanya perlu dibuka. Objek UI hanya dapat memiliki salah satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) yang ditetapkan.

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.


setOverflowMenu(menu)

Menetapkan menu pop-up yang akan dibuka saat objek diklik. Setiap item dalam menu dapat menentukan tindakan yang akan dipicu saat diklik. Menu bertingkat tidak didukung, tindakan untuk item menu tidak boleh menentukan menu tambahan.

Hanya tersedia untuk aplikasi Google Chat. Tidak tersedia untuk Add-on 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();

Parameter

NamaJenisDeskripsi
menuOverflowMenuObjek yang menentukan menu tambahan untuk ditampilkan saat elemen ini diklik.

Pulang pergi

ImageButton — Objek ini, untuk pembuatan rantai.