Package google.apps.card.v1

Indeks

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

string

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

Untuk contoh penggunaan, lihat Membaca data formulir.
parameters[]

ActionParameter

Daftar parameter tindakan.
load_indicator

LoadIndicator

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

bool

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

Jika true, nilai formulir 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

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 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.
required_widgets[]

string

Opsional. Isi daftar ini dengan nama widget yang diperlukan Action ini untuk pengiriman yang valid.

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

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

bool

Opsional. Jika ini benar, semua widget dianggap diperlukan oleh tindakan ini.

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

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

string

Nama parameter untuk skrip tindakan.
value

string

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.

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

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

BorderType

Jenis batas.
stroke_color

Color

Warna yang akan digunakan jika jenisnya adalah BORDER_TYPE_STROKE.
corner_radius

int32

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 Image (bukan ImageComponent) dan setel tindakan onClick.

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

Kolom
text

string

Teks yang ditampilkan di dalam tombol.
icon

Icon

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

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, menyetel latar belakang biru kemungkinan akan menghasilkan teks putih.

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

Untuk merah, hijau, dan biru, nilai setiap kolom adalah angka float yang dapat Anda ekspresikan dengan salah satu dari dua cara berikut: sebagai angka antara 0 dan 255 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 itu pada skala RGB.

Secara opsional, 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 setengah warna merah transparan:

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

OnClick

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

bool

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

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&quot;.
type

Type

Menentukan jenis tombol.

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

Jenis

Jenis tombol.

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[]

Button

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 Builder

Untuk mempelajari cara membuat kartu, lihat dokumentasi berikut:

Contoh: Pesan kartu untuk aplikasi Google Chat

Contoh kartu kontak

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

CardHeader

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

Section

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

DividerStyle

Gaya pemisah antarbagian.
card_actions[]

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"
      }
    }
  }
]
name

string

Nama kartu. Digunakan sebagai ID kartu dalam navigasi kartu.

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

DisplayStyle

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

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

CardHeader

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

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

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
action_label

string

Label yang ditampilkan sebagai item menu tindakan.
on_click

OnClick

Tindakan onClick untuk item tindakan ini.

CardFixedFooter

Footer (melekat) yang muncul di bagian bawah kartu.

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. Untuk contoh di aplikasi Google Chat, lihat Menambahkan footer persisten.

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

Kolom
primary_button

Button

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

Button

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

CardHeader

Mewakili header kartu. Untuk contoh aplikasi Google Chat, lihat Menambahkan header.

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

Kolom
title

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, kode tersebut akan menggunakan kedua baris.
subtitle

string

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

ImageType

Bentuk yang digunakan untuk memangkas gambar.

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

string

URL HTTPS gambar di header kartu.
image_alt_text

string

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

string

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[]

Widget

Semua widget di bagian tersebut. Harus berisi minimal satu widget.
collapsible

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 lagi widget dengan mengklik Tampilkan lebih sedikit.

Untuk menentukan widget mana yang disembunyikan, tentukan uncollapsibleWidgetsCount.
uncollapsible_widgets_count

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 akan diciutkan secara default. uncollapsibleWidgetsCount hanya diperhitungkan jika collapsible adalah true.
collapse_control

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. Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

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

Icon

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

string

Teks yang ditampilkan di dalam chip.
on_click

OnClick

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

bool

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

bool

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

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&quot;.

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

Layout

Tata letak daftar chip yang ditentukan.
chips[]

Chip

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
horizontal_alignment

HorizontalAlignment

Perataan horizontal tombol luaskan dan ciutkan.
expand_button

Button

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

Button

Opsional. Tentukan tombol yang dapat disesuaikan untuk menciutkan bagian. Kolom perluas_button dan ciutkan_button 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
column_items[]

Column

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

Kolom

Kolom.

Add-on Google Workspace dan aplikasi Chat

Kolom
horizontal_size_style

HorizontalSizeStyle

Menentukan cara kolom mengisi lebar kartu.
horizontal_alignment

HorizontalAlignment

Menentukan apakah widget diratakan ke kiri, kanan, atau tengah kolom.
vertical_alignment

VerticalAlignment

