Indeks
Action
(pesan)Action.ActionParameter
(pesan)Action.Interaction
(enum)Action.LoadIndicator
(enum)BorderStyle
(pesan)BorderStyle.BorderType
(enum)Button
(pesan)Button.Type
(enum)ButtonList
(pesan)Card
(pesan)Card.CardAction
(pesan)Card.CardFixedFooter
(pesan)Card.CardHeader
(pesan)Card.DisplayStyle
(enum)Card.DividerStyle
(enum)Card.Section
(pesan)Chip
(pesan)ChipList
(pesan)ChipList.Layout
(enum)CollapseControl
(pesan)Columns
(pesan)Columns.Column
(pesan)Columns.Column.HorizontalSizeStyle
(enum)Columns.Column.VerticalAlignment
(enum)Columns.Column.Widgets
(pesan)DateTimePicker
(pesan)DateTimePicker.DateTimePickerType
(enum)DecoratedText
(pesan)DecoratedText.SwitchControl
(pesan)DecoratedText.SwitchControl.ControlType
(enum)Divider
(pesan)EndNavigation
(pesan)EndNavigation.Action
(enum)GetAutocompletionResponse
(pesan)Grid
(pesan)Grid.GridItem
(pesan)Grid.GridItem.GridItemLayout
(enum)Icon
(pesan)Image
(pesan)ImageComponent
(pesan)ImageCropStyle
(pesan)ImageCropStyle.ImageCropType
(enum)Link
(pesan)LinkPreview
(pesan)MaterialIcon
(pesan)Navigation
(pesan)Notification
(pesan)OnClick
(pesan)OpenLink
(pesan)OpenLink.OnClose
(enum)OpenLink.OpenAs
(enum)OverflowMenu
(pesan)OverflowMenu.OverflowMenuItem
(pesan)RenderActions
(pesan)RenderActions.Action
(pesan)SelectionInput
(pesan)SelectionInput.PlatformDataSource
(pesan)SelectionInput.PlatformDataSource.CommonDataSource
(enum)SelectionInput.SelectionItem
(pesan)SelectionInput.SelectionType
(enum)SubmitFormResponse
(pesan)Suggestions
(pesan)Suggestions.SuggestionItem
(pesan)TextInput
(pesan)TextInput.Type
(enum)TextParagraph
(pesan)Validation
(pesan)Validation.InputType
(enum)Widget
(pesan)Widget.HorizontalAlignment
(enum)Widget.ImageType
(enum)
Tindakan
Tindakan yang menjelaskan perilaku saat formulir dikirimkan. Misalnya, Anda dapat memanggil skrip Apps Script untuk menangani formulir. Jika tindakan dipicu, nilai formulir akan dikirim ke server.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
function |
Fungsi kustom yang akan dipanggil saat elemen yang memuatnya diklik atau diaktifkan. Untuk contoh penggunaan, lihat Membaca data formulir. |
parameters[] |
Daftar parameter tindakan. |
loadIndicator |
Menentukan indikator pemuatan yang ditampilkan tindakan saat membuat pesan ajakan (CTA). |
persistValues |
Menunjukkan apakah nilai formulir tetap ada setelah tindakan. Nilai default-nya adalah Jika Jika |
interaction |
Opsional. Wajib saat membuka dialog. Apa yang harus dilakukan sebagai respons terhadap interaksi dengan pengguna, seperti pengguna mengklik tombol di pesan kartu. Jika tidak ditentukan, aplikasi akan merespons dengan mengeksekusi Dengan menentukan
|
requiredWidgets[] |
Jika widget yang tercantum di sini tidak memiliki nilai saat Action ini dipanggil, pengiriman formulir akan dibatalkan.
|
allWidgetsAreRequired |
|
ActionParameter
Daftar parameter string yang akan disediakan saat metode tindakan dipanggil. Misalnya, pertimbangkan tiga tombol tidur sebentar: penundaan sekarang, tunda satu hari, atau tunda minggu depan. Anda mungkin menggunakan action method = snooze()
, dengan meneruskan jenis penundaan dan waktu penundaan dalam daftar parameter string.
Untuk mempelajari lebih lanjut, lihat CommonEventObject
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
key |
Nama parameter untuk skrip tindakan. |
value |
Nilai parameter. |
Interaksi
Opsional. Wajib saat membuka dialog.
Apa yang harus dilakukan sebagai respons terhadap interaksi dengan pengguna, seperti pengguna mengklik tombol di pesan kartu.
Jika tidak ditentukan, aplikasi akan merespons dengan mengeksekusi action
—seperti membuka link atau menjalankan fungsi—seperti biasa.
Dengan menentukan interaction
, aplikasi dapat merespons dengan cara interaktif khusus. Misalnya, dengan menyetel interaction
ke OPEN_DIALOG
, aplikasi dapat membuka dialog.
Jika ditentukan, indikator pemuatan tidak akan ditampilkan. Jika ditentukan untuk add-on, seluruh kartu akan dihapus dan tidak ada yang ditampilkan di klien.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Enum | |
---|---|
INTERACTION_UNSPECIFIED |
Nilai default. action berjalan seperti biasa. |
OPEN_DIALOG |
Membuka dialog, antarmuka berbasis kartu dan berjendela yang digunakan aplikasi Chat untuk berinteraksi dengan pengguna. Hanya didukung oleh aplikasi Chat sebagai respons terhadap klik tombol pada pesan kartu. Jika ditentukan untuk add-on, seluruh kartu akan dihapus dan tidak ada yang ditampilkan di klien.
|
LoadIndicator
Menentukan indikator pemuatan yang ditampilkan tindakan saat membuat pesan ajakan (CTA).
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
SPINNER |
Menampilkan indikator lingkaran berputar untuk menunjukkan bahwa konten sedang dimuat. |
NONE |
Tidak ada yang ditampilkan. |
BorderStyle
Opsi gaya untuk batas kartu atau widget, termasuk jenis dan warna batas.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
type |
Jenis batas. |
strokeColor |
Warna yang akan digunakan jika jenisnya adalah Untuk menetapkan warna goresan, tentukan nilai untuk kolom Misalnya, kode berikut menyetel warna ke merah pada intensitas maksimumnya:
Kolom |
cornerRadius |
Radius sudut untuk batas. |
BorderType
Mewakili jenis batas yang diterapkan ke widget.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
BORDER_TYPE_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
NO_BORDER |
Nilai default. Tidak ada batas. |
STROKE |
{i>Outline<i}. |
Tombol
Teks, ikon, atau teks dan tombol ikon yang dapat diklik pengguna. Untuk contoh aplikasi Google Chat, lihat Menambahkan tombol.
Untuk membuat gambar menjadi tombol yang dapat diklik, tentukan
(bukan Image
) dan setel tindakan ImageComponent
onClick
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
text |
Teks yang ditampilkan di dalam tombol. |
icon |
Ikon yang ditampilkan di dalam tombol. Jika |
color |
Opsional. Warna tombol. Jika ditetapkan, tombol Untuk menetapkan warna tombol, tentukan nilai untuk kolom Misalnya, kode berikut menyetel warna ke merah pada intensitas maksimumnya:
Kolom |
onClick |
Wajib diisi. Tindakan yang akan dilakukan saat pengguna mengklik tombol, seperti membuka hyperlink atau menjalankan fungsi kustom. |
disabled |
Jika |
altText |
Teks alternatif yang digunakan untuk aksesibilitas. Tetapkan teks deskriptif yang memungkinkan pengguna mengetahui fungsi tombol. Misalnya, jika sebuah tombol membuka hyperlink, Anda dapat menulis: "Membuka tab browser baru dan membuka dokumentasi developer Google Chat di https://developers.google.com/workspace/chat". |
type |
Opsional. Jenis tombol. Jika tidak disetel, jenis tombol akan ditetapkan secara default ke
|
Jenis
Opsional. Jenis tombol. Jika kolom color
disetel, type
akan dipaksa ke FILLED
.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
OUTLINED |
Tombol {i>outline<i} adalah tombol dengan penekanan sedang. Add-on biasanya berisi tindakan yang penting, tetapi bukan tindakan utama di aplikasi Chat atau add-on. |
FILLED |
Tombol yang terisi memiliki penampung dengan warna solid. Warna ini memiliki dampak visual paling besar dan direkomendasikan untuk tindakan penting dan utama di aplikasi Chat atau add-on. |
FILLED_TONAL |
Tombol {i>tonal<i} yang terisi adalah jalan tengah alternatif antara tombol yang terisi dan {i>outline<i}. Diagram ini berguna dalam konteks di mana tombol dengan prioritas lebih rendah memerlukan penekanan yang sedikit lebih besar daripada yang diberikan oleh tombol garis besar. |
BORDERLESS |
Tombol tidak memiliki penampung yang tidak terlihat dalam status defaultnya. Hal ini sering digunakan untuk tindakan prioritas terendah, terutama saat menyajikan beberapa opsi. |
ButtonList
Daftar tombol yang ditata secara horizontal. Untuk contoh aplikasi Google Chat, lihat Menambahkan tombol.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
buttons[] |
Array tombol. |
Kartu
Antarmuka kartu yang ditampilkan di pesan Google Chat atau Add-on Google Workspace.
{i>Card<i} mendukung tata letak yang ditentukan, elemen-elemen UI interaktif seperti tombol, dan multimedia seperti gambar. Gunakan kartu untuk menyajikan informasi mendetail, mengumpulkan informasi dari pengguna, dan memandu pengguna untuk mengambil langkah berikutnya.
Desain dan pratinjau kartu dengan Card Builder.
Membuka Card BuilderUntuk mempelajari cara membuat kartu, lihat dokumentasi berikut:
- Untuk aplikasi Google Chat, lihat Mendesain komponen kartu atau dialog.
- Untuk Add-on Google Workspace, lihat Antarmuka berbasis kartu.
Contoh: Pesan kartu untuk aplikasi Google Chat
Untuk membuat contoh pesan kartu di Google Chat, gunakan JSON berikut:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Kolom | |
---|---|
header |
Header kartu. {i>Header<i} biasanya berisi gambar utama dan judul. Header selalu muncul di bagian atas kartu. |
sections[] |
Berisi kumpulan widget. Setiap bagian memiliki {i>header<i} opsionalnya sendiri. Bagian-bagian secara visual dipisahkan oleh pemisah garis. Untuk contoh di aplikasi Google Chat, lihat Menentukan bagian kartu. |
sectionDividerStyle |
Gaya pemisah antarbagian. |
cardActions[] |
Tindakan kartu. Tindakan ditambahkan ke menu toolbar kartu.
Misalnya, JSON berikut membuat menu tindakan kartu dengan opsi
|
name |
Nama kartu. Digunakan sebagai ID kartu dalam navigasi kartu.
|
fixedFooter |
Footer tetap ditampilkan di bagian bawah kartu ini. Menyetel
|
displayStyle |
Di Add-on Google Workspace, tetapkan properti tampilan
|
peekCardHeader |
Saat menampilkan konten kontekstual, header kartu cuplikan berfungsi sebagai placeholder sehingga pengguna dapat berpindah maju antara kartu halaman beranda dan kartu kontekstual.
|
CardAction
Tindakan kartu adalah tindakan yang terkait dengan kartu. Misalnya, kartu invoice dapat berisi tindakan seperti menghapus invoice, mengirim invoice melalui email, atau membuka invoice di browser.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Kolom | |
---|---|
actionLabel |
Label yang ditampilkan sebagai item menu tindakan. |
onClick |
Tindakan |
CardHeader
Mewakili header kartu. Untuk contoh aplikasi Google Chat, lihat Menambahkan header.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
title |
Wajib diisi. Judul header kartu. {i>Header<i} memiliki tinggi tetap: jika judul dan subjudul ditentukan, masing-masing membutuhkan satu baris. Jika hanya judul yang ditentukan, kode tersebut akan menggunakan kedua baris. |
subtitle |
Subjudul header kartu. Jika ditentukan, akan muncul pada barisnya sendiri di bawah |
imageType |
Bentuk yang digunakan untuk memangkas gambar.
|
imageUrl |
URL HTTPS gambar di header kartu. |
imageAltText |
Teks alternatif dari gambar ini yang digunakan untuk aksesibilitas. |
DisplayStyle
Di Add-on Google Workspace, menentukan cara kartu ditampilkan.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Enum | |
---|---|
DISPLAY_STYLE_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
PEEK |
Header kartu muncul di bagian bawah sidebar, yang sebagian menutupi kartu atas tumpukan saat ini. Mengklik header akan memunculkan kartu ke dalam tumpukan kartu. Jika kartu tidak memiliki header, header yang dihasilkan akan digunakan. |
REPLACE |
Nilai default. Kartu ditampilkan dengan mengganti tampilan kartu teratas di tumpukan kartu. |
DividerStyle
Gaya pembagi kartu. Saat ini hanya digunakan untuk pemisah antarbagian kartu.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
DIVIDER_STYLE_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
SOLID_DIVIDER |
Opsi default. Merender pemisah yang solid. |
NO_DIVIDER |
Jika ditetapkan, tidak ada pemisah yang akan dirender. Gaya ini sepenuhnya menghapus pemisah dari tata letak. Hasilnya setara dengan tidak menambahkan {i>divider<i} sama sekali. |
Bagian
Bagian berisi kumpulan widget yang dirender secara vertikal dalam urutan yang ditentukan.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
header |
Teks yang muncul di atas suatu bagian. Mendukung teks berformat HTML sederhana. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. |
widgets[] |
Semua widget di bagian tersebut. Harus berisi minimal satu widget. |
collapsible |
Menunjukkan apakah bagian ini dapat diciutkan. Bagian yang dapat diciutkan menyembunyikan beberapa atau semua widget, tetapi pengguna dapat meluaskan bagian tersebut untuk menampilkan widget tersembunyi dengan mengklik Tampilkan lainnya. Pengguna dapat menyembunyikan lagi widget dengan mengklik Tampilkan lebih sedikit. Untuk menentukan widget mana yang disembunyikan, tentukan |
uncollapsibleWidgetsCount |
Jumlah widget yang tidak dapat diciutkan yang tetap terlihat meskipun bagian diciutkan. Misalnya, jika sebuah bagian berisi lima widget dan |
collapseControl |
Opsional. Menentukan tombol luaskan dan ciutkan bagian. Tombol ini hanya akan ditampilkan jika bagian tersebut dapat diciutkan. Jika kolom ini tidak disetel, tombol default akan digunakan. |
Chip
Teks, ikon, atau teks dan chip ikon yang dapat diklik pengguna.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
icon |
Gambar ikon. Jika |
label |
Teks yang ditampilkan di dalam chip. |
onClick |
Opsional. Tindakan yang akan dilakukan saat pengguna mengklik chip, seperti membuka hyperlink atau menjalankan fungsi kustom. |
enabled |
Apakah chip dalam status aktif dan merespons tindakan pengguna. Default-nya adalah |
disabled |
Apakah chip dalam status tidak aktif dan mengabaikan tindakan pengguna. Default-nya adalah |
altText |
Teks alternatif yang digunakan untuk aksesibilitas. Tetapkan teks deskriptif yang memungkinkan pengguna mengetahui fungsi chip tersebut. Misalnya, jika chip membuka hyperlink, tulis: "Membuka tab browser baru dan membuka dokumentasi developer Google Chat di https://developers.google.com/workspace/chat". |
ChipList
Daftar chip ditata secara horizontal, yang dapat di-scroll secara horizontal atau digabungkan ke baris berikutnya.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
layout |
Tata letak daftar chip yang ditentukan. |
chips[] |
Array chip. |
Tata Letak
Tata letak daftar chip.
Enum | |
---|---|
LAYOUT_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
WRAPPED |
Nilai default. Daftar chip digabungkan ke baris berikutnya jika ruang horizontal tidak cukup. |
HORIZONTAL_SCROLLABLE |
Chip akan di-scroll secara horizontal jika tidak pas dengan ruang yang tersedia. |
CollapseControl
Merepresentasikan kontrol luaskan dan ciutkan. Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
horizontalAlignment |
Perataan horizontal tombol luaskan dan ciutkan. |
expandButton |
Opsional. Tentukan tombol yang dapat disesuaikan untuk meluaskan bagian tersebut. Kolom ExpandButton dan ciutkanButton harus ditetapkan. Hanya satu kumpulan kolom yang tidak akan diterapkan. Jika kolom ini tidak disetel, tombol default akan digunakan. |
collapseButton |
Opsional. Tentukan tombol yang dapat disesuaikan untuk menciutkan bagian. Kolom ExpandButton dan ciutkanButton harus ditetapkan. Hanya satu kumpulan kolom yang tidak akan diterapkan. Jika kolom ini tidak disetel, tombol default akan digunakan. |
Kolom
Widget Columns
menampilkan hingga 2 kolom dalam kartu atau dialog. Anda dapat menambahkan widget ke setiap kolom; widget muncul sesuai urutan yang ditentukan. Untuk contoh aplikasi Google Chat, lihat Menampilkan kartu dan dialog di kolom.
Ketinggian setiap kolom ditentukan oleh kolom yang lebih tinggi. Misalnya, jika kolom pertama lebih tinggi daripada kolom kedua, kedua kolom memiliki tinggi kolom pertama. Karena setiap kolom dapat berisi jumlah widget yang berbeda, Anda tidak dapat menentukan baris atau meratakan widget di antara kolom.
Kolom ditampilkan secara berdampingan. Anda dapat menyesuaikan lebar setiap kolom menggunakan kolom HorizontalSizeStyle
. Jika lebar layar pengguna terlalu sempit, kolom kedua akan digabungkan di bawah yang pertama:
- Di web, kolom kedua akan digabungkan jika lebar layar kurang dari atau sama dengan 480 piksel.
- Pada perangkat iOS, kolom kedua akan digabungkan jika lebar layar kurang dari atau sama dengan 300 pt.
- Pada perangkat Android, kolom kedua akan digabungkan jika lebar layar kurang dari atau sama dengan 320 dp.
Untuk menyertakan lebih dari 2 kolom, atau menggunakan baris, gunakan widget
.Grid
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
columnItems[] |
Array kolom. Anda dapat menyertakan hingga 2 kolom dalam kartu atau dialog. |
Kolom
Kolom.
Kolom | |
---|---|
horizontalSizeStyle |
Menentukan cara kolom mengisi lebar kartu. |
horizontalAlignment |
Menentukan apakah widget diratakan ke kiri, kanan, atau tengah kolom. |
verticalAlignment |
Menentukan apakah widget diratakan dengan bagian atas, bawah, atau tengah kolom. |
widgets[] |
Array widget yang disertakan dalam kolom. Widget muncul sesuai urutan yang ditentukan. |
HorizontalSizeStyle
Menentukan cara kolom mengisi lebar kartu. Lebar setiap kolom bergantung pada HorizontalSizeStyle
dan lebar widget dalam kolom.
Enum | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
FILL_AVAILABLE_SPACE |
Nilai default. Kolom mengisi ruang yang tersedia, hingga 70% dari lebar kartu. Jika kedua kolom ditetapkan ke FILL_AVAILABLE_SPACE , setiap kolom akan mengisi 50% ruang. |
FILL_MINIMUM_SPACE |
Kolom mengisi ruang seminimal mungkin dan tidak lebih dari 30% dari lebar kartu. |
VerticalAlignment
Menentukan apakah widget diratakan dengan bagian atas, bawah, atau tengah kolom.
Enum | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
CENTER |
Nilai default. Meratakan widget ke tengah kolom. |
TOP |
Meratakan widget ke bagian atas kolom. |
BOTTOM |
Meratakan widget ke bagian bawah kolom. |
Widget
Widget yang didukung yang dapat Anda sertakan dalam kolom.
Kolom | |
---|---|
Kolom union
|
|
textParagraph |
Widget |
image |
Widget |
decoratedText |
Widget |
buttonList |
Widget |
textInput |
Widget |
selectionInput |
Widget |
dateTimePicker |
Widget |
chipList |
Widget |
DateTimePicker
Memungkinkan pengguna memasukkan tanggal, waktu, atau tanggal dan waktu. Untuk contoh di aplikasi Google Chat, lihat Mengizinkan pengguna memilih tanggal dan waktu.
Pengguna dapat memasukkan teks atau menggunakan pemilih untuk memilih tanggal dan waktu. Jika pengguna memasukkan tanggal atau waktu yang tidak valid, pemilih akan menampilkan error yang meminta pengguna untuk memasukkan informasi dengan benar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
name |
Nama yang digunakan untuk mengidentifikasi Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
label |
Teks yang meminta pengguna untuk memasukkan tanggal, waktu, atau tanggal dan waktu. Misalnya, jika pengguna menjadwalkan janji temu, gunakan label seperti |
type |
Apakah widget mendukung memasukkan tanggal, waktu, atau tanggal dan waktu. |
valueMsEpoch |
Nilai default yang ditampilkan di widget, dalam milidetik sejak epoch Unix. Tentukan nilai berdasarkan jenis alat pilih (
|
timezoneOffsetDate |
Angka yang mewakili selisih zona waktu dari UTC, dalam menit. Jika disetel, |
onChangeAction |
Dipicu saat pengguna mengklik Simpan atau Hapus dari antarmuka |
validation |
Opsional. Tentukan validasi yang diperlukan untuk pemilih datetime ini.
|
DateTimePickerType
Format untuk tanggal dan waktu di widget DateTimePicker
. Menentukan apakah pengguna dapat memasukkan tanggal, waktu, atau tanggal dan waktu.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
DATE_AND_TIME |
Pengguna memasukkan tanggal dan waktu. |
DATE_ONLY |
Pengguna memasukkan tanggal. |
TIME_ONLY |
Pengguna memasukkan waktu. |
DecoratedText
Widget yang menampilkan teks dengan dekorasi opsional seperti label di atas atau di bawah teks, ikon di depan teks, widget pilihan, atau tombol setelah teks. Untuk contoh aplikasi Google Chat, lihat Menampilkan teks dengan teks dekoratif.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
icon |
Tidak digunakan lagi dan digantikan dengan |
startIcon |
Ikon yang ditampilkan di depan teks. |
topLabel |
Teks yang muncul di atas |
text |
Wajib diisi. Teks utama. Mendukung pemformatan sederhana. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. |
wrapText |
Setelan kemas teks. Jika Hanya berlaku untuk |
bottomLabel |
Teks yang muncul di bawah |
onClick |
Tindakan ini dipicu saat pengguna mengklik |
Kolom union control . Tombol, tombol akses, kotak centang, atau gambar yang muncul di sebelah kanan teks dalam widget decoratedText . control hanya dapat berupa salah satu dari yang berikut: |
|
button |
Tombol yang dapat diklik pengguna untuk memicu tindakan. |
switchControl |
Widget tombol akses yang dapat diklik pengguna untuk mengubah statusnya dan memicu tindakan. |
endIcon |
Ikon yang ditampilkan setelah teks. |
SwitchControl
Tombol gaya beralih atau kotak centang di dalam widget decoratedText
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Hanya didukung di widget decoratedText
.
Kolom | |
---|---|
name |
Nama yang digunakan untuk mengidentifikasi widget tombol dalam peristiwa input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
value |
Nilai yang dimasukkan oleh pengguna, ditampilkan sebagai bagian dari peristiwa input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
selected |
Saat |
onChangeAction |
Tindakan yang akan dilakukan saat status tombol berubah, seperti fungsi yang akan dijalankan. |
controlType |
Cara tombol muncul di antarmuka pengguna.
|
ControlType
Cara tombol muncul di antarmuka pengguna.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
SWITCH |
Tombol gaya beralih. |
CHECKBOX |
Tidak digunakan lagi dan digantikan dengan CHECK_BOX . |
CHECK_BOX |
Kotak centang. |
Pembatas
Jenis ini tidak memiliki kolom.
Menampilkan pemisah antar-widget sebagai garis horizontal. Untuk contoh aplikasi Google Chat, lihat Menambahkan pemisah horizontal antar-widget.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Misalnya, JSON berikut membuat pemisah:
"divider": {}
GetAutocompletionResponse
Respons untuk mendapatkan penampung pelengkapan otomatis, yang mencakup elemen yang diperlukan untuk menampilkan item pelengkapan otomatis untuk kolom teks.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat. Contoh:
{
"autoComplete": {
"items": [
{
"text": "C++"
},
{
"text": "Java"
},
{
"text": "JavaScript"
},
{
"text": "Python"
}
]
}
}
Kolom | |
---|---|
autoComplete |
|
schema |
Ini adalah kolom skema tanpa pengoperasian yang mungkin ada di markup untuk pemeriksaan sintaksis. |
Petak
Menampilkan petak dengan kumpulan item. Item hanya boleh menyertakan teks atau gambar. Untuk kolom responsif, atau untuk menyertakan lebih dari sekadar teks atau gambar, gunakan
. Untuk contoh aplikasi Google Chat, lihat Menampilkan Petak dengan kumpulan item.Columns
{i>Grid<i} mendukung sejumlah kolom dan item. Jumlah baris ditentukan dengan item dibagi dengan kolom. Grid dengan 10 item dan 2 kolom memiliki 5 baris. Grid dengan 11 item dan 2 kolom memiliki 6 baris.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Misalnya, JSON berikut membuat petak 2 kolom dengan satu item:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
Kolom | |
---|---|
title |
Teks yang ditampilkan di header grid. |
items[] |
Item yang akan ditampilkan dalam petak. |
borderStyle |
Gaya batas yang akan diterapkan ke setiap item petak. |
columnCount |
Jumlah kolom yang akan ditampilkan di petak. Nilai default digunakan jika kolom ini tidak ditentukan, dan nilai default tersebut berbeda-beda bergantung pada tempat petak ditampilkan (dialog versus pengiring). |
onClick |
Callback ini digunakan kembali oleh setiap item petak, tetapi dengan ID dan indeks item dalam daftar item yang ditambahkan ke parameter callback. |
GridItem
Mewakili item dalam tata letak petak. Item dapat berisi teks, gambar, atau teks dan gambar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
id |
ID yang ditentukan pengguna untuk item petak ini. ID ini ditampilkan dalam parameter callback |
image |
Gambar yang ditampilkan dalam item petak. |
title |
Judul item petak. |
subtitle |
Subtitel item petak. |
layout |
Tata letak yang akan digunakan untuk item petak. |
GridItemLayout
Menampilkan berbagai opsi tata letak yang tersedia untuk item petak.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
TEXT_BELOW |
Judul dan subjudul ditampilkan di bawah gambar item petak. |
TEXT_ABOVE |
Judul dan subjudul ditampilkan di atas gambar item petak. |
Ikon
Ikon yang ditampilkan dalam widget pada kartu. Untuk contoh aplikasi Google Chat, lihat Menambahkan ikon.
Mendukung ikon bawaan dan khusus.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
altText |
Opsional. Deskripsi ikon yang digunakan untuk aksesibilitas. Jika tidak ditentukan, nilai default Jika ikon disetel di |
imageType |
Gaya pemangkasan yang diterapkan ke gambar. Dalam beberapa kasus, menerapkan pemangkasan |
Kolom union icons . Ikon yang ditampilkan di widget pada kartu. icons hanya dapat berupa salah satu dari berikut: |
|
knownIcon |
Menampilkan salah satu ikon bawaan yang disediakan oleh Google Workspace. Misalnya, untuk menampilkan ikon pesawat, tentukan Untuk daftar lengkap ikon yang didukung, lihat ikon bawaan. |
iconUrl |
Menampilkan ikon kustom yang dihosting di URL HTTPS. Contoh:
Jenis file yang didukung mencakup |
materialIcon |
Menampilkan salah satu Ikon Material Google. Misalnya, untuk menampilkan ikon kotak centang, gunakan
|
Gambar
Gambar yang ditentukan oleh URL dan dapat memiliki tindakan onClick
. Untuk contoh, lihat Menambahkan gambar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
imageUrl |
URL HTTPS yang menghosting gambar. Contoh:
|
onClick |
Saat pengguna mengklik gambar, klik tersebut akan memicu tindakan ini. |
altText |
Teks alternatif dari gambar ini yang digunakan untuk aksesibilitas. |
ImageComponent
Menampilkan gambar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
imageUri |
URL gambar. |
altText |
Label aksesibilitas untuk gambar. |
cropStyle |
Gaya pemangkasan yang akan diterapkan ke gambar. |
borderStyle |
Gaya batas yang akan diterapkan pada gambar. |
ImageCropStyle
Mewakili gaya pemangkasan yang diterapkan pada gambar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Misalnya, berikut cara menerapkan rasio aspek 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
Kolom | |
---|---|
type |
Jenis pemangkasan. |
aspectRatio |
Rasio aspek yang digunakan jika jenis pemangkasan adalah Misalnya, berikut cara menerapkan rasio aspek 16:9:
|
ImageCropType
Mewakili gaya pemangkasan yang diterapkan pada gambar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
SQUARE |
Nilai default. Menerapkan pemangkasan persegi. |
CIRCLE |
Menerapkan pemangkasan lingkaran. |
RECTANGLE_CUSTOM |
Menerapkan pemangkasan persegi panjang dengan rasio aspek kustom. Tetapkan rasio aspek kustom dengan aspectRatio . |
RECTANGLE_4_3 |
Menerapkan pangkas persegi panjang dengan rasio aspek 4:3. |
Link
Objek link untuk resource pihak ketiga yang ditampilkan ke add-on. Untuk mengetahui informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Kolom | |
---|---|
url |
URL link untuk kembali ke add-on. |
title |
Judul link untuk kembali ke add-on. |
LinkPreview
Tindakan kartu yang melihat pratinjau link pihak ketiga dengan menampilkan kartu dan smart chip. Untuk mempelajari lebih lanjut, lihat Melihat pratinjau link dengan smart chip.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Misalnya, JSON berikut menampilkan judul unik untuk pratinjau link dan smart chip-nya, serta kartu pratinjau dengan header dan deskripsi teks:
{
"action": {
"linkPreview": {
"title": "Smart chip title",
"linkPreviewTitle": "Link preview title",
"previewCard": {
"header": {
"title": "Preview card header",
},
"sections": [
{
"widgets": [
{
"textParagraph": {
"text": "Description of the link."
}
}
]
}
]
}
}
}
}
Contoh ini menampilkan pratinjau link berikut:
Kolom | |
---|---|
previewCard |
Kartu yang menampilkan informasi tentang link dari layanan pihak ketiga. |
title |
Judul yang ditampilkan di smart chip untuk pratinjau link. Jika tidak disetel, smart chip akan menampilkan header |
linkPreviewTitle |
Judul yang ditampilkan di pratinjau link. Jika tidak disetel, pratinjau link akan menampilkan header |
MaterialIcon
Ikon Material Google, yang mencakup lebih dari 2.500 opsi.
Misalnya, untuk menampilkan ikon kotak centang dengan berat dan tingkat yang disesuaikan, tulis hal berikut:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
name |
Nama ikon yang ditentukan dalam Ikon Material Google, misalnya, |
fill |
Apakah ikon dirender sebagai terisi. Nilai defaultnya adalah false (salah). Untuk melihat pratinjau setelan ikon yang berbeda, buka Ikon Google Font dan sesuaikan setelan di bagian Sesuaikan. |
weight |
Ketebalan goresan ikon. Pilih dari {100, 200, 300, 400, 500, 600, 700}. Jika tidak ada, nilai defaultnya adalah 400. Jika ada nilai lain yang ditentukan, nilai default akan digunakan. Untuk melihat pratinjau setelan ikon yang berbeda, buka Ikon Google Font dan sesuaikan setelan di bagian Sesuaikan. |
grade |
Bobot dan gradasi memengaruhi ketebalan simbol. Penyesuaian nilai lebih terperinci daripada penyesuaian bobot dan memiliki dampak kecil pada ukuran simbol. Pilih dari {-25, 0, 200}. Jika tidak ada, nilai defaultnya adalah 0. Jika ada nilai lain yang ditentukan, nilai default akan digunakan. Untuk melihat pratinjau setelan ikon yang berbeda, buka Ikon Google Font dan sesuaikan setelan di bagian Sesuaikan. |
Notifikasi
Tindakan kartu yang menampilkan notifikasi di aplikasi host.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Kolom | |
---|---|
text |
Teks biasa yang ditampilkan untuk notifikasi, tanpa tag HTML. |
OnClick
Merepresentasikan cara merespons saat pengguna mengklik elemen interaktif pada kartu, seperti tombol.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
Kolom union
|
|
action |
Jika ditentukan, tindakan akan dipicu oleh |
openLink |
Jika ditentukan, |
openDynamicLinkAction |
Add-on memicu tindakan ini ketika tindakan perlu membuka link. Ini berbeda dengan
|
card |
Kartu baru didorong ke tumpukan kartu setelah diklik jika ditentukan.
|
overflowMenu |
Jika ditentukan, |
OpenLink
Merepresentasikan peristiwa onClick
yang membuka hyperlink.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
url |
URL yang akan dibuka. |
openAs |
Cara membuka link.
|
onClose |
Apakah klien melupakan link setelah membukanya, atau mengamatinya hingga jendela tertutup.
|
OnClose
Yang dilakukan klien saat link dibuka oleh tindakan OnClick
ditutup.
Implementasinya bergantung pada kemampuan platform klien. Misalnya, browser web dapat membuka link di jendela pop-up dengan pengendali OnClose
.
Jika pengendali OnOpen
dan OnClose
ditetapkan, dan platform klien tidak dapat mendukung kedua nilai tersebut, OnClose
akan diprioritaskan.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Enum | |
---|---|
NOTHING |
Nilai default. Kartu tidak dapat dimuat ulang; tidak akan terjadi apa pun. |
RELOAD |
Memuat ulang kartu setelah jendela turunan ditutup. Jika digunakan bersama dengan |
OpenAs
Saat tindakan OnClick
membuka link, klien dapat membukanya sebagai jendela ukuran penuh (jika itu adalah frame yang digunakan oleh klien), atau overlay (seperti pop-up). Implementasinya bergantung pada kemampuan platform klien, dan nilai yang dipilih mungkin diabaikan jika klien tidak mendukungnya. FULL_SIZE
didukung oleh semua klien.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.
Enum | |
---|---|
FULL_SIZE |
Link akan terbuka sebagai jendela ukuran penuh (jika itu adalah frame yang digunakan oleh klien). |
OVERLAY |
Tautan akan terbuka sebagai overlay, misalnya sebagai pop-up. |
OverflowMenu
Widget yang menampilkan menu pop-up dengan satu atau beberapa tindakan yang dapat dipanggil oleh pengguna. Misalnya, menampilkan tindakan non-utama di kartu. Anda dapat menggunakan widget ini saat tindakan tidak sesuai dengan ruang yang tersedia. Untuk menggunakannya, tentukan widget ini di tindakan OnClick
widget yang mendukungnya. Misalnya, dalam Button
.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
items[] |
Wajib diisi. Daftar opsi menu. |
OverflowMenuItem
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
startIcon |
Ikon yang ditampilkan di depan teks. |
text |
Wajib diisi. Teks yang mengidentifikasi atau menjelaskan item kepada pengguna. |
onClick |
Wajib diisi. Tindakan ini dipanggil saat opsi menu dipilih. |
disabled |
Apakah opsi menu dinonaktifkan. Nilai defaultnya adalah false (salah). |
RenderActions
Serangkaian petunjuk render yang memberi tahu kartu untuk melakukan tindakan, atau memberi tahu aplikasi host add-on atau aplikasi Chat untuk melakukan tindakan khusus aplikasi.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
action |
|
hostAppAction |
Tindakan yang ditangani oleh setiap aplikasi host. |
schema |
Ini adalah kolom skema tanpa pengoperasian yang mungkin ada di markup untuk pemeriksaan sintaksis. |
Tindakan
Kolom | |
---|---|
navigations[] |
Mengirim, memunculkan, atau memperbarui kartu yang ditampilkan. |
link |
Segera buka link target dalam tab baru atau pop-up. |
notification |
Tampilkan notifikasi kepada pengguna akhir. |
linkPreview |
Tampilkan pratinjau link kepada pengguna akhir. |
links[] |
Link untuk referensi pihak ketiga yang dibuat dari dalam aplikasi Google Workspace. Diformat sebagai array objek dengan satu item. Untuk mengetahui informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @. |
SelectionInput
Widget yang membuat satu atau beberapa item UI yang dapat dipilih pengguna. Misalnya, menu dropdown atau kotak centang. Anda dapat menggunakan widget ini untuk mengumpulkan data yang dapat diprediksi atau dienumerasi. Untuk contoh aplikasi Google Chat, lihat Menambahkan elemen UI yang dapat dipilih.
Aplikasi Chat dapat memproses nilai item yang dipilih atau dimasukkan pengguna. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.
Untuk mengumpulkan data yang tidak ditentukan atau abstrak dari pengguna, gunakan widget TextInput
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
name |
Wajib diisi. Nama yang mengidentifikasi input pilihan dalam peristiwa input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
label |
Teks yang muncul di atas kolom input pilihan di antarmuka pengguna. Tentukan teks yang membantu pengguna memasukkan informasi yang dibutuhkan aplikasi Anda. Misalnya, jika pengguna memilih urgensi tiket kerja dari menu drop-down, labelnya mungkin adalah "Urgensi" atau "Pilih urgensi". |
type |
Jenis item yang ditampilkan kepada pengguna di widget |
items[] |
Array item yang dapat dipilih. Misalnya, array tombol pilihan atau kotak centang. Mendukung hingga 100 item. |
onChangeAction |
Jika ditentukan, formulir akan dikirim saat pilihan berubah. Jika tidak ditentukan, Anda harus menentukan tombol terpisah yang mengirimkan formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
multiSelectMaxSelectedItems |
Untuk menu multi-pilihan, jumlah item maksimum yang dapat dipilih pengguna. Nilai minimumnya adalah 1 item. Jika tidak ditentukan, setelan defaultnya adalah 3 item. |
multiSelectMinQueryLength |
Untuk menu multi-pilihan, jumlah karakter teks yang dimasukkan pengguna sebelum kueri aplikasi akan dilengkapi secara otomatis dan menampilkan item yang disarankan dalam menu. Jika tidak ditentukan, defaultnya adalah 0 karakter untuk sumber data statis dan 3 karakter untuk sumber data eksternal. |
validation |
Untuk menu dropdown, validasi untuk kolom input pilihan ini.
|
Kolom union
|
|
externalDataSource |
Sumber data eksternal, seperti basis data relasional. |
platformDataSource |
Sumber data dari Google Workspace. |
PlatformDataSource
Untuk widget
yang menggunakan menu multi-pilihan, sumber data dari Google Workspace. Digunakan untuk mengisi item dalam menu multi-pilihan.SelectionInput
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Kolom | |
---|---|
Kolom union data_source . Sumber data. data_source hanya dapat berupa salah satu dari berikut: |
|
commonDataSource |
Sumber data yang digunakan bersama oleh semua aplikasi Google Workspace, seperti pengguna di organisasi Google Workspace. |
hostAppDataSource |
Sumber data yang unik untuk aplikasi host Google Workspace, seperti ruang di Google Chat. Kolom ini mendukung Library Klien Google API, tetapi tidak tersedia di Library Klien Cloud. Untuk mempelajari lebih lanjut, lihat Menginstal library klien. |
CommonDataSource
Sumber data yang digunakan bersama oleh semua aplikasi Google Workspace.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Enum | |
---|---|
UNKNOWN |
Nilai default. Jangan gunakan. |
USER |
pengguna Google Workspace. Pengguna hanya dapat melihat dan memilih pengguna dari organisasi Google Workspace miliknya. |
SelectionItem
Item yang dapat dipilih pengguna dalam input pilihan, seperti kotak centang atau tombol.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
text |
Teks yang mengidentifikasi atau menjelaskan item kepada pengguna. |
value |
Nilai yang terkait dengan item ini. Klien harus menggunakan ini sebagai nilai input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
selected |
Apakah item dipilih secara default. Jika input pilihan hanya menerima satu nilai (seperti untuk tombol pilihan atau menu dropdown), hanya setel kolom ini untuk satu item. |
startIconUri |
Untuk menu multi-pilihan, URL untuk ikon yang ditampilkan di samping kolom |
bottomText |
Untuk menu pilihan multi-pilihan, deskripsi teks atau label ditampilkan di bawah kolom |
SelectionType
Format untuk item yang dapat dipilih pengguna. Opsi yang berbeda mendukung jenis interaksi yang berbeda. Misalnya, pengguna dapat memilih beberapa kotak centang, tetapi hanya dapat memilih satu item dari menu dropdown.
Setiap input pilihan mendukung satu jenis pilihan. Mencampur kotak centang dan tombol, misalnya, tidak didukung.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
CHECK_BOX |
Sekumpulan kotak centang. Pengguna dapat memilih satu atau beberapa kotak centang. |
RADIO_BUTTON |
Serangkaian tombol pilihan. Pengguna dapat memilih satu tombol pilihan. |
SWITCH |
Sekumpulan tombol. Pengguna dapat mengaktifkan satu atau beberapa tombol. |
DROPDOWN |
Menu dropdown. Pengguna dapat memilih satu item dari menu. |
MULTI_SELECT |
Menu multi-pilihan untuk data statis atau dinamis. Dari panel menu, pengguna memilih satu atau beberapa item. Pengguna juga dapat memasukkan nilai untuk mengisi data dinamis. Misalnya, pengguna dapat mulai mengetik nama ruang Google Chat dan widget akan menyarankan ruang tersebut secara otomatis. Untuk mengisi item pada menu multi-pilihan, Anda dapat menggunakan salah satu jenis sumber data berikut:
Untuk contoh cara menerapkan menu multi-pilihan, lihat Menambahkan menu multi-pilihan.
|
SubmitFormResponse
Respons terhadap pengiriman formulir selain mendapatkan penampung pelengkapan otomatis, yang berisi tindakan yang harus dilakukan kartu dan/atau yang harus dilakukan aplikasi host add-on, dan apakah status kartu telah berubah.
Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat. Contoh:
{
"renderActions": {
"action": {
"notification": {
"text": "Email address is added: salam.heba@example.com"
}
},
"hostAppAction": {
"gmailAction": {
"openCreatedDraftAction": {
"draftId": "msg-a:r-79766936926021702",
"threadServerPermId": "thread-f:15700999851086004"
}
}
}
}
}
Kolom | |
---|---|
renderActions |
Serangkaian petunjuk render yang memberi tahu kartu untuk melakukan tindakan dan/atau memberi tahu aplikasi host add-on untuk melakukan tindakan khusus aplikasi. |
stateChanged |
Apakah status kartu telah berubah dan data dalam kartu yang ada sudah usang. |
schema |
Ini adalah kolom skema tanpa pengoperasian yang mungkin ada di markup untuk pemeriksaan sintaksis. |
Saran
Nilai yang disarankan yang dapat dimasukkan pengguna. Nilai ini muncul saat pengguna mengklik di dalam kolom input teks. Saat pengguna mengetik, nilai yang disarankan akan memfilter secara dinamis agar sesuai dengan yang diketik pengguna.
Misalnya, kolom input teks untuk bahasa pemrograman dapat menyarankan Java, JavaScript, Python, dan C++. Ketika pengguna mulai mengetik Jav
, daftar filter saran akan menampilkan Java
dan JavaScript
.
Nilai yang disarankan akan membantu memandu pengguna untuk memasukkan nilai yang dapat dipahami oleh aplikasi Anda. Saat merujuk ke JavaScript, beberapa pengguna mungkin memasukkan javascript
dan lainnya java script
. Menyarankan JavaScript
dapat menstandarkan cara pengguna berinteraksi dengan aplikasi Anda.
Jika ditentukan, TextInput.type
akan selalu SINGLE_LINE
, meskipun ditetapkan ke MULTIPLE_LINE
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
items[] |
Daftar saran yang digunakan untuk rekomendasi pelengkapan otomatis di kolom input teks. |
SuggestionItem
Satu nilai yang disarankan yang dapat dimasukkan pengguna dalam kolom input teks.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
Kolom union
|
|
text |
Nilai input yang disarankan ke kolom input teks. Ini sama dengan apa yang dimasukkan pengguna. |
TextInput
Kolom tempat pengguna dapat memasukkan teks. Mendukung saran dan tindakan saat perubahan. Untuk contoh aplikasi Google Chat, lihat Menambahkan kolom tempat pengguna dapat memasukkan teks.
Aplikasi Chat menerima dan dapat memproses nilai teks yang dimasukkan selama peristiwa input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.
Saat Anda perlu mengumpulkan data yang tidak ditentukan atau abstrak dari pengguna, gunakan input teks. Untuk mengumpulkan data yang ditentukan atau dienumerasi dari pengguna, gunakan widget SelectionInput
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
name |
Nama yang digunakan untuk mengidentifikasi input teks dalam peristiwa input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
label |
Teks yang muncul di atas kolom input teks di antarmuka pengguna. Tentukan teks yang membantu pengguna memasukkan informasi yang dibutuhkan aplikasi Anda. Misalnya, jika Anda menanyakan nama seseorang, tetapi secara khusus memerlukan nama belakangnya, tulis Wajib ada jika |
hintText |
Teks yang muncul di bawah kolom input teks yang dimaksudkan untuk membantu pengguna dengan meminta mereka memasukkan nilai tertentu. Teks ini selalu terlihat. Wajib ada jika |
value |
Nilai yang dimasukkan oleh pengguna, ditampilkan sebagai bagian dari peristiwa input formulir. Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir. |
type |
Cara kolom input teks muncul di antarmuka pengguna. Misalnya, apakah kolom satu atau beberapa baris. |
onChangeAction |
Tindakan yang harus dilakukan saat terjadi perubahan dalam kolom input teks. Misalnya, pengguna yang menambahkan ke kolom atau menghapus teks. Contoh tindakan yang dapat dilakukan antara lain menjalankan fungsi kustom atau membuka dialog di Google Chat. |
initialSuggestions |
Nilai yang disarankan yang dapat dimasukkan pengguna. Nilai ini muncul saat pengguna mengklik di dalam kolom input teks. Saat pengguna mengetik, nilai yang disarankan akan memfilter secara dinamis agar sesuai dengan yang diketik pengguna. Misalnya, kolom input teks untuk bahasa pemrograman dapat menyarankan Java, JavaScript, Python, dan C++. Ketika pengguna mulai mengetik Nilai yang disarankan akan membantu memandu pengguna untuk memasukkan nilai yang dapat dipahami oleh aplikasi Anda. Saat merujuk ke JavaScript, beberapa pengguna mungkin memasukkan Jika ditentukan,
|
autoCompleteAction |
Opsional. Menentukan tindakan yang akan diambil saat kolom input teks memberikan saran kepada pengguna yang berinteraksi dengannya. Jika tidak ditentukan, saran akan ditetapkan oleh Jika ditentukan, aplikasi akan mengambil tindakan yang ditentukan di sini, seperti menjalankan fungsi kustom.
|
validation |
Tentukan validasi yang diperlukan untuk kolom input teks ini.
|
placeholderText |
Teks yang muncul di kolom input teks saat kolom kosong. Gunakan teks ini untuk meminta pengguna memasukkan nilai. Misalnya,
|
Jenis
Cara kolom input teks muncul di antarmuka pengguna. Misalnya, baik berupa kolom input baris tunggal atau input multibaris. Jika initialSuggestions
ditetapkan, type
akan selalu SINGLE_LINE
, meski ditetapkan ke MULTIPLE_LINE
.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
SINGLE_LINE |
Kolom input teks memiliki tinggi tetap satu baris. |
MULTIPLE_LINE |
Kolom input teks memiliki tinggi tetap beberapa baris. |
TextParagraph
Paragraf teks yang mendukung pemformatan. Untuk contoh di aplikasi Google Chat, lihat Menambahkan paragraf teks berformat. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
text |
Teks yang ditampilkan di widget. |
maxLines |
Jumlah maksimum baris teks yang ditampilkan di widget. Jika teks melebihi jumlah baris maksimum yang ditentukan, kelebihan konten akan disembunyikan di balik tombol show more. Jika teks sama atau lebih pendek dari jumlah baris maksimum yang ditentukan, tombol tampilkan lebih banyak tidak akan ditampilkan. Nilai defaultnya adalah 0, yang dalam hal ini semua konteks ditampilkan. Nilai negatif akan diabaikan. |
Validasi
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Kolom | |
---|---|
characterLimit |
|
inputType |
Tentukan jenis widget input.
|
InputType
Jenis widget input.
Enum | |
---|---|
INPUT_TYPE_UNSPECIFIED |
Jenis tidak ditentukan. Jangan gunakan. |
TEXT |
Teks biasa yang menerima semua karakter. |
INTEGER |
Nilai bilangan bulat. |
FLOAT |
Nilai float. |
EMAIL |
Alamat email. |
EMOJI_PICKER |
Emoji yang dipilih dari pemilih emoji yang disediakan sistem. |
Widget
Setiap kartu terdiri dari widget.
Widget adalah objek gabungan yang dapat merepresentasikan salah satu dari teks, gambar, tombol, dan jenis objek lainnya.
Kolom | |
---|---|
horizontalAlignment |
Menentukan apakah widget diratakan ke kiri, kanan, atau tengah kolom. |
Kolom union data . Widget hanya boleh memiliki salah satu dari item berikut. Anda dapat menggunakan beberapa kolom widget untuk menampilkan lebih banyak item. data hanya dapat berupa salah satu dari berikut: |
|
textParagraph |
Menampilkan paragraf teks. Mendukung teks berformat HTML sederhana. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. Misalnya, JSON berikut membuat teks tebal:
|
image |
Menampilkan gambar. Misalnya, JSON berikut membuat gambar dengan teks alternatif:
|
decoratedText |
Menampilkan item teks dengan dekorasi. Misalnya, JSON berikut membuat widget teks berdekorasi yang menampilkan alamat email:
|
buttonList |
Daftar tombol. Misalnya, JSON berikut membuat dua tombol. Yang pertama adalah tombol teks biru dan yang kedua adalah tombol gambar untuk membuka link:
|
textInput |
Menampilkan kotak teks tempat pengguna dapat mengetik. Misalnya, JSON berikut membuat input teks untuk alamat email:
Contoh lain, JSON berikut membuat input teks untuk bahasa pemrograman dengan saran statis:
|
selectionInput |
Menampilkan kontrol pilihan yang memungkinkan pengguna memilih item. Kontrol pilihan dapat berupa kotak centang, tombol pilihan, tombol akses, atau menu dropdown. Misalnya, JSON berikut membuat menu dropdown yang memungkinkan pengguna memilih ukuran:
|
dateTimePicker |
Menampilkan widget yang memungkinkan pengguna memasukkan tanggal, waktu, atau tanggal dan waktu. Misalnya, JSON berikut membuat pemilih tanggal dan waktu untuk menjadwalkan janji temu:
|
divider |
Menampilkan pemisah garis horizontal di antara widget. Misalnya, JSON berikut membuat pemisah:
|
grid |
Menampilkan petak dengan kumpulan item. {i>Grid<i} mendukung sejumlah kolom dan item. Jumlah baris ditentukan oleh batas atas item jumlah dibagi dengan jumlah kolom. Grid dengan 10 item dan 2 kolom memiliki 5 baris. Grid dengan 11 item dan 2 kolom memiliki 6 baris.
Misalnya, JSON berikut membuat petak 2 kolom dengan satu item:
|
columns |
Menampilkan hingga 2 kolom. Untuk menyertakan lebih dari 2 kolom, atau menggunakan baris, gunakan widget Misalnya, JSON berikut membuat 2 kolom yang masing-masing berisi paragraf teks:
|
chipList |
Daftar chip. Misalnya, JSON berikut membuat dua chip. Yang pertama adalah chip teks dan yang kedua adalah chip ikon yang membuka link:
|
HorizontalAlignment
Menentukan apakah widget diratakan ke kiri, kanan, atau tengah kolom.
Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.
Enum | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED |
Jangan gunakan. Tidak ditentukan. |
START |
Nilai default. Meratakan widget ke posisi awal kolom. Untuk tata letak kiri-ke-kanan, ratakan ke kiri. Untuk tata letak kanan-ke-kiri, sejajarkan ke kanan. |
CENTER |
Meratakan widget ke tengah kolom. |
END |
Meratakan widget ke posisi akhir kolom. Untuk tata letak kiri-ke-kanan, sejajarkan widget ke kanan. Untuk tata letak kanan-ke-kiri, sejajarkan widget ke kiri. |
ImageType
Bentuk yang digunakan untuk memangkas gambar.
Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.
Enum | |
---|---|
SQUARE |
Nilai default. Menerapkan mask persegi ke gambar. Misalnya, gambar 4x3 menjadi 3x3. |
CIRCLE |
Menerapkan mask lingkaran ke gambar. Misalnya, sebuah gambar berukuran 4x3 menjadi lingkaran dengan diameter 3. |