Class Image

Gambar

Widget yang menampilkan satu gambar. Untuk mengetahui informasi tentang memangkas gambar, lihat ImageCropStyle.

Tersedia untuk add-on Google Workspace dan aplikasi Google Chat. 

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addEventAction(eventAction)WidgetMenambahkan tindakan peristiwa yang dapat dilakukan pada widget.
setAltText(altText)ImageMenetapkan teks alternatif gambar untuk aksesibilitas.
setAuthorizationAction(action)ImageMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setComposeAction(action, composedEmailType)ImageMenetapkan tindakan yang menyusun email draf saat objek diklik.
setId(id)WidgetMenetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah.
setImageUrl(url)ImageMenetapkan gambar yang akan digunakan dengan memberikan URL atau string datanya.
setOnClickAction(action)ImageMenetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)ImageMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)ImageMenetapkan URL yang akan dibuka saat objek diklik.
setVisibility(visibility)WidgetMenetapkan visibilitas widget.

Dokumentasi mendetail

addEventAction(eventAction)

Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.

Parameter

NamaJenisDeskripsi
eventActionEventActionEventAction yang akan ditambahkan.

Pulang pergi

Widget — Objek, untuk pengaitan.

setAltText(altText)

Menetapkan teks alternatif gambar untuk aksesibilitas. Wajib.

Parameter

NamaJenisDeskripsi
altTextStringTeks alternatif yang akan ditetapkan ke gambar ini.

Pulang pergi

Image — Objek ini, untuk pengaitan.

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 satu set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType). 

// ...

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

Image — Objek ini, untuk pengaitan.

setComposeAction(action, composedEmailType)

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

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(e) {
  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 compose yang akan diambil saat elemen ini diklik.
composedEmailTypeComposedEmailTypeNilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau draf balasan.

Pulang pergi

Image — Objek ini, untuk pengaitan.

setId(id)

Menetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah. Mutasi widget hanya didukung di Add-On.

Parameter

NamaJenisDeskripsi
idStringID widget, dengan batas 64 karakter dan dalam format `[a-zA-Z0-9-]+`.

Pulang pergi

Widget — Objek ini, untuk pengaitan.

setImageUrl(url)

Menetapkan gambar yang akan digunakan dengan memberikan URL atau string datanya. Wajib.

URL yang diberikan dapat berupa URL yang dapat diakses secara publik atau string gambar berenkode base64. Untuk mendapatkan yang terakhir, Anda dapat menggunakan kode berikut untuk membuat string gambar yang dienkode dari gambar di Google Drive Anda, lalu menyimpan string tersebut untuk digunakan nanti dengan setImageUrl(url). Metode ini mencegah add-on Anda perlu mengakses URL gambar yang tersedia secara publik: 

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

Parameter

NamaJenisDeskripsi
urlStringAlamat URL gambar yang dihosting untuk digunakan, atau string gambar yang dienkode.

Pulang pergi

Image — Objek ini, untuk pengaitan.

setOnClickAction(action)

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

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 harus diambil saat elemen ini diklik.

Pulang pergi

Image — Objek ini, untuk pengaitan.

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 satu set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

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 buka link yang akan diambil saat elemen ini diklik.

Pulang pergi

Image — Objek ini, untuk pengaitan.

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

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

Image — Objek ini, untuk pengaitan.

setVisibility(visibility)

Menetapkan visibilitas widget. Nilai defaultnya adalah `VISIBLE`.

Parameter

NamaJenisDeskripsi
visibilityVisibilityVisibility widget.

Pulang pergi

Widget — Objek, untuk pengaitan.