- Referensi: Pesan
- Representasi JSON
- Kartu
- CardHeader
- ImageStyle
- Bagian
- WidgetMarkup
- TextParagraph
- Gambar
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Ikon
- Tombol
- TextButton
- ImageButton
- CardAction
- CardWithId
- Kartu
- CardHeader
- ImageType
- Bagian
- Widget
- TextParagraph
- Gambar
- OnClick
- Tindakan
- ActionParameter
- LoadIndicator
- Interaksi
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Ikon
- MaterialIcon
- DecoratedText
- Tombol
- Warna
- Jenis
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Jenis
- Saran
- SuggestionItem
- Validasi
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Pemisah
- Petak
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Kolom
- Kolom
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widget
- ChipList
- Tata letak
- Chip
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Anotasi
- AnnotationType
- UserMentionMetadata
- Jenis
- SlashCommandMetadata
- Jenis
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- Rangkaian pesan
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Kode
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- Metode
Resource: Pesan
Pesan di ruang Google Chat.
Representasi JSON |
---|
{ "name": string, "sender": { object ( |
Kolom | |
---|---|
name |
Nama resource pesan. Format: Dengan Jika menetapkan ID kustom saat membuat pesan, Anda dapat menggunakan ID ini untuk menentukan pesan dalam permintaan dengan mengganti |
sender |
Hanya output. Pengguna yang membuat pesan. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, output akan mengisi pengguna |
createTime |
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. |
lastUpdateTime |
Hanya output. Waktu saat pesan terakhir diedit oleh pengguna. Jika pesan belum pernah diedit, kolom ini kosong. |
deleteTime |
Hanya output. Waktu saat pesan dihapus di Google Chat. Jika pesan tidak pernah dihapus, kolom ini kosong. |
text |
Isi teks biasa pesan. 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. |
formattedText |
Hanya output. Berisi pesan
Untuk informasi selengkapnya, baca Melihat format teks yang dikirim dalam pesan |
cards[] |
Tidak digunakan lagi: Sebagai gantinya, gunakan Kartu lengkap, 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 teks biasa pada pesan. Ukuran maksimum |
cardsV2[] |
Array kartu. Hanya aplikasi Chat yang dapat membuat kartu. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, pesan tidak dapat berisi kartu. Untuk mempelajari cara membuat pesan yang berisi kartu, lihat Mengirim pesan. Desain dan pratinjau kartu dengan Card Builder. Membuka Card Builder |
annotations[] |
Hanya output. Anotasi yang terkait dengan |
thread |
Rangkaian pesan tempat pesan berada. Untuk mengetahui contoh penggunaannya, lihat Memulai atau membalas rangkaian pesan. |
space |
Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, output akan mengisi ruang |
fallbackText |
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. |
argumentText |
Hanya output. Isi teks biasa pesan dengan semua sebutan di aplikasi Chat dihapus. |
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 |
Opsional. ID kustom untuk pesan. Anda dapat menggunakan kolom untuk mengidentifikasi pesan, atau untuk mendapatkan, menghapus, atau memperbarui pesan. Untuk menetapkan ID kustom, tentukan kolom |
emojiReactionSummaries[] |
Hanya output. Daftar ringkasan reaksi emoji di pesan. |
privateMessageViewer |
Tidak dapat diubah. Input untuk membuat pesan, atau hanya output. Pengguna yang dapat melihat pesan. Jika disetel, pesan akan bersifat pribadi dan hanya terlihat oleh pengguna tertentu dan aplikasi Chat. Untuk menyertakan kolom ini dalam permintaan, Anda harus memanggil Chat API menggunakan autentikasi aplikasi dan menghapus hal berikut: Untuk mengetahui detailnya, lihat Mengirim pesan secara pribadi. |
deletionMetadata |
Hanya output. Informasi tentang pesan yang dihapus. Pesan dihapus saat |
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. |
accessoryWidgets[] |
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. Pembuatan pesan dengan widget aksesori memerlukan autentikasi aplikasi. |
CardWithId
Kartu di pesan Google Chat.
Hanya aplikasi Chat yang dapat membuat kartu. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, pesan tidak dapat berisi kartu.
Desain dan pratinjau kartu dengan Card Builder.
Membuka Card BuilderRepresentasi JSON |
---|
{
"cardId": string,
"card": {
object ( |
Kolom | |
---|---|
cardId |
Wajib ada jika pesan berisi beberapa kartu. ID unik untuk kartu dalam pesan. |
card |
Kartu. Ukuran maksimum adalah 32 KB. |
Annotation
Hanya output. Anotasi yang terkait dengan isi teks biasa pada pesan. Untuk menambahkan pemformatan dasar ke pesan teks, 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 sesuai dengan anotasi ini. |
startIndex |
Indeks awal (berbasis 0, inklusif) dalam isi pesan teks biasa yang sesuai dengan anotasi ini. |
Kolom union metadata . Metadata tambahan tentang anotasi. metadata hanya dapat berupa salah satu dari berikut: |
|
userMention |
Metadata sebutan pengguna. |
slashCommand |
Metadata untuk perintah garis miring. |
richLinkMetadata |
Metadata untuk link kaya. |
AnnotationType
Jenis anotasi.
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
USER_MENTION |
Pengguna disebutkan. |
SLASH_COMMAND |
Perintah garis miring dipanggil. |
RICH_LINK |
Anotasi rich link. |
UserMentionMetadata
Metadata anotasi untuk sebutan pengguna (@).
Representasi JSON |
---|
{ "user": { object ( |
Kolom | |
---|---|
user |
Pengguna menyebutkan. |
type |
Jenis sebutan pengguna. |
Jenis
Enum | |
---|---|
TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
ADD |
Tambahkan pengguna ke ruang. |
MENTION |
Sebutkan pengguna di 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 ditujukan untuk dialog. |
Jenis
Enum | |
---|---|
TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
ADD |
Tambahkan aplikasi Chat ke ruang. |
INVOKE |
Panggil perintah garis miring di ruang. |
RichLinkMetadata
Link lengkap ke referensi.
Representasi JSON |
---|
{ "uri": string, "richLinkType": enum ( |
Kolom | |
---|---|
uri |
URI link ini. |
richLinkType |
Jenis link multimedia. |
Kolom union data . Data untuk resource tertaut. data hanya dapat berupa salah satu dari berikut: |
|
driveLinkData |
Data untuk link drive. |
chatSpaceLinkData |
Data untuk link ruang chat. |
RichLinkType
Jenis link multimedia. Jenis lainnya mungkin ditambahkan di masa mendatang.
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
DRIVE_FILE |
Jenis link kaya Google Drive. |
CHAT_SPACE |
Jenis link kaya ruang Chat. Misalnya, smart chip ruang. |
DriveLinkData
Data untuk penautan Google Drive.
Representasi JSON |
---|
{
"driveDataRef": {
object ( |
Kolom | |
---|---|
driveDataRef |
DriveDataRef yang mereferensikan file Google Drive. |
mimeType |
Jenis mime resource Google Drive yang ditautkan. |
ChatSpaceLinkData
Data untuk link ruang Chat.
Representasi JSON |
---|
{ "space": string, "thread": string, "message": string } |
Kolom | |
---|---|
space |
Ruang resource ruang Chat yang ditautkan. Format: |
thread |
Thread dari resource ruang Chat yang ditautkan. Format: |
message |
Pesan resource ruang Chat yang ditautkan. Format: |
Rangkaian pesan
Rangkaian pesan di ruang Google Chat. Untuk mengetahui contoh penggunaannya, lihat Memulai atau membalas rangkaian pesan.
Jika menentukan rangkaian pesan saat membuat pesan, Anda dapat menetapkan kolom messageReplyOption
untuk menentukan apa yang terjadi jika tidak ditemukan rangkaian pesan yang cocok.
Representasi JSON |
---|
{ "name": string, "threadKey": string } |
Kolom | |
---|---|
name |
Nama resource thread. Contoh: |
threadKey |
Opsional. Input untuk membuat atau mengupdate thread. Jika tidak, hanya output. ID untuk thread. Mendukung hingga 4000 karakter. ID ini unik untuk aplikasi Chat yang menetapkannya. Misalnya, jika beberapa aplikasi Chat membuat pesan menggunakan kunci rangkaian pesan yang sama, pesan-pesan tersebut akan diposting di rangkaian pesan yang berbeda. Untuk membalas dalam rangkaian pesan yang dibuat oleh seseorang atau aplikasi Chat lain, tentukan kolom |
ActionResponse
Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting.
Representasi JSON |
---|
{ "type": enum ( |
Kolom | |
---|---|
type |
Input saja. Jenis respons aplikasi Chat. |
url |
Input saja. URL untuk pengguna untuk diautentikasi atau dikonfigurasi. (Hanya untuk |
dialogAction |
Input saja. Respons terhadap peristiwa interaksi yang terkait dengan dialog. Harus disertai dengan |
updatedWidget |
Input saja. Respons dari widget yang diupdate. |
ResponseType
Jenis respons aplikasi Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Jenis default yang ditangani sebagai NEW_MESSAGE . |
NEW_MESSAGE |
Memposting sebagai pesan baru dalam topik. |
UPDATE_MESSAGE |
Update pesan aplikasi Chat. Ini hanya diizinkan pada peristiwa CARD_CLICKED yang jenis pengirim pesannya adalah BOT . |
UPDATE_USER_MESSAGE_CARDS |
Perbarui kartu pada pesan pengguna. Pesan ini hanya diizinkan sebagai respons terhadap peristiwa MESSAGE dengan URL yang cocok, atau peristiwa CARD_CLICKED yang jenis pengirim pesannya adalah HUMAN . Teks diabaikan. |
REQUEST_CONFIG |
Minta pengguna untuk melakukan autentikasi atau konfigurasi tambahan secara pribadi. |
DIALOG |
Menampilkan dialog. |
UPDATE_WIDGET |
Kueri opsi pelengkapan otomatis teks widget. |
DialogAction
Berisi dialog dan kode status permintaan.
Representasi JSON |
---|
{ "actionStatus": { object ( |
Kolom | |
---|---|
actionStatus |
Input saja. Status permintaan untuk memanggil atau mengirimkan dialog. Menampilkan status dan pesan kepada pengguna, jika perlu. Misalnya, jika terjadi error atau berhasil. |
Kolom union action . Tindakan yang akan dilakukan. action hanya dapat berupa salah satu dari berikut: |
|
dialog |
Input saja. Dialog untuk permintaan. |
Dialog
Wrapper di sekitar isi kartu dialog.
Representasi JSON |
---|
{
"body": {
object ( |
Kolom | |
---|---|
body |
Input saja. Isi dialog, yang dirender dalam modal. Aplikasi Google Chat tidak mendukung entitas kartu berikut: |
ActionStatus
Merepresentasikan status permintaan untuk memanggil atau mengirimkan dialog.
Representasi JSON |
---|
{
"statusCode": enum ( |
Kolom | |
---|---|
statusCode |
Kode status. |
userFacingMessage |
Pesan untuk dikirim kepada pengguna tentang status permintaan mereka. Jika tidak disetel, pesan umum berdasarkan |
Kode
Kode error kanonis pada gRPC API.
Terkadang beberapa kode error dapat terjadi. Layanan seharusnya menampilkan kode error paling spesifik yang berlaku. Misalnya, lebih memilih menampilkan OUT_OF_RANGE
daripada FAILED_PRECONDITION
jika kedua kode berlaku. Demikian pula, untuk lebih memilih menampilkan NOT_FOUND
atau ALREADY_EXISTS
daripada FAILED_PRECONDITION
.
Enum | |
---|---|
OK |
Bukan error; ditampilkan jika berhasil. Pemetaan HTTP: 200 OK |
CANCELLED |
Operasi dibatalkan, biasanya oleh pemanggil. Pemetaan HTTP: 499 Client Closed Request |
UNKNOWN |
Error tidak diketahui. Misalnya, error ini dapat ditampilkan jika nilai Pemetaan HTTP: Error Server Internal 500 |
INVALID_ARGUMENT |
Klien menetapkan argumen yang tidak valid. Perhatikan bahwa ini berbeda dengan Pemetaan HTTP: 400 Permintaan Tidak Valid |
DEADLINE_EXCEEDED |
Batas waktu berakhir sebelum operasi selesai. Untuk operasi yang mengubah keadaan sistem, error ini mungkin ditampilkan, bahkan jika, operasi tersebut telah selesai. Sebagai contoh, respons berhasil dari suatu server dapat tertunda selama waktu yang cukup lama hingga tenggat waktu berakhir. Pemetaan HTTP: 504 Gateway Timeout |
NOT_FOUND |
Beberapa entity yang diminta (misalnya, file atau direktori) tidak ditemukan. Catatan bagi developer server: apabila suatu permintaan ditolak pada seluruh kelas pengguna, seperti peluncuran bertahap, atau daftar yang diberi akses, Pemetaan HTTP: 404 Not Found |
ALREADY_EXISTS |
Entitas yang coba dibuat oleh klien (misalnya, file atau direktori) sudah ada. Pemetaan HTTP: 409 Conflict |
PERMISSION_DENIED |
Pemanggil tidak memiliki izin untuk menjalankan operasi yang ditentukan. Pemetaan HTTP: 403 Forbidden |
UNAUTHENTICATED |
Permintaan tidak memiliki kredensial autentikasi operasi yang valid. Pemetaan HTTP: 401 Tidak Sah |
RESOURCE_EXHAUSTED |
Beberapa resource telah habis, kemungkinan adalah kuota per pengguna, atau kemungkinan seluruh sistem file kehabisan ruang. Pemetaan HTTP: 429 Too Many Requests |
FAILED_PRECONDITION |
Operasi tersebut ditolak karena sistem tidak dalam keadaan dibutuhkan untuk menjalankan operasi. Misalnya, direktori yang akan dihapus tidak kosong, operasi rmdir diterapkan pada non-direktori, dll. Pelaksana layanan dapat menggunakan panduan berikut untuk menentukan manakah yang paling sesuai di antara Pemetaan HTTP: 400 Permintaan Tidak Valid |
ABORTED |
Operasi dibatalkan, umumnya karena masalah konkurensi seperti kegagalan pemeriksaan pengurut atau pembatalan transaksi. Lihat panduan di atas untuk menentukan manakah yang sesuai antara Pemetaan HTTP: 409 Conflict |
OUT_OF_RANGE |
Upaya operasi dilakukan melampaui rentang yang valid. Mis., mencari tahu atau membaca melampaui akhir file. Tidak seperti Terdapat sedikit tumpang-tindih antara Pemetaan HTTP: 400 Permintaan Tidak Valid |
UNIMPLEMENTED |
Operasi tidak diterapkan atau tidak didukung/diaktifkan dalam layanan ini. Pemetaan HTTP: 501 Not Implemented |
INTERNAL |
Error internal. Artinya beberapa invarian yang diperlukan oleh sistem pokok telah rusak. Kode error ini disediakan untuk error yang bersifat serius. Pemetaan HTTP: Error Server Internal 500 |
UNAVAILABLE |
Saat ini layanan tidak tersedia. Kemungkinan besar ini hanya kondisi sementara, yang dapat diperbaiki dengan mencoba kembali menggunakan backoff. Perlu diketahui bahwa mencoba kembali operasi non-idempoten tidak selalu aman. Lihat panduan di atas untuk menentukan manakah yang sesuai antara Pemetaan HTTP: 503 Layanan Tidak Tersedia |
DATA_LOSS |
Data hilang atau rusak yang tidak dapat dipulihkan. Pemetaan HTTP: Error Server Internal 500 |
UpdatedWidget
Respons dari widget yang diupdate. Digunakan untuk memberikan opsi pelengkapan otomatis untuk widget.
Representasi JSON |
---|
{ "widget": string, // Union field |
Kolom | |
---|---|
widget |
ID widget yang diperbarui. ID harus cocok dengan ID untuk widget yang memicu permintaan update. |
Kolom union updated_widget . Widget diupdate sebagai respons terhadap tindakan pengguna. updated_widget hanya dapat berupa salah satu dari berikut: |
|
suggestions |
Daftar hasil pelengkapan otomatis widget |
SelectionItems
Daftar hasil pelengkapan otomatis widget.
Representasi JSON |
---|
{
"items": [
{
object ( |
Kolom | |
---|---|
items[] |
Array objek SelectionItem. |
SlashCommand
Perintah garis miring di Google Chat.
Representasi JSON |
---|
{ "commandId": string } |
Kolom | |
---|---|
commandId |
ID perintah garis miring yang dipanggil. |
MatchedUrl
URL yang cocok dalam pesan Chat. Aplikasi Chat dapat melihat pratinjau URL yang cocok. Untuk informasi selengkapnya, lihat Pratinjau link.
Representasi JSON |
---|
{ "url": string } |
Kolom | |
---|---|
url |
Hanya output. URL yang cocok. |
EmojiReactionSummary
Jumlah orang yang memberi reaksi pada pesan dengan emoji tertentu.
Representasi JSON |
---|
{
"emoji": {
object ( |
Kolom | |
---|---|
emoji |
Emoji yang terkait dengan reaksi. |
reactionCount |
Jumlah total reaksi yang menggunakan emoji terkait. |
DeletionMetadata
Informasi tentang pesan yang dihapus. Pesan dihapus saat deleteTime
ditetapkan.
Representasi JSON |
---|
{
"deletionType": enum ( |
Kolom | |
---|---|
deletionType |
Menunjukkan siapa yang menghapus pesan. |
DeletionType
Siapa yang menghapus pesan dan bagaimana pesan dihapus.
Enum | |
---|---|
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. |
QuotedMessageMetadata
Informasi tentang pesan yang dikutip.
Representasi JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Kolom | |
---|---|
name |
Hanya output. Nama resource dari pesan yang dikutip. Format: |
lastUpdateTime |
Hanya output. Stempel waktu saat pesan yang dikutip dibuat atau saat pesan yang dikutip terakhir diperbarui. |
AttachedGif
Gambar GIF yang ditentukan oleh URL.
Representasi JSON |
---|
{ "uri": string } |
Kolom | |
---|---|
uri |
Hanya output. URL yang menghosting gambar GIF. |
AccessoryWidget
Satu atau beberapa widget interaktif yang muncul di bagian bawah pesan. Untuk mengetahui detailnya, lihat Menambahkan widget interaktif di bagian bawah pesan.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union action . Jenis tindakan. action hanya dapat berupa salah satu dari berikut: |
|
buttonList |
Daftar tombol. |
Metode |
|
---|---|
|
Membuat pesan di ruang Google Chat. |
|
Menghapus pesan. |
|
Menampilkan detail tentang pesan. |
|
Mencantumkan pesan dalam ruang tempat pemanggil menjadi anggota, termasuk pesan dari anggota dan ruang yang diblokir. |
|
Memperbarui pesan. |
|
Memperbarui pesan. |