Package google.apps.card.v1

Indeks

Action

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.

loadIndicator

LoadIndicator

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

persistValues

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 atas interaksi dengan pengguna, seperti pengguna mengklik tombol di pesan kartu.

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

Dengan menentukan interaction, aplikasi dapat merespons dengan cara interaktif khusus. Misalnya, dengan menyetel interaction ke OPEN_DIALOG, aplikasi dapat membuka dialog. Jika ditentukan, indikator pemuatan tidak akan ditampilkan. Jika ditentukan untuk add-on, seluruh kartu akan dihapus dan tidak ada yang ditampilkan di klien.

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

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 atas interaksi dengan pengguna, seperti pengguna mengklik tombol di pesan kartu.

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

Dengan menentukan interaction, aplikasi dapat merespons dengan cara interaktif khusus. Misalnya, dengan menyetel interaction ke OPEN_DIALOG, aplikasi dapat membuka dialog.

Jika ditentukan, indikator pemuatan tidak akan ditampilkan. Jika ditentukan untuk add-on, seluruh kartu akan dihapus dan tidak ada yang ditampilkan di klien.

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

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.

strokeColor

Color

Warna yang akan digunakan jika jenisnya adalah BORDER_TYPE_STROKE.

cornerRadius

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

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

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.

altText

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

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.

sectionDividerStyle

DividerStyle

Gaya pemisah antarbagian.

cardActions[]

CardAction

Tindakan kartu. Tindakan ditambahkan ke menu toolbar kartu.

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

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

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

string

Nama kartu. Digunakan sebagai ID kartu dalam navigasi kartu.

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

fixedFooter

CardFixedFooter

Footer tetap ditampilkan di bagian bawah kartu ini.

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

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

displayStyle

DisplayStyle

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

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

peekCardHeader

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
actionLabel

string

Label yang ditampilkan sebagai item menu tindakan.

onClick

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
primaryButton

Button

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

secondaryButton

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

subtitle

string

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

imageType

ImageType

Bentuk yang digunakan untuk memangkas gambar.

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

imageUrl

string

URL HTTPS gambar di header kartu.

imageAltText

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. Tampilkan pemisah yang solid di antara bagian.
NO_DIVIDER Jika ditetapkan, tidak ada pemisah yang akan dirender di antara bagian.

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.

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

Kolom

Widget Columns menampilkan hingga 2 kolom dalam kartu atau dialog. Anda dapat menambahkan widget ke setiap kolom; widget akan muncul sesuai urutan yang ditentukan. Untuk contoh aplikasi Google Chat, lihat Menampilkan kartu dan dialog di kolom.

Ketinggian setiap kolom ditentukan oleh kolom yang lebih tinggi. Misalnya, jika kolom pertama lebih tinggi daripada kolom kedua, kedua kolom memiliki tinggi kolom pertama. Karena setiap kolom dapat berisi jumlah widget yang berbeda, Anda tidak dapat menentukan baris atau meratakan widget di antara kolom.

Kolom ditampilkan secara berdampingan. Anda dapat menyesuaikan lebar setiap kolom menggunakan kolom HorizontalSizeStyle. Jika lebar layar pengguna terlalu sempit, kolom kedua akan digabungkan di bawah yang pertama:

  • Di web, kolom kedua akan digabungkan jika lebar layar kurang dari atau sama dengan 480 piksel.
  • Pada perangkat iOS, kolom kedua akan digabungkan jika lebar layar kurang dari atau sama dengan 300 pt.
  • Pada perangkat Android, kolom kedua akan digabungkan jika lebar layar kurang dari atau sama dengan 320 dp.

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

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

Kolom
columnItems[]

Column

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

Kolom

Kolom.

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

Kolom
horizontalSizeStyle

HorizontalSizeStyle

Menentukan cara kolom mengisi lebar kartu.

horizontalAlignment

HorizontalAlignment

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

verticalAlignment

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.

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

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.

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

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.

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

Kolom

Kolom union data.

data hanya dapat berupa salah satu dari yang berikut:

textParagraph

TextParagraph

Widget TextParagraph.

image

Image

Widget Image.

decoratedText

DecoratedText

Widget DecoratedText.

buttonList

ButtonList

Widget ButtonList.

textInput

TextInput

Widget TextInput.

