Package google.apps.card.v1

string

Fungsi kustom yang akan dipanggil saat elemen penampung diklik atau diaktifkan.

Untuk contoh penggunaan, lihat Membaca data formulir.

ActionParameter

Daftar parameter tindakan.

LoadIndicator

Menentukan indikator pemuatan yang ditampilkan tindakan saat melakukan pesan ajakan (CTA).

bool

Menunjukkan apakah nilai formulir tetap ada setelah tindakan. Nilai default-nya adalah false.

Jika true, nilai formulir akan tetap ada setelah tindakan dipicu. Untuk mengizinkan pengguna membuat perubahan saat tindakan sedang diproses, tetapkan LoadIndicator ke NONE. Untuk pesan kartu di aplikasi Chat, Anda juga harus menetapkan ResponseType tindakan ke UPDATE_MESSAGE dan menggunakan card_id yang sama dari kartu yang berisi tindakan.

Jika false, nilai formulir akan dihapus saat tindakan dipicu. Untuk mencegah pengguna membuat perubahan saat tindakan sedang diproses, tetapkan LoadIndicator ke SPINNER.

Interaction

Opsional. Diperlukan saat membuka dialog.

Apa yang harus dilakukan sebagai respons atas 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.

string

Nama parameter untuk skrip tindakan.

string

Nilai parameter.

BorderType

Jenis batas.

Color

Warna yang akan digunakan saat jenisnya adalah BORDER_TYPE_STROKE.

int32

Radius sudut untuk batas.

string

Teks yang ditampilkan di dalam tombol.

Icon

Gambar ikon. Jika icon dan text disetel, ikon akan muncul sebelum teks.

Color

Jika disetel, tombol akan diisi dengan warna latar belakang yang solid dan warna font akan berubah untuk mempertahankan kontras dengan warna latar belakang. Misalnya, menetapkan latar belakang biru kemungkinan akan menghasilkan teks putih.

Jika tidak disetel, latar belakang gambar akan berwarna putih dan warna font akan berwarna biru.

Untuk warna merah, hijau, dan biru, nilai setiap kolom adalah angka float yang dapat Anda nyatakan dengan salah satu dari dua cara berikut: sebagai angka antara 0 dan 255 yang dibagi 255 (153/255), atau sebagai nilai antara 0 dan 1 (0,6). 0 mewakili tidak adanya warna dan 1 atau 255/255 mewakili kehadiran penuh warna pada skala RGB.

Jika perlu, setel alpha, yang menetapkan tingkat transparansi menggunakan persamaan ini:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Untuk alpha, nilai 1 sesuai dengan warna solid, dan nilai 0 sesuai dengan warna yang sepenuhnya transparan.

Misalnya, warna berikut mewakili merah transparan setengah:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}

OnClick

Wajib. Tindakan yang harus dilakukan saat pengguna mengklik tombol, seperti membuka hyperlink atau menjalankan fungsi kustom.

bool

Jika true, tombol ditampilkan dalam keadaan tidak aktif dan tidak merespons tindakan pengguna.

string

Teks alternatif yang digunakan untuk aksesibilitas.

Menyetel teks deskriptif yang memungkinkan pengguna mengetahui fungsi tombol tersebut. Misalnya, jika sebuah tombol membuka hyperlink, Anda mungkin menulis: "Membuka tab browser baru dan membuka dokumentasi developer Google Chat di https://developers.google.com/workspace/chat".

Button

Array tombol.

CardHeader

Header kartu. {i>Header<i} biasanya berisi gambar utama dan judul. Header selalu muncul di bagian atas kartu.

Section

Berisi kumpulan widget. Setiap bagian memiliki header opsional sendiri. Bagian secara visual dipisahkan oleh garis pembagi. Untuk contoh di aplikasi Google Chat, lihat Menentukan bagian kartu.

DividerStyle

Gaya pemisah antarbagian.

CardAction

Tindakan kartu. Tindakan ditambahkan ke menu toolbar kartu.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

Misalnya, JSON berikut membuat menu tindakan kartu dengan opsi Settings dan Send Feedback:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

Nama kartu. Digunakan sebagai ID kartu dalam navigasi kartu.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

CardFixedFooter

Footer tetap yang ditampilkan di bagian bawah kartu ini.

