- Referensi: Pesan
- Kartu
- CardHeader
- ImageStyle
- Bagian
- WidgetMarkup
- TextParagraph
- Gambar
- OnClick
- FormAction
- ActionParameter
- OpenLink
- Nilai Kunci
- Ikon
- Tombol
- TextButton
- ImageButton
- CardAction
- CardWithId
- Kartu
- CardHeader
- ImageType
- Bagian
- Widget
- TextParagraph
- Gambar
- OnClick
- Tindakan
- ActionParameter
- LoadIndicator
- Interaksi
- OpenLink
- OpenA
- Tutup
- TeksHias
- Ikon
- Tombol
- Warna
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Jenis
- Saran
- Item Saran
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Pemisah
- Petak
- Item Petak
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- Jenis Batas
- GridItemLayout
- Kolom
- Kolom
- HorizontalSizeStyle
- Perataan Horizontal
- Perataan Vertikal
- Widget
- DividerStyle
- CardAction
- CardFixedFooter
- GayaTampilan
- Anotasi
- AnnotationType
- UserSebutanMetadata
- Jenis
- SlashCommandMetadata
- Jenis
- Rangkaian pesan
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Kode
- SlashCommand
- CocokUrl
- EmojiReactionSummary
- DeletionMetadata
- Jenis Penghapusan
- KutipandMessageMetadata
- AttachedGif
- Metode
Resource: Pesan
Pesan di ruang Google Chat.
Representasi JSON |
---|
{ "name": string, "sender": { object ( |
Kolom | |
---|---|
name |
Nama resource dalam formulir Contoh: |
sender |
Hanya output. Pengguna yang membuat pesan. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, outputnya akan mengisi |
createTime |
Untuk ruang yang dibuat di Chat, waktu saat pesan dibuat. Kolom ini hanya merupakan output, kecuali jika digunakan dalam ruang yang diimpor. Untuk ruang yang diimpor, tetapkan kolom ini ke stempel waktu historis saat pesan dibuat di sumber untuk mempertahankan waktu pembuatan asli. |
lastUpdateTime |
Hanya output. Waktu saat pesan terakhir kali diedit oleh pengguna. Jika pesan belum pernah diedit, kolom ini akan kosong. |
deleteTime |
Hanya output. Waktu saat pesan dihapus di Google Chat. Jika pesan tidak pernah dihapus, kolom ini akan kosong. |
text |
Isi pesan dalam teks biasa. Link pertama ke gambar, video, atau halaman web menghasilkan chip pratinjau. Anda juga dapat @menyebut pengguna Google Chat, atau semua orang dalam ruang. Untuk mempelajari cara membuat pesan teks, lihat Mengirim pesan teks. |
formattedText |
Hanya output. Berisi pesan
Untuk informasi selengkapnya, baca Melihat format teks yang dikirim dalam pesan |
cards[] |
Tidak digunakan lagi: Sebagai gantinya, gunakan Kartu yang kaya, diformat, 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 teks biasa pada pesan. |
cardsV2[] |
Array kartu. Hanya aplikasi Chat yang dapat membuat kartu. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, pesan tidak boleh berisi kartu. Untuk mempelajari kartu dan cara membuatnya, lihat Mendesain UI yang dinamis, interaktif, dan konsisten dengan kartu. |
annotations[] |
Hanya output. Anotasi yang terkait dengan |
thread |
Rangkaian yang mencakup pesan. Untuk contoh penggunaan, lihat Memulai atau membalas rangkaian pesan. |
space |
Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, outputnya akan mengisi ruang |
fallbackText |
Deskripsi teks biasa untuk kartu pesan, yang digunakan saat kartu sebenarnya tidak dapat ditampilkan—misalnya, notifikasi seluler. |
actionResponse |
Hanya input. Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting. |
argumentText |
Hanya output. Isi pesan dalam teks biasa dengan semua sebutan aplikasi Chat dihilangkan. |
slashCommand |
Hanya output. Informasi perintah garis miring, jika berlaku. |
attachment[] |
Lampiran yang diupload pengguna. |
matchedUrl |
Hanya output. URL di |
threadReply |
Hanya output. Jika Jika ruang tidak mendukung balasan dalam rangkaian pesan, kolom ini selalu |
clientAssignedMessageId |
Nama kustom untuk pesan Chat yang ditetapkan saat pembuatan. Harus diawali dengan |
emojiReactionSummaries[] |
Hanya output. Daftar ringkasan reaksi emoji di pesan. |
deletionMetadata |
Hanya output. Informasi tentang pesan yang dihapus. Pesan akan dihapus jika |
quotedMessageMetadata |
Hanya output. Informasi tentang pesan yang dikutip oleh pengguna Google Chat dalam ruang. Pengguna Google Chat dapat mengutip pesan untuk membalasnya. |
attachedGifs[] |
Hanya output. Gambar GIF yang dilampirkan ke pesan. |
KartuDenganId
Kartu dalam pesan Google Chat.
Hanya aplikasi Chat yang dapat membuat kartu. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, pesan tidak boleh berisi kartu.
Representasi JSON |
---|
{
"cardId": string,
"card": {
object ( |
Kolom | |
---|---|
cardId |
Wajib jika pesan berisi beberapa kartu. ID unik untuk kartu di pesan. |
card |
Kartu. Ukuran maksimum adalah 32 KB. |
Annotation
Hanya output. Anotasi yang terkait dengan isi pesan dalam teks biasa. Untuk menambahkan pemformatan dasar ke SMS, lihat Memformat pesan teks.
Contoh isi pesan teks biasa:
Hello @FooBot how are you!"
Metadata anotasi yang sesuai:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Representasi JSON |
---|
{ "type": enum ( |
Kolom | |
---|---|
type |
Jenis anotasi ini. |
length |
Panjang substring dalam isi pesan teks biasa yang terkait dengan anotasi ini. |
startIndex |
Mulai indeks (berbasis 0, inklusif) dalam isi pesan teks biasa yang terkait dengan anotasi ini. |
Kolom union metadata . Metadata tambahan tentang anotasi. metadata hanya dapat berupa salah satu dari berikut: |
|
userMention |
Metadata yang disebutkan oleh pengguna. |
slashCommand |
Metadata untuk perintah garis miring. |
AnnotationType
Jenis anotasi.
Enumerasi | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
USER_MENTION |
Seorang pengguna disebutkan. |
SLASH_COMMAND |
Perintah garis miring dipanggil. |
Metadata SebutanPengguna
Metadata anotasi untuk sebutan pengguna (@).
Representasi JSON |
---|
{ "user": { object ( |
Kolom | |
---|---|
user |
Yang disebutkan pengguna. |
type |
Jenis sebutan pengguna. |
Type
Enumerasi | |
---|---|
TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
ADD |
Tambahkan pengguna ke ruang. |
MENTION |
Sebutkan pengguna dalam ruang. |
SlashCommandMetadata
Metadata anotasi untuk perintah garis miring (/).
Representasi JSON |
---|
{ "bot": { object ( |
Kolom | |
---|---|
bot |
Aplikasi Chat yang perintahnya dipanggil. |
type |
Jenis perintah garis miring. |
commandName |
Nama perintah garis miring yang dipanggil. |
commandId |
ID perintah dari perintah garis miring yang dipanggil. |
triggersDialog |
Menunjukkan apakah perintah garis miring digunakan untuk sebuah dialog. |
Type
Enumerasi | |
---|---|
TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
ADD |
Menambahkan aplikasi Chat ke ruang. |
INVOKE |
Panggil perintah garis miring di spasi. |
Rangkaian pesan
Rangkaian pesan di ruang Google Chat. Untuk contoh penggunaan, lihat Memulai atau membalas rangkaian pesan.
Jika menentukan rangkaian pesan saat membuat pesan, Anda dapat menetapkan kolom messageReplyOption
untuk menentukan hal yang akan terjadi jika tidak ditemukan rangkaian pesan yang cocok.
Representasi JSON |
---|
{ "name": string, "threadKey": string } |
Kolom | |
---|---|
name |
Hanya output. Nama resource thread. Contoh: |
threadKey |
Opsional. Input untuk membuat atau memperbarui thread. 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 tersebut akan diposting dalam rangkaian pesan yang berbeda. Untuk membalas dalam rangkaian pesan yang dibuat oleh pengguna atau aplikasi Chat lainnya, tentukan kolom |
Respons Tindakan
Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting.
Representasi JSON |
---|
{ "type": enum ( |
Kolom | |
---|---|
type |
Hanya input. Jenis respons aplikasi Chat. |
url |
Hanya input. URL yang akan diautentikasi atau dikonfigurasi pengguna. (Hanya untuk |
dialogAction |
Hanya input. Respons terhadap peristiwa yang terkait dengan dialog. Harus disertai dengan |
Jenis Respons
Jenis respons aplikasi Chat.
Enumerasi | |
---|---|
TYPE_UNSPECIFIED |
Jenis default yang ditangani sebagai NEW_MESSAGE . |
NEW_MESSAGE |
Memposting sebagai pesan baru dalam topik. |
UPDATE_MESSAGE |
Perbarui pesan aplikasi Chat. Hal ini hanya diizinkan pada peristiwa CARD_CLICKED jika jenis pengirim pesan adalah BOT . |
UPDATE_USER_MESSAGE_CARDS |
Perbarui kartu di pesan pengguna. Tindakan ini hanya diizinkan sebagai respons terhadap peristiwa MESSAGE dengan URL yang cocok, atau peristiwa CARD_CLICKED jika jenis pengirim pesan adalah HUMAN . Teks diabaikan. |
REQUEST_CONFIG |
Minta pengguna untuk melakukan autentikasi atau konfigurasi tambahan secara pribadi. |
DIALOG |
Menampilkan dialog. |
Tindakan Dialog
Berisi dialog dan kode status permintaan.
Representasi JSON |
---|
{ "actionStatus": { object ( |
Kolom | |
---|---|
actionStatus |
Hanya input. Status permintaan untuk memanggil atau mengirim dialog. Menampilkan status dan pesan kepada pengguna, jika perlu. Misalnya, jika terjadi error atau keberhasilan. |
Kolom union
|
|
dialog |
Hanya input. Dialog untuk permintaan. |
Dialog
Wrapper di sekitar isi kartu pada dialog.
Representasi JSON |
---|
{
"body": {
object ( |
Kolom | |
---|---|
body |
Hanya input. Isi dialog, yang dirender dalam modal. Aplikasi Google Chat tidak mendukung entitas kartu berikut: |
StatusTindakan
Merepresentasikan status permintaan untuk memanggil atau mengirimkan dialog.
Representasi JSON |
---|
{
"statusCode": enum ( |
Kolom | |
---|---|
statusCode |
Kode status. |
userFacingMessage |
Pesan yang akan dikirim kepada pengguna tentang status permintaan mereka. Jika tidak disetel, pesan umum berdasarkan |
Kode
Kode error kanonis untuk gRPC API.
Terkadang beberapa kode error mungkin berlaku. Layanan harus menampilkan kode error paling spesifik yang berlaku. Misalnya, lebih suka OUT_OF_RANGE
daripada FAILED_PRECONDITION
jika kedua kode berlaku. Demikian pula, lebih memilih NOT_FOUND
atau ALREADY_EXISTS
daripada FAILED_PRECONDITION
.
Enumerasi | |
---|---|
OK |
Bukan error; ditampilkan jika berhasil. Pemetaan HTTP: 200 OK |
CANCELLED |
Operasi dibatalkan, biasanya oleh pemanggil. Pemetaan HTTP: Permintaan 499 yang Ditutup oleh Klien |
UNKNOWN |
Error tidak diketahui. Misalnya, error ini dapat ditampilkan jika nilai Pemetaan HTTP: Kesalahan Server Internal 500 |
INVALID_ARGUMENT |
Klien menetapkan argumen yang tidak valid. Perhatikan bahwa ini berbeda dengan Pemetaan HTTP: 400 Permintaan Buruk |
DEADLINE_EXCEEDED |
Batas waktu berakhir sebelum operasi selesai. Untuk operasi yang mengubah status sistem, error ini dapat ditampilkan bahkan jika operasi telah berhasil dilakukan. Misalnya, respons yang berhasil dari server dapat tertunda untuk waktu yang cukup lama hingga batas waktu berakhir. Pemetaan HTTP: Waktu Tunggu Gateway 504 |
NOT_FOUND |
Beberapa entitas yang diminta (misalnya, file atau direktori) tidak ditemukan. Catatan untuk developer server: jika permintaan ditolak untuk seluruh kelas pengguna, seperti peluncuran fitur secara bertahap atau daftar yang diizinkan yang tidak terdokumentasi, Pemetaan HTTP: 404 Tidak Ditemukan |
ALREADY_EXISTS |
Entitas yang coba dibuat oleh klien (misalnya, file atau direktori) sudah ada. Pemetaan HTTP: Konflik 409 |
PERMISSION_DENIED |
Pemanggil tidak memiliki izin untuk menjalankan operasi yang ditentukan. Pemetaan HTTP: 403 Terlarang |
UNAUTHENTICATED |
Permintaan tidak memiliki kredensial autentikasi yang valid untuk operasi. Pemetaan HTTP: 401 Tidak Sah |
RESOURCE_EXHAUSTED |
Beberapa resource telah habis, mungkin kuota per pengguna, atau mungkin kapasitas keseluruhan sistem file sudah habis. Pemetaan HTTP: 429 Terlalu Banyak Permintaan |
FAILED_PRECONDITION |
Operasi tersebut ditolak karena sistem tidak memiliki status yang diperlukan untuk menjalankan operasi. Misalnya, direktori yang akan dihapus tidak kosong, operasi rmdir diterapkan ke non-direktori, dll. Implementasi layanan dapat menggunakan panduan berikut untuk menentukan antara Pemetaan HTTP: 400 Permintaan Buruk |
ABORTED |
Operasi dibatalkan, biasanya karena masalah serentak seperti kegagalan pemeriksaan pengurut atau pembatalan transaksi. Lihat panduan di atas untuk menentukan antara Pemetaan HTTP: Konflik 409 |
OUT_OF_RANGE |
Operasi dicoba melampaui rentang yang valid. Misalnya, mencari atau membaca akhir file. Tidak seperti Ada sedikit tumpang-tindih antara Pemetaan HTTP: 400 Permintaan Buruk |
UNIMPLEMENTED |
Operasi tidak diterapkan atau tidak didukung/diaktifkan dalam layanan ini. Pemetaan HTTP: 501 Tidak Diterapkan |
INTERNAL |
Error internal. Artinya beberapa invarian yang diharapkan oleh sistem pokok telah rusak. Kode error ini disediakan untuk error serius. Pemetaan HTTP: Kesalahan Server Internal 500 |
UNAVAILABLE |
Saat ini layanan tidak tersedia. Kemungkinan besar ini hanya kondisi sementara, yang dapat dikoreksi dengan mencoba kembali dengan backoff. Perlu diketahui bahwa mencoba ulang operasi non-idempoten tidak selalu aman. Lihat panduan di atas untuk menentukan antara Pemetaan HTTP: 503 Layanan Tidak Tersedia |
DATA_LOSS |
Kehilangan atau kerusakan data yang tidak dapat dipulihkan. Pemetaan HTTP: Kesalahan Server Internal 500 |
{i>SlashCommand<i}
Perintah garis miring di Google Chat.
Representasi JSON |
---|
{ "commandId": string } |
Kolom | |
---|---|
commandId |
ID perintah garis miring yang dipanggil. |
URL yang Cocok
URL yang cocok dalam pesan Chat. Aplikasi Chat dapat melihat pratinjau URL yang cocok. Untuk informasi lebih lanjut, lihat Melihat pratinjau link.
Representasi JSON |
---|
{ "url": string } |
Kolom | |
---|---|
url |
Hanya output. URL yang cocok. |
Ringkasan EmojiReaction
Jumlah orang yang bereaksi pada pesan dengan emoji tertentu.
Representasi JSON |
---|
{
"emoji": {
object ( |
Kolom | |
---|---|
emoji |
Emoji yang terkait dengan reaksi. |
reactionCount |
Jumlah total reaksi yang menggunakan emoji terkait. |
Metadata Penghapusan
Informasi tentang pesan yang dihapus. Pesan akan dihapus jika deleteTime
disetel.
Representasi JSON |
---|
{
"deletionType": enum ( |
Kolom | |
---|---|
deletionType |
Menunjukkan siapa yang menghapus pesan. |
Jenis Penghapusan
Siapa yang menghapus pesan dan bagaimana pesan dihapus.
Enumerasi | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Nilai ini tidak digunakan. |
CREATOR |
Pengguna menghapus pesannya sendiri. |
SPACE_OWNER |
Pemilik ruang menghapus pesan. |
ADMIN |
Admin Google Workspace menghapus pesan. |
APP_MESSAGE_EXPIRY |
Aplikasi Chat menghapus pesannya sendiri saat masa berlakunya habis. |
CREATOR_VIA_APP |
Aplikasi Chat menghapus pesan atas nama pengguna. |
SPACE_OWNER_VIA_APP |
Aplikasi Chat menghapus pesan atas nama pemilik ruang. |
KutipandMessageMetadata
Informasi tentang pesan kutipan.
Representasi JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Kolom | |
---|---|
name |
Hanya output. Nama resource pesan yang dikutip. Format: |
lastUpdateTime |
Hanya output. Stempel waktu saat pesan yang dikutip dibuat atau saat pesan yang dikutip terakhir diperbarui. |
TerlampirGif
Gambar GIF yang ditentukan oleh URL.
Representasi JSON |
---|
{ "uri": string } |
Kolom | |
---|---|
uri |
Hanya output. URL yang menghosting gambar GIF. |
Metode |
|
---|---|
|
Membuat pesan di ruang Google Chat. |
|
Menghapus pesan. |
|
Menampilkan detail tentang pesan. |
|
Mencantumkan pesan di ruang tempat pemanggil menjadi anggota, termasuk pesan dari anggota dan ruang yang diblokir. |
|
Memperbarui pesan. |
|
Memperbarui pesan. |