selectionInput

SelectionInput

Widget SelectionInput.

dateTimePicker

DateTimePicker

Widget DateTimePicker.

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.

valueMsEpoch

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

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.

onChangeAction

Action

Dipicu saat pengguna mengklik Simpan atau Hapus dari antarmuka DateTimePicker.

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.

startIcon

Icon

Ikon yang ditampilkan di depan teks.

topLabel

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.

wrapText

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.

bottomLabel

string

Teks yang muncul di bawah text. Selalu dikemas.

onClick

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.

switchControl

SwitchControl

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

endIcon

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.

onChangeAction

Action

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

controlType

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

EndNavigation

Tindakan alur dialog.

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

Kolom
action

Action

Tindakan render bagi klien untuk mengakhiri alur dialog.

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

Action

Jenis tindakan render yang dapat digunakan klien untuk mengakhiri alur dialog.

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

Enum
ACTION_UNSPECIFIED Tindakan belum ditetapkan.
CLOSE_DIALOG Tutup alur dialog.
CLOSE_DIALOG_AND_EXECUTE Tutup alur dialog dan muat ulang kartu yang membuka alur dialog.

GetAutocompletionResponse

Respons untuk mendapatkan penampung pelengkapan otomatis, yang mencakup elemen yang diperlukan untuk menampilkan item pelengkapan otomatis untuk kolom teks.

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

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
Kolom
autoComplete

Suggestions

schema

string

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

Petak

Menampilkan petak dengan kumpulan item. Item hanya boleh menyertakan teks atau gambar. Untuk kolom responsif, atau untuk menyertakan lebih dari sekadar teks atau gambar, gunakan 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.

borderStyle

BorderStyle

Gaya batas yang akan diterapkan ke setiap item petak.

columnCount

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

onClick

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
altText

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.

imageType

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 ada berupa salah satu diantara berikut:
knownIcon

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.

iconUrl

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

MaterialIcon

Menampilkan salah satu Ikon Material Google.

Misalnya, untuk menampilkan ikon kotak centang, gunakan

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

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

Gambar

Gambar yang ditentukan oleh URL dan dapat memiliki tindakan onClick. Untuk contoh, lihat Menambahkan gambar.

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

Kolom
imageUrl

string

URL HTTPS yang menghosting gambar.

Contoh:

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

OnClick

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

altText

string

Teks alternatif dari gambar ini yang digunakan untuk aksesibilitas.

ImageComponent

Menampilkan gambar.

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

Kolom
imageUri

string

URL gambar.

altText

string

Label aksesibilitas untuk gambar.

cropStyle

ImageCropStyle

Gaya pemangkasan yang akan diterapkan ke gambar.

borderStyle

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.

aspectRatio

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.

LinkPreview

Tindakan kartu yang melihat pratinjau link pihak ketiga dengan menampilkan kartu dan smart chip. Untuk mempelajari lebih lanjut, lihat Melihat pratinjau link dengan smart chip.

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

Misalnya, JSON berikut menampilkan judul unik untuk pratinjau link dan smart chip-nya, serta kartu pratinjau dengan header dan deskripsi teks:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

Contoh ini menampilkan pratinjau link berikut:

Contoh pratinjau link

Kolom
previewCard

Card

Kartu yang menampilkan informasi tentang link dari layanan pihak ketiga.

title

string

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

linkPreviewTitle

string

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

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.

Tindakan kartu yang memanipulasi tumpukan kartu.

Contoh:

1) Tambahkan kartu baru ke tumpukan (navigasi ke depan). Untuk aplikasi Chat, hanya tersedia untuk beranda aplikasi.

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

 navigations : {
    pushCard : CARD
  }

2) Perbarui kartu di atas tumpukan (pembaruan kartu).

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

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Kembali satu langkah ke belakang tanpa memperbarui.

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

  navigations : {
    popCard : true,
  }

4) Kembali beberapa langkah dan perbarui kartu tersebut.

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

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Kembali beberapa langkah ke CARD_NAME yang ditentukan.

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

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Kembali ke root dan perbarui kartu itu.

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

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Buka kartu yang ditentukan dan lepaskan kartu itu juga.

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

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Ganti kartu teratas dengan kartu yang baru. Untuk aplikasi Chat, hanya tersedia untuk beranda aplikasi.

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

  navigations : {
    updateCard : CARD
  }
