Package google.chat.v1

ButtonList

Daftar tombol.

ResponseType

Hanya input. Jenis respons aplikasi Chat.

string

Hanya input. URL untuk pengguna mengautentikasi atau mengonfigurasi. (Hanya untuk jenis respons REQUEST_CONFIG.)

DialogAction

Input saja. Respons terhadap peristiwa interaksi yang terkait dengan dialog. Harus disertai dengan ResponseType.Dialog.

UpdatedWidget

Hanya input. Respons dari widget yang diupdate.

SelectionItem

Array objek SelectionItem.

string

ID widget yang diperbarui. ID harus cocok dengan ID untuk widget yang memicu permintaan update.

SelectionItems

Daftar hasil pelengkapan otomatis widget

Code

Kode status.

string

Pesan yang akan dikirim kepada pengguna tentang status permintaan mereka. Jika tidak ditetapkan, pesan umum berdasarkan status_code akan dikirim.

AnnotationType

Jenis anotasi ini.

int32

Panjang substring dalam isi pesan teks biasa yang sesuai dengan anotasi ini.

int32

Indeks awal (berbasis 0, inklusif) dalam isi pesan teks biasa yang sesuai dengan anotasi ini.

UserMentionMetadata

Metadata sebutan pengguna.

SlashCommandMetadata

Metadata untuk perintah garis miring.

RichLinkMetadata

Metadata untuk link yang kaya.

string

Hanya output. URL yang menghosting gambar GIF.

string

Opsional. Nama resource lampiran, dalam bentuk spaces/{space}/messages/{message}/attachments/{attachment}.

string

Hanya output. Nama file asli untuk konten, bukan jalur lengkap.

string

Hanya output. Jenis konten (jenis MIME) file.

string

Hanya output. URL thumbnail yang harus digunakan untuk melihat pratinjau lampiran kepada pengguna manusia. Aplikasi chat tidak boleh menggunakan URL ini untuk mendownload konten lampiran.

string

Hanya output. URL download yang harus digunakan untuk mengizinkan pengguna manusia mendownload lampiran. Aplikasi chat tidak boleh menggunakan URL ini untuk mendownload konten lampiran.

Source

Hanya output. Sumber lampiran.

AttachmentDataRef

Opsional. Referensi ke data lampiran. Kolom ini digunakan untuk membuat atau memperbarui pesan dengan lampiran, atau dengan media API untuk mendownload data lampiran.

DriveDataRef

Hanya output. Referensi ke lampiran Google Drive. Kolom ini digunakan dengan Google Drive API.

string

Opsional. Nama resource data lampiran. Kolom ini digunakan dengan media API untuk mendownload data lampiran.

string

Opsional. Token buram yang berisi referensi ke lampiran yang diupload. Dianggap oleh klien sebagai string buram dan digunakan untuk membuat atau memperbarui pesan Chat dengan lampiran.

string

Wajib diisi jika pesan berisi beberapa kartu. ID unik untuk kartu dalam pesan.

Card

Kartu. Ukuran maksimum adalah 32 KB.

string

Ruang resource ruang Chat tertaut.

Format: spaces/{space}

string

Rangkaian pesan resource ruang Chat tertaut.

Format: spaces/{space}/threads/{thread}

string

Pesan resource ruang Chat yang ditautkan.

Format: spaces/{space}/messages/{message}

string

Wajib. Nama resource ruang mode impor.

Format: spaces/{space}

Space

Ruang mode impor.

CardHeader

Header kartu. Header biasanya berisi judul dan gambar.

Section

Bagian dipisahkan oleh pemisah garis.

CardAction

Tindakan kartu ini.

string

Nama kartu.

string

Label yang digunakan untuk ditampilkan di item menu tindakan.

OnClick

Tindakan onclick untuk item tindakan ini.

string

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

string

Subjudul header kartu.

ImageStyle

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

string

URL gambar di header kartu.

string

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

WidgetMarkup

Bagian harus berisi minimal satu widget.

CustomEmoji

Wajib. Emoji kustom yang akan dibuat.

string

Wajib. Nama resource ruang yang akan dibuat keanggotaannya.

Format: spaces/{space}

Membership

Wajib. Hubungan keanggotaan yang akan dibuat.

Kolom memberType harus berisi pengguna dengan kolom user.name dan user.type terisi. Server akan menetapkan nama resource dan menimpa apa pun yang ditentukan.

Saat membuat hubungan keanggotaan untuk pengguna manusia, aplikasi Chat harus menggunakan cakupan otorisasi tertentu dan menetapkan nilai tertentu untuk kolom tertentu:

• Saat mengautentikasi sebagai pengguna, cakupan otorisasi chat.memberships diperlukan.

• Saat melakukan autentikasi sebagai aplikasi, cakupan otorisasi chat.app.memberships diperlukan. Mengautentikasi sebagai aplikasi tersedia di

• Tetapkan user.type ke HUMAN, dan tetapkan user.name dengan format users/{user}, dengan {user} dapat berupa alamat email untuk pengguna. Untuk pengguna di organisasi Workspace yang sama, {user} juga dapat berupa id orang dari People API, atau id untuk pengguna di Directory API. Misalnya, jika ID profil Orang People API untuk user@example.com adalah 123456789, Anda dapat menambahkan pengguna ke ruang dengan menetapkan membership.member.name ke users/user@example.com atau users/123456789.

Saat membuat hubungan keanggotaan untuk dirinya sendiri, aplikasi Chat harus melakukan autentikasi sebagai pengguna] dan menggunakan cakupan chat.memberships.app, menetapkan user.type ke BOT, dan menetapkan user.name ke users/app.

bool

Opsional. Jika true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

Membuat langganan aplikasi atau membuat langganan untuk pengguna di luar organisasi Google Workspace administrator tidak didukung menggunakan akses admin.

string

Wajib. Nama resource ruang tempat membuat pesan.

Format: spaces/{space}

Message

Wajib. Isi pesan.

string

Opsional. Tidak digunakan lagi: Gunakan thread.thread_key sebagai gantinya. ID untuk thread. Mendukung hingga 4.000 karakter. Untuk memulai atau menambahkan ke rangkaian pesan, buat pesan dan tentukan threadKey atau thread.name. Untuk contoh penggunaan, lihat Memulai atau membalas rangkaian pesan.

string

Opsional. ID permintaan unik untuk pesan ini. Menentukan ID permintaan yang ada akan menampilkan pesan yang dibuat dengan ID tersebut, bukan membuat pesan baru.

MessageReplyOption

Opsional. Menentukan apakah pesan memulai rangkaian pesan atau membalas rangkaian pesan. Hanya didukung di ruang yang diberi nama.

Saat merespons interaksi pengguna, kolom ini akan diabaikan. Untuk interaksi dalam rangkaian pesan, balasan dibuat dalam rangkaian pesan yang sama. Jika tidak, balasan akan dibuat sebagai rangkaian pesan baru.

string

Opsional. ID kustom untuk pesan. Memungkinkan aplikasi Chat mendapatkan, memperbarui, atau menghapus pesan tanpa perlu menyimpan ID yang ditetapkan sistem di nama resource pesan (diwakili di kolom name pesan).

Nilai untuk kolom ini harus memenuhi persyaratan berikut:

• Dimulai dengan client-. Misalnya, client-custom-name adalah ID kustom yang valid, tetapi custom-name tidak.
• Berisi maksimal 63 karakter dan hanya huruf kecil, angka, dan tanda hubung.
• Unik dalam ruang. Aplikasi Chat tidak dapat menggunakan ID kustom yang sama untuk pesan yang berbeda.

Untuk mengetahui detailnya, lihat Memberi nama pesan.

string

Wajib. Pesan tempat reaksi dibuat.

Format: spaces/{space}/messages/{message}

Reaction

Wajib. Reaksi yang akan dibuat.

Space

Wajib. Kolom displayName dan spaceType harus diisi. Hanya SpaceType.SPACE dan SpaceType.GROUP_CHAT yang didukung. SpaceType.GROUP_CHAT hanya dapat digunakan jika importMode ditetapkan ke benar.

Jika Anda menerima pesan error ALREADY_EXISTS, coba displayName yang berbeda. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Ruang name ditetapkan di server sehingga apa pun yang ditentukan di kolom ini akan diabaikan.

