Class Grid

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.
Petak

Petak terkelola untuk menampilkan koleksi item petak.

var 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 dijalankan 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

NameJenisDeskripsi
gridItemGridItemItem petak yang akan ditambahkan.

Return

Grid — Objek ini, untuk 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 satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) yang ditetapkan.

// ...

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

Parameter

NameJenisDeskripsi
actionAuthorizationActionObjek yang menentukan tindakan otorisasi yang harus dilakukan saat elemen ini diklik.

Return

Grid — Objek ini, untuk rantai.


setBorderStyle(borderStyle)

Menetapkan gaya batas yang diterapkan ke setiap item petak. Defaultnya adalah NO_BORDER.

Parameter

NameJenisDeskripsi
borderStyleBorderStyleGaya batas yang akan diterapkan.

Return

Grid — Objek ini, untuk rantai.


setComposeAction(action, composedEmailType)

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

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

NameJenisDeskripsi
actionActionObjek yang menentukan tindakan tulis yang akan diambil saat elemen ini diklik.
composedEmailTypeComposedEmailTypeNilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau draf balasan.

Return

Grid — Objek ini, untuk rantai.


setNumColumns(numColumns)

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

Parameter

NameJenisDeskripsi
numColumnsIntegerJumlah kolom.

Return

Grid — Objek ini, untuk rantai.


setOnClickAction(action)

Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya dapat memiliki 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.

// ...

var 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

NameJenisDeskripsi
actionActionTindakan yang harus diambil saat elemen ini diklik.

Return

Grid — Objek ini, untuk rantai.


setOnClickOpenLinkAction(action)

Menetapkan tindakan yang membuka URL di tab saat objek diklik. Gunakan fungsi ini saat URL harus dibuat atau saat Anda perlu melakukan tindakan lain selain membuat objek OpenLink. Objek UI hanya dapat memiliki 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).

// ...

var 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

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

Return

Grid — Objek ini, untuk rantai.


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

Parameter

NameJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Return

Grid — Objek ini, untuk rantai.


setTitle(title)

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

Parameter

NameJenisDeskripsi
titleStringTeks judul.

Return

Grid — Objek ini, untuk rantai.