Kolom

Kolom union navigate_action.

navigate_action hanya dapat berupa salah satu dari yang berikut:

popToRoot

bool

Tumpukan kartu menghilangkan semua kartu kecuali kartu root.

pop

bool

Tumpukan kartu memunculkan satu kartu.

popToCard

string

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

pushCard

Card

Tumpukan kartu mendorong kartu ke tumpukan kartu.

updateCard

Card

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

endNavigation

EndNavigation

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

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

Notifikasi

Tindakan kartu yang menampilkan notifikasi di aplikasi host.

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

Kolom
text

string

Teks biasa yang ditampilkan untuk notifikasi, tanpa tag HTML.

OnClick

Merepresentasikan cara merespons saat pengguna mengklik elemen interaktif pada kartu, seperti tombol.

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

Kolom

Kolom union data.

data hanya dapat berupa salah satu dari yang berikut:

action

Action

Jika ditentukan, tindakan akan dipicu oleh onClick ini.

openDynamicLinkAction

Action

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

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

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.

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 ada yang terjadi.
RELOAD

Memuat ulang kartu setelah jendela turunan ditutup.

Jika digunakan bersama dengan OpenAs.OVERLAY, jendela turunan akan 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.

RenderActions

Serangkaian petunjuk render yang memberi tahu kartu untuk melakukan tindakan, atau memberi tahu aplikasi host add-on atau aplikasi Chat untuk melakukan tindakan khusus aplikasi.

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

Kolom
action

Action

hostAppAction

HostAppActionMarkup

Tindakan yang ditangani oleh setiap aplikasi host.

schema

string

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

Action

Kolom
navigations[]

Navigation

Mengirim, memunculkan, atau memperbarui kartu yang ditampilkan.

notification

Notification

Tampilkan notifikasi kepada pengguna akhir.

linkPreview

LinkPreview

Tampilkan pratinjau link kepada pengguna akhir.

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

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.

Tetapkan teks yang membantu pengguna memasukkan informasi yang dibutuhkan aplikasi Anda. Misalnya, jika pengguna memilih urgensi tiket kerja dari menu drop-down, labelnya mungkin "Urgensi" atau "Pilih urgensi".

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.

onChangeAction

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.

multiSelectMaxSelectedItems

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.

multiSelectMinQueryLength

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.

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 ada berupa salah satu diantara berikut:

externalDataSource

Action

Sumber data eksternal, seperti basis data relasional.

platformDataSource

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 ada berupa salah satu diantara berikut:
commonDataSource

CommonDataSource

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

hostAppDataSource

HostAppDataSourceMarkup

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

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.

startIconUri

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.

bottomText

string

Untuk menu 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. Opsi multi-pilihan untuk Add-on Google Workspace sedang dalam Pratinjau Developer.

SubmitFormResponse

Respons terhadap pengiriman formulir selain mendapatkan penampung pelengkapan otomatis, yang berisi tindakan yang harus dilakukan kartu dan/atau yang harus dilakukan aplikasi host add-on, dan apakah status kartu telah berubah.

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

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
Kolom
renderActions

RenderActions

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

stateChanged

bool

Apakah status kartu telah berubah dan data dalam kartu yang ada sudah usang.

schema

string

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

Saran

Nilai yang disarankan yang dapat dimasukkan pengguna. Nilai ini muncul saat pengguna mengklik di dalam kolom input teks. Saat pengguna mengetik, nilai yang disarankan akan memfilter secara dinamis agar sesuai dengan yang diketik pengguna.

Misalnya, kolom input teks untuk bahasa pemrograman dapat menyarankan Java, JavaScript, Python, dan C++. Saat 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.

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

hintText

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.

onChangeAction

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.

initialSuggestions

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 mungkin menyarankan Java, JavaScript, Python, dan C++. Saat 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.

autoCompleteAction

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.

placeholderText

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.

Widget

Setiap kartu terdiri dari widget.

Widget adalah objek gabungan yang dapat merepresentasikan salah satu dari teks, gambar, tombol, dan jenis objek lainnya.

Kolom
horizontalAlignment

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 ada berupa salah satu diantara berikut:
textParagraph

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

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

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

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

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

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

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