Menyetel fixedFooter tanpa menentukan primaryButton atau secondaryButton akan menyebabkan error. Untuk aplikasi Chat, Anda dapat menggunakan footer tetap dalam dialog, tetapi tidak dapat menggunakan pesan kartu.

Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.

DisplayStyle

Di Add-on Google Workspace, tetapkan properti tampilan peekCardHeader.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

CardHeader

Saat menampilkan konten kontekstual, header kartu intip berfungsi sebagai placeholder sehingga pengguna dapat berpindah antara kartu halaman beranda dan kartu kontekstual.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

string

Label yang ditampilkan sebagai item menu tindakan.

OnClick

Tindakan onClick untuk item tindakan ini.

Button

Tombol utama footer tetap. Tombol tersebut harus berupa tombol teks dengan teks dan warna yang disetel.

Button

Tombol sekunder pada footer tetap. Tombol tersebut harus berupa tombol teks dengan teks dan warna yang disetel. Jika secondaryButton ditetapkan, Anda juga harus menetapkan primaryButton.

string

Wajib. Judul header kartu. Header memiliki tinggi tetap: jika judul dan subtitel ditentukan, masing-masing memerlukan satu baris. Jika hanya judul yang ditentukan, judul akan mengisi kedua baris.

string

Subjudul header kartu. Jika ditentukan, akan muncul pada barisnya sendiri di bawah title.

ImageType

Bentuk yang digunakan untuk memangkas gambar.

Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.

string

URL HTTPS gambar di header kartu.

string

Teks alternatif gambar ini yang digunakan untuk aksesibilitas.

string

Teks yang muncul di bagian atas suatu bagian. Mendukung teks berformat HTML sederhana. Untuk mengetahui informasi selengkapnya tentang cara memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

Widget

Semua widget di bagian tersebut. Harus berisi setidaknya satu widget.

bool

Menunjukkan apakah bagian ini dapat diciutkan.

Bagian yang dapat diciutkan menyembunyikan beberapa atau semua widget, tetapi pengguna dapat meluaskan bagian tersebut untuk menampilkan widget yang disembunyikan dengan mengklik Tampilkan lainnya. Pengguna dapat menyembunyikan widget lagi dengan mengklik Tampilkan lebih sedikit.

Untuk menentukan widget mana yang disembunyikan, tentukan uncollapsibleWidgetsCount.

int32

Jumlah widget yang tidak dapat diciutkan yang tetap terlihat meskipun bagian diciutkan.

Misalnya, jika bagian berisi lima widget dan uncollapsibleWidgetsCount disetel ke 2, dua widget pertama selalu ditampilkan dan tiga widget terakhir diciutkan secara default. uncollapsibleWidgetsCount hanya diperhitungkan jika collapsible adalah true.

Column

Array kolom. Anda dapat menyertakan maksimal 2 kolom dalam kartu atau dialog.

HorizontalSizeStyle

Menentukan cara kolom mengisi lebar kartu.

HorizontalAlignment

Menentukan apakah widget sejajar dengan kiri, kanan, atau tengah kolom.

VerticalAlignment

Menentukan apakah widget sejajar dengan bagian atas, bawah, atau tengah kolom.

Widgets

Array widget yang disertakan dalam kolom. Widget muncul sesuai urutan yang ditentukan.

TextParagraph

Widget TextParagraph.

Image

Widget Image.

DecoratedText

Widget DecoratedText.

ButtonList

Widget ButtonList.

TextInput

Widget TextInput.

SelectionInput

Widget SelectionInput.

DateTimePicker

Widget DateTimePicker.

string

Nama yang digunakan untuk mengidentifikasi DateTimePicker dalam peristiwa input formulir.

Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.

string

Teks yang meminta pengguna untuk memasukkan tanggal, waktu, atau tanggal dan waktu. Misalnya, jika pengguna menjadwalkan janji temu, gunakan label seperti Appointment date atau Appointment date and time.

DateTimePickerType

Apakah widget mendukung masukan tanggal, waktu, atau tanggal dan waktu.

int64

Nilai default yang ditampilkan di widget, dalam milidetik sejak waktu epoch Unix.

Tentukan nilai berdasarkan jenis pemilih (DateTimePickerType):