string

Opsional. ID unik untuk permintaan ini. Sebaiknya gunakan UUID acak. Menentukan ID permintaan yang ada akan menampilkan ruang yang dibuat dengan ID tersebut, bukan membuat ruang baru. Menentukan ID permintaan yang ada dari aplikasi Chat yang sama dengan pengguna terautentikasi yang berbeda akan menampilkan error.

string

ID. Nama resource emoji kustom, yang ditetapkan oleh server.

Format: customEmojis/{customEmoji}

string

Hanya output. Kunci unik untuk resource emoji kustom.

string

Opsional. Tidak dapat diubah. Nama yang diberikan pengguna untuk emoji kustom, yang unik dalam organisasi.

Diperlukan saat emoji kustom dibuat, hanya output jika tidak.

Nama emoji harus diawali dan diakhiri dengan titik dua, harus berupa huruf kecil, dan hanya dapat berisi karakter alfanumerik, tanda hubung, serta garis bawah. Tanda hubung dan garis bawah harus digunakan untuk memisahkan kata dan tidak dapat digunakan secara berurutan.

Contoh: :valid-emoji-name:

string

Hanya output. URL gambar untuk emoji kustom, yang valid minimal selama 10 menit. Perhatikan bahwa ini tidak diisi dalam respons saat emoji kustom dibuat.

CustomEmojiPayload

Opsional. Hanya input. Data payload. Wajib ada saat emoji kustom dibuat.

bytes

Wajib. Input saja. Gambar yang digunakan untuk emoji kustom.

Payload harus kurang dari 256 KB dan dimensi gambar harus antara 64 dan 500 piksel. Batasan dapat berubah sewaktu-waktu.

string

Wajib. Hanya input. Nama file gambar.

Ekstensi file yang didukung: .png, .jpg, .gif.

string

Wajib. Nama resource emoji kustom yang akan dihapus.

Format: customEmojis/{customEmoji}

Anda dapat menggunakan nama emoji sebagai alias untuk {customEmoji}. Misalnya, customEmojis/:example-emoji: dengan :example-emoji: adalah nama emoji untuk emoji kustom.

string

Wajib. Nama resource dari keanggotaan yang akan dihapus. Aplikasi chat dapat menghapus langganan pengguna manusia atau langganannya sendiri. Aplikasi Chat tidak dapat menghapus keanggotaan aplikasi lain.

Saat menghapus langganan manusia, memerlukan cakupan chat.memberships dan format spaces/{space}/members/{member}. Anda dapat menggunakan email sebagai alias untuk {member}. Misalnya, spaces/{space}/members/example@gmail.com dengan example@gmail.com adalah email pengguna Google Chat.

Saat menghapus langganan aplikasi, Anda memerlukan cakupan chat.memberships.app dan format spaces/{space}/members/app.

Format: spaces/{space}/members/{member} atau spaces/{space}/members/app.

bool

Opsional. Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

Menghapus keanggotaan aplikasi dalam ruang tidak didukung menggunakan akses admin.

string

Wajib. Nama resource pesan.

Format: spaces/{space}/messages/{message}

Jika telah menetapkan ID kustom untuk pesan, Anda dapat menggunakan nilai dari kolom clientAssignedMessageId untuk {message}. Untuk mengetahui detailnya, lihat Memberi nama pesan.

bool

Opsional. Saat true, menghapus pesan juga akan menghapus balasan berangkainya. Jika false, jika pesan memiliki balasan berangkai, penghapusan akan gagal.

Hanya berlaku saat mengautentikasi sebagai pengguna. Tidak berpengaruh saat melakukan autentikasi sebagai aplikasi Chat.

string

Wajib. Nama reaksi yang akan dihapus.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

string

Wajib. Nama resource ruang yang akan dihapus.

Format: spaces/{space}

bool

Opsional. Jika true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.delete.

DeletionType

Menunjukkan siapa yang menghapus pesan.

Card

Hanya input. Isi dialog, yang dirender dalam modal. Aplikasi Google Chat tidak mendukung entitas kartu berikut: DateTimePicker, OnChangeAction.

ActionStatus

Input saja. Status untuk permintaan guna memanggil atau mengirimkan dialog. Menampilkan status dan pesan kepada pengguna, jika diperlukan. Misalnya, jika terjadi error atau berhasil.

Dialog

Hanya input. Dialog untuk permintaan.

string

ID untuk file Drive. Gunakan dengan Drive API.

DriveDataRef

DriveDataRef yang mereferensikan file Google Drive.

string

Jenis mime resource Google Drive tertaut.

string

Opsional. Emoji dasar yang direpresentasikan oleh string unicode.

CustomEmoji

Hanya output. Emoji kustom.

Emoji

Hanya output. Emoji yang terkait dengan reaksi.

int32

Hanya output. Jumlah total reaksi yang menggunakan emoji terkait.

string

Wajib. Nama resource pengguna untuk menemukan pesan langsung.

Format: users/{user}, dengan {user} adalah id untuk orang dari People API, atau id untuk pengguna di Directory API. Misalnya, jika ID profil People API adalah 123456789, Anda dapat menemukan pesan langsung dengan orang tersebut menggunakan users/123456789 sebagai name. Saat diautentikasi sebagai pengguna, Anda dapat menggunakan email sebagai alias untuk {user}. Misalnya, users/example@gmail.com dengan example@gmail.com adalah email pengguna Google Chat.

string

Wajib. Nama resource lampiran, dalam bentuk spaces/{space}/messages/{message}/attachments/{attachment}.

string

Wajib. Nama resource emoji kustom.

Format: customEmojis/{customEmoji}

Anda dapat menggunakan nama emoji sebagai alias untuk {customEmoji}. Misalnya, customEmojis/:example-emoji: dengan :example-emoji: adalah nama emoji untuk emoji kustom.

string

Wajib. Nama resource langganan yang akan diambil.

Untuk mendapatkan keanggotaan aplikasi sendiri menggunakan autentikasi pengguna, Anda dapat menggunakan spaces/{space}/members/app (opsional).

Format: spaces/{space}/members/{member} atau spaces/{space}/members/app

Anda dapat menggunakan email pengguna sebagai alias untuk {member}. Misalnya, spaces/{space}/members/example@gmail.com dengan example@gmail.com adalah email pengguna Google Chat.

bool

Opsional. Jika true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.memberships atau chat.admin.memberships.readonly.

Mendapatkan langganan aplikasi di ruang tidak didukung saat menggunakan akses admin.

string

Wajib. Nama resource pesan.

Format: spaces/{space}/messages/{message}

Jika telah menetapkan ID kustom untuk pesan, Anda dapat menggunakan nilai dari kolom clientAssignedMessageId untuk {message}. Untuk mengetahui detailnya, lihat Memberi nama pesan.

string

Wajib. Nama resource peristiwa ruang.

Format: spaces/{space}/spaceEvents/{spaceEvent}

string

Wajib. Format: users/{pengguna}/spaces/{space}/spaceNotificationSetting

• users/me/spaces/{space}/spaceNotificationSetting, ATAU
• users/user@example.com/spaces/{space}/spaceNotificationSetting, ATAU
• users/123456789/spaces/{space}/spaceNotificationSetting. Catatan: Hanya ID pengguna atau email pemanggil yang diizinkan di jalur.

string

Wajib. Nama resource status baca ruang yang akan diambil.

Hanya mendukung mendapatkan status baca untuk pengguna yang memanggil.

Untuk merujuk ke pengguna yang menelepon, tetapkan salah satu dari hal berikut:

• Alias me. Misalnya, users/me/spaces/{space}/spaceReadState.

• Alamat email Workspace mereka. Misalnya, users/user@example.com/spaces/{space}/spaceReadState.

• ID penggunanya. Misalnya, users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState

string

Wajib. Nama resource ruang, dalam bentuk spaces/{space}.

Format: spaces/{space}

bool

Opsional. Jika true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.spaces atau chat.admin.spaces.readonly.

string

Wajib. Nama resource dari status pembacaan thread yang akan diambil.

Hanya mendukung mendapatkan status baca untuk pengguna yang memanggil.

Untuk merujuk ke pengguna yang menelepon, tetapkan salah satu dari hal berikut:

• Alias me. Misalnya, users/me/spaces/{space}/threads/{thread}/threadReadState.

• Alamat email Workspace mereka. Misalnya, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

• ID penggunanya. Misalnya, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Format: pengguna/{pengguna}/ruang/{ruang}/threads/{thread}/threadReadState

string

Nama resource untuk grup Google.

Merepresentasikan grup di Cloud Identity Groups API.

Format: groups/{group}

int32

Opsional. Jumlah maksimum emoji kustom yang ditampilkan. Layanan dapat menampilkan lebih sedikit emoji kustom daripada nilai ini. Jika tidak ditentukan, nilai defaultnya adalah 25. Nilai maksimumnya adalah 200; nilai di atas 200 akan diubah menjadi 200.

string

Opsional. (Jika melanjutkan dari kueri sebelumnya.)

Token halaman yang diterima dari panggilan emoji kustom daftar sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, nilai filter harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak diharapkan.

string

Opsional. Filter kueri.

Mendukung pemfilteran berdasarkan kreator.

Untuk memfilter menurut kreator, Anda harus menentukan nilai yang valid. Saat ini, hanya creator("users/me") dan NOT creator("users/me") yang diterima untuk memfilter emoji kustom berdasarkan apakah emoji tersebut dibuat oleh pengguna yang melakukan panggilan atau tidak.

Misalnya, kueri berikut menampilkan emoji kustom yang dibuat oleh pemanggil:

creator("users/me")

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

CustomEmoji

Daftar yang tidak diurutkan. Daftar emoji kustom di halaman yang diminta (atau pertama).

string

Token yang dapat Anda kirim sebagai pageToken untuk mengambil halaman hasil berikutnya. Jika kosong, tidak ada halaman berikutnya.

string

Wajib. Nama resource ruang yang akan mengambil daftar keanggotaan.

Format: spaces/{space}

int32

Opsional. Jumlah maksimum langganan yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, maksimal 100 langganan yang ditampilkan.

Nilai maksimumnya adalah 1.000. Jika Anda menggunakan nilai lebih dari 1.000, nilai tersebut akan otomatis diubah menjadi 1.000.

Nilai negatif menampilkan error INVALID_ARGUMENT.

string

Opsional. Token halaman, yang diterima dari panggilan sebelumnya untuk mencantumkan keanggotaan. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.

string

Opsional. Filter kueri.

Anda dapat memfilter langganan menurut peran (role) dan jenis anggota (member.type).

Untuk memfilter berdasarkan peran, tetapkan role ke ROLE_MEMBER atau ROLE_MANAGER.

Untuk memfilter menurut jenis, tetapkan member.type ke HUMAN atau BOT. Anda juga dapat memfilter member.type menggunakan operator !=.

Untuk memfilter menurut peran dan jenis, gunakan operator AND. Untuk memfilter menurut peran atau jenis, gunakan operator OR.

member.type = "HUMAN" atau member.type != "BOT" diperlukan saat use_admin_access ditetapkan ke benar. Filter jenis anggota lainnya akan ditolak.

Misalnya, kueri berikut valid:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Kueri berikut tidak valid:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

bool

Opsional. Jika true, juga menampilkan langganan yang terkait dengan Google Group, selain jenis langganan lainnya. Jika filter ditetapkan, langganan Google Group yang tidak cocok dengan kriteria filter tidak akan ditampilkan.

bool

Opsional. Jika true, juga menampilkan langganan yang terkait dengan pelanggan invited, selain jenis langganan lainnya. Jika filter ditetapkan, langganan invited yang tidak cocok dengan kriteria filter tidak akan ditampilkan.

Saat ini memerlukan autentikasi pengguna.

bool

Opsional. Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.readonly atau chat.admin.memberships.

Mencantumkan keanggotaan aplikasi di ruang tidak didukung saat menggunakan akses admin.

Membership

Daftar yang tidak diurutkan. Daftar langganan di halaman yang diminta (atau pertama).

string

Token yang dapat Anda kirim sebagai pageToken untuk mengambil halaman hasil berikutnya. Jika kosong, tidak ada halaman berikutnya.

string

Wajib. Nama resource ruang tempat pesan akan dicantumkan.

Format: spaces/{space}

int32

Opsional. Jumlah maksimum pesan yang ditampilkan. Layanan mungkin menampilkan lebih sedikit pesan daripada nilai ini.

Jika tidak ditentukan, maksimal 25 akan ditampilkan.

Nilai maksimumnya adalah 1.000. Jika Anda menggunakan nilai lebih dari 1.000, nilai tersebut akan otomatis diubah menjadi 1.000.

Nilai negatif menampilkan error INVALID_ARGUMENT.

string

Opsional. Token halaman yang diterima dari panggilan list messages sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.

string

Opsional. Filter kueri.

Anda dapat memfilter pesan menurut tanggal (create_time) dan rangkaian pesan (thread.name).

Untuk memfilter pesan menurut tanggal pembuatannya, tentukan create_time dengan stempel waktu dalam format RFC-3339 dan tanda kutip ganda. Misalnya, "2023-04-21T11:30:00-04:00". Anda dapat menggunakan operator lebih besar dari > untuk mencantumkan pesan yang dibuat setelah stempel waktu, atau operator kurang dari < untuk mencantumkan pesan yang dibuat sebelum stempel waktu. Untuk memfilter pesan dalam interval waktu, gunakan operator AND di antara dua stempel waktu.

Untuk memfilter menurut rangkaian pesan, tentukan thread.name, yang diformat sebagai spaces/{space}/threads/{thread}. Anda hanya dapat menentukan satu thread.name per kueri.

Untuk memfilter menurut rangkaian pesan dan tanggal, gunakan operator AND dalam kueri Anda.

Misalnya, kueri berikut valid:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

string

Opsional. Cara daftar pesan diurutkan. Tentukan nilai yang akan diurutkan berdasarkan operasi pengurutan. Nilai operasi pengurutan yang valid adalah sebagai berikut:

• ASC untuk menaik.

• DESC untuk menurun.

Pengurutan defaultnya adalah create_time ASC.

bool

Opsional. Apakah akan menyertakan pesan yang dihapus. Pesan yang dihapus mencakup waktu penghapusan dan metadata tentang penghapusannya, tetapi konten pesan tidak tersedia.

Message

Daftar pesan.

string

Anda dapat mengirim token sebagai pageToken untuk mengambil halaman hasil berikutnya. Jika kosong, tidak ada halaman berikutnya.

string

Wajib. Pesan yang diberi reaksi oleh pengguna.

Format: spaces/{space}/messages/{message}

int32

Opsional. Jumlah maksimum reaksi yang ditampilkan. Layanan dapat menampilkan lebih sedikit reaksi daripada nilai ini. Jika tidak ditentukan, nilai defaultnya adalah 25. Nilai maksimumnya adalah 200; nilai di atas 200 akan diubah menjadi 200.

string

Opsional. (Jika melanjutkan dari kueri sebelumnya.)

Token halaman yang diterima dari panggilan list reactions sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, nilai filter harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak diharapkan.

string

Opsional. Filter kueri.

Anda dapat memfilter reaksi menurut emoji (emoji.unicode atau emoji.custom_emoji.uid) dan pengguna (user.name).

Untuk memfilter reaksi beberapa emoji atau pengguna, gabungkan kolom yang serupa dengan operator OR, seperti emoji.unicode = "🙂" OR emoji.unicode = "👍" dan user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Untuk memfilter reaksi menurut emoji dan pengguna, gunakan operator AND, seperti emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Jika kueri Anda menggunakan AND dan OR, kelompokkan keduanya dengan tanda kurung.

Misalnya, kueri berikut valid:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Kueri berikut tidak valid:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

Reaction

Daftar reaksi di halaman yang diminta (atau pertama).

string

Token lanjutan untuk mengambil halaman hasil berikutnya. Kolom ini kosong untuk halaman hasil terakhir.

string

Wajib. Nama resource ruang Google Chat tempat peristiwa terjadi.

Format: spaces/{space}.

int32

Opsional. Jumlah maksimum peristiwa ruang yang ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Nilai negatif menampilkan error INVALID_ARGUMENT.

string

