Widget yang menampilkan teks dengan dekorasi opsional. Kemungkinan kunci mencakup ikon, label di atas, dan label di bawah. Menetapkan konten teks dan salah satu kunci diperlukan menggunakan set dan salah satu dari Decorated, Decorated, set, atau set. Class ini dimaksudkan untuk menggantikan .
Key
Tersedia untuk add-on Google Workspace dan aplikasi Google Chat.
const decoratedText = CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel'); const multilineDecoratedText = CardService.newDecoratedText() .setText('Text') .setTopLabel('TopLabel') .setWrapText(true) .setBottomLabel('BottomLabel');
Metode
| Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
|---|---|---|
add | Widget | Menambahkan tindakan peristiwa yang dapat dilakukan pada widget. |
set | Decorated | Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik. |
set | Decorated | Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks. |
set | Decorated | Menetapkan Button yang ditampilkan di sebelah kanan teks. |
set | Decorated | Menetapkan tindakan yang menyusun email draf saat objek diklik. |
set | Decorated | Menetapkan Icon opsional yang ditampilkan di sebelah kanan konten. |
set | Widget | Menetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah. |
set | Decorated | Menetapkan tindakan yang dijalankan saat objek diklik. |
set | Decorated | Menetapkan tindakan yang membuka URL di tab saat objek diklik. |
set | Decorated | Menetapkan URL yang akan dibuka saat objek diklik. |
set | Decorated | Menetapkan Icon opsional untuk ditampilkan sebelum konten teks. |
set | Decorated | Menetapkan Switch yang ditampilkan di sebelah kanan konten. |
set | Decorated | Menetapkan teks yang akan digunakan sebagai nilai. |
set | Decorated | Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks. |
set | Widget | Menetapkan visibilitas widget. |
set | Decorated | Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris. |
Dokumentasi mendetail
add Event Action(eventAction)
Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
event | Event | Event yang akan ditambahkan. |
Pulang pergi
Widget — Objek, untuk pengaitan.
set Authorization Action(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 set, set, set, set, atau set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action | Authorization | Objek yang menentukan tindakan otorisasi yang akan diambil saat elemen ini diklik. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Bottom Label(text)
Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
text | String | Teks label. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Button(button)
Menetapkan Button yang ditampilkan di sebelah kanan teks. Decorated hanya dapat mendukung satu tombol atau satu sakelar.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
button | Button | Tombol untuk menambahkan. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Compose Action(action, composedEmailType)
Menetapkan tindakan yang menyusun email draf saat objek diklik. Objek UI hanya dapat
memiliki satu setelan set, set, set,
set, atau set.
Parameter Action harus menentukan fungsi callback yang menampilkan objek Compose yang dikonfigurasi menggunakan Compose.
// ... 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. |
composed | Composed | Nilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau draf balasan. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set End Icon(endIcon)
Menetapkan Icon opsional yang ditampilkan di sebelah kanan konten. Decorated hanya dapat mendukung satu tombol, satu tombol geser, atau satu ikon.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
end | Icon | Ikon yang akan ditambahkan. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Id(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 pengaitan.
set On Click Action(action)
Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya dapat memiliki satu set
set, set, set, set, atau set.
Parameter Action harus menentukan fungsi callback yang menampilkan objek Action.
// ... 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
Decorated — Objek ini, untuk pengaitan.
set On Click Open Link Action(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 Open. Objek UI hanya dapat memiliki satu set set, set, set, set, atau
set.
Parameter Action harus menentukan fungsi callback yang menampilkan objek Action yang dikonfigurasi menggunakan Action.
// ... 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
Decorated — Objek ini, untuk pengaitan.
set Open Link(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 set,
set, set, set,
atau set.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
open | Open | Objek Open yang menjelaskan URL yang akan dibuka. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Start Icon(startIcon)
Menetapkan Icon opsional untuk ditampilkan sebelum konten teks.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
start | Icon | Ikon yang akan ditampilkan. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Switch Control(switchToSet)
Menetapkan Switch yang ditampilkan di sebelah kanan konten. Decorated
hanya dapat mendukung satu tombol atau satu sakelar.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
switch | Switch | Tombol yang akan ditambahkan. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Text(text)
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
Decorated — Objek ini, untuk pengaitan.
set Top Label(text)
Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
text | String | Teks label. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.
set Visibility(visibility)
Menetapkan visibilitas widget. Nilai defaultnya adalah `VISIBLE`.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
visibility | Visibility | Visibility widget. |
Pulang pergi
Widget — Objek, untuk pengaitan.
set Wrap Text(wrapText)
Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
wrap | Boolean | Jika true, teks akan di-wrap dan ditampilkan dalam beberapa baris. Jika tidak,
teks akan terpotong. |
Pulang pergi
Decorated — Objek ini, untuk pengaitan.