• DATE_AND_TIME: tanggal dan waktu kalender dalam UTC. Misalnya, untuk merepresentasikan 1 Januari 2023 pukul 12.00 UTC, gunakan 1672574400000.
• DATE_ONLY: tanggal kalender pada pukul 00:00:00 UTC. Misalnya, untuk merepresentasikan 1 Januari 2023, gunakan 1672531200000.
• TIME_ONLY: waktu dalam UTC. Misalnya, untuk merepresentasikan pukul 12.00, gunakan 43200000 (atau 12 * 60 * 60 * 1000).

int32

Angka yang mewakili offset zona waktu dari UTC, dalam menit. Jika disetel, value_ms_epoch akan ditampilkan di zona waktu yang ditentukan. Jika tidak disetel, nilai akan ditetapkan secara default ke setelan zona waktu pengguna.

Action

Dipicu saat pengguna mengklik Simpan atau Hapus dari antarmuka DateTimePicker.

Icon

Tidak digunakan lagi dan digantikan dengan startIcon.

Icon

Ikon yang ditampilkan di depan teks.

string

Teks yang muncul di atas text. Selalu potong.

string

Wajib. Teks utama.

Mendukung pemformatan sederhana. Untuk mengetahui informasi selengkapnya tentang cara memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

bool

Setelan kemas teks. Jika true, teks akan digabungkan dan ditampilkan di beberapa baris. Jika tidak, teks akan terpotong.

Hanya berlaku untuk text, bukan topLabel dan bottomLabel.

string

Teks yang muncul di bawah text. Selalu gabungkan.

OnClick

Tindakan ini akan dipicu saat pengguna mengklik topLabel atau bottomLabel.

Button

Tombol yang dapat diklik pengguna untuk memicu tindakan.

SwitchControl

Widget tombol akses yang dapat diklik pengguna untuk mengubah statusnya dan memicu tindakan.

Icon

Ikon yang ditampilkan setelah teks.

Mendukung ikon bawaan dan kustom.

string

Nama yang digunakan widget tombol untuk diidentifikasi dalam peristiwa input formulir.

Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.

string

Nilai yang dimasukkan oleh pengguna, ditampilkan sebagai bagian dari peristiwa input formulir.

Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.

bool

Saat true, tombol dipilih.

Action

Tindakan yang harus dilakukan saat status tombol berubah, seperti fungsi yang akan dijalankan.

ControlType

Cara tombol muncul di antarmuka pengguna.

Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.

Action

Tindakan render bagi klien untuk mengakhiri alur dialog.

Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

Suggestions

string

Ini adalah kolom skema tanpa pengoperasian yang mungkin ada di markup untuk pemeriksaan sintaksis.

string

Teks yang ditampilkan di header petak.

GridItem

Item yang akan ditampilkan di petak.

BorderStyle

Gaya batas yang akan diterapkan ke setiap item petak.

int32

Jumlah kolom yang akan ditampilkan di petak. Nilai default digunakan jika kolom ini tidak ditentukan, dan nilai default tersebut berbeda bergantung pada tempat petak ditampilkan (dialog versus pendamping).

OnClick

Callback ini digunakan kembali oleh setiap item petak, tetapi dengan ID dan indeks item dalam daftar item yang ditambahkan ke parameter callback.

string

ID yang ditentukan pengguna untuk item petak ini. ID ini ditampilkan di parameter callback onClick petak induk.

ImageComponent

Gambar yang ditampilkan di item petak.

string

Judul item petak.

string

Subtitel item petak.

GridItemLayout

Tata letak yang akan digunakan untuk item petak.

string

Opsional. Deskripsi ikon yang digunakan untuk aksesibilitas. Jika tidak ditentukan, nilai default Button akan diberikan. Sebagai praktik terbaik, Anda harus menetapkan deskripsi yang berguna untuk apa yang ditampilkan ikon tersebut, dan jika memungkinkan, apa yang dilakukan ikon tersebut. Misalnya, A user's account portrait, atau Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Jika ikon disetel dalam Button, altText akan muncul sebagai teks bantuan saat pengguna mengarahkan kursor ke tombol. Namun, jika tombol juga menetapkan text, altText ikon akan diabaikan.

ImageType

Gaya pangkas yang diterapkan pada gambar. Dalam beberapa kasus, menerapkan pemangkasan CIRCLE akan menyebabkan gambar digambar lebih besar daripada ikon bawaan.