Opsional. Token halaman, diterima dari panggilan peristiwa ruang daftar sebelumnya. Berikan atribut ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk mencantumkan peristiwa ruang harus sesuai dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.

string

Wajib. Filter kueri.

Anda harus menentukan minimal satu jenis peristiwa (event_type) menggunakan operator has :. Untuk memfilter menurut beberapa jenis peristiwa, gunakan operator OR. Hapus jenis peristiwa batch di filter Anda. Permintaan akan otomatis menampilkan peristiwa batch terkait. Misalnya, jika Anda memfilter menurut reaksi baru (google.workspace.chat.reaction.v1.created), server juga akan menampilkan peristiwa reaksi baru dalam batch (google.workspace.chat.reaction.v1.batchCreated). Untuk mengetahui daftar jenis peristiwa yang didukung, lihat dokumentasi referensi SpaceEvents.

Secara opsional, Anda juga dapat memfilter berdasarkan waktu mulai (start_time) dan waktu berakhir (end_time):

• start_time: Stempel waktu eksklusif untuk mulai mencantumkan peristiwa ruang. Anda dapat mencantumkan peristiwa yang terjadi hingga 28 hari yang lalu. Jika tidak ditentukan, daftar peristiwa ruang dari 28 hari terakhir.
• end_time: Stempel waktu inklusif hingga peristiwa ruang dicantumkan. Jika tidak ditentukan, mencantumkan peristiwa hingga saat permintaan dibuat.

Untuk menentukan waktu mulai atau waktu berakhir, gunakan operator sama dengan = dan format dalam RFC-3339. Untuk memfilter menurut start_time dan end_time, gunakan operator AND.

Misalnya, kueri berikut valid:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Kueri berikut tidak valid:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

SpaceEvent

Hasil ditampilkan dalam urutan kronologis (peristiwa terlama terlebih dahulu). Catatan: Kolom permissionSettings tidak ditampilkan dalam objek Ruang untuk permintaan daftar.

string

Token kelanjutan yang digunakan untuk mengambil lebih banyak peristiwa. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

int32

Opsional. Jumlah maksimum spasi yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, maksimal 100 spasi akan ditampilkan.

Nilai maksimumnya adalah 1.000. Jika Anda menggunakan nilai lebih dari 1.000, nilai akan otomatis diubah menjadi 1.000.

Nilai negatif menampilkan error INVALID_ARGUMENT.

string

Opsional. Token halaman, diterima dari panggilan list spaces sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, nilai filter harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak terduga.

string

Opsional. Filter kueri.

Anda dapat memfilter ruang menurut jenis ruang (space_type).

Untuk memfilter menurut jenis ruang, Anda harus menentukan nilai enum yang valid, seperti SPACE atau GROUP_CHAT (space_type tidak boleh SPACE_TYPE_UNSPECIFIED). Untuk membuat kueri beberapa jenis ruang, gunakan operator OR.

Misalnya, kueri berikut valid:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

Space

Daftar ruang di halaman yang diminta (atau pertama). Catatan: Kolom permissionSettings tidak ditampilkan dalam objek Ruang untuk permintaan daftar.

string

Anda dapat mengirim token sebagai pageToken untuk mengambil halaman hasil berikutnya. Jika kosong, tidak ada halaman berikutnya.

string

Hanya output. URL yang cocok.

string

ID. Nama resource langganan, yang ditetapkan oleh server.

Format: spaces/{space}/members/{member}

MembershipState

Hanya output. Status keanggotaan.

MembershipRole

Opsional. Peran pengguna dalam ruang Chat, yang menentukan tindakan yang diizinkan di ruang tersebut.

Kolom ini hanya dapat digunakan sebagai input di UpdateMembership.

Timestamp

Opsional. Tidak dapat diubah. Waktu pembuatan langganan, seperti saat anggota bergabung atau diundang untuk bergabung ke ruang. Kolom ini hanya output, kecuali jika digunakan untuk mengimpor langganan historis di ruang mode impor.

Timestamp

Opsional. Tidak dapat diubah. Waktu penghapusan keanggotaan, seperti saat anggota keluar atau dihapus dari ruang. Kolom ini hanya output, kecuali jika digunakan untuk mengimpor langganan historis di ruang mode impor.

User

Opsional. Pengguna atau aplikasi Google Chat yang sesuai dengan keanggotaan. Jika aplikasi Chat Anda diautentikasi sebagai pengguna, output akan mengisi name dan type pengguna.

Group

Opsional. Grup Google yang sesuai dengan keanggotaan.

Membaca atau mengubah keanggotaan untuk Google Grup memerlukan autentikasi pengguna.

MembershipCreatedEventData

Daftar keanggotaan baru.

MembershipDeletedEventData

Daftar keanggotaan yang dihapus.

MembershipUpdatedEventData

Daftar keanggotaan yang diperbarui.

Membership

Langganan baru.

Membership

Langganan yang dihapus. Hanya kolom name dan state yang diisi.

Membership

Langganan yang diperbarui.

string

ID. Nama resource pesan.

Format: spaces/{space}/messages/{message}

Dengan {space} adalah ID ruang tempat pesan diposting dan {message} adalah ID yang ditetapkan sistem untuk pesan. Misalnya, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jika menetapkan ID kustom saat membuat pesan, Anda dapat menggunakan ID ini untuk menentukan pesan dalam permintaan dengan mengganti {message} dengan nilai dari kolom clientAssignedMessageId. Misalnya, spaces/AAAAAAAAAAA/messages/client-custom-name. Untuk mengetahui detailnya, lihat Memberi nama pesan.

User

Hanya output. Pengguna yang membuat pesan. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, output akan mengisi pengguna name dan type.

Timestamp

Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu saat pesan dibuat. Kolom ini hanya output, kecuali jika digunakan dalam ruang mode impor.

Untuk ruang mode impor, tetapkan kolom ini ke stempel waktu historis saat pesan dibuat di sumber untuk mempertahankan waktu pembuatan asli.

Timestamp

Hanya output. Waktu saat pesan terakhir diedit oleh pengguna. Jika pesan belum pernah diedit, kolom ini akan kosong.

Timestamp

Hanya output. Waktu saat pesan dihapus di Google Chat. Jika pesan tidak pernah dihapus, kolom ini akan kosong.

string

Opsional. Isi teks biasa pesan. Link pertama ke gambar, video, atau halaman web akan menghasilkan chip pratinjau. Anda juga dapat @menyebut pengguna Google Chat, atau semua orang di ruang.

Untuk mempelajari cara membuat pesan teks, lihat Mengirim pesan.

string

Hanya output. Berisi pesan text dengan markup yang ditambahkan untuk menyampaikan pemformatan. Kolom ini mungkin tidak menangkap semua format yang terlihat di UI, tetapi mencakup hal berikut:

• Sintaksis markup untuk cetak tebal, miring, dicoret, spasi tunggal, blok spasi tunggal, dan daftar berbutir.

• Sebutan pengguna menggunakan format <users/{user}>.

• Hyperlink kustom menggunakan format <{url}|{rendered_text}> dengan string pertama adalah URL dan string kedua adalah teks yang dirender—misalnya, <http://example.com|custom text>.

• Emoji kustom menggunakan format :{emoji_name}:—misalnya, :smile:. Hal ini tidak berlaku untuk emoji Unicode, seperti U+1F600 untuk emoji wajah tersenyum.

Untuk informasi selengkapnya, baca Melihat format teks yang dikirim dalam pesan

Card

Tidak digunakan lagi: Gunakan cards_v2 sebagai gantinya.

Kartu yang kaya, berformat, dan interaktif yang dapat Anda gunakan untuk menampilkan elemen UI seperti: teks berformat, tombol, dan gambar yang dapat diklik. Kartu biasanya ditampilkan di bawah isi pesan teks biasa. cards dan cards_v2 dapat memiliki ukuran maksimum 32 KB.

CardWithId

Opsional. Array kartu.

Hanya aplikasi Chat yang dapat membuat kartu. Jika aplikasi Chat Anda diautentikasi sebagai pengguna, pesan tidak boleh berisi kartu.

Untuk mempelajari cara membuat pesan yang berisi kartu, lihat Mengirim pesan.

Buat desain dan lihat pratinjau kartu dengan Pembuat Kartu.

