Cards v1

Kartu

Kartu adalah elemen UI yang dapat berisi widget UI seperti teks dan gambar.

Representasi JSON
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Kolom
header

object (CardHeader)

Header kartu. Header biasanya berisi judul dan gambar.

sections[]

object (Section)

Bagian dipisahkan oleh pembatas garis.

cardActions[]

object (CardAction)

Tindakan kartu ini.

name

string

Nama kartu.

CardHeader

Representasi JSON
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Kolom
title

string

Judul harus ditentukan. Header memiliki tinggi tetap: jika judul dan subjudul ditentukan, masing-masing akan menempati satu baris. Jika hanya judul yang ditentukan, judul akan menempati kedua baris.

subtitle

string

Subjudul header kartu.

imageStyle

enum (ImageStyle)

Jenis gambar (misalnya, batas persegi atau batas melingkar).

imageUrl

string

URL gambar di header kartu.

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Batas persegi.
AVATAR Batas melingkar.

Bagian

Bagian berisi kumpulan widget yang dirender (secara vertikal) dalam urutan yang ditentukan. Di semua platform, kartu memiliki lebar tetap yang sempit, sehingga saat ini tidak diperlukan properti tata letak (misalnya, float).

Representasi JSON
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Kolom
header

string

Header bagian. Teks yang diformat didukung. Untuk mengetahui informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

widgets[]

object (WidgetMarkup)

Bagian harus berisi setidaknya satu widget.

WidgetMarkup

Widget adalah elemen UI yang menampilkan teks dan gambar.

Representasi JSON
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Kolom
buttons[]

object (Button)

Daftar tombol. Tombol juga oneof data dan hanya salah satu kolom ini yang harus disetel.

WidgetMarkup hanya dapat memiliki salah satu item berikut. Anda dapat menggunakan beberapa kolom WidgetMarkup untuk menampilkan lebih banyak item. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
textParagraph

object (TextParagraph)

Menampilkan paragraf teks di widget ini.

image

object (Image)

Menampilkan gambar di widget ini.

keyValue

object (KeyValue)

Menampilkan item nilai utama di widget ini.

Akhir kolom yang saling eksklusif.

TextParagraph

Paragraf teks. Teks berformat didukung. Untuk mengetahui informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

Representasi JSON
{
  "text": string
}
Kolom
text

string

Gambar

Gambar yang ditentukan oleh URL dan dapat memiliki tindakan onclick.

Representasi JSON
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Kolom
imageUrl

string

URL gambar.

onClick

object (OnClick)

Tindakan onclick.

aspectRatio

number

Rasio aspek gambar ini (lebar dan tinggi). Dengan kolom ini, Anda dapat memesan tinggi yang tepat untuk gambar saat menunggu gambar dimuat. Tindakan ini tidak dimaksudkan untuk menggantikan rasio aspek bawaan gambar. Jika tidak disetel, server akan mengisinya dengan melakukan pengambilan data gambar terlebih dahulu.

OnClick

Tindakan onclick (misalnya, membuka link).

Representasi JSON
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Kolom
Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
action

object (FormAction)

Tindakan formulir dipicu oleh tindakan onclick ini jika ditentukan.

Akhir kolom yang saling eksklusif.

FormAction

Tindakan formulir menjelaskan perilaku saat formulir dikirimkan. Misalnya, Anda dapat memanggil Apps Script untuk menangani formulir.

Representasi JSON
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
Kolom
actionMethodName

string

Nama metode digunakan untuk mengidentifikasi bagian formulir mana yang memicu pengiriman formulir. Informasi ini dikembalikan ke aplikasi Chat sebagai bagian dari peristiwa klik kartu. Anda dapat menggunakan nama metode yang sama untuk beberapa elemen yang memicu perilaku umum.

parameters[]

object (ActionParameter)

Daftar parameter tindakan.

ActionParameter

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

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

string

Nama parameter untuk skrip tindakan.

value

string

Nilai parameter.

KeyValue

Elemen UI berisi kunci (label) dan nilai (konten). Elemen ini juga dapat berisi beberapa tindakan seperti tombol onclick.

Representasi JSON
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Kolom
topLabel

string

Teks label teratas. Teks berformat didukung. Untuk mengetahui informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

content

string

Teks konten. Teks berformat didukung dan selalu diperlukan. Untuk mengetahui informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

contentMultiline

boolean

Jika konten harus berupa multiline.

bottomLabel

string

Teks label bawah. Teks berformat didukung. Untuk mengetahui informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.

onClick

object (OnClick)

Tindakan onclick. Hanya label atas, label bawah, dan wilayah konten yang dapat diklik.

Setidaknya salah satu ikon, top_label dan bottom_label harus ditentukan. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
icon

enum (Icon)

Nilai enum yang digantikan oleh Chat API dengan gambar ikon yang sesuai.

iconUrl

string

Ikon yang ditentukan oleh URL.

Akhir kolom yang saling eksklusif.
Widget kontrol. Anda dapat menyetel button atau switch_widget, tetapi tidak keduanya. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
button

object (Button)

Tombol yang dapat diklik untuk memicu tindakan.

Akhir kolom yang saling eksklusif.

Ikon

Kumpulan ikon yang didukung.

Enum
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Tombol

Tombol. Dapat berupa tombol teks atau tombol gambar.

Representasi JSON
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Kolom
Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
textButton

object (TextButton)

Tombol dengan teks dan onclick tindakan.

imageButton

object (ImageButton)

Tombol dengan gambar dan onclick tindakan.

Akhir kolom yang saling eksklusif.

TextButton

Tombol dengan teks dan onclick tindakan.

Representasi JSON
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Kolom
text

string

Teks tombol.

onClick

object (OnClick)

Tindakan onclick tombol.

ImageButton

Tombol gambar dengan tindakan onclick.

Representasi JSON
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
Kolom
onClick

object (OnClick)

Tindakan onclick.

name

string

Nama imageButton yang digunakan untuk aksesibilitas. Nilai default diberikan jika nama ini tidak ditentukan.

Ikon dapat ditentukan oleh Icon enum atau URL. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
icon

enum (Icon)

Ikon yang ditentukan oleh enum yang mengindeks ke ikon yang disediakan oleh Chat API.

iconUrl

string

Ikon yang ditentukan oleh URL.

Akhir kolom yang saling eksklusif.

CardAction

Tindakan kartu adalah tindakan yang terkait dengan kartu. Untuk kartu invoice, tindakan umumnya adalah: hapus invoice, kirim invoice melalui email, atau buka invoice di browser.

Tidak didukung oleh aplikasi Google Chat.

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

string

Label yang digunakan untuk ditampilkan di item menu tindakan.

onClick

object (OnClick)

Tindakan onclick untuk item tindakan ini.