Halaman ini diterjemahkan oleh Cloud Translation API.

Class KeyValue

Tidak digunakan lagi. Class ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Class ini tidak digunakan lagi. Sebagai gantinya, gunakan DecoratedText.

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`setAuthorizationAction(action)`	`KeyValue`	Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
`setComposeAction(action, composedEmailType)`	`KeyValue`	Menetapkan tindakan yang menulis draf email saat objek diklik.
`setOnClickAction(action)`	`KeyValue`	Menetapkan tindakan yang dieksekusi saat objek diklik.
`setOnClickOpenLinkAction(action)`	`KeyValue`	Menetapkan tindakan yang membuka URL di tab saat objek diklik.
`setOpenLink(openLink)`	`KeyValue`	Menetapkan URL yang akan dibuka saat objek diklik.

Metode yang tidak digunakan lagi

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`setBottomLabel(text)`	`KeyValue`	Menetapkan teks label yang akan digunakan sebagai kunci.
`setButton(button)`	`KeyValue`	Menetapkan `Button` yang ditampilkan di sebelah kanan konteks.
`setContent(text)`	`KeyValue`	Menetapkan teks yang akan digunakan sebagai nilai.
`setIcon(icon)`	`KeyValue`	Menetapkan ikon yang akan digunakan sebagai kunci.
`setIconAltText(altText)`	`KeyValue`	Menetapkan teks alternatif untuk ikon.
`setIconUrl(url)`	`KeyValue`	Menetapkan URL ikon yang akan digunakan sebagai kunci.
`setMultiline(multiline)`	`KeyValue`	Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.
`setSwitch(switchToSet)`	`KeyValue`	Menetapkan `Switch` yang ditampilkan di sebelah kanan konten.
`setTopLabel(text)`	`KeyValue`	Menetapkan teks label yang akan digunakan sebagai kunci.

Dokumentasi mendetail

`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

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

Pulang pergi

KeyValue — Objek ini, untuk perantaian.

`setComposeAction(action, composedEmailType)`

Menetapkan tindakan yang membuat email draf 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).

Catatan: Metode ini tidak menetapkan tindakan compose yang digunakan untuk memperluas UI compose. Namun, metode ini akan menghubungkan elemen UI ini ke Action yang membuat draf pesan 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() {
  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 ditulis merupakan draf mandiri atau draf balasan.

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setOnClickAction(action)`

Menetapkan tindakan yang dijalankan 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

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

Pulang pergi

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

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

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setOpenLink(openLink)`

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

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

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

Metode yang tidak digunakan lagi

`setBottomLabel(text)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan teks label yang akan digunakan sebagai kunci. Ditampilkan di bawah konten teks.

Parameter

Nama	Jenis	Deskripsi
`text`	`String`	Teks label. Catatan: Editor ini tidak mendukung pemformatan HTML dasar.

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setButton(button)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan Button yang ditampilkan di sebelah kanan konteks. KeyValue hanya dapat mendukung satu tombol, satu tombol akses, atau satu ikon.

Parameter

Nama	Jenis	Deskripsi
`button`	`Button`	Tombol untuk ditambahkan.

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setContent(text)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan teks yang akan digunakan sebagai nilai. Mendukung pemformatan HTML dasar. Wajib.

Parameter

Nama	Jenis	Deskripsi
`text`	`String`	Konten teks untuk widget ini.

Pulang pergi

KeyValue — Objek ini, untuk perantaian.

`setIcon(icon)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan ikon yang akan digunakan sebagai kunci.

Parameter

Nama	Jenis	Deskripsi
`icon`	`Icon`	Salah satu nilai `Icon` yang telah ditetapkan.

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setIconAltText(altText)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan teks alternatif untuk ikon.

Parameter

Nama	Jenis	Deskripsi
`altText`	`String`	Teks alternatif untuk ikon.

Pulang pergi

KeyValue — Objek ini, untuk perantaian.

`setIconUrl(url)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan URL ikon yang akan digunakan sebagai kunci.

Parameter

Nama	Jenis	Deskripsi
`url`	`String`	Alamat URL gambar yang dihosting untuk digunakan sebagai ikon.

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setMultiline(multiline)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.

Parameter

Nama	Jenis	Deskripsi
`multiline`	`Boolean`	Setelan multibaris.

Pulang pergi

KeyValue — Objek ini, untuk pembuatan rantai.

`setSwitch(switchToSet)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan Switch yang ditampilkan di sebelah kanan konten. KeyValue hanya dapat mendukung satu tombol, satu tombol akses, atau satu ikon.

Parameter

Nama	Jenis	Deskripsi
`switchToSet`	`Switch`	Tombol yang akan ditambahkan.

Pulang pergi

KeyValue — Objek ini, untuk perantaian.

`setTopLabel(text)`

Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Menetapkan teks label yang akan digunakan sebagai kunci. Ditampilkan di atas konten teks.

Parameter

Nama	Jenis	Deskripsi
`text`	`String`	Teks label. Catatan: Fitur ini tidak mendukung pemformatan HTML dasar.

Pulang pergi

KeyValue — Objek ini, untuk perantaian.