Annotation

Hanya output. Anotasi yang terkait dengan text dalam pesan ini.

Thread

Rangkaian pesan yang menyertakan pesan tersebut. Untuk contoh penggunaan, lihat Memulai atau membalas rangkaian pesan.

Space

Hanya output. Jika aplikasi Chat Anda diautentikasi sebagai pengguna, output hanya akan mengisi ruang name.

string

Opsional. Deskripsi teks biasa tentang kartu pesan, yang digunakan saat kartu sebenarnya tidak dapat ditampilkan—misalnya, notifikasi seluler.

ActionResponse

Input saja. Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting.

string

Hanya output. Isi pesan teks biasa dengan semua sebutan aplikasi Chat dihapus.

SlashCommand

Hanya output. Informasi perintah garis miring, jika ada.

Attachment

Opsional. Lampiran yang diupload pengguna.

MatchedUrl

Hanya output. URL di spaces.messages.text yang cocok dengan pola pratinjau link. Untuk informasi selengkapnya, lihat Link pratinjau.

bool

Hanya output. Jika true, pesan tersebut adalah respons dalam rangkaian pesan balasan. Jika false, pesan akan terlihat di percakapan tingkat teratas ruang sebagai pesan pertama dari rangkaian pesan atau pesan tanpa balasan rangkaian pesan.

Jika ruang tidak mendukung balasan dalam rangkaian pesan, kolom ini selalu false.

string

Opsional. ID khusus untuk pesan. Anda dapat menggunakan kolom untuk mengidentifikasi pesan, atau untuk mendapatkan, menghapus, atau memperbarui pesan. Untuk menetapkan ID kustom, tentukan kolom messageId saat Anda membuat pesan. Untuk mengetahui detailnya, lihat Memberi nama pesan.

EmojiReactionSummary

Hanya output. Daftar ringkasan reaksi emoji di pesan.

User

Opsional. Tidak dapat diubah. Input untuk membuat pesan, jika tidak, hanya output. Pengguna yang dapat melihat pesan. Jika ditetapkan, pesan bersifat pribadi dan hanya dapat dilihat oleh pengguna yang ditentukan dan aplikasi Chat. Untuk menyertakan kolom ini dalam permintaan, Anda harus memanggil Chat API menggunakan autentikasi aplikasi dan menghapus hal berikut:

• Lampiran
• Widget aksesori

Untuk mengetahui detailnya, lihat Mengirim pesan secara pribadi.

DeletionMetadata

Hanya output. Informasi tentang pesan yang dihapus. Pesan akan dihapus saat delete_time ditetapkan.

QuotedMessageMetadata

Hanya output. Informasi tentang pesan yang dikutip oleh pengguna Google Chat di ruang. Pengguna Google Chat dapat mengutip pesan untuk membalasnya.

AttachedGif

Hanya output. Gambar GIF yang dilampirkan ke pesan.

AccessoryWidget

Opsional. Satu atau beberapa widget interaktif yang muncul di bagian bawah pesan. Anda dapat menambahkan widget aksesori ke pesan yang berisi teks, kartu, atau teks dan kartu. Tidak didukung untuk pesan yang berisi dialog. Untuk mengetahui detailnya, lihat Menambahkan widget interaktif di bagian bawah pesan.

Membuat pesan dengan widget aksesori memerlukan autentikasi aplikasi.

MessageCreatedEventData

Daftar pesan baru.

MessageDeletedEventData

Daftar pesan yang dihapus.

MessageUpdatedEventData

Daftar pesan yang diperbarui.

Message

Pesan baru.

Message

Pesan yang dihapus. Hanya kolom name, createTime, deleteTime, dan deletionMetadata yang diisi.

Message

Pesan yang diperbarui.

string

Hanya output. Nama resource dari pesan yang dikutip.

Format: spaces/{space}/messages/{message}

Timestamp

Hanya output. Stempel waktu saat pesan yang dikutip dibuat atau saat pesan yang dikutip terakhir diperbarui.

string

ID. Nama resource reaksi.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

User

Hanya output. Pengguna yang membuat reaksi.

Emoji

Wajib. Emoji yang digunakan dalam reaksi.

ReactionCreatedEventData

Daftar reaksi baru.

ReactionDeletedEventData

Daftar reaksi yang dihapus.

Reaction

Reaksi baru.

Reaction

Reaksi yang dihapus.

string

URI link ini.

RichLinkType

Jenis link multimedia.

DriveLinkData

Data untuk link Drive.

ChatSpaceLinkData

Data untuk link ruang chat.

bool

Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.spaces.readonly atau chat.admin.spaces.

Metode ini saat ini hanya mendukung akses admin, sehingga hanya true yang diterima untuk kolom ini.

int32

Jumlah maksimum spasi yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan.

Nilai maksimumnya adalah 1.000. Jika Anda menggunakan nilai lebih dari 1.000, nilai tersebut akan otomatis diubah menjadi 1.000.

string

Token, diterima dari panggilan ruang penelusuran sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.

string

Wajib. Kueri penelusuran.

Anda dapat melakukan penelusuran menggunakan parameter berikut:

• create_time
• customer
• display_name
• external_user_allowed
• last_active_time
• space_history_state
• space_type

create_time dan last_active_time menerima stempel waktu dalam format RFC-3339 dan operator perbandingan yang didukung adalah: =, <, >, <=, >=.

customer diperlukan dan digunakan untuk menunjukkan pelanggan mana yang akan mengambil ruang. customers/my_customer adalah satu-satunya nilai yang didukung.

display_name hanya menerima operator HAS (:). Teks yang akan dicocokkan akan ditokenkan terlebih dahulu menjadi token dan setiap token dicocokkan dengan awalan yang tidak peka huruf besar/kecil dan secara terpisah sebagai substring di mana pun dalam display_name ruang. Misalnya, Fun Eve cocok dengan Fun event atau The evening was fun, tetapi tidak cocok dengan notFun event atau even.

external_user_allowed menerima true atau false.

space_history_state hanya menerima nilai dari kolom historyState dari resource space.

space_type diperlukan dan satu-satunya nilai yang valid adalah SPACE.

Di berbagai kolom, hanya operator AND yang didukung. Contoh yang valid adalah space_type = "SPACE" AND display_name:"Hello" dan contoh yang tidak valid adalah space_type = "SPACE" OR display_name:"Hello".

Di antara kolom yang sama, space_type tidak mendukung operator AND atau OR. display_name, 'space_history_state', dan 'external_user_permissions' hanya mendukung operator OR. last_active_time dan create_time mendukung operator AND dan OR. AND hanya dapat digunakan untuk merepresentasikan interval, seperti last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Contoh kueri berikut valid:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

string

Opsional. Cara pengurutan daftar ruang.

Atribut yang didukung untuk diurutkan adalah:

• membership_count.joined_direct_human_user_count — Menunjukkan jumlah pengguna manusia yang telah bergabung langsung ke ruang.
• last_active_time — Menunjukkan waktu saat item terakhir yang memenuhi syarat ditambahkan ke topik ruang ini.
• create_time — Menunjukkan waktu pembuatan ruang.

Nilai operasi pengurutan yang valid adalah:

• ASC untuk menaik. Nilai default.

• DESC untuk menurun.

Sintaksis yang didukung adalah:

• membership_count.joined_direct_human_user_count DESC
• membership_count.joined_direct_human_user_count ASC
• last_active_time DESC
• last_active_time ASC
• create_time DESC
• create_time ASC

Space

Halaman ruang yang diminta.

string

Token yang dapat digunakan untuk mengambil halaman berikutnya. Jika kolom ini kosong, tidak ada halaman berikutnya.

int32

Jumlah total ruang yang cocok dengan kueri, di semua halaman. Jika hasilnya melebihi 10.000 spasi, nilai ini adalah perkiraan.

Space

Wajib. Kolom Space.spaceType wajib diisi.

Untuk membuat ruang, tetapkan Space.spaceType ke SPACE, lalu setel Space.displayName. Jika Anda menerima pesan error ALREADY_EXISTS saat menyiapkan ruang, coba displayName lain. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Untuk membuat chat grup, tetapkan Space.spaceType ke GROUP_CHAT. Jangan setel Space.displayName.

