Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

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

object (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.

enum (DividerStyle)

Gaya pemisah antarbagian.

object (CardAction)

Tindakan kartu. Tindakan ditambahkan ke menu toolbar kartu.

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

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

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

string

Nama kartu. Digunakan sebagai ID kartu dalam navigasi kartu.

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

object (CardFixedFooter)

Footer tetap ditampilkan di bagian bawah kartu ini.

Latar (Setting) fixedFooter tanpa menentukan primaryButton atau secondaryButton yang menyebabkan error. Untuk aplikasi Chat, Anda dapat menggunakan footer tetap di dialog, tetapi jangan pesan kartu.

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

enum (DisplayStyle)

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

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

object (CardHeader)

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

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

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

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

string

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

enum (ImageType)

Bentuk yang digunakan untuk memangkas gambar.

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

string

URL HTTPS gambar di header kartu.

string

Teks alternatif dari gambar ini yang digunakan untuk aksesibilitas.

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

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.

object (Widget)

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

boolean

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

Untuk menentukan widget mana yang disembunyikan, tentukan uncollapsibleWidgetsCount.

integer

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

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

object (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.

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

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

object (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>"
}

object (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"
}

object (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"
  }
}

object (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,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

object (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
    }
  ]
}

object (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"
}

object (Divider)

Menampilkan pembagi garis horizontal di antara widget.

Misalnya, JSON berikut membuat pemisah:

"divider": {
}

object (Grid)

Menampilkan petak dengan kumpulan item.

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

object (Columns)

Menampilkan hingga 2 kolom.

Untuk menyertakan lebih dari 2 kolom, atau menggunakan baris, gunakan 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"
          }
        }
      ]
    }
  ]
}

object (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.

{
  "text": string,
  "maxLines": integer
}

string

Teks yang ditampilkan di widget.

integer

Jumlah maksimum baris teks yang ditampilkan di widget. Jika teks melebihi jumlah baris maksimum yang ditentukan, kelebihan konten akan disembunyikan dengan tampilkan lebih banyak tombol. Jika teks sama atau lebih pendek dari jumlah baris maksimum yang ditentukan, tampilkan lebih banyak tombol tidak 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.

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

URL HTTPS yang menghosting gambar.

Contoh:

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

object (OnClick)

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

string

Teks alternatif gambar ini yang digunakan untuk aksesibilitas.

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}

object (Action)

Jika ditentukan, tindakan akan dipicu oleh ini onClick.

object (OpenLink)

Jika ditentukan, onClick memicu tindakan link terbuka.

object (Action)

Add-on memicu tindakan ini ketika tindakan perlu membuka link. Hal ini berbeda dengan openLink di atas sehingga perlu berkomunikasi dengan server untuk mendapatkan tautan. 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.

object (Card)

Kartu baru didorong ke tumpukan kartu setelah diklik jika ditentukan.

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

object (OverflowMenu)

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

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

string

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

Untuk contoh penggunaan, lihat Baca data formulir.

object (ActionParameter)

Daftar parameter tindakan.

enum (LoadIndicator)

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

boolean

Menunjukkan apakah nilai formulir tetap ada setelah tindakan. Nilai defaultnya adalah false.

Jika true, nilai formulir akan tetap ada setelah tindakan dipicu. Untuk memungkinkan pengguna melakukan perubahan saat tindakan sedang diproses, tetapkan LoadIndicator dapat NONE. Sebagai pesan kartu di aplikasi Chat, Anda juga harus menetapkan ResponseType dapat UPDATE_MESSAGE dan menggunakan cardId dari kartu yang berisi tindakan.

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

enum (Interaction)

Opsional. Wajib ada 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 mengeksekusi action —seperti membuka link atau menjalankan fungsi—seperti biasa.

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

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

string

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

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

boolean

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

{
  "key": string,
  "value": string
}

string

Nama parameter untuk skrip tindakan.

string

Nilai parameter.

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

URL yang akan dibuka.

enum (OpenAs)

Cara membuka link.

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

enum (OnClose)

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

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

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

Wajib. Daftar opsi menu.

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

Ikon yang ditampilkan di depan teks.

string

Wajib. Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.

object (OnClick)

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

boolean

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

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

string

Opsional. Deskripsi ikon yang digunakan untuk aksesibilitas. Jika tidak ditentukan, nilai default-nya Button disediakan. 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 diatur dalam Button, altText muncul sebagai teks bantuan ketika pengguna mengarahkan kursor ke tombol itu. Namun, jika tombol itu juga mengatur text, altText akan diabaikan.

enum (ImageType)

Gaya pemangkasan yang diterapkan ke gambar. Dalam beberapa kasus, menerapkan pemangkasan CIRCLE menyebabkan gambar digambar lebih besar dari ikon bawaan.

