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

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addItem(gridItem)GridMenambahkan item petak baru ke petak.
setAuthorizationAction(action)GridMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setBorderStyle(borderStyle)GridMenetapkan gaya batas yang diterapkan ke setiap item petak.
setComposeAction(action, composedEmailType)GridMenetapkan tindakan yang menulis draf email saat objek diklik.
setNumColumns(numColumns)GridJumlah kolom yang akan ditampilkan dalam petak.
setOnClickAction(action)GridMenetapkan tindakan yang dieksekusi saat objek diklik.
setOnClickOpenLinkAction(action)GridMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)GridMenetapkan URL yang akan dibuka saat objek diklik.
setTitle(title)GridMenetapkan teks judul petak.

Dokumentasi mendetail

addItem(gridItem)

Menambahkan item petak baru ke petak.

Parameter

NamaJenisDeskripsi
gridItemGridItemItem petak yang akan ditambahkan.

Pulang pergi

Grid — Objek ini, untuk pembuatan rantai.


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

Grid — Objek ini, untuk pembuatan rantai.


setBorderStyle(borderStyle)

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

Parameter

NamaJenisDeskripsi
borderStyleBorderStyleGaya batas yang akan diterapkan.

Pulang pergi

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

Pulang pergi

Grid — Objek ini, untuk pembuatan rantai.


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

NamaJenisDeskripsi
numColumnsIntegerJumlah kolom.

Pulang pergi

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

Grid — Objek ini, untuk pembuatan rantai.


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

Pulang pergi

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

Grid — Objek ini, untuk pembuatan rantai.


setTitle(title)

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

Parameter

NamaJenisDeskripsi
titleStringTeks judul.

Pulang pergi

Grid — Objek ini, untuk pembuatan rantai.