string

Menampilkan salah satu ikon bawaan yang disediakan oleh Google Workspace.

Misalnya, untuk menampilkan ikon pesawat, tentukan AIRPLANE. Untuk bus, tentukan BUS.

Untuk mengetahui daftar lengkap ikon yang didukung, lihat ikon bawaan.

string

Menampilkan ikon kustom yang dihosting di URL HTTPS.

Contoh:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Jenis file yang didukung mencakup .png dan .jpg.

MaterialIcon

Tampilkan salah satu Ikon Material Google.

Misalnya, untuk menampilkan ikon kotak centang, gunakan

"materialIcon": {
  "name": "check_box"
}

Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

string

URL HTTPS yang menghosting gambar.

Contoh:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

Saat pengguna mengklik gambar, klik tersebut akan memicu tindakan ini.

string

Teks alternatif gambar ini yang digunakan untuk aksesibilitas.

string

URL gambar.

string

Label aksesibilitas untuk gambar.

ImageCropStyle

Gaya pangkas yang akan diterapkan pada gambar.

BorderStyle

Gaya batas yang akan diterapkan pada gambar.

ImageCropType

Jenis pemangkasan.

double

Rasio aspek yang akan digunakan jika jenis pemangkasan adalah RECTANGLE_CUSTOM.

Misalnya, berikut adalah cara menerapkan rasio aspek 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

URL link untuk kembali ke add-on.

string

Judul link untuk kembali ke add-on.

Card

Kartu yang menampilkan informasi tentang link dari layanan pihak ketiga.

string

Judul yang ditampilkan di smart chip untuk pratinjau link. Jika tidak disetel, smart chip akan menampilkan header preview_card.

string

Judul yang ditampilkan di pratinjau link. Jika tidak disetel, pratinjau link akan menampilkan header preview_card.

string

Nama ikon yang ditentukan dalam Ikon Material Google, misalnya, check_box. Setiap nama yang tidak valid akan diabaikan dan diganti dengan string kosong dan menyebabkan ikon gagal dirender.

bool

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.

int32

Ketebalan goresan ikon. Pilih dari {100, 200, 300, 400, 500, 600, 700}. Jika tidak ada, nilai defaultnya adalah 400. Jika nilai lain ditentukan, nilai default akan digunakan.

Untuk melihat pratinjau setelan ikon yang berbeda, buka Ikon Google Font dan sesuaikan setelan di bagian Sesuaikan.

int32

Bobot dan gradasi memengaruhi ketebalan simbol. Penyesuaian gradasi lebih terperinci daripada penyesuaian bobot dan memiliki dampak kecil terhadap ukuran simbol. Pilih dari {-25, 0, 200}. Jika tidak ada, nilai defaultnya adalah 0. Jika nilai lain ditentukan, nilai default akan digunakan.

Untuk melihat pratinjau setelan ikon yang berbeda, buka Ikon Google Font dan sesuaikan setelan di bagian Sesuaikan.

bool

Tumpukan kartu memunculkan semua kartu kecuali kartu root.

bool

Tumpukan kartu memunculkan satu kartu.

string

Tumpukan kartu memunculkan semua kartu di atas kartu yang ditentukan dengan nama kartu tertentu.

Card

Tumpukan kartu mendorong kartu ke tumpukan kartu.

Card

Tumpukan kartu memperbarui kartu teratas dengan kartu baru dan mempertahankan nilai kolom formulir yang terisi. Untuk kolom yang tidak setara, nilai akan dihapus.

EndNavigation

Tindakan navigasi akhir alur dialog. Untuk mengetahui informasi selengkapnya, lihat Merespons dialog untuk pesan kartu layar utama aplikasi

Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

string

Teks biasa yang akan ditampilkan untuk notifikasi, tanpa tag HTML.

Action

Jika ditentukan, tindakan akan dipicu oleh onClick ini.

OpenLink

Jika ditentukan, onClick ini akan memicu tindakan link terbuka.

Action

Add-on memicu tindakan ini saat tindakan perlu membuka link. Hal ini berbeda dengan open_link di atas karena perlu berkomunikasi dengan server untuk mendapatkan link. Oleh karena itu, klien web perlu melakukan beberapa tugas persiapan sebelum respons tindakan link terbuka muncul kembali.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