string

Menampilkan salah satu ikon bawaan yang disediakan oleh Google Workspace.

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

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

string

Menampilkan ikon kustom yang dihosting di URL HTTPS.

Contoh:

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

Jenis file yang didukung mencakup .png dan .jpg.

object (MaterialIcon)

Tampilkan salah satu Ikon Material Google.

Misalnya, untuk menampilkan ikon kotak centang, gunakan

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

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

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

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

boolean

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

Untuk melihat pratinjau berbagai setelan ikon, buka Ikon Google Font dan sesuaikan pengaturan pada Sesuaikan.

integer

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 berbagai setelan ikon, buka Ikon Google Font dan sesuaikan pengaturan pada Sesuaikan.

integer

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 nilai lain ditentukan, nilai default akan digunakan.

Untuk melihat pratinjau berbagai setelan ikon, buka Ikon Google Font dan sesuaikan pengaturan pada Sesuaikan.

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

object (Icon)

Tidak berlaku lagi dan digantikan startIcon.

object (Icon)

Ikon yang ditampilkan di depan teks.

string

Teks yang muncul di atas text. Selalu potong.

string

Wajib. Teks utama.

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

boolean

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

Hanya berlaku untuk text, bukan topLabel dan bottomLabel.

string

Teks yang muncul di bawah text. Selalu dikemas.

object (OnClick)

Tindakan ini dipicu saat pengguna mengklik topLabel atau bottomLabel.

object (Button)

Tombol yang dapat diklik pengguna untuk memicu tindakan.

object (SwitchControl)

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

object (Icon)

Ikon yang ditampilkan setelah teks.

Mendukung bawaan dan kustom ikon.

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

Teks yang ditampilkan di dalam tombol.

object (Icon)

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

object (Color)

Opsional. Warna tombol. Jika ditetapkan, tombol type ditetapkan ke FILLED dan warna kolom text dan icon ditetapkan ke warna yang kontras untuk keterbacaan. Misalnya, jika warna tombol disetel ke biru, teks atau ikon apa pun dalam tombol akan disetel menjadi putih.

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

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

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

Tujuan alpha bidang isian tidak tersedia untuk warna tombol. Jika ditentukan, kolom ini akan diabaikan.

object (OnClick)

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

boolean

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

string

Teks alternatif yang digunakan untuk aksesibilitas.

Tetapkan teks deskriptif yang memungkinkan pengguna mengetahui fungsi tombol. Misalnya, jika tombol membuka hyperlink, Anda dapat menulis: "Membuka tab browser baru dan membuka dokumentasi developer Google Chat di https://developers.google.com/workspace/chat&quot;.

enum (Type)

Opsional. Jenis tombol. Jika tidak disetel, jenis tombol akan ditetapkan secara default ke OUTLINED. Jika color isian diatur, jenis tombol dipaksa untuk FILLED dan nilai apa pun yang ditetapkan untuk kolom ini akan diabaikan.

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

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

Jumlah merah dalam warna sebagai nilai dalam interval [0, 1].

number

Jumlah hijau dalam warna sebagai nilai dalam interval [0, 1].

number

Jumlah biru dalam warna sebagai nilai dalam interval [0, 1].

number

Fraksi warna ini yang harus diterapkan ke piksel. Yaitu, warna piksel akhir ditentukan oleh persamaan:

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

Ini berarti bahwa nilai 1,0 berarti warna solid, sedangkan nilai 0,0 berarti warna yang sepenuhnya transparan. Kode ini menggunakan pesan wrapper, bukan skalar float sederhana sehingga memungkinkan untuk membedakan antara nilai default dan nilai yang tidak disetel. Jika dihilangkan, objek warna ini akan dirender sebagai warna solid (seolah-olah nilai alfa telah secara eksplisit diberikan nilai 1,0).

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

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

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

string

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

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

boolean

Kapan true, tombol akan dipilih.

object (Action)

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

enum (ControlType)

Cara tombol muncul di antarmuka pengguna.

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

Array tombol.

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}

string

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

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

string

Teks yang muncul di atas kolom input teks di antarmuka pengguna.

Tentukan teks yang membantu pengguna memasukkan informasi yang diperlukan aplikasi Anda. Misalnya, jika Anda menanyakan nama seseorang, tetapi secara khusus membutuhkan nama belakangnya, tulis surname bukannya name.

Wajib jika hintText tidak ditentukan. Jika tidak, opsional.

string

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

Wajib jika label tidak ditentukan. Jika tidak, opsional.

string

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

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

enum (Type)

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

object (Action)

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

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

