Class Grid

Petak

Petak yang teratur untuk menampilkan kumpulan item petak.

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

const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem(
    CardService.newGridItem().setTitle('My item'));

Metode

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
addEventAction(eventAction)	Widget	Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.
addItem(gridItem)	Grid	Menambahkan item petak baru ke petak.
setAuthorizationAction(action)	Grid	Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setBorderStyle(borderStyle)	Grid	Menetapkan gaya batas yang diterapkan ke setiap item petak.
setComposeAction(action, composedEmailType)	Grid	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.
setNumColumns(numColumns)	Grid	Jumlah kolom yang akan ditampilkan dalam petak.
setOnClickAction(action)	Grid	Menetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)	Grid	Menetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)	Grid	Menetapkan URL yang akan dibuka saat objek diklik.
setTitle(title)	Grid	Menetapkan teks judul petak.
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.

---

addItem(gridItem)

Menambahkan item petak baru ke petak.

Parameter

Nama	Jenis	Deskripsi
gridItem	GridItem	Item petak yang akan ditambahkan.

Pulang pergi

Grid — 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

Grid — Objek ini, untuk dirangkaikan.

---

setBorderStyle(borderStyle)

Menetapkan gaya batas yang diterapkan ke setiap item petak. Default-nya adalah NO_BORDER.

Parameter

Nama	Jenis	Deskripsi
borderStyle	BorderStyle	Gaya batas yang akan diterapkan.

Pulang pergi

Grid — 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

Grid — 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.

---

setNumColumns(numColumns)

Jumlah kolom yang akan ditampilkan dalam petak. Jika ditampilkan di panel samping kanan, Anda dapat menampilkan 1-2 kolom dan nilai defaultnya adalah 1. Jika ditampilkan dalam dialog, Anda dapat menampilkan 2-3 kolom dan nilai defaultnya adalah 2.

Parameter

Nama	Jenis	Deskripsi
numColumns	Integer	Jumlah kolom.

Pulang pergi

Grid — 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

Grid — 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

Grid — 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

Grid — Objek ini, untuk dirangkaikan.

---

setTitle(title)

Menetapkan teks judul petak. Teks harus berupa string biasa tanpa format.

Parameter

Nama	Jenis	Deskripsi
title	String	Teks judul.

Pulang pergi

Grid — 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.