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 panggilan ke tindakan.

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 melakukan 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 tersebut.

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

Interaction

Opsional. Wajib saat membuka dialog.

Tindakan yang harus dilakukan sebagai respons terhadap interaksi dengan pengguna, seperti pengguna mengklik tombol dalam pesan kartu.

Jika tidak ditentukan, aplikasi akan merespons dengan menjalankan action—seperti membuka link atau menjalankan fungsi—seperti biasa.

Dengan menentukan interaction, aplikasi dapat merespons dengan cara interaktif khusus. Misalnya, dengan menetapkan 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

Jika widget yang tercantum di sini tidak memiliki nilai saat Tindakan ini dipanggil, pengiriman formulir akan dibatalkan.

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

bool

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

string

Nama parameter untuk skrip tindakan.

string

Nilai parameter.

BorderType

Jenis batas.

Color

Warna yang akan digunakan jika jenisnya adalah BORDER_TYPE_STROKE.

Untuk menetapkan warna goresan, tentukan nilai untuk kolom red, green, dan blue. Nilainya harus berupa angka float antara 0 dan 1 berdasarkan nilai warna RGB, dengan 0 (0/255) mewakili tidak adanya warna dan 1 (255/255) mewakili intensitas maksimum warna.

Misalnya, kode berikut menetapkan warna ke merah pada intensitas maksimumnya:

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

Kolom alpha tidak tersedia untuk warna goresan. Jika ditentukan, kolom ini akan diabaikan.

int32

Radius sudut untuk batas.

string

Teks yang ditampilkan di dalam tombol.

Icon

Ikon yang ditampilkan di dalam tombol. Jika icon dan text disetel, ikon akan muncul sebelum teks.

Color

Opsional. Warna tombol. Jika ditetapkan, tombol type akan ditetapkan ke FILLED dan warna kolom text serta icon ditetapkan ke warna yang kontras agar mudah dibaca. Misalnya, jika warna tombol ditetapkan ke biru, teks atau ikon apa pun di tombol akan ditetapkan ke putih.

Untuk menetapkan warna tombol, tentukan nilai untuk kolom red, green, dan blue. Nilainya harus berupa angka float antara 0 dan 1 berdasarkan nilai warna RGB, dengan 0 (0/255) mewakili tidak adanya warna dan 1 (255/255) mewakili intensitas maksimum warna.

Misalnya, kode berikut menetapkan warna ke merah pada intensitas maksimumnya:

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

Kolom alpha tidak tersedia untuk warna tombol. Jika ditentukan, kolom ini akan diabaikan.

OnClick

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

bool

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

string

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 OUTLINED. Jika kolom color ditetapkan, jenis tombol akan dipaksa ke FILLED dan nilai apa pun yang ditetapkan untuk kolom ini akan diabaikan.

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

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 {i>header<i} opsional masing-masing. Bagian dipisahkan secara visual oleh pemisah garis. Untuk contoh di aplikasi Google Chat, lihat Menentukan bagian kartu.

DividerStyle

Gaya pemisah antara header, bagian, dan footer.

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:

"card_actions": [
  {
    "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 di dialog, tetapi tidak di pesan kartu.

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

DisplayStyle

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

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

CardHeader

Saat menampilkan konten kontekstual, header kartu sekilas berfungsi sebagai placeholder sehingga pengguna dapat beralih 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 harus berupa tombol teks dengan teks dan warna yang disetel.

Button

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

string

Wajib. Judul header kartu. {i>Header<i} memiliki tinggi tetap: jika judul dan subjudul ditentukan, masing-masing membutuhkan satu baris. Jika hanya judul yang ditentukan, judul akan menempati 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. 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.

Widget

Semua widget di bagian. Harus berisi minimal 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 tersembunyi 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 sebuah bagian berisi lima widget dan uncollapsibleWidgetsCount ditetapkan ke 2, dua widget pertama selalu ditampilkan dan tiga widget terakhir secara default akan diciutkan. uncollapsibleWidgetsCount hanya diperhitungkan jika collapsible adalah true.

CollapseControl

Opsional. Tentukan tombol luaskan dan ciutkan bagian. Tombol ini hanya akan ditampilkan jika bagian dapat diciutkan. Jika kolom ini tidak ditetapkan, tombol default akan digunakan. Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

Icon

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

string

Teks yang ditampilkan di dalam chip.

OnClick

Opsional. Tindakan yang akan dilakukan saat pengguna mengklik chip, seperti membuka hyperlink atau menjalankan fungsi kustom.

bool

Apakah chip dalam status aktif dan merespons tindakan pengguna. Default-nya adalah true. Tidak digunakan lagi. Sebagai gantinya, gunakan disabled.

bool

Apakah chip dalam status tidak aktif dan mengabaikan tindakan pengguna. Default-nya adalah false.

string

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".

Layout

Tata letak daftar chip yang ditentukan.

Chip

Array chip.

HorizontalAlignment

Perataan horizontal tombol luaskan dan ciutkan.

Button

Opsional. Tentukan tombol yang dapat disesuaikan untuk meluaskan bagian tersebut. Kolom expand_button dan collapse_button harus ditetapkan. Hanya satu kumpulan kolom yang tidak akan diterapkan. Jika kolom ini tidak ditetapkan, tombol default akan digunakan.

Button

Opsional. Tentukan tombol yang dapat disesuaikan untuk menciutkan bagian. Kolom expand_button dan collapse_button harus ditetapkan. Hanya satu kumpulan kolom yang tidak akan diterapkan. Jika kolom ini tidak ditetapkan, tombol default akan digunakan.

Column

Array kolom. Anda dapat menyertakan hingga 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.

ChipList

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

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 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 input 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 mewakili 1 Januari 2023 pukul 24.00 UTC, gunakan 1672574400000.
• DATE_ONLY: tanggal kalender pada pukul 00:00:00 UTC. Misalnya, untuk mewakili 1 Januari 2023, gunakan 1672531200000.
• TIME_ONLY: waktu dalam UTC. Misalnya, untuk mewakili pukul 12.00, gunakan 43200000 (atau 12 * 60 * 60 * 1000).

int32

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

Action

Dipicu saat pengguna mengklik Simpan atau Hapus dari antarmuka DateTimePicker.

Validation

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

Icon

Tidak digunakan lagi dan diganti 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 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 digabungkan.

OnClick

Tindakan ini dipicu saat pengguna mengklik topLabel atau bottomLabel.

Button

Tombol yang dapat diklik pengguna untuk memicu tindakan.

SwitchControl

Widget tombol 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 untuk mengidentifikasi widget tombol 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

Jika true, tombol akan dipilih.

Action

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

ControlType

Cara tombol muncul di antarmuka pengguna.

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

string

Teks yang ditampilkan di header grid.

GridItem

Item yang akan ditampilkan dalam petak.

BorderStyle

Gaya batas yang akan diterapkan ke setiap item petak.

int32

Jumlah kolom yang akan ditampilkan dalam petak. Nilai default digunakan jika kolom ini tidak ditentukan, dan nilai default tersebut berbeda-beda 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 dalam 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 bermanfaat untuk apa yang ditampilkan ikon, dan jika ada, fungsinya. 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 di 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 pemangkasan yang diterapkan ke gambar. Dalam beberapa kasus, menerapkan pemangkasan CIRCLE menyebabkan gambar digambar lebih besar dari 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

Menampilkan salah satu Ikon Material Google.

Misalnya, untuk menampilkan ikon kotak centang, gunakan

"material_icon": {
  "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 pemangkasan yang akan diterapkan ke gambar.

BorderStyle

Gaya batas yang akan diterapkan ke gambar.

ImageCropType

Jenis pemangkasan.

double

Rasio aspek yang akan digunakan jika jenis pemangkasan adalah RECTANGLE_CUSTOM.

Misalnya, berikut cara menerapkan rasio aspek 16:9:

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

string

Nama ikon yang ditentukan di Ikon Google Material, misalnya, check_box. Nama yang tidak valid akan dihapus dan diganti dengan string kosong, sehingga ikon gagal dirender.

bool

Apakah ikon dirender sebagai terisi. Nilai defaultnya adalah false (salah).

Untuk melihat pratinjau setelan ikon yang berbeda, buka Ikon Font Google 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 Font Google dan sesuaikan setelan di bagian Sesuaikan.

int32

Bobot dan gradasi memengaruhi ketebalan simbol. Penyesuaian pada gradasi lebih terperinci daripada penyesuaian pada ketebalan dan memiliki dampak kecil pada 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 Font Google dan sesuaikan setelan di bagian Sesuaikan.

Action

Jika ditentukan, tindakan akan dipicu oleh onClick ini.

OpenLink

Jika ditentukan, onClick ini akan memicu tindakan buka link.

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, beberapa pekerjaan persiapan diperlukan untuk dilakukan klien web sebelum respons tindakan link terbuka ditampilkan.

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

Card

Kartu baru akan didorong ke tumpukan kartu setelah diklik jika ditentukan.

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

OverflowMenu

Jika ditentukan, onClick ini akan membuka menu tambahan. Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

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 lupa tentang link setelah membukanya, atau mengamatinya hingga jendela ditutup.

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

OverflowMenuItem

Wajib. Daftar opsi menu.

Icon

Ikon yang ditampilkan di depan teks.

string

Wajib. Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.

OnClick

Wajib. Tindakan yang dipanggil saat opsi menu dipilih. OnClick ini tidak boleh berisi OverflowMenu, OverflowMenu yang ditentukan akan dihapus dan item menu dinonaktifkan.

bool

Apakah opsi menu dinonaktifkan. Nilai defaultnya adalah false (salah).

string

Wajib. Nama yang mengidentifikasi input pilihan 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 di antarmuka pengguna.

Tentukan teks yang membantu pengguna memasukkan informasi yang diperlukan 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 multipilih, 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 menu menampilkan item pilihan yang disarankan.

Jika tidak ditetapkan, menu multipilih akan menggunakan nilai default berikut:

• Jika menu menggunakan array statis item SelectionInput, defaultnya adalah 0 karakter dan langsung mengisi item dari array.
• Jika menu menggunakan sumber data dinamis (multi_select_data_source), defaultnya adalah 3 karakter sebelum membuat kueri sumber data untuk menampilkan item yang disarankan.

Validation

Untuk menu dropdown, validasi untuk kolom input pilihan ini.

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

Action

Sumber data eksternal, seperti database relasional.

PlatformDataSource

Sumber data dari Google Workspace.

CommonDataSource

Sumber data yang dibagikan 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.

Kolom ini mendukung Library Klien Google API, tetapi tidak tersedia di Library Klien Cloud. Untuk mempelajari lebih lanjut, lihat Menginstal library klien.

string

Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.

string

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.

bool

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

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 multipilih, deskripsi teks atau label yang ditampilkan di bawah kolom text item.

SuggestionItem

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

string

Nilai input yang disarankan ke kolom input teks. Ini setara dengan yang dimasukkan pengguna sendiri.

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 diperlukan aplikasi Anda. Misalnya, jika Anda menanyakan nama seseorang, tetapi secara khusus memerlukan nama belakangnya, 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 kolom tersebut satu atau beberapa baris.

Action

Tindakan yang harus dilakukan saat terjadi perubahan dalam kolom input teks. Misalnya, pengguna yang menambahkan ke kolom atau menghapus teks.

Contoh tindakan yang harus dilakukan mencakup 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 agar cocok dengan yang telah diketik pengguna.

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

Nilai yang disarankan membantu memandu pengguna memasukkan nilai yang dapat dipahami aplikasi Anda. Saat merujuk ke JavaScript, beberapa 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 melakukan tindakan yang ditentukan di sini, seperti menjalankan fungsi kustom.

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

Validation

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

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.

int32

Jumlah maksimum baris teks yang ditampilkan di widget. Jika teks melebihi jumlah maksimum baris yang ditentukan, konten berlebih akan disembunyikan di balik tombol tampilkan lainnya. Jika teks sama dengan atau lebih pendek dari jumlah maksimum baris yang ditentukan, tombol lihat lainnya tidak akan ditampilkan.

Nilai defaultnya adalah 0, yang dalam hal ini semua konteks ditampilkan. Nilai negatif akan diabaikan. Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

Menampilkan paragraf teks. Mendukung teks berformat HTML sederhana. Untuk 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 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 yang dihias 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 biru dan yang kedua adalah tombol gambar yang membuka link:

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

TextInput

Menampilkan kotak teks yang dapat diketik oleh pengguna.

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 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:

"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 pembagi garis horizontal di antara widget.

Misalnya, JSON berikut membuat pemisah:

"divider": {
}

Grid

Menampilkan petak dengan koleksi item.

{i>Grid<i} mendukung sejumlah kolom dan item. Jumlah baris ditentukan oleh batas atas jumlah item dibagi dengan jumlah kolom. Grid 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 untuk 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"
          }
        }
      ]
    }
  ]
}

ChipList

Daftar chip.

Misalnya, JSON berikut membuat dua chip. Yang pertama adalah chip teks dan yang kedua adalah chip ikon yang membuka link:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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