Untuk membuat percakapan 1:1 antara manusia, tetapkan Space.spaceType ke DIRECT_MESSAGE dan tetapkan Space.singleUserBotDm ke false. Jangan tetapkan Space.displayName atau Space.spaceDetails.

Untuk membuat percakapan 1:1 antara manusia dan aplikasi Chat yang menelepon, tetapkan Space.spaceType ke DIRECT_MESSAGE dan Space.singleUserBotDm ke true. Jangan menetapkan Space.displayName atau Space.spaceDetails.

Jika ruang DIRECT_MESSAGE sudah ada, ruang tersebut akan ditampilkan, bukan membuat ruang baru.

string

Opsional. ID unik untuk permintaan ini. Sebaiknya gunakan UUID acak. Menentukan ID permintaan yang ada akan menampilkan ruang yang dibuat dengan ID tersebut, bukan membuat ruang baru. Menentukan ID permintaan yang ada dari aplikasi Chat yang sama dengan pengguna terautentikasi yang berbeda akan menampilkan error.

Membership

Opsional. Pengguna atau grup Google Chat yang akan diundang untuk bergabung ke ruang. Hapus pengguna yang menelepon, karena pengguna tersebut ditambahkan secara otomatis.

Set saat ini mengizinkan hingga 20 langganan (selain pemanggil).

Untuk keanggotaan manusia, kolom Membership.member harus berisi user dengan name terisi (format: users/{user}) dan type ditetapkan ke User.Type.HUMAN. Anda hanya dapat menambahkan pengguna manusia saat menyiapkan ruang (penambahan aplikasi Chat hanya didukung untuk penyiapan pesan langsung dengan aplikasi panggilan). Anda juga dapat menambahkan anggota menggunakan email pengguna sebagai alias untuk {user}. Misalnya, user.name dapat berupa users/example@gmail.com. Untuk mengundang pengguna Gmail atau pengguna dari domain Google Workspace eksternal, email pengguna harus digunakan untuk {user}.

Untuk langganan grup Google, kolom Membership.group_member harus berisi group dengan name terisi (format groups/{group}). Anda hanya dapat menambahkan grup Google saat menetapkan Space.spaceType ke SPACE.

Opsional saat menetapkan Space.spaceType ke SPACE.

Wajib saat menetapkan Space.spaceType ke GROUP_CHAT, bersama dengan minimal dua langganan.

Wajib saat menetapkan Space.spaceType ke DIRECT_MESSAGE dengan pengguna manusia, beserta satu keanggotaan.

Harus kosong saat membuat percakapan 1:1 antara manusia dan aplikasi Chat panggilan (saat menetapkan Space.spaceType ke DIRECT_MESSAGE dan Space.singleUserBotDm ke true).

int64

ID perintah garis miring yang dipanggil.

User

Aplikasi Chat yang perintahnya dipanggil.

Type

Jenis perintah garis miring.

string

Nama perintah garis miring yang dipanggil.

int64

ID perintah dari perintah garis miring yang dipanggil.

bool

Menunjukkan apakah perintah garis miring ditujukan untuk dialog.

string

ID. Nama resource ruang.

Format: spaces/{space}

Dengan {space} mewakili ID yang ditetapkan sistem untuk ruang. Anda dapat memperoleh ID ruang dengan memanggil metode spaces.list() atau dari URL ruang. Misalnya, jika URL ruang adalah https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, ID ruang adalah AAAAAAAAA.

Type

Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan space_type. Jenis ruang.

SpaceType

Opsional. Jenis ruang. Diperlukan saat membuat ruang atau memperbarui jenis ruang. Output hanya untuk penggunaan lain.

bool

Opsional. Apakah ruang tersebut adalah DM antara aplikasi Chat dan satu orang.

bool

Hanya output. Tidak digunakan lagi: Gunakan spaceThreadingState sebagai gantinya. Apakah pesan disusun dalam ruang ini.

string

Opsional. Nama tampilan ruang. Diperlukan saat membuat ruang dengan spaceType dari SPACE. Jika Anda menerima pesan error ALREADY_EXISTS saat membuat ruang atau memperbarui displayName, coba displayName yang berbeda. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Untuk pesan langsung, kolom ini mungkin kosong.

Mendukung maksimal 128 karakter.

bool

Opsional. Tidak dapat diubah. Apakah ruang ini mengizinkan pengguna Google Chat sebagai anggota. Input saat membuat ruang di organisasi Google Workspace. Hapus kolom ini saat membuat ruang dalam kondisi berikut:

• Pengguna yang diautentikasi menggunakan akun konsumen (akun pengguna yang tidak dikelola). Secara default, ruang yang dibuat oleh akun konsumen mengizinkan semua pengguna Google Chat.

Untuk ruang yang ada, kolom ini hanya output.

SpaceThreadingState

Hanya output. Status rangkaian pesan di ruang Chat.

SpaceDetails

Opsional. Detail tentang ruang, termasuk deskripsi dan aturan.

HistoryState

Opsional. Status histori pesan untuk pesan dan rangkaian pesan di ruang ini.

bool

Opsional. Apakah ruang ini dibuat di Import Mode sebagai bagian dari migrasi data ke Google Workspace. Saat sedang diimpor, ruang tidak akan terlihat oleh pengguna hingga impor selesai.

Pembuatan ruang di Import Mode memerlukan autentikasi pengguna.

Timestamp

Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu pembuatan ruang. Kolom ini hanya output, kecuali jika digunakan di ruang mode impor.

Untuk ruang mode impor, tetapkan kolom ini ke stempel waktu historis saat ruang dibuat di sumber untuk mempertahankan waktu pembuatan asli.

Hanya diisi dalam output jika spaceType adalah GROUP_CHAT atau SPACE.

Timestamp

Hanya output. Stempel waktu pesan terakhir dalam ruang.

bool

Hanya output. Untuk ruang pesan langsung (DM) dengan aplikasi Chat, apakah ruang tersebut dibuat oleh administrator Google Workspace. Administrator dapat menginstal dan menyiapkan pesan langsung dengan aplikasi Chat atas nama pengguna di organisasi mereka.

Untuk mendukung penginstalan admin, aplikasi Chat Anda harus memiliki fitur pesan langsung.

MembershipCount

Hanya output. Jumlah keanggotaan gabungan yang dikelompokkan menurut jenis anggota. Diisi saat space_type adalah SPACE, DIRECT_MESSAGE, atau GROUP_CHAT.

AccessSettings

Opsional. Menentukan setelan akses ruang. Hanya diisi jika space_type adalah SPACE.

string

Hanya output. URI bagi pengguna untuk mengakses ruang.

string

Opsional. Tidak dapat diubah. ID pelanggan domain ruang. Hanya diperlukan saat membuat ruang dengan autentikasi aplikasi dan SpaceType adalah SPACE. Jika tidak, tidak boleh ditetapkan.

Dalam format customers/{customer}, dengan customer adalah id dari [resource pelanggan Admin SDK]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Aplikasi pribadi juga dapat menggunakan alias customers/my_customer untuk membuat ruang di organisasi Google Workspace yang sama dengan aplikasi.

Untuk DM, kolom ini tidak diisi.

PredefinedPermissionSettings

Opsional. Hanya input. Setelan izin ruang yang telah ditetapkan sebelumnya, hanya masukkan saat membuat ruang. Jika kolom tidak ditetapkan, ruang kolaborasi akan dibuat. Setelah Anda membuat ruang, setelan akan diisi di kolom PermissionSettings.

PermissionSettings

Opsional. Setelan izin ruang untuk ruang yang ada. Input untuk memperbarui setelan izin ruang yang tepat, dengan setelan izin yang ada diganti. Output mencantumkan setelan izin saat ini.

AccessState

Hanya output. Menunjukkan status akses ruang.

string

Opsional. Nama resource target audiens yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan dalam ruang. Jika tidak ditetapkan, hanya pengguna atau Google Grup yang telah diundang atau ditambahkan ke ruang secara terpisah yang dapat mengaksesnya. Untuk mengetahui detailnya, lihat Membuat ruang yang dapat ditemukan oleh target audiens.

Format: audiences/{audience}

Untuk menggunakan audiens target default untuk organisasi Google Workspace, tetapkan ke audiences/default.