Menentukan apakah widget diratakan dengan bagian atas, bawah, atau tengah kolom.
widgets[]

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.

Add-on Google Workspace dan aplikasi Chat

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.

Add-on Google Workspace dan aplikasi Chat

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.

Add-on Google Workspace dan aplikasi Chat

Kolom

Kolom union data.

data hanya dapat berupa salah satu dari yang berikut:
text_paragraph

TextParagraph

Widget TextParagraph.
image

Image

Widget Image.
decorated_text

DecoratedText

Widget DecoratedText.
button_list

ButtonList

Widget ButtonList.
text_input

TextInput

Widget TextInput.
selection_input

SelectionInput

Widget SelectionInput.
date_time_picker

DateTimePicker

Widget DateTimePicker.
chip_list

ChipList

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

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

string

Nama yang digunakan untuk mengidentifikasi DateTimePicker dalam peristiwa input formulir.

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

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

DateTimePickerType

Apakah widget mendukung memasukkan tanggal, waktu, atau tanggal dan waktu.
value_ms_epoch

int64

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

Tentukan nilai berdasarkan jenis alat pilih (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 12.00, gunakan 43200000 (atau 12 * 60 * 60 * 1000).
timezone_offset_date

int32

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

Action

Dipicu saat pengguna mengklik Simpan atau Hapus dari antarmuka DateTimePicker.
validation

Validation

Opsional. Tentukan validasi yang diperlukan untuk pemilih datetime ini.

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

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
(deprecated)

Icon

Tidak digunakan lagi dan digantikan dengan startIcon.
start_icon

Icon

Ikon yang ditampilkan di depan teks.
top_label

string

Teks yang muncul di atas text. Selalu potong.
text

string

Wajib. 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.
wrap_text

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

string

Teks yang muncul di bawah text. Selalu dikemas.
on_click

OnClick

Tindakan ini dipicu saat pengguna mengklik topLabel atau bottomLabel.
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

Button

Tombol yang dapat diklik pengguna untuk memicu tindakan.
switch_control

SwitchControl

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

Icon

Ikon yang ditampilkan setelah teks.

Mendukung ikon bawaan dan khusus.

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

string

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

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

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

bool

Saat true, tombol akan dipilih.
on_change_action

Action

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

ControlType

Cara tombol muncul di antarmuka pengguna.

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

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": {}

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 Columns. Untuk contoh aplikasi Google Chat, lihat Menampilkan Petak dengan kumpulan item.

{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

string

Teks yang ditampilkan di header grid.
items[]

GridItem

Item yang akan ditampilkan dalam petak.
border_style

BorderStyle

Gaya batas yang akan diterapkan ke setiap item petak.
column_count

int32

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).
on_click

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

string

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

ImageComponent

Gambar yang ditampilkan dalam item petak.
title

string

Judul item petak.
subtitle

string

Subtitel item petak.
layout

GridItemLayout

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
alt_text

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 memungkinkan, 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 tersebut. Namun, jika tombol tersebut juga menetapkan text, altText ikon akan diabaikan.
image_type

ImageType

Gaya pemangkasan yang diterapkan ke gambar. Dalam beberapa kasus, menerapkan pemangkasan CIRCLE akan menyebabkan gambar digambar lebih besar daripada ikon bawaan.
Kolom union icons. Ikon yang ditampilkan di widget pada kartu. icons hanya dapat berupa salah satu dari berikut:
known_icon

string

Menampilkan salah satu ikon bawaan yang disediakan oleh Google Workspace.

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

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

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

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.

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
image_url

string

URL HTTPS yang menghosting gambar.

Contoh:

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

OnClick

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

string

Teks alternatif dari gambar ini yang digunakan untuk aksesibilitas.

ImageComponent

Menampilkan gambar.

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

Kolom
image_uri

string

URL gambar.
alt_text

string

Label aksesibilitas untuk gambar.
crop_style

ImageCropStyle

Gaya pemangkasan yang akan diterapkan ke gambar.
border_style

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

ImageCropType

Jenis pemangkasan.
aspect_ratio

double

Rasio aspek yang digunakan jika jenis pemangkasan adalah RECTANGLE_CUSTOM.

Misalnya, berikut cara menerapkan rasio aspek 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 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.

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

string

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

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

int32

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

int32

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.

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

data hanya dapat berupa salah satu dari yang berikut:
action

Action

Jika ditentukan, tindakan akan dipicu oleh onClick ini.
card

Card

Kartu baru didorong ke tumpukan kartu setelah diklik jika ditentukan.

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

OverflowMenu

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

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.OVERLAY, jendela turunan berfungsi sebagai dialog modal dan kartu induk diblokir hingga jendela turunan ditutup.

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[]

OverflowMenuItem

Wajib. Daftar opsi menu.

OverflowMenuItem

Opsi yang dapat dipanggil pengguna dalam menu tambahan.

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

Kolom
start_icon

Icon

Ikon yang ditampilkan di depan teks.
text

string

Wajib. Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.
on_click

OnClick

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

bool

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

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

string

Wajib. Nama yang mengidentifikasi input pilihan dalam peristiwa input formulir.

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

string

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

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.
items[]

SelectionItem

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

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

int32

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

int32

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

Validation

Untuk menu dropdown, validasi untuk kolom input pilihan ini.

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

Kolom union multi_select_data_source. Untuk menu multi-pilihan, sumber data yang mengisi item pilihan.

Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace. multi_select_data_source hanya dapat berupa salah satu dari berikut:
external_data_source

Action

Sumber data eksternal, seperti basis data relasional.
platform_data_source

PlatformDataSource

Sumber data dari Google Workspace.

PlatformDataSource

Untuk widget SelectionInput yang menggunakan menu multi-pilihan, sumber data dari Google Workspace. Digunakan untuk mengisi item dalam menu multi-pilihan.

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

CommonDataSource

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

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.

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

string

Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.
value

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

bool

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

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

string

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

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:

  • Data statis: Item ditentukan sebagai objek SelectionItem dalam widget. Hingga 100 item.
  • Data Google Workspace: Item diisi menggunakan data dari Google Workspace, seperti pengguna Google Workspace atau ruang Google Chat.
  • Data eksternal: Item diisi dari sumber data eksternal di luar Google Workspace.

Untuk contoh cara menerapkan menu multi-pilihan, lihat Menambahkan menu multi-pilihan.

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

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[]

SuggestionItem

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

content hanya dapat berupa salah satu dari yang berikut:
text

string

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

string

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

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

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

Wajib ada jika hintText tidak ditentukan. Jika tidak, opsional.
hint_text

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 ada jika label tidak ditentukan. Jika tidak, opsional.
value

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

Type

Cara kolom input teks muncul di antarmuka pengguna. Misalnya, apakah kolom satu atau beberapa baris.
on_change_action

Action

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

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

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

Action

Opsional. Menentukan 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.
validation

Validation

Tentukan validasi yang diperlukan untuk kolom input teks ini.

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

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.

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

string

Teks yang ditampilkan di widget.
max_lines

int32

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. Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk Add-on Google Workspace.

Validasi

Mewakili data yang diperlukan untuk memvalidasi widget yang dilampirkan.

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

Kolom
character_limit

int32

Tentukan batas karakter untuk widget input teks. Perhatikan bahwa ini hanya digunakan untuk input teks dan diabaikan untuk widget lainnya.

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

InputType

Tentukan jenis widget input.

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

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
horizontal_alignment

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

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:

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

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"
}
decorated_text

DecoratedText

Menampilkan item teks dengan dekorasi.

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"
  }
}
button_list

ButtonList

Daftar tombol.

Misalnya, JSON berikut membuat dua tombol. Yang pertama adalah tombol teks biru dan yang kedua adalah tombol gambar untuk membuka 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"
        }
      }
    }
  ]
}
text_input

TextInput

Menampilkan kotak teks tempat pengguna dapat mengetik.

Misalnya, JSON berikut membuat input teks untuk alamat email:

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

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"
      }
    ]
  }
}
selection_input

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
    }
  ]
}
date_time_picker

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

Divider

Menampilkan pemisah garis horizontal di antara widget.

Misalnya, JSON berikut membuat pemisah:

"divider": {
}
grid

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.

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

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"
          }
        }
      ]
    }
  ]
}
chip_list

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.

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.