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.

Representasi JSON 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Kolom
function

string

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

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

object (ActionParameter)

Daftar parameter tindakan.
loadIndicator

enum (LoadIndicator)

Menentukan indikator pemuatan yang ditampilkan tindakan saat melakukan panggilan ke tindakan.
persistValues

boolean

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

Jika true, nilai formulir akan tetap ada setelah tindakan dipicu. Untuk mengizinkan pengguna melakukan perubahan saat tindakan sedang diproses, tetapkan LoadIndicator ke NONE. Untuk pesan kartu di aplikasi Chat, Anda juga harus menetapkan ResponseType tindakan ke UPDATE_MESSAGE dan menggunakan cardId 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

enum (Interaction)

Opsional. Diperlukan saat membuka dialog.

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

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

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

Tersedia untuk aplikasi Google Chat dan tidak tersedia untuk add-on Google Workspace.
requiredWidgets[]

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

boolean

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

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

ActionParameter

Daftar parameter string yang akan diberikan saat metode tindakan dipanggil. Misalnya, pertimbangkan tiga tombol tunda: tunda sekarang, tunda satu hari, atau tunda minggu depan. Anda dapat menggunakan action method = snooze(), dengan meneruskan jenis snooze dan waktu snooze dalam daftar parameter string.

Untuk mempelajari lebih lanjut, lihat CommonEventObject.

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

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string

Nama parameter untuk skrip tindakan.
value

string

Nilai parameter.

LoadIndicator

Menentukan indikator pemuatan yang ditampilkan tindakan saat melakukan panggilan ke tindakan.

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.

Interaksi

Opsional. Diperlukan saat membuka dialog.

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

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

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

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

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

Enum
INTERACTION_UNSPECIFIED Nilai default. action dijalankan seperti biasa.
OPEN_DIALOG

Membuka dialog, antarmuka berbasis kartu 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.