Membaca target audiens mendukung:

• Autentikasi pengguna

• Autentikasi aplikasi dengan persetujuan administrator dengan cakupan chat.app.spaces di

Kolom ini tidak diisi saat menggunakan cakupan chat.bot dengan autentikasi aplikasi.

Menetapkan audiens target memerlukan autentikasi pengguna.

int32

Hanya output. Jumlah pengguna manusia yang telah bergabung langsung ke ruang, tidak termasuk pengguna yang bergabung dengan memiliki keanggotaan di grup yang bergabung.

int32

Hanya output. Jumlah semua grup yang telah bergabung langsung ke ruang.

bool

Opsional. Apakah pengelola ruang memiliki izin ini.

bool

Opsional. Apakah anggota non-pengelola memiliki izin ini.

PermissionSetting

Opsional. Setelan untuk mengelola anggota dan grup di ruang.

PermissionSetting

Opsional. Setelan untuk memperbarui nama, avatar, deskripsi, dan panduan ruang.

PermissionSetting

Opsional. Setelan untuk mengaktifkan dan menonaktifkan histori ruang.

PermissionSetting

Opsional. Setelan untuk menggunakan @semua di ruang.

PermissionSetting

Opsional. Setelan untuk mengelola aplikasi dalam ruang.

PermissionSetting

Opsional. Setelan untuk mengelola webhook di ruang.

PermissionSetting

Hanya output. Setelan untuk memposting pesan dalam ruang.

PermissionSetting

Opsional. Setelan untuk membalas pesan dalam ruang.

string

Opsional. Deskripsi ruang. Misalnya, jelaskan topik diskusi, tujuan fungsional, atau peserta ruang.

Mendukung hingga 150 karakter.

string

Opsional. Aturan, ekspektasi, dan etika ruang.

Mendukung hingga 5.000 karakter.

SpaceUpdatedEventData

Daftar ruang yang diperbarui.

string

Nama resource dari peristiwa ruang.

Format: spaces/{space}/spaceEvents/{spaceEvent}

Timestamp

Waktu saat peristiwa terjadi.

string

Jenis peristiwa ruang. Setiap jenis peristiwa memiliki versi batch, yang mewakili beberapa instance jenis peristiwa yang terjadi dalam jangka waktu singkat. Untuk permintaan spaceEvents.list(), hapus jenis peristiwa batch di filter kueri Anda. Secara default, server menampilkan jenis peristiwa dan versi batch-nya.

Jenis peristiwa yang didukung untuk messages:

• Pesan baru: google.workspace.chat.message.v1.created
• Pesan yang diperbarui: google.workspace.chat.message.v1.updated
• Pesan yang dihapus: google.workspace.chat.message.v1.deleted
• Beberapa pesan baru: google.workspace.chat.message.v1.batchCreated
• Beberapa pesan yang diperbarui: google.workspace.chat.message.v1.batchUpdated
• Beberapa pesan yang dihapus: google.workspace.chat.message.v1.batchDeleted

Jenis acara yang didukung untuk langganan:

• Langganan baru: google.workspace.chat.membership.v1.created
• Keanggotaan yang diperbarui: google.workspace.chat.membership.v1.updated
• Langganan yang dihapus: google.workspace.chat.membership.v1.deleted
• Beberapa keanggotaan baru: google.workspace.chat.membership.v1.batchCreated
• Beberapa langganan yang diperbarui: google.workspace.chat.membership.v1.batchUpdated
• Beberapa keanggotaan yang dihapus: google.workspace.chat.membership.v1.batchDeleted

Jenis peristiwa yang didukung untuk reaksi:

• Reaksi baru: google.workspace.chat.reaction.v1.created
• Reaksi yang dihapus: google.workspace.chat.reaction.v1.deleted
• Beberapa reaksi baru: google.workspace.chat.reaction.v1.batchCreated
• Beberapa reaksi yang dihapus: google.workspace.chat.reaction.v1.batchDeleted

Jenis peristiwa yang didukung tentang ruang:

• Ruang yang diperbarui: google.workspace.chat.space.v1.updated
• Beberapa pembaruan ruang: google.workspace.chat.space.v1.batchUpdated

MessageCreatedEventData

Payload peristiwa untuk pesan baru.

Jenis peristiwa: google.workspace.chat.message.v1.created

MessageUpdatedEventData

Payload peristiwa untuk pesan yang diperbarui.

Jenis peristiwa: google.workspace.chat.message.v1.updated

MessageDeletedEventData

Payload peristiwa untuk pesan yang dihapus.

Jenis peristiwa: google.workspace.chat.message.v1.deleted

MessageBatchCreatedEventData

Payload peristiwa untuk beberapa pesan baru.

Jenis peristiwa: google.workspace.chat.message.v1.batchCreated

MessageBatchUpdatedEventData

Payload peristiwa untuk beberapa pesan yang diperbarui.

Jenis peristiwa: google.workspace.chat.message.v1.batchUpdated

MessageBatchDeletedEventData

Payload peristiwa untuk beberapa pesan yang dihapus.

Jenis peristiwa: google.workspace.chat.message.v1.batchDeleted

SpaceUpdatedEventData

Payload peristiwa untuk update ruang.

Jenis peristiwa: google.workspace.chat.space.v1.updated

SpaceBatchUpdatedEventData

Payload peristiwa untuk beberapa pembaruan pada ruang.

Jenis peristiwa: google.workspace.chat.space.v1.batchUpdated

MembershipCreatedEventData

Payload peristiwa untuk langganan baru.

Jenis peristiwa: google.workspace.chat.membership.v1.created

MembershipUpdatedEventData

Payload peristiwa untuk langganan yang diperbarui.

Jenis peristiwa: google.workspace.chat.membership.v1.updated

MembershipDeletedEventData

Payload peristiwa untuk keanggotaan yang dihapus.

Jenis peristiwa: google.workspace.chat.membership.v1.deleted

MembershipBatchCreatedEventData

Payload peristiwa untuk beberapa langganan baru.

Jenis acara: google.workspace.chat.membership.v1.batchCreated

MembershipBatchUpdatedEventData

Payload peristiwa untuk beberapa keanggotaan yang diperbarui.

Jenis peristiwa: google.workspace.chat.membership.v1.batchUpdated

MembershipBatchDeletedEventData

Payload peristiwa untuk beberapa keanggotaan yang dihapus.

Jenis peristiwa: google.workspace.chat.membership.v1.batchDeleted

ReactionCreatedEventData

Payload peristiwa untuk reaksi baru.

Jenis acara: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Payload peristiwa untuk reaksi yang dihapus.

Jenis peristiwa: google.workspace.chat.reaction.v1.deleted

ReactionBatchCreatedEventData

Payload peristiwa untuk beberapa reaksi baru.

Jenis peristiwa: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Payload peristiwa untuk beberapa reaksi yang dihapus.

Jenis peristiwa: google.workspace.chat.reaction.v1.batchDeleted

string

ID. Nama resource setelan notifikasi ruang. Format: users/{user}/spaces/{space}/spaceNotificationSetting.

NotificationSetting

Setelan notifikasi.

MuteSetting

Setelan bisukan notifikasi ruang.

string

Nama resource status baca ruang.

Format: users/{user}/spaces/{space}/spaceReadState

Timestamp

Opsional. Waktu saat status baca ruang pengguna diperbarui. Biasanya, ini sesuai dengan stempel waktu pesan yang terakhir dibaca, atau stempel waktu yang ditentukan oleh pengguna untuk menandai posisi terakhir yang dibaca dalam ruang.

Space

Ruang yang diperbarui.

string

ID. Nama resource thread.

Contoh: spaces/{space}/threads/{thread}

string

Opsional. Input untuk membuat atau memperbarui rangkaian pesan. Jika tidak, hanya output. ID untuk thread. Mendukung hingga 4.000 karakter.

ID ini unik untuk aplikasi Chat yang menetapkannya. Misalnya, jika beberapa aplikasi Chat membuat pesan menggunakan kunci rangkaian pesan yang sama, pesan akan diposting di rangkaian pesan yang berbeda. Untuk membalas di rangkaian pesan yang dibuat oleh seseorang atau aplikasi Chat lain, tentukan kolom name rangkaian pesan.

string