object (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++. Saat pengguna mulai mengetik Jav, daftar filter saran yang hanya akan ditampilkan 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 bisa menstandarkan cara pengguna berinteraksi dengan aplikasi Anda.

Bila ditentukan, TextInput.type selalu SINGLE_LINE, meskipun disetel ke MULTIPLE_LINE.

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

object (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.

object (Validation)

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

string

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

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

Action

Navigation

Kirim atau perbarui kartu yang ditampilkan.

Card

Tumpukan kartu mendorong kartu ke tumpukan kartu.

Card

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

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

Nilai input yang disarankan ke kolom input teks. Ini sama dengan apa yang dimasukkan pengguna.

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

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

enum (InputType)

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

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

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

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

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 adalah "Urgensi" atau "Pilih urgensi".

enum (SelectionType)

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

object (SelectionItem)

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

object (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 Terima data formulir.

integer

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

integer

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.

object (Validation)

Untuk menu dropdown, validasi untuk kolom input pilihan ini.

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

object (Action)

Sumber data eksternal, seperti basis data relasional.

object (PlatformDataSource)

Sumber data dari Google Workspace.

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

Teks yang mengidentifikasi atau menjelaskan item kepada pengguna.

string

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

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

boolean

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

string

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

string

Untuk menu pilihan banyak, deskripsi teks atau label ditampilkan di bawah text kolom tersebut.

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

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

object (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 Instal library klien.

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

Sumber data dari Google Chat.

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

Ruang Google Chat tempat pengguna menjadi anggota.

{
  "defaultToCurrentSpace": boolean
}

boolean

Jika ditetapkan ke true, menu multi-pilihan akan memilih ruang Google Chat saat ini sebagai item secara default.

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

string

Nama yang digunakan untuk mengidentifikasi DateTimePicker dalam peristiwa input formulir.

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

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

Tentukan nilai berdasarkan jenis pemilih ( DateTimePickerType):

• DATE_AND_TIME : tanggal dan waktu kalender dalam UTC. Misalnya, untuk menunjukkan 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 mewakili pukul 12.00, gunakan 43200000 (atau 12 * 60 * 60 * 1000).

integer

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

object (Action)

Dipicu saat pengguna mengklik Simpan atau Hapus dari DateTimePicker dalam antarmuka berbasis web yang sederhana.

object (Validation)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

Teks yang ditampilkan di header petak.

object (GridItem)

Item yang akan ditampilkan dalam petak.

object (BorderStyle)

Gaya batas yang akan diterapkan ke setiap item petak.

integer

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

object (OnClick)

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

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

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

object (ImageComponent)

Gambar yang ditampilkan dalam item petak.

string

Judul item petak.

string

Subtitel item petak.

enum (GridItemLayout)

Tata letak yang akan digunakan untuk item petak.

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

URL gambar.

string

Label aksesibilitas untuk gambar.

object (ImageCropStyle)

Gaya pemangkasan yang akan diterapkan ke gambar.

object (BorderStyle)

Gaya batas yang akan diterapkan pada gambar.

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

Jenis pemangkasan.

number

Rasio aspek yang akan digunakan jika jenis pemangkasan adalah RECTANGLE_CUSTOM.

Misalnya, berikut cara menerapkan rasio aspek 16:9:

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

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

Jenis batas.

object (Color)

Warna yang akan digunakan ketika jenis BORDER_TYPE_STROKE.

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

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

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

Tujuan alpha bidang isian tidak tersedia untuk warna goresan. Jika ditentukan, kolom ini akan diabaikan.

integer

Radius sudut untuk batas.

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

Menentukan cara kolom mengisi lebar kartu.

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph .

object (Image)

Image .

object (DecoratedText)

Widget DecoratedText.

object (ButtonList)

ButtonList .

object (TextInput)

Widget TextInput.

object (SelectionInput)

SelectionInput .

object (DateTimePicker)

DateTimePicker .

object (ChipList)

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

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

Tata letak daftar chip yang ditentukan.

object (Chip)

Array chip.

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

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

string

Teks yang ditampilkan di dalam chip.

object (OnClick)

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

boolean

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

boolean

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

string

Teks alternatif yang digunakan untuk aksesibilitas.

Tetapkan teks deskriptif yang memungkinkan pengguna mengetahui fungsi chip tersebut. Misalnya, jika chip membuka hyperlink, tulis: "Membuka tab browser baru dan membuka dokumentasi developer Google Chat di https://developers.google.com/workspace/chat&quot;.

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

Perataan horizontal tombol luaskan dan ciutkan.

object (Button)

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

object (Button)

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

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

Label yang ditampilkan sebagai item menu tindakan.

object (OnClick)

Tindakan onClick untuk item tindakan ini.

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

object (Button)

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