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

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

Dokumentasi mendetail

addEventAction(eventAction)

Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.

Parameter

Nama	Jenis	Deskripsi
eventAction	EventAction	EventAction yang akan ditambahkan.

Pulang pergi

Widget — Objek, untuk dirangkaikan.

---

setAltText(altText)

Menetapkan teks alternatif gambar untuk aksesibilitas. Wajib.

Parameter

Nama	Jenis	Deskripsi
altText	String	Teks alternatif yang akan ditetapkan ke gambar ini.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

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

Nama	Jenis	Deskripsi
action	AuthorizationAction	Objek yang menentukan tindakan otorisasi yang akan diambil saat elemen ini diklik.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

setComposeAction(action, composedEmailType)

Menetapkan tindakan yang menyusun email draf saat objek diklik. Objek UI hanya dapat memiliki satu setelan 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).

Catatan: Metode ini tidak menetapkan tindakan compose yang digunakan untuk memperluas UI compose. Sebaliknya, metode ini menghubungkan elemen UI ini ke Action yang membuat pesan draf di Apps Script yang dibuka di Gmail saat tindakan selesai.

// ...

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

Nama	Jenis	Deskripsi
action	Action	Objek yang menentukan tindakan compose yang akan diambil saat elemen ini diklik.
composedEmailType	ComposedEmailType	Nilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau draf balasan.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

setId(id)

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

Parameter

Nama	Jenis	Deskripsi
id	String	ID widget, dengan batas 64 karakter dan dalam format `[a-zA-Z0-9-]+`.

Pulang pergi

Widget — Objek ini, untuk dirangkaikan.

---

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

Nama	Jenis	Deskripsi
url	String	Alamat URL gambar yang dihosting untuk digunakan, atau string gambar yang dienkode.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

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

Nama	Jenis	Deskripsi
action	Action	Tindakan yang harus diambil saat elemen ini diklik.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

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

Nama	Jenis	Deskripsi
action	Action	Objek yang menentukan tindakan buka link yang akan diambil saat elemen ini diklik.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

setOpenLink(openLink)

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

Nama	Jenis	Deskripsi
openLink	OpenLink	Objek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

Image — Objek ini, untuk dirangkaikan.

---

setVisibility(visibility)

Menetapkan visibilitas widget. Nilai defaultnya adalah `VISIBLE`.

Parameter

Nama	Jenis	Deskripsi
visibility	Visibility	Visibility widget.

Pulang pergi

Widget — Objek, untuk dirangkaikan.