Nama resource dari status pembacaan thread.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Timestamp

Waktu saat status pembacaan thread pengguna diperbarui. Biasanya ini berkaitan dengan stempel waktu pesan yang terakhir dibaca dalam rangkaian pesan.

Membership

Wajib. Keanggotaan yang akan diperbarui. Hanya kolom yang ditentukan oleh update_mask yang akan diperbarui.

FieldMask

Wajib. Jalur kolom yang akan diperbarui. Pisahkan beberapa nilai dengan koma atau gunakan * untuk memperbarui semua jalur kolom.

Jalur kolom yang didukung saat ini:

• role

bool

Opsional. Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

Message

Wajib. Pesan dengan kolom diperbarui.

FieldMask

Wajib. Jalur kolom yang akan diperbarui. Pisahkan beberapa nilai dengan koma atau gunakan * untuk memperbarui semua jalur kolom.

Jalur kolom yang didukung saat ini:

• text

• attachment

• cards (Memerlukan autentikasi aplikasi.)

• cards_v2 (Memerlukan autentikasi aplikasi.)

• accessory_widgets (Memerlukan autentikasi aplikasi.)

bool

Opsional. Jika true dan pesan tidak ditemukan, pesan baru akan dibuat dan updateMask akan diabaikan. ID pesan yang ditentukan harus client-assigned atau permintaan gagal.

SpaceNotificationSetting

Wajib. Nama resource untuk setelan notifikasi ruang harus diisi dalam bentuk users/{user}/spaces/{space}/spaceNotificationSetting. Hanya kolom yang ditentukan oleh update_mask yang diperbarui.

FieldMask

Wajib. Jalur kolom yang didukung: - notification_setting - mute_setting

SpaceReadState

Wajib. Status operasi baca ruang dan kolom yang akan diperbarui.

Hanya mendukung pembaruan status baca untuk pengguna yang memanggil.

Untuk merujuk ke pengguna yang menelepon, tetapkan salah satu dari hal berikut:

• Alias me. Misalnya, users/me/spaces/{space}/spaceReadState.

• Alamat email Workspace mereka. Misalnya, users/user@example.com/spaces/{space}/spaceReadState.

• ID penggunanya. Misalnya, users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState

FieldMask

Wajib. Jalur kolom yang akan diperbarui. Jalur kolom yang saat ini didukung:

• last_read_time

Jika last_read_time berada sebelum waktu pembuatan pesan terbaru, ruang akan muncul sebagai belum dibaca di UI.

Untuk menandai ruang sebagai telah dibaca, tetapkan last_read_time ke nilai mana pun nanti (lebih besar) dari waktu pembuatan pesan terbaru. last_read_time dikonversi agar cocok dengan waktu pembuatan pesan terbaru. Perhatikan bahwa status baca ruang hanya memengaruhi status baca pesan yang terlihat di percakapan tingkat teratas ruang. Balasan dalam rangkaian pesan tidak terpengaruh oleh stempel waktu ini, dan sebagai gantinya bergantung pada status baca rangkaian pesan.

Space

Wajib. Ruang dengan kolom yang akan diperbarui. Space.name harus diisi dalam bentuk spaces/{space}. Hanya kolom yang ditentukan oleh update_mask yang diperbarui.

FieldMask

Wajib. Jalur kolom yang diperbarui, dipisahkan koma jika ada beberapa.

Anda dapat memperbarui kolom berikut untuk ruang:

space_details: Memperbarui deskripsi ruang. Mendukung hingga 150 karakter.

display_name: Hanya mendukung pembaruan nama tampilan untuk ruang dengan kolom spaceType SPACE. Jika Anda menerima pesan error ALREADY_EXISTS, coba nilai yang berbeda. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

space_type: Hanya mendukung perubahan jenis ruang GROUP_CHAT menjadi SPACE. Sertakan display_name bersama dengan space_type dalam mask update dan pastikan ruang yang ditentukan memiliki nama tampilan yang tidak kosong dan jenis ruang SPACE. Menyertakan mask space_type dan jenis SPACE di ruang yang ditentukan saat memperbarui nama tampilan bersifat opsional jika ruang yang ada sudah memiliki jenis SPACE. Mencoba memperbarui jenis ruang dengan cara lain akan mengakibatkan error argumen yang tidak valid. space_type tidak didukung dengan useAdminAccess.

space_history_state: Memperbarui setelan histori ruang dengan mengaktifkan atau menonaktifkan histori untuk ruang. Hanya didukung jika setelan histori diaktifkan untuk organisasi Google Workspace. Untuk memperbarui status histori ruang, Anda harus menghapus semua mask kolom lainnya dalam permintaan. space_history_state tidak didukung dengan useAdminAccess.

access_settings.audience: Memperbarui setelan akses tentang siapa yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan di ruang bernama dengan kolom spaceType adalah SPACE. Jika ruang yang ada memiliki target audiens, Anda dapat menghapus audiens dan membatasi akses ruang dengan menghilangkan nilai untuk mask kolom ini. Untuk memperbarui setelan akses ruang, pengguna yang melakukan autentikasi harus menjadi pengelola ruang dan menghapus semua mask kolom lain dalam permintaan Anda. Anda tidak dapat memperbarui kolom ini jika ruang berada dalam mode impor. Untuk mempelajari lebih lanjut, lihat Membuat ruang dapat ditemukan oleh pengguna tertentu. access_settings.audience tidak didukung dengan useAdminAccess.

permission_settings: Mendukung perubahan setelan izin ruang. Saat memperbarui setelan izin, Anda hanya dapat menentukan mask kolom permissionSettings; Anda tidak dapat memperbarui mask kolom lain secara bersamaan. permissionSettings tidak didukung dengan useAdminAccess. Mask kolom yang didukung meliputi:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

bool

Opsional. Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.spaces.

Beberapa nilai FieldMask tidak didukung menggunakan akses admin. Untuk mengetahui detailnya, lihat deskripsi update_mask.

string

Nama resource untuk user Google Chat.

Format: users/{user}. users/app dapat digunakan sebagai alias untuk pengguna bot aplikasi panggilan.

Untuk human users, {user} adalah ID pengguna yang sama dengan:

• id untuk Person di People API. Misalnya, users/123456789 di Chat API mewakili orang yang sama dengan ID profil Orang 123456789 di People API.

• id untuk pengguna di Admin SDK Directory API.

• alamat email pengguna dapat digunakan sebagai alias untuk {user} dalam permintaan API. Misalnya, jika ID profil Orang People API untuk user@example.com adalah 123456789, Anda dapat menggunakan users/user@example.com sebagai alias untuk mereferensikan users/123456789. Hanya nama resource kanonis (misalnya users/123456789) yang akan ditampilkan dari API.

string

Hanya output. Nama tampilan pengguna.

string

ID unik domain Google Workspace pengguna.

Type

Jenis pengguna.

bool

Hanya output. Jika true, pengguna akan dihapus atau profilnya tidak terlihat.

User

Pengguna menyebutkan.

Type

Jenis sebutan pengguna.

Button

Daftar tombol. Tombol juga oneof data dan hanya satu dari kolom ini yang harus ditetapkan.

TextParagraph

Tampilkan paragraf teks dalam widget ini.

Image

Tampilkan gambar dalam widget ini.

KeyValue

Menampilkan item nilai kunci di widget ini.

TextButton

Tombol dengan teks dan tindakan onclick.

ImageButton

Tombol dengan gambar dan tindakan onclick.

string

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

ActionParameter

Daftar parameter tindakan.

string

Nama parameter untuk skrip tindakan.

string

Nilai parameter.

string

URL gambar.

OnClick

Tindakan onclick.

double

Rasio aspek gambar ini (lebar dan tinggi). Kolom ini memungkinkan Anda mencadangkan tinggi yang tepat untuk gambar sambil menunggu gambar dimuat. Hal ini tidak dimaksudkan untuk mengganti rasio aspek bawaan gambar. Jika tidak ditetapkan, server akan mengisinya dengan mengambil gambar terlebih dahulu.

OnClick

Tindakan onclick.

string

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

Icon

Ikon yang ditetapkan oleh enum yang menunjukkan ikon yang disediakan oleh Chat API.

string

Ikon yang ditentukan oleh URL.