Card

Kartu baru didorong ke tumpukan kartu setelah diklik jika ditentukan.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

string

URL yang akan dibuka.

OpenAs

Cara membuka link.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

OnClose

Apakah klien melupakan link setelah membukanya, atau mengamatinya hingga jendela ditutup.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

Action

HostAppActionMarkup

Tindakan yang ditangani oleh setiap aplikasi host.

string

Ini adalah kolom skema tanpa pengoperasian yang mungkin ada di markup untuk pemeriksaan sintaksis.

Navigation

Mendorong, memunculkan, atau memperbarui kartu yang ditampilkan.

OpenLink

Segera buka link target dalam tab baru atau jendela pop-up.

Notification

Tampilkan notifikasi kepada pengguna akhir.

LinkPreview

Menampilkan pratinjau link kepada pengguna akhir.

Link

Link untuk referensi pihak ketiga yang dibuat dari dalam aplikasi Google Workspace. Diformat sebagai array objek dengan satu item. Untuk informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @.

string

Nama yang mengidentifikasi input pemilihan dalam peristiwa input formulir.

Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.

string

Teks yang muncul di atas kolom input pilihan pada 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 "Urgensi" atau "Pilih urgensi".

SelectionType

Jenis item yang ditampilkan kepada pengguna di widget SelectionInput. Jenis pilihan mendukung berbagai jenis interaksi. Misalnya, pengguna dapat memilih satu atau beberapa kotak centang, tetapi mereka hanya dapat memilih satu nilai dari menu dropdown.

SelectionItem

Array item yang dapat dipilih. Misalnya, array tombol pilihan atau kotak centang. Mendukung hingga 100 item.

Action

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.

int32

Untuk menu multi-pilihan, jumlah maksimum item yang dapat dipilih pengguna. Nilai minimum adalah 1 item. Jika tidak ditentukan, setelan defaultnya adalah 3 item.

int32

Untuk menu multi-pilihan, jumlah karakter teks yang dimasukkan pengguna sebelum kueri aplikasi dilengkapi secara otomatis dan menampilkan item yang disarankan dalam menu.

Jika tidak ditentukan, ditetapkan default ke 0 karakter untuk sumber data statis dan 3 karakter untuk sumber data eksternal.

Action

Sumber data eksternal, seperti basis data relasional.

PlatformDataSource

Sumber data dari Google Workspace.

CommonDataSource

Sumber data yang digunakan bersama oleh semua aplikasi Google Workspace, seperti pengguna di organisasi Google Workspace.

HostAppDataSourceMarkup

Sumber data yang unik untuk aplikasi host Google Workspace, seperti ruang di Google Chat.

string

Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.

string

Nilai yang terkait dengan item ini. Klien harus menggunakan nilai ini sebagai nilai input formulir.

Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.

bool

Apakah item dipilih secara default. Jika input pilihan hanya menerima satu nilai (seperti untuk tombol pilihan atau menu dropdown), tetapkan kolom ini untuk satu item saja.

string

Untuk menu multi-pilihan, URL untuk ikon yang ditampilkan di samping kolom text item. Mendukung file PNG dan JPEG. Harus berupa URL HTTPS. Misalnya, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

string

Untuk menu multi-pilihan, deskripsi teks atau label yang ditampilkan di bawah kolom text item.

RenderActions

Satu set petunjuk render yang memberi tahu kartu untuk melakukan tindakan dan/atau memberi tahu aplikasi host add-on untuk melakukan tindakan khusus aplikasi.

bool

Apakah status kartu telah berubah dan data di kartu yang ada sudah tidak berlaku.

string

Ini adalah kolom skema tanpa pengoperasian yang mungkin ada di markup untuk pemeriksaan sintaksis.

SuggestionItem

Daftar saran yang digunakan untuk rekomendasi pelengkapan otomatis di kolom input teks.

string

Nilai input yang disarankan ke kolom input teks. Hal ini setara dengan apa yang dimasukkan sendiri oleh pengguna.

string

Nama yang digunakan untuk mengidentifikasi input teks dalam peristiwa input formulir.

Untuk mengetahui detail tentang cara menggunakan input formulir, lihat Menerima data formulir.

string

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 meminta nama seseorang, tetapi memerlukan nama belakangnya secara khusus, tulis surname, bukan name.

Wajib jika hintText tidak ditentukan. Jika tidak, bersifat opsional.

string

Teks yang muncul di bawah kolom input teks yang dimaksudkan untuk membantu pengguna dengan meminta mereka memasukkan nilai tertentu. Teks ini selalu terlihat.

Wajib jika label tidak ditentukan. Jika tidak, bersifat opsional.

string

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 kolomnya satu atau beberapa baris.

Action

Apa yang harus dilakukan saat perubahan terjadi di kolom input teks. Misalnya, pengguna yang menambahkan kolom atau menghapus teks.

Contoh tindakan yang dapat dilakukan antara lain menjalankan fungsi kustom atau membuka dialog di Google Chat.

Suggestions

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 difilter secara dinamis untuk mencocokkan dengan apa yang telah diketik pengguna.

Misalnya, kolom input teks untuk bahasa pemrograman mungkin menyarankan Java, JavaScript, Python, dan C++. Saat pengguna mulai mengetik Jav, daftar filter saran akan menampilkan Java dan JavaScript saja.

Nilai yang disarankan membantu memandu pengguna untuk memasukkan nilai yang dapat dipahami oleh aplikasi Anda. Saat merujuk ke JavaScript, sebagian pengguna mungkin memasukkan javascript dan yang lainnya java script. Menyarankan JavaScript dapat menstandarkan cara pengguna berinteraksi dengan aplikasi Anda.

Jika ditentukan, TextInput.type selalu SINGLE_LINE, meskipun ditetapkan ke MULTIPLE_LINE.

Tersedia untuk aplikasi Google Chat dan Add-on Google Workspace.

Action

Opsional. Tentukan tindakan yang akan diambil saat kolom input teks memberikan saran kepada pengguna yang berinteraksi dengannya.

Jika tidak ditentukan, saran akan ditetapkan oleh initialSuggestions dan diproses oleh klien.

Jika ditentukan, aplikasi akan mengambil tindakan yang ditentukan di sini, seperti menjalankan fungsi kustom.

Tersedia untuk Add-on Google Workspace dan tidak tersedia untuk aplikasi Google Chat.

string

Teks yang muncul di kolom input teks saat kolom kosong. Gunakan teks ini untuk meminta pengguna memasukkan nilai. Misalnya, Enter a number from 0 to 100.

Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

string

Teks yang ditampilkan di widget.

HorizontalAlignment

Menentukan apakah widget sejajar dengan kiri, kanan, atau tengah kolom.

TextParagraph

Menampilkan paragraf teks. Mendukung teks berformat HTML sederhana. Untuk mengetahui informasi selengkapnya tentang cara memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

Misalnya, JSON berikut membuat teks yang dicetak tebal:

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

Menampilkan gambar.

Misalnya, JSON berikut membuat gambar dengan teks alternatif:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

Menampilkan item teks yang didekorasi.

Misalnya, JSON berikut membuat widget teks berdekorasi yang menampilkan alamat email:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

Daftar tombol.

Misalnya, JSON berikut membuat dua tombol. Yang pertama adalah tombol teks berwarna biru dan yang kedua adalah tombol gambar yang membuka sebuah link:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
        "alpha": 1
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

Menampilkan kotak teks tempat pengguna dapat mengetik.

Misalnya, JSON berikut membuat input teks untuk alamat email:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Sebagai contoh lain, JSON berikut membuat input teks untuk bahasa pemrograman dengan saran statis:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

Menampilkan kontrol pemilihan 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:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

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:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

Menampilkan pemisah garis horizontal antar-widget.

Misalnya, JSON berikut membuat pemisah:

"divider": {
}

Grid

Menampilkan petak dengan koleksi item.

Petak mendukung berapa pun kolom dan item. Jumlah baris ditentukan oleh batas atas item jumlah dibagi dengan jumlah kolom. Petak dengan 10 item dan 2 kolom memiliki 5 baris. Petak 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"
    }
  }
}

Columns

Menampilkan hingga 2 kolom.

Untuk menyertakan lebih dari 2 kolom, atau menggunakan baris, gunakan widget Grid.

Misalnya, JSON berikut membuat 2 kolom yang masing-masing berisi paragraf teks:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}