Indeks
ChatService
(antarmuka)AccessoryWidget
(pesan)ActionResponse
(pesan)ActionResponse.ResponseType
(enum)ActionResponse.SelectionItems
(pesan)ActionResponse.UpdatedWidget
(pesan)ActionStatus
(pesan)Annotation
(pesan)AnnotationType
(enum)AttachedGif
(pesan)Attachment
(pesan)Attachment.Source
(enum)AttachmentDataRef
(pesan)CardWithId
(pesan)ChatSpaceLinkData
(pesan)CompleteImportSpaceRequest
(pesan)CompleteImportSpaceResponse
(pesan)ContextualAddOnMarkup
(pesan)ContextualAddOnMarkup.Card
(pesan)ContextualAddOnMarkup.Card.CardAction
(pesan)ContextualAddOnMarkup.Card.CardHeader
(pesan)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum)ContextualAddOnMarkup.Card.Section
(pesan)CreateMembershipRequest
(pesan)CreateMessageRequest
(pesan)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(pesan)CreateSpaceRequest
(pesan)CustomEmoji
(pesan)DeleteMembershipRequest
(pesan)DeleteMessageRequest
(pesan)DeleteReactionRequest
(pesan)DeleteSpaceRequest
(pesan)DeletionMetadata
(pesan)DeletionMetadata.DeletionType
(enum)Dialog
(pesan)DialogAction
(pesan)DriveDataRef
(pesan)DriveLinkData
(pesan)Emoji
(pesan)EmojiReactionSummary
(pesan)FindDirectMessageRequest
(pesan)GetAttachmentRequest
(pesan)GetMembershipRequest
(pesan)GetMessageRequest
(pesan)GetSpaceEventRequest
(pesan)GetSpaceReadStateRequest
(pesan)GetSpaceRequest
(pesan)GetThreadReadStateRequest
(pesan)Group
(pesan)HistoryState
(enum)ListMembershipsRequest
(pesan)ListMembershipsResponse
(pesan)ListMessagesRequest
(pesan)ListMessagesResponse
(pesan)ListReactionsRequest
(pesan)ListReactionsResponse
(pesan)ListSpaceEventsRequest
(pesan)ListSpaceEventsResponse
(pesan)ListSpacesRequest
(pesan)ListSpacesResponse
(pesan)MatchedUrl
(pesan)Membership
(pesan)Membership.MembershipRole
(enum)Membership.MembershipState
(enum)MembershipBatchCreatedEventData
(pesan)MembershipBatchDeletedEventData
(pesan)MembershipBatchUpdatedEventData
(pesan)MembershipCreatedEventData
(pesan)MembershipDeletedEventData
(pesan)MembershipUpdatedEventData
(pesan)Message
(pesan)MessageBatchCreatedEventData
(pesan)MessageBatchDeletedEventData
(pesan)MessageBatchUpdatedEventData
(pesan)MessageCreatedEventData
(pesan)MessageDeletedEventData
(pesan)MessageUpdatedEventData
(pesan)QuotedMessageMetadata
(pesan)Reaction
(pesan)ReactionBatchCreatedEventData
(pesan)ReactionBatchDeletedEventData
(pesan)ReactionCreatedEventData
(pesan)ReactionDeletedEventData
(pesan)RichLinkMetadata
(pesan)RichLinkMetadata.RichLinkType
(enum)SearchSpacesRequest
(pesan)SearchSpacesResponse
(pesan)SetUpSpaceRequest
(pesan)SlashCommand
(pesan)SlashCommandMetadata
(pesan)SlashCommandMetadata.Type
(enum)Space
(pesan)Space.AccessSettings
(pesan)Space.AccessSettings.AccessState
(enum)Space.MembershipCount
(pesan)Space.PermissionSetting
(pesan)Space.PermissionSettings
(pesan)Space.PredefinedPermissionSettings
(enum)Space.SpaceDetails
(pesan)Space.SpaceThreadingState
(enum)Space.SpaceType
(enum)Space.Type
(enum)SpaceBatchUpdatedEventData
(pesan)SpaceEvent
(pesan)SpaceReadState
(pesan)SpaceUpdatedEventData
(pesan)Thread
(pesan)ThreadReadState
(pesan)UpdateMembershipRequest
(pesan)UpdateMessageRequest
(pesan)UpdateSpaceReadStateRequest
(pesan)UpdateSpaceRequest
(pesan)User
(pesan)User.Type
(enum)UserMentionMetadata
(pesan)UserMentionMetadata.Type
(enum)WidgetMarkup
(pesan)WidgetMarkup.Button
(pesan)WidgetMarkup.FormAction
(pesan)WidgetMarkup.FormAction.ActionParameter
(pesan)WidgetMarkup.Icon
(enum)WidgetMarkup.Image
(pesan)WidgetMarkup.ImageButton
(pesan)WidgetMarkup.KeyValue
(pesan)WidgetMarkup.OnClick
(pesan)WidgetMarkup.OpenLink
(pesan)WidgetMarkup.TextButton
(pesan)WidgetMarkup.TextParagraph
(pesan)
ChatService
Memungkinkan developer membangun aplikasi dan integrasi Chat di Platform Google Chat.
CompleteImportSpace |
---|
Menyelesaikan proses impor untuk ruang yang ditentukan dan membuatnya terlihat oleh pengguna. Memerlukan autentikasi aplikasi dan delegasi tingkat domain. Untuk mengetahui informasi selengkapnya, lihat Mengizinkan aplikasi Google Chat untuk mengimpor data.
|
CreateMembership |
---|
Membuat keanggotaan untuk aplikasi Chat panggilan, pengguna, atau grup Google. Pembuatan keanggotaan untuk aplikasi Chat lain tidak didukung. Saat membuat langganan, jika anggota yang ditentukan menonaktifkan kebijakan terima otomatis, mereka akan diundang dan harus menerima undangan ruang sebelum bergabung. Jika tidak, pembuatan langganan akan menambahkan anggota langsung ke ruang yang ditentukan. Memerlukan autentikasi pengguna. Untuk contoh penggunaan, lihat:
|
CreateMessage |
---|
Membuat pesan di ruang Google Chat. Untuk contoh, lihat Mengirim pesan. Metode Gambar berikut menunjukkan cara Chat mengatribusikan pesan saat Anda menggunakan autentikasi aplikasi. Chat menampilkan aplikasi Chat sebagai pengirim pesan. Konten pesan dapat berisi teks ( Gambar berikut menunjukkan cara Chat mengatribusikan pesan saat Anda menggunakan autentikasi pengguna. Chat menampilkan pengguna sebagai pengirim pesan dan mengatribusikan aplikasi Chat ke pesan dengan menampilkan namanya. Konten pesan hanya boleh berisi teks ( Ukuran pesan maksimum, termasuk konten pesan, adalah 32.000 byte.
|
CreateReaction |
---|
Membuat reaksi dan menambahkannya ke pesan. Hanya emoji unicode yang didukung. Sebagai contoh, lihat Menambahkan reaksi pada pesan. Memerlukan autentikasi pengguna.
|
CreateSpace |
---|
Membuat ruang tanpa anggota. Dapat digunakan untuk membuat ruang yang diberi nama. Ruang yang dikelompokkan menurut topik tidak didukung. Sebagai contoh, lihat Membuat ruang. Jika Anda menerima pesan error Jika Anda adalah anggota program Pratinjau Developer, Anda dapat membuat chat grup dalam mode impor menggunakan Memerlukan autentikasi pengguna.
|
DeleteMembership |
---|
Menghapus keanggotaan. Sebagai contoh, lihat Menghapus pengguna atau aplikasi Google Chat dari ruang. Memerlukan autentikasi pengguna.
|
DeleteMessage |
---|
Menghapus pesan. Sebagai contoh, lihat Menghapus pesan. Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna. Saat menggunakan autentikasi aplikasi, permintaan hanya dapat menghapus pesan yang dibuat oleh aplikasi Chat panggilan.
|
DeleteReaction |
---|
Menghapus reaksi terhadap pesan. Hanya emoji unicode yang didukung. Untuk mengetahui contohnya, lihat Menghapus reaksi. Memerlukan autentikasi pengguna.
|
DeleteSpace |
---|
Menghapus ruang yang diberi nama. Selalu melakukan penghapusan beruntun, yang berarti resource turunan ruang, seperti pesan yang diposting dalam ruang dan keanggotaan dalam ruang, juga akan dihapus. Sebagai contoh, lihat Menghapus ruang. Memerlukan autentikasi pengguna dari pengguna yang memiliki izin untuk menghapus ruang.
|
FindDirectMessage |
---|
Menampilkan pesan langsung yang sudah ada dengan pengguna yang ditentukan. Jika ruang pesan langsung tidak ditemukan, error Dengan autentikasi pengguna, menampilkan ruang pesan langsung antara pengguna yang ditentukan dan pengguna terautentikasi. Dengan autentikasi aplikasi, menampilkan ruang pesan langsung antara pengguna yang ditentukan dan aplikasi Chat panggilan. Memerlukan autentikasi pengguna atau autentikasi aplikasi.
|
GetAttachment |
---|
Mendapatkan metadata lampiran pesan. Data lampiran diambil menggunakan API media. Sebagai contoh, lihat Mendapatkan metadata tentang lampiran pesan. Memerlukan autentikasi aplikasi.
|
GetMembership |
---|
Menampilkan detail tentang langganan. Misalnya, lihat Mendapatkan detail tentang keanggotaan pengguna atau aplikasi Google Chat. Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna.
|
GetMessage |
---|
Menampilkan detail tentang pesan. Sebagai contoh, lihat Mendapatkan detail tentang pesan. Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna. Catatan: Mungkin menampilkan pesan dari anggota atau ruang yang diblokir.
|
GetSpace |
---|
Menampilkan detail tentang ruang. Sebagai contoh, lihat Mendapatkan detail tentang ruang. Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna.
|
GetSpaceEvent |
---|
Menampilkan peristiwa dari ruang Google Chat. Payload peristiwa berisi versi terbaru resource yang berubah. Misalnya, jika Anda meminta peristiwa tentang pesan baru, tetapi pesan tersebut kemudian diperbarui, server akan menampilkan resource Memerlukan autentikasi pengguna. Untuk mendapatkan acara, pengguna yang diautentikasi harus menjadi anggota ruang. Sebagai contoh, lihat Mendapatkan detail acara dari ruang Google Chat.
|
GetSpaceReadState |
---|
Menampilkan detail tentang status sudah dibaca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang sudah dibaca dan belum dibaca. Sebagai contoh, lihat Mendapatkan detail tentang status pembacaan ruang pengguna. Memerlukan autentikasi pengguna.
|
GetThreadReadState |
---|
Menampilkan detail tentang status sudah dibaca pengguna dalam rangkaian pesan, yang digunakan untuk mengidentifikasi pesan yang sudah dibaca dan belum dibaca. Sebagai contoh, lihat Mendapatkan detail tentang status pembacaan thread pengguna. Memerlukan autentikasi pengguna.
|
ListMemberships |
---|
Mencantumkan keanggotaan dalam ruang. Sebagai contoh, lihat Mencantumkan pengguna dan aplikasi Google Chat dalam ruang. Keanggotaan listingan dengan autentikasi aplikasi mencantumkan keanggotaan dalam ruang yang dapat diakses aplikasi Chat, tetapi tidak menyertakan keanggotaan aplikasi Chat, termasuk keanggotaannya sendiri. Keanggotaan listingan dengan Autentikasi pengguna mencantumkan keanggotaan dalam ruang yang dapat diakses oleh pengguna terautentikasi. Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna.
|
ListMessages |
---|
Mencantumkan pesan dalam ruang tempat pemanggil menjadi anggota, termasuk pesan dari anggota dan ruang yang diblokir. Jika Anda mencantumkan pesan dari ruang tanpa pesan, responsnya adalah objek kosong. Saat menggunakan antarmuka REST/HTTP, respons akan berisi objek JSON kosong,
|
ListReactions |
---|
Mencantumkan reaksi terhadap pesan. Untuk mengetahui contohnya, lihat Membuat daftar reaksi untuk pesan. Memerlukan autentikasi pengguna.
|
ListSpaceEvents |
---|
Mencantumkan peristiwa dari ruang Google Chat. Untuk setiap peristiwa, payload berisi resource Chat versi terbaru. Misalnya, jika Anda mencantumkan peristiwa tentang anggota ruang baru, server akan menampilkan resource Memerlukan autentikasi pengguna. Untuk mencantumkan peristiwa, pengguna yang diautentikasi harus menjadi anggota ruang. Sebagai contoh, lihat Mencantumkan peristiwa dari ruang Google Chat.
|
ListSpaces |
---|
Mencantumkan ruang tempat pemanggil menjadi anggota. Chat grup dan DM tidak dicantumkan hingga pesan pertama dikirim. Sebagai contoh, lihat Daftar ruang. Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna. Mencantumkan ruang yang terlihat oleh pemanggil atau pengguna yang diautentikasi. Chat grup dan DM tidak dicantumkan hingga pesan pertama dikirim. Untuk mencantumkan semua ruang bernama menurut organisasi Google Workspace, gunakan metode
|
SearchSpaces |
---|
use_admin_access ke true .
|
SetUpSpace |
---|
Membuat ruang dan menambahkan pengguna tertentu ke ruang tersebut. Pengguna yang menelepon akan otomatis ditambahkan ke ruang, dan tidak boleh ditentukan sebagai keanggotaan dalam permintaan. Sebagai contoh, lihat Menyiapkan ruang dengan anggota awal. Untuk menentukan anggota manusia yang akan ditambahkan, tambahkan keanggotaan dengan Untuk menentukan grup Google yang akan ditambahkan, tambahkan keanggotaan dengan Untuk ruang atau chat grup yang telah diberi nama, jika pemanggil memblokir atau diblokir oleh beberapa anggota, atau tidak memiliki izin untuk menambahkan beberapa anggota, anggota tersebut tidak akan ditambahkan ke ruang yang dibuat. Untuk membuat pesan langsung (DM) antara pengguna yang menelepon dan pengguna manusia lainnya, tentukan dengan tepat satu keanggotaan untuk mewakili pengguna manusia. Jika satu pengguna memblokir pengguna lainnya, permintaan akan gagal dan DM tidak dibuat. Untuk membuat DM antara pengguna yang menelepon dan aplikasi panggilan, tetapkan Jika DM sudah ada di antara dua pengguna, meskipun satu pengguna memblokir pengguna lainnya pada saat permintaan dibuat, DM yang sudah ada akan ditampilkan. Ruang dengan balasan berangkai tidak didukung. Jika Anda menerima pesan error Memerlukan autentikasi pengguna.
|
UpdateMembership |
---|
Memperbarui langganan. Misalnya, lihat Memperbarui langganan pengguna di ruang. Memerlukan autentikasi pengguna.
|
UpdateMessage |
---|
Memperbarui pesan. Terdapat perbedaan antara metode Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna. Saat menggunakan autentikasi aplikasi, permintaan hanya dapat memperbarui pesan yang dibuat oleh aplikasi Chat panggilan.
|
UpdateSpace |
---|
Memperbarui ruang. Sebagai contoh, lihat Memperbarui ruang. Jika Anda memperbarui kolom Memerlukan autentikasi pengguna.
|
UpdateSpaceReadState |
---|
Memperbarui status dibaca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang sudah dibaca dan belum dibaca. Misalnya, lihat Memperbarui status pembacaan ruang pengguna. Memerlukan autentikasi pengguna.
|
AccessoryWidget
Satu atau beberapa widget interaktif yang muncul di bagian bawah pesan. Untuk mengetahui detailnya, lihat Menambahkan widget interaktif di bagian bawah pesan.
Kolom | |
---|---|
Kolom union action . Jenis tindakan. action hanya dapat berupa salah satu dari berikut: |
|
button_list |
Daftar tombol. |
ActionResponse
Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting.
Kolom | |
---|---|
type |
Input saja. Jenis respons aplikasi Chat. |
url |
Input saja. URL untuk pengguna untuk diautentikasi atau dikonfigurasi. (Hanya untuk |
dialog_action |
Input saja. Respons terhadap peristiwa interaksi yang terkait dengan dialog. Harus disertai dengan |
updated_widget |
Hanya input. 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. |
SelectionItems
Daftar hasil pelengkapan otomatis widget.
Kolom | |
---|---|
items[] |
Array objek SelectionItem. |
UpdatedWidget
Respons dari widget yang diupdate. Digunakan untuk memberikan opsi pelengkapan otomatis untuk widget.
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 |
ActionStatus
Merepresentasikan status permintaan untuk memanggil atau mengirimkan dialog.
Kolom | |
---|---|
status_code |
Kode status. |
user_facing_message |
Pesan untuk dikirim kepada pengguna tentang status permintaan mereka. Jika tidak disetel, pesan umum berdasarkan |
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"
}
}]
Kolom | |
---|---|
type |
Jenis anotasi ini. |
length |
Panjang substring dalam isi pesan teks biasa yang sesuai dengan anotasi ini. |
start_index |
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: |
|
user_mention |
Metadata sebutan pengguna. |
slash_command |
Metadata untuk perintah garis miring. |
rich_link_metadata |
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. |
AttachedGif
Gambar GIF yang ditentukan oleh URL.
Kolom | |
---|---|
uri |
Hanya output. URL yang menghosting gambar GIF. |
Lampiran
Lampiran di Google Chat.
Kolom | |
---|---|
name |
Nama resource lampiran, dalam bentuk |
content_name |
Hanya output. Nama file asli untuk konten, bukan jalur lengkap. |
content_type |
Hanya output. Jenis konten (jenis MIME) dari file. |
thumbnail_uri |
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. |
download_uri |
Hanya output. URL download yang harus digunakan agar pengguna manusia dapat mendownload lampiran tersebut. Aplikasi chat tidak boleh menggunakan URL ini untuk mendownload konten lampiran. |
source |
Hanya output. Sumber lampiran. |
Kolom union data_ref . Referensi data ke lampiran tersebut. data_ref hanya dapat berupa salah satu dari berikut: |
|
attachment_data_ref |
Referensi ke data lampiran. Kolom ini digunakan dengan media API untuk mendownload data lampiran. |
drive_data_ref |
Hanya output. Referensi ke lampiran Google Drive. Kolom ini digunakan dengan Google Drive API. |
Sumber
Sumber lampiran.
Enum | |
---|---|
SOURCE_UNSPECIFIED |
Direservasi. |
DRIVE_FILE |
File tersebut adalah file Google Drive. |
UPLOADED_CONTENT |
File akan diupload ke Chat. |
AttachmentDataRef
Referensi ke data lampiran.
Kolom | |
---|---|
resource_name |
Nama resource data lampiran. Kolom ini digunakan dengan API media untuk mendownload data lampiran. |
attachment_upload_token |
Token buram yang berisi referensi ke lampiran yang diupload. Diperlakukan oleh klien sebagai string buram dan digunakan untuk membuat atau memperbarui pesan Chat dengan lampiran. |
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 BuilderKolom | |
---|---|
card_id |
Wajib ada jika pesan berisi beberapa kartu. ID unik untuk kartu dalam pesan. |
card |
Kartu. Ukuran maksimum adalah 32 KB. |
ChatSpaceLinkData
Data untuk link ruang Chat.
Kolom | |
---|---|
space |
Ruang resource ruang Chat tertaut. Format: |
thread |
Rangkaian pesan resource ruang Chat tertaut. Format: |
message |
Pesan resource ruang Chat yang ditautkan. Format: |
CompleteImportSpaceRequest
Pesan permintaan untuk menyelesaikan proses impor ruang.
Kolom | |
---|---|
name |
Wajib. Nama resource ruang mode impor. Format: |
CompleteImportSpaceResponse
Pesan respons untuk menyelesaikan proses impor ruang.
Kolom | |
---|---|
space |
Ruang mode impor. |
ContextualAddOnMarkup
Jenis ini tidak memiliki kolom.
Markup bagi developer untuk menentukan konten AddOn kontekstual.
Kartu
Kartu adalah elemen UI yang dapat berisi widget UI seperti teks dan gambar.
Kolom | |
---|---|
header |
Header kartu. {i>Header<i} biasanya berisi judul dan gambar. |
sections[] |
Bagian dipisahkan oleh pemisah garis. |
card_actions[] |
Tindakan kartu ini. |
name |
Nama kartu. |
CardAction
Tindakan kartu adalah tindakan yang terkait dengan kartu. Untuk kartu invoice, tindakan yang umum dilakukan adalah: menghapus invoice, mengirim invoice melalui email, atau membuka invoice di browser.
Tidak didukung oleh aplikasi Google Chat.
Kolom | |
---|---|
action_label |
Label yang biasa ditampilkan di item menu tindakan. |
on_click |
Tindakan onclick untuk item tindakan ini. |
CardHeader
Kolom | |
---|---|
title |
Judul harus ditetapkan. {i>Header<i} memiliki tinggi tetap: jika judul dan subjudul ditentukan, masing-masing membutuhkan satu baris. Jika hanya judul yang ditentukan, nama tersebut akan menggunakan kedua baris. |
subtitle |
Subjudul header kartu. |
image_style |
Jenis gambar (misalnya, batas persegi atau batas lingkaran). |
image_url |
URL gambar di header kartu. |
ImageStyle
Enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Batas persegi. |
AVATAR |
Batas melingkar. |
Bagian
Bagian berisi kumpulan widget yang dirender (secara vertikal) dalam urutan yang ditentukan. Di semua platform, kartu memiliki lebar tetap yang sempit, sehingga saat ini properti tata letak tidak diperlukan (misalnya, float).
Kolom | |
---|---|
header |
Header bagian. Teks terformat didukung. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. |
widgets[] |
Bagian harus berisi minimal satu widget. |
CreateMembershipRequest
Pesan permintaan untuk membuat keanggotaan.
Kolom | |
---|---|
parent |
Wajib. Nama resource ruang tempat membuat keanggotaan. Format: spasi/{space} |
membership |
Wajib. Hubungan keanggotaan yang akan dibuat. Kolom |
use_admin_access |
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 Pembuatan keanggotaan aplikasi atau membuat keanggotaan untuk pengguna di luar organisasi Google Workspace administrator tidak didukung menggunakan akses admin. |
CreateMessageRequest
Membuat pesan.
Kolom | |
---|---|
parent |
Wajib. Nama resource ruang tempat membuat pesan. Format: |
message |
Wajib. Isi pesan. |
thread_key |
Opsional. Tidak digunakan lagi: Sebagai gantinya, gunakan |
request_id |
Opsional. ID permintaan unik untuk pesan ini. Menentukan ID permintaan yang ada akan menampilkan pesan yang dibuat dengan ID tersebut, bukan membuat pesan baru. |
message_reply_option |
Opsional. Menentukan apakah pesan memulai rangkaian pesan atau membalas rangkaian pesan. Hanya didukung di ruang yang diberi nama. |
message_id |
Opsional. ID kustom untuk pesan. Memungkinkan aplikasi Chat mendapatkan, mengupdate, atau menghapus pesan tanpa perlu menyimpan ID yang ditetapkan sistem dalam nama resource pesan (diwakili dalam kolom Nilai untuk kolom ini harus memenuhi persyaratan berikut:
Untuk mengetahui detailnya, lihat Memberi nama pesan. |
MessageReplyOption
Menentukan cara membalas pesan. Negara bagian lainnya mungkin akan ditambahkan di masa mendatang.
Enum | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Default. Memulai rangkaian pesan baru. Menggunakan opsi ini akan mengabaikan thread ID atau yang disertakan. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Membuat pesan sebagai balasan untuk rangkaian pesan yang ditentukan oleh thread ID atau . Jika gagal, pesan akan memulai rangkaian pesan baru. |
REPLY_MESSAGE_OR_FAIL |
Membuat pesan sebagai balasan untuk rangkaian pesan yang ditentukan oleh thread ID atau . Jika thread_key baru digunakan, thread baru akan dibuat. Jika pembuatan pesan gagal, error NOT_FOUND akan ditampilkan. |
CreateReactionRequest
Membuat reaksi terhadap pesan.
Kolom | |
---|---|
parent |
Wajib. Pesan tempat reaksi dibuat. Format: |
reaction |
Wajib. Reaksi yang akan dibuat. |
CreateSpaceRequest
Permintaan untuk membuat ruang tanpa anggota.
Kolom | |
---|---|
space |
Wajib. Kolom Jika Anda menerima pesan error Jika Anda adalah anggota program Pratinjau Developer, Ruang |
request_id |
Opsional. ID unik untuk permintaan ini. UUID acak direkomendasikan. 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. |
CustomEmoji
Mewakili emoji kustom.
Kolom | |
---|---|
uid |
Hanya output. Kunci unik untuk resource emoji kustom. |
DeleteMembershipRequest
Permintaan untuk menghapus keanggotaan dalam ruang.
Kolom | |
---|---|
name |
Wajib. Nama resource dari keanggotaan yang akan dihapus. Aplikasi Chat dapat menghapus data pengguna atau keanggotaan mereka sendiri. Aplikasi Chat tidak dapat menghapus aplikasi lain keanggotaan. Saat menghapus langganan manusia, memerlukan cakupan Saat menghapus langganan aplikasi, Anda memerlukan cakupan Format: |
use_admin_access |
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 Menghapus keanggotaan aplikasi dalam ruang tidak didukung menggunakan akses admin. |
DeleteMessageRequest
Permintaan untuk menghapus pesan.
Kolom | |
---|---|
name |
Wajib. Nama resource pesan. Format: Jika sudah menetapkan ID kustom untuk pesan, Anda dapat menggunakan nilai dari kolom |
force |
Saat Hanya berlaku saat mengautentikasi sebagai pengguna. Tidak berpengaruh saat mengautentikasi sebagai aplikasi Chat. |
DeleteReactionRequest
Menghapus reaksi terhadap pesan.
Kolom | |
---|---|
name |
Wajib. Nama reaksi yang akan dihapus. Format: |
DeleteSpaceRequest
Permintaan untuk menghapus ruang.
Kolom | |
---|---|
name |
Wajib. Nama resource ruang yang akan dihapus. Format: |
use_admin_access |
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 |
DeletionMetadata
Informasi tentang pesan yang dihapus. Pesan dihapus saat delete_time
disetel.
Kolom | |
---|---|
deletion_type |
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. |
Dialog
Wrapper di sekitar isi kartu dialog.
Kolom | |
---|---|
body |
Input saja. Isi dialog, yang dirender dalam modal. Aplikasi Google Chat tidak mendukung entitas kartu berikut: |
DialogAction
Berisi dialog dan kode status permintaan.
Kolom | |
---|---|
action_status |
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. |
DriveDataRef
Referensi ke data lampiran drive.
Kolom | |
---|---|
drive_file_id |
ID untuk file drive. Gunakan dengan Drive API. |
DriveLinkData
Data untuk link Google Drive.
Kolom | |
---|---|
drive_data_ref |
DriveDataRef yang mereferensikan file Google Drive. |
mime_type |
Jenis mime resource Google Drive tertaut. |
Emoji
Emoji yang digunakan sebagai reaksi terhadap pesan.
Kolom | |
---|---|
Kolom union content . Konten emoji. content hanya dapat berupa salah satu dari berikut: |
|
unicode |
Emoji dasar yang direpresentasikan oleh string unicode. |
custom_emoji |
Hanya output. Emoji kustom. |
EmojiReactionSummary
Jumlah orang yang memberi reaksi pada pesan dengan emoji tertentu.
Kolom | |
---|---|
emoji |
Emoji yang terkait dengan reaksi. |
reaction_count |
Jumlah total reaksi yang menggunakan emoji terkait. |
FindDirectMessageRequest
Permintaan untuk mendapatkan ruang pesan langsung berdasarkan resource pengguna.
Kolom | |
---|---|
name |
Wajib. Nama resource pengguna yang akan dilihat pesan langsungnya. Format: |
GetAttachmentRequest
Permintaan untuk mendapatkan lampiran.
Kolom | |
---|---|
name |
Wajib. Nama resource lampiran, dalam bentuk |
GetMembershipRequest
Meminta untuk mendapatkan langganan ruang.
Kolom | |
---|---|
name |
Wajib. Nama resource dari keanggotaan yang akan diambil. Untuk mendapatkan keanggotaan aplikasi sendiri menggunakan autentikasi pengguna, Anda dapat menggunakan Format: Saat diautentikasi sebagai pengguna, Anda dapat menggunakan email pengguna tersebut sebagai alias untuk |
use_admin_access |
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 Mendapatkan keanggotaan aplikasi di ruang tidak didukung saat menggunakan akses admin. |
GetMessageRequest
Permintaan untuk mendapatkan pesan.
Kolom | |
---|---|
name |
Wajib. Nama resource pesan. Format: Jika sudah menetapkan ID kustom untuk pesan, Anda dapat menggunakan nilai dari kolom |
GetSpaceEventRequest
Pesan permintaan untuk mendapatkan acara ruang.
Kolom | |
---|---|
name |
Wajib. Nama resource acara ruang. Format: |
GetSpaceReadStateRequest
Pesan permintaan untuk GetSpaceReadState API.
Kolom | |
---|---|
name |
Wajib. Nama resource dari status baca ruang yang akan diambil. Hanya mendukung mendapatkan status baca untuk pengguna yang memanggil. Untuk merujuk ke pengguna yang menelepon, tetapkan salah satu opsi berikut:
Format: users/{pengguna}/spaces/{space}/spaceReadState |
GetSpaceRequest
Permintaan untuk menampilkan satu spasi.
Kolom | |
---|---|
name |
Wajib. Nama resource ruang, dalam bentuk Format: |
use_admin_access |
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 |
GetThreadReadStateRequest
Pesan permintaan untuk GetThreadReadStateRequest API.
Kolom | |
---|---|
name |
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 opsi berikut:
Format: pengguna/{pengguna}/ruang/{ruang}/threads/{thread}/threadReadState |
Grup
Grup Google di Google Chat.
Kolom | |
---|---|
name |
Nama resource untuk Google Grup. Merepresentasikan grup di Cloud Identity Groups API. Format: groups/{group} |
HistoryState
Status histori untuk pesan dan ruang. Menentukan durasi penyimpanan pesan dan rangkaian percakapan setelah dibuat.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Nilai default. Jangan gunakan. |
HISTORY_OFF |
Histori nonaktif. Pesan dan rangkaian pesan disimpan selama 24 jam. |
HISTORY_ON |
Histori aktif. Aturan retensi Vault organisasi menentukan durasi penyimpanan pesan dan rangkaian pesan. |
ListMembershipsRequest
Pesan permintaan untuk keanggotaan listingan.
Kolom | |
---|---|
parent |
Wajib. Nama resource ruang tempat daftar keanggotaan akan diambil. Format: spasi/{space} |
page_size |
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 akan otomatis diubah menjadi 1.000. Nilai negatif menampilkan error |
page_token |
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 memberikan hasil yang tidak diharapkan. |
filter |
Opsional. Filter kueri. Anda dapat memfilter keanggotaan berdasarkan peran ( Untuk memfilter menurut peran, tetapkan Untuk memfilter menurut jenis, tetapkan Untuk memfilter menurut peran dan jenis, gunakan operator
Misalnya, kueri berikut valid:
Kueri berikut tidak valid:
Kueri yang tidak valid ditolak oleh server dengan error |
show_groups |
Opsional. Jika |
show_invited |
Opsional. Jika Saat ini memerlukan autentikasi pengguna. |
use_admin_access |
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 Mencantumkan keanggotaan aplikasi di ruang tidak didukung saat menggunakan akses admin. |
ListMembershipsResponse
Respons untuk mencantumkan langganan ruang.
Kolom | |
---|---|
memberships[] |
Daftar yang tidak diurutkan. Daftar langganan di halaman yang diminta (atau pertama). |
next_page_token |
Token yang dapat Anda kirim sebagai |
ListMessagesRequest
Mencantumkan pesan di ruang yang ditentukan tempat pengguna menjadi anggota.
Kolom | |
---|---|
parent |
Wajib. Nama resource ruang tempat daftar pesan. Format: |
page_size |
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 akan otomatis diubah menjadi 1.000. Nilai negatif menampilkan error |
page_token |
Opsional, jika melanjutkan dari kueri sebelumnya. Token halaman yang diterima dari panggilan pesan daftar 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 memberikan hasil yang tidak diharapkan. |
filter |
Filter kueri. Anda dapat memfilter pesan menurut tanggal ( Untuk memfilter pesan berdasarkan tanggal pembuatannya, tentukan Untuk memfilter menurut thread, tentukan Untuk memfilter menurut rangkaian pesan dan tanggal, gunakan operator Misalnya, kueri berikut valid:
Kueri yang tidak valid ditolak oleh server dengan error |
order_by |
Opsional, jika melanjutkan dari kueri sebelumnya. Cara pengurutan daftar pesan. Tentukan nilai yang akan diurutkan berdasarkan operasi pengurutan. Nilai operasi pengurutan yang valid adalah sebagai berikut:
Urutan default-nya adalah |
show_deleted |
Apakah akan menyertakan pesan yang dihapus. Pesan yang dihapus mencakup waktu yang dihapus dan metadata tentang penghapusannya, tetapi konten pesannya tidak tersedia. |
ListMessagesResponse
Pesan respons untuk pesan listingan.
Kolom | |
---|---|
messages[] |
Daftar pesan. |
next_page_token |
Anda dapat mengirim token sebagai |
ListReactionsRequest
Mencantumkan reaksi terhadap pesan.
Kolom | |
---|---|
parent |
Wajib. Pesan yang ditanggapi pengguna. Format: |
page_size |
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. |
page_token |
Opsional. (Jika melanjutkan dari kueri sebelumnya.) Token halaman yang diterima dari panggilan reaksi daftar sebelumnya. Berikan atribut ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, nilai filter harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak diharapkan. |
filter |
Opsional. Filter kueri. Anda dapat memfilter reaksi berdasarkan emoji ( Agar dapat memfilter reaksi untuk beberapa emoji atau pengguna, gabungkan kolom serupa menggunakan operator Untuk memfilter reaksi menurut emoji dan pengguna, gunakan operator Jika kueri Anda menggunakan Misalnya, kueri berikut valid:
Kueri berikut tidak valid:
Kueri yang tidak valid ditolak oleh server dengan error |
ListReactionsResponse
Respons terhadap permintaan reaksi daftar.
Kolom | |
---|---|
reactions[] |
Daftar reaksi di halaman yang diminta (atau pertama). |
next_page_token |
Token lanjutan untuk mengambil halaman hasil berikutnya. Halaman terakhir dari hasil ini kosong. |
ListSpaceEventsRequest
Pesan permintaan untuk mencantumkan acara ruang.
Kolom | |
---|---|
parent |
Wajib. Nama resource ruang Google Chat tempat peristiwa terjadi. Format: |
page_size |
Opsional. Jumlah maksimum peristiwa ruang yang ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Nilai negatif menampilkan error |
page_token |
Token halaman, yang diterima dari panggilan peristiwa ruang daftar sebelumnya. Berikan atribut ini untuk mengambil halaman selanjutnya. Saat memberi nomor halaman, semua parameter lain yang diberikan untuk peristiwa ruang daftar harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat memberikan hasil yang tidak diharapkan. |
filter |
Wajib. Filter kueri. Anda harus menentukan minimal satu jenis peristiwa ( Atau, Anda juga dapat memfilter menurut waktu mulai (
Untuk menentukan waktu mulai atau berakhir, gunakan operator sama dengan Misalnya, kueri berikut valid:
Kueri berikut tidak valid:
Kueri yang tidak valid ditolak oleh server dengan error |
ListSpaceEventsResponse
Pesan respons untuk mencantumkan peristiwa ruang.
Kolom | |
---|---|
space_events[] |
Hasil ditampilkan dalam urutan kronologis (peristiwa terlama terlebih dahulu). |
next_page_token |
Token lanjutan digunakan untuk mengambil lebih banyak peristiwa. Jika kolom ini dihilangkan, tidak ada halaman berikutnya. |
ListSpacesRequest
Permintaan untuk mencantumkan ruang tempat pemanggil menjadi anggota.
Kolom | |
---|---|
page_size |
Opsional. Jumlah spasi maksimum 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 |
page_token |
Opsional. Token halaman, yang diterima dari panggilan ruang daftar 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 diharapkan. |
filter |
Opsional. Filter kueri. Anda dapat memfilter ruang berdasarkan jenis ruang ( Untuk memfilter menurut jenis ruang, Anda harus menentukan nilai enum yang valid, seperti Misalnya, kueri berikut valid:
Kueri yang tidak valid ditolak oleh server dengan error |
ListSpacesResponse
Respons untuk permintaan daftar ruang.
Kolom | |
---|---|
spaces[] |
Daftar spasi di halaman yang diminta (atau pertama). |
next_page_token |
Anda dapat mengirim token sebagai |
MatchedUrl
URL yang cocok dalam pesan Chat. Aplikasi Chat dapat melihat pratinjau URL yang cocok. Untuk informasi selengkapnya, lihat Pratinjau link.
Kolom | |
---|---|
url |
Hanya output. URL yang cocok. |
Langganan
Mewakili hubungan keanggotaan di Google Chat, seperti apakah pengguna atau aplikasi Chat diundang, menjadi bagian dari, atau tidak ada di ruang.
Kolom | |
---|---|
name |
Nama resource keanggotaan, yang ditetapkan oleh server. Format: |
state |
Hanya output. Status keanggotaan. |
role |
Opsional. Peran pengguna dalam ruang Chat, yang menentukan tindakan yang diizinkan dalam ruang tersebut. Kolom ini hanya dapat digunakan sebagai input di |
create_time |
Opsional. Tidak dapat diubah. Waktu pembuatan keanggotaan, seperti saat anggota bergabung atau diundang untuk bergabung ke ruang. Kolom ini hanya merupakan output, kecuali jika digunakan untuk mengimpor keanggotaan historis di ruang mode impor. |
delete_time |
Opsional. Tidak dapat diubah. Waktu penghapusan keanggotaan, seperti saat anggota keluar dari ruang. Kolom ini hanya merupakan output, kecuali jika digunakan untuk mengimpor keanggotaan historis di ruang mode impor. |
Kolom union memberType . Anggota yang terkait dengan keanggotaan ini. Jenis anggota lainnya mungkin didukung pada masa mendatang. memberType hanya dapat berupa salah satu dari berikut: |
|
member |
Pengguna atau aplikasi Google Chat yang sesuai dengan keanggotaan. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, output akan mengisi pengguna |
group_member |
Google Grup tempat keanggotaan sesuai. |
MembershipRole
Mewakili tindakan yang diizinkan pengguna di ruang Chat. Nilai enum lainnya mungkin ditambahkan di masa mendatang.
Enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Nilai default. Untuk users : dia bukan anggota ruang, tetapi dapat diundang. Untuk Google Groups : mereka selalu diberi peran ini (nilai enum lainnya dapat digunakan di masa mendatang). |
ROLE_MEMBER |
Anggota ruang. Pengguna memiliki izin dasar, seperti mengirim pesan ke ruang. Dalam percakapan grup 1:1 dan tanpa nama, semua orang memiliki peran ini. |
ROLE_MANAGER |
Pengelola ruang. Pengguna memiliki semua izin dasar ditambah izin administratif yang memungkinkan mereka mengelola ruang, seperti menambahkan atau menghapus anggota. Hanya didukung dalam bahasa SpaceType.SPACE . |
MembershipState
Menentukan hubungan anggota dengan ruang. Status keanggotaan lainnya mungkin didukung pada masa mendatang.
Enum | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Nilai default. Jangan gunakan. |
JOINED |
Pengguna ditambahkan ke ruang dan dapat berpartisipasi dalam ruang. |
INVITED |
Pengguna diundang untuk bergabung ke ruang, tetapi belum bergabung. |
NOT_A_MEMBER |
Pengguna bukan anggota ruang dan tidak memiliki undangan tertunda untuk bergabung ke ruang tersebut. |
MembershipBatchCreatedEventData
Payload peristiwa untuk beberapa keanggotaan baru.
Jenis acara: google.workspace.chat.membership.v1.batchCreated
Kolom | |
---|---|
memberships[] |
Daftar keanggotaan baru. |
MembershipBatchDeletedEventData
Payload peristiwa untuk beberapa keanggotaan yang dihapus.
Jenis acara: google.workspace.chat.membership.v1.batchDeleted
Kolom | |
---|---|
memberships[] |
Daftar keanggotaan yang dihapus. |
MembershipBatchUpdatedEventData
Payload peristiwa untuk beberapa keanggotaan yang diperbarui.
Jenis acara: google.workspace.chat.membership.v1.batchUpdated
Kolom | |
---|---|
memberships[] |
Daftar keanggotaan yang diperbarui. |
MembershipCreatedEventData
Payload peristiwa untuk keanggotaan baru.
Jenis peristiwa: google.workspace.chat.membership.v1.created
.
Kolom | |
---|---|
membership |
Keanggotaan baru. |
MembershipDeletedEventData
Payload peristiwa untuk keanggotaan yang dihapus.
Jenis acara: google.workspace.chat.membership.v1.deleted
Kolom | |
---|---|
membership |
Keanggotaan yang dihapus. Hanya kolom |
MembershipUpdatedEventData
Payload peristiwa untuk keanggotaan yang diperbarui.
Jenis acara: google.workspace.chat.membership.v1.updated
Kolom | |
---|---|
membership |
Keanggotaan yang diperbarui. |
Pesan
Pesan di ruang Google Chat.
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 |
create_time |
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. |
last_update_time |
Hanya output. Waktu saat pesan terakhir diedit oleh pengguna. Jika pesan belum pernah diedit, kolom ini kosong. |
delete_time |
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. |
formatted_text |
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 |
cards_v2[] |
Array kartu. Hanya aplikasi Chat yang dapat membuat kartu. Jika aplikasi Chat Anda diautentikasi 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 |
fallback_text |
Deskripsi teks biasa tentang kartu pesan, yang digunakan saat kartu sebenarnya tidak dapat ditampilkan—misalnya, notifikasi seluler. |
action_response |
Input saja. Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting. |
argument_text |
Hanya output. Isi teks biasa pesan dengan semua sebutan di aplikasi Chat dihapus. |
slash_command |
Hanya output. Informasi perintah garis miring, jika berlaku. |
attachment[] |
Lampiran yang diupload pengguna. |
matched_url |
Hanya output. URL di |
thread_reply |
Hanya output. Jika Jika ruang tidak mendukung balasan dalam rangkaian pesan, kolom ini selalu |
client_assigned_message_id |
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 |
emoji_reaction_summaries[] |
Hanya output. Daftar ringkasan reaksi emoji di pesan. |
private_message_viewer |
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. |
deletion_metadata |
Hanya output. Informasi tentang pesan yang dihapus. Pesan dihapus saat |
quoted_message_metadata |
Hanya output. Informasi tentang pesan yang dikutip oleh pengguna Google Chat dalam ruang. Pengguna Google Chat dapat mengutip pesan untuk membalasnya. |
attached_gifs[] |
Hanya output. Gambar GIF yang dilampirkan ke pesan. |
accessory_widgets[] |
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. |
MessageBatchCreatedEventData
Payload peristiwa untuk beberapa pesan baru.
Jenis acara: google.workspace.chat.message.v1.batchCreated
Kolom | |
---|---|
messages[] |
Daftar pesan baru. |
MessageBatchDeletedEventData
Payload peristiwa untuk beberapa pesan yang dihapus.
Jenis acara: google.workspace.chat.message.v1.batchDeleted
Kolom | |
---|---|
messages[] |
Daftar pesan yang dihapus. |
MessageBatchUpdatedEventData
Payload peristiwa untuk beberapa pesan yang diperbarui.
Jenis acara: google.workspace.chat.message.v1.batchUpdated
Kolom | |
---|---|
messages[] |
Daftar pesan yang diperbarui. |
MessageCreatedEventData
Payload peristiwa untuk pesan baru.
Jenis acara: google.workspace.chat.message.v1.created
Kolom | |
---|---|
message |
Pesan baru. |
MessageDeletedEventData
Payload peristiwa untuk pesan yang dihapus.
Jenis acara: google.workspace.chat.message.v1.deleted
Kolom | |
---|---|
message |
Pesan yang dihapus. Hanya kolom |
MessageUpdatedEventData
Payload peristiwa untuk pesan yang diperbarui.
Jenis acara: google.workspace.chat.message.v1.updated
Kolom | |
---|---|
message |
Pesan yang diperbarui. |
QuotedMessageMetadata
Informasi tentang pesan yang dikutip.
Kolom | |
---|---|
name |
Hanya output. Nama resource dari pesan yang dikutip. Format: |
last_update_time |
Hanya output. Stempel waktu saat pesan yang dikutip dibuat atau saat pesan yang dikutip terakhir diperbarui. |
Reaksi
Reaksi terhadap pesan.
Kolom | |
---|---|
name |
Nama resource reaksi. Format: |
user |
Hanya output. Pengguna yang membuat reaksi. |
emoji |
Emoji yang digunakan dalam reaksi. |
ReactionBatchCreatedEventData
Payload peristiwa untuk beberapa reaksi baru.
Jenis acara: google.workspace.chat.reaction.v1.batchCreated
Kolom | |
---|---|
reactions[] |
Daftar reaksi baru. |
ReactionBatchDeletedEventData
Payload peristiwa untuk beberapa reaksi yang dihapus.
Jenis acara: google.workspace.chat.reaction.v1.batchDeleted
Kolom | |
---|---|
reactions[] |
Daftar reaksi yang dihapus. |
ReactionCreatedEventData
Payload peristiwa untuk reaksi baru.
Jenis acara: google.workspace.chat.reaction.v1.created
Kolom | |
---|---|
reaction |
Reaksi baru. |
ReactionDeletedEventData
Payload peristiwa untuk reaksi yang dihapus.
Jenis: google.workspace.chat.reaction.v1.deleted
Kolom | |
---|---|
reaction |
Reaksi yang dihapus. |
RichLinkMetadata
Link lengkap ke referensi.
Kolom | |
---|---|
uri |
URI link ini. |
rich_link_type |
Jenis link multimedia. |
Kolom union data . Data untuk resource tertaut. data hanya dapat berupa salah satu dari berikut: |
|
drive_link_data |
Data untuk link drive. |
chat_space_link_data |
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. |
SearchSpacesRequest
Permintaan untuk menelusuri daftar ruang berdasarkan kueri.
Kolom | |
---|---|
use_admin_access |
Saat Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang. Memerlukan cakupan OAuth 2.0 Saat ini metode ini hanya mendukung akses admin, sehingga hanya |
page_size |
Jumlah spasi maksimum 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. |
page_token |
Token, yang 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 memberikan hasil yang tidak diharapkan. |
query |
Wajib. Kueri penelusuran. Anda dapat melakukan penelusuran menggunakan parameter berikut:
Di berbagai kolom, hanya operator Di antara kolom yang sama, Contoh kueri berikut valid:
|
order_by |
Opsional. Cara pengurutan daftar ruang. Atribut yang didukung untuk diurutkan adalah:
Nilai operasi pengurutan yang valid adalah:
Sintaksis yang didukung adalah:
|
SearchSpacesResponse
Respons dengan daftar ruang yang sesuai dengan permintaan ruang penelusuran.
Kolom | |
---|---|
spaces[] |
Halaman dari ruang yang diminta. |
next_page_token |
Token yang dapat digunakan untuk mengambil halaman berikutnya. Jika kolom ini kosong, tidak ada halaman berikutnya. |
total_size |
Total jumlah spasi yang cocok dengan kueri, di semua halaman. Jika hasilnya melebihi 10.000 spasi, nilai ini adalah perkiraan. |
SetUpSpaceRequest
Meminta pembuatan ruang dan menambahkan pengguna tertentu ke dalamnya.
Kolom | |
---|---|
space |
Wajib. Kolom Untuk membuat ruang, tetapkan Untuk membuat chat grup, tetapkan Untuk membuat percakapan 1:1 antar-manusia, tetapkan Untuk membuat percakapan 1:1 antara manusia dan aplikasi Chat yang memanggil, tetapkan Jika ruang |
request_id |
Opsional. ID unik untuk permintaan ini. UUID acak direkomendasikan. 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. |
memberships[] |
Opsional. Pengguna atau grup Google Chat yang akan diundang untuk bergabung ke ruang. Hapus pengguna yang menelepon, karena pengguna tersebut ditambahkan secara otomatis. Kumpulan tersebut saat ini mengizinkan hingga 20 keanggotaan (selain penelepon). Untuk keanggotaan manusia, kolom Untuk keanggotaan grup Google, kolom Opsional saat menetapkan Wajib jika menetapkan Wajib saat menyetel Harus kosong saat membuat percakapan 1:1 antara manusia dan aplikasi Chat panggilan (saat menetapkan |
SlashCommand
Perintah garis miring di Google Chat.
Kolom | |
---|---|
command_id |
ID perintah garis miring yang dipanggil. |
SlashCommandMetadata
Metadata anotasi untuk perintah garis miring (/).
Kolom | |
---|---|
bot |
Aplikasi Chat yang perintahnya dipanggil. |
type |
Jenis perintah garis miring. |
command_name |
Nama perintah garis miring yang dipanggil. |
command_id |
ID perintah dari perintah garis miring yang dipanggil. |
triggers_dialog |
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. |
Spasi
Ruang di Google Chat. Ruang adalah percakapan antara dua pengguna atau lebih, atau pesan 1:1 antara pengguna dan aplikasi Chat.
Kolom | |
---|---|
name |
Nama resource ruang. Format: Dengan |
type |
Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan |
space_type |
Jenis ruang. Wajib saat membuat ruang atau memperbarui jenis ruang. Output hanya untuk penggunaan lain. |
single_user_bot_dm |
Opsional. Apakah ruang adalah DM antara aplikasi Chat dan satu orang. |
threaded |
Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan |
display_name |
Nama tampilan ruang. Wajib saat membuat ruang dengan Untuk pesan langsung, kolom ini mungkin kosong. Mendukung hingga 128 karakter. |
external_user_allowed |
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 spasi dalam kondisi berikut:
Untuk ruang yang sudah ada, kolom ini hanya output. |
space_threading_state |
Hanya output. Status rangkaian pesan di ruang Chat. |
space_details |
Detail tentang ruang, termasuk deskripsi dan aturan. |
space_history_state |
Status histori pesan untuk pesan dan rangkaian pesan di ruang ini. |
import_mode |
Opsional. Apakah ruang ini dibuat di |
create_time |
Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu pembuatan ruang. Kolom ini hanya output, kecuali jika digunakan dalam 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 saat |
last_active_time |
Hanya output. Stempel waktu pesan terakhir dalam ruang. |
admin_installed |
Hanya output. Untuk ruang pesan langsung (DM) dengan aplikasi Chat, baik 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 oleh admin, aplikasi Chat Anda harus memiliki fitur pesan langsung. |
membership_count |
Hanya output. Jumlah langganan yang bergabung yang dikelompokkan menurut jenis anggota. Diisi saat |
access_settings |
Opsional. Menentukan setelan akses ruang. Hanya diisi saat |
space_uri |
Hanya output. URI bagi pengguna untuk mengakses ruang. |
Kolom union space_permission_settings . Menampilkan setelan izin ruang. Hanya diisi saat space_type adalah SPACE . space_permission_settings hanya dapat berupa salah satu dari yang berikut: |
|
predefined_permission_settings |
Opsional. Input saja. Setelan izin ruang. Input untuk membuat ruang, ruang kolaborasi akan dibuat jika kolom ini tidak disetel. Setelah Anda membuat ruang, setelan akan diisi di kolom |
permission_settings |
Opsional. Setelan izin yang tepat yang dapat disetel untuk memperbarui ruang. Input untuk memperbarui ruang. Jika tidak, hanya output. Untuk membuat ruang, gunakan |
AccessSettings
Merepresentasikan setelan akses ruang.
Kolom | |
---|---|
access_state |
Hanya output. Menunjukkan status akses ruang. |
audience |
Opsional. Nama resource target audiens yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan dalam ruang. Jika tidak disetel, hanya pengguna atau Google Grup yang telah diundang atau ditambahkan secara terpisah ke ruang yang dapat mengaksesnya. Untuk mengetahui detailnya, lihat Membuat ruang yang dapat ditemukan oleh target audiens. Format: Untuk menggunakan target audiens default untuk organisasi Google Workspace, tetapkan ke |
AccessState
Menampilkan status akses ruang.
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Status akses tidak diketahui atau tidak didukung dalam API ini. |
PRIVATE |
Hanya pengguna atau Google Grup yang telah ditambahkan atau diundang secara terpisah oleh pengguna lain atau administrator Google Workspace yang dapat menemukan dan mengakses ruang tersebut. |
DISCOVERABLE |
Pengelola ruang telah memberi target audiens akses ke ruang. Pengguna atau Google Grup yang telah ditambahkan atau diundang secara terpisah ke ruang juga dapat menemukan dan mengakses ruang. Untuk mempelajari lebih lanjut, lihat Membuat ruang yang dapat ditemukan oleh pengguna tertentu. |
MembershipCount
Kolom | |
---|---|
joined_direct_human_user_count |
Jumlah pengguna manusia yang telah langsung bergabung ke ruang, bukan termasuk pengguna yang bergabung dengan memiliki keanggotaan dalam grup gabungan. |
joined_group_count |
Jumlah semua grup yang telah bergabung langsung ke ruang. |
PermissionSetting
Mewakili setelan izin ruang.
Kolom | |
---|---|
managers_allowed |
Apakah pengelola ruang memiliki izin ini atau tidak. |
members_allowed |
Apakah anggota non-pengelola memiliki izin ini atau tidak. |
PermissionSettings
Setelan izin untuk ruang yang diberi nama. Untuk menetapkan setelan izin saat membuat ruang, tentukan kolom PredefinedPermissionSettings
dalam permintaan Anda.
Kolom | |
---|---|
manage_members_and_groups |
Setelan untuk mengelola anggota dan grup dalam ruang. |
modify_space_details |
Setelan untuk memperbarui nama, avatar, deskripsi, dan panduan ruang. |
toggle_history |
Setelan untuk mengaktifkan dan menonaktifkan histori ruang. |
use_at_mention_all |
Setelan untuk menggunakan @semua dalam ruang. |
manage_apps |
Setelan untuk mengelola aplikasi dalam ruang. |
manage_webhooks |
Setelan untuk mengelola webhook dalam ruang. |
post_messages |
Hanya output. Setelan untuk memposting pesan dalam ruang. |
reply_messages |
Setelan untuk membalas pesan dalam ruang. |
PredefinedPermissionSettings
Setelan izin ruang yang dapat Anda tentukan saat membuat ruang yang diberi nama. Setelan lainnya mungkin ditambahkan di masa mendatang. Untuk mengetahui detail tentang setelan izin untuk ruang yang diberi nama, lihat Pelajari ruang.
Enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Tidak ditentukan. Jangan gunakan. |
COLLABORATION_SPACE |
Setelan untuk membuat ruang menjadi ruang kolaborasi tempat semua anggota dapat memposting pesan. |
ANNOUNCEMENT_SPACE |
Setelan untuk membuat ruang menjadi ruang pengumuman tempat hanya pengelola ruang yang dapat memposting pesan. |
SpaceDetails
Detail tentang ruang, termasuk deskripsi dan aturan.
Kolom | |
---|---|
description |
Opsional. Deskripsi ruang. Misalnya, jelaskan topik diskusi, tujuan fungsional, atau peserta ruang. Mendukung hingga 150 karakter. |
guidelines |
Opsional. Aturan, ekspektasi, dan etika ruang. Mendukung hingga 5.000 karakter. |
SpaceThreadingState
Menentukan jenis status rangkaian pesan di ruang Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Direservasi. |
THREADED_MESSAGES |
Ruang bernama yang mendukung rangkaian pesan. Saat pengguna merespons pesan, mereka dapat membalas dalam rangkaian pesan, yang mempertahankan respons mereka dalam konteks pesan asli. |
GROUPED_MESSAGES |
Ruang bernama tempat percakapan diatur menurut topik. Topik dan balasannya dikelompokkan bersama. |
UNTHREADED_MESSAGES |
Pesan langsung (DM) antara dua orang dan percakapan grup antara 3 orang atau lebih. |
SpaceType
Jenis ruang. Wajib ada saat membuat atau memperbarui ruang. Output hanya untuk penggunaan lain.
Enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Direservasi. |
SPACE |
Tempat orang-orang mengirim pesan, berbagi file, dan berkolaborasi. SPACE dapat menyertakan aplikasi Chat. |
GROUP_CHAT |
Percakapan grup antara 3 orang atau lebih. GROUP_CHAT dapat menyertakan aplikasi Chat. |
DIRECT_MESSAGE |
Pesan 1:1 antara dua orang atau manusia dan aplikasi Chat. |
Jenis
Tidak digunakan lagi: Sebagai gantinya, gunakan SpaceType
.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Direservasi. |
ROOM |
Percakapan antara dua manusia atau lebih. |
DM |
Pesan Langsung 1:1 antara manusia dan aplikasi Chat, di mana semua pesan ditampilkan secara datar. Perhatikan bahwa ini tidak termasuk pesan langsung antara dua manusia. |
SpaceBatchUpdatedEventData
Payload peristiwa untuk beberapa update pada ruang.
Jenis acara: google.workspace.chat.space.v1.batchUpdated
Kolom | |
---|---|
spaces[] |
Daftar ruang yang diperbarui. |
SpaceEvent
Peristiwa yang mewakili perubahan atau aktivitas di ruang Google Chat. Untuk mempelajari lebih lanjut, lihat Menggunakan acara dari Google Chat.
Kolom | |
---|---|
name |
Nama resource dari peristiwa ruang. Format: |
event_time |
Waktu saat peristiwa terjadi. |
event_type |
Jenis peristiwa ruang angkasa. Setiap jenis peristiwa memiliki versi batch, yang mewakili beberapa instance jenis peristiwa yang terjadi dalam waktu singkat. Untuk permintaan Jenis peristiwa yang didukung untuk messages:
Jenis acara yang didukung untuk langganan:
Jenis peristiwa yang didukung untuk reaksi:
Jenis peristiwa yang didukung tentang ruang:
|
Kolom union
|
|
message_created_event_data |
Payload peristiwa untuk pesan baru. Jenis acara: |
message_updated_event_data |
Payload peristiwa untuk pesan yang diperbarui. Jenis acara: |
message_deleted_event_data |
Payload peristiwa untuk pesan yang dihapus. Jenis acara: |
message_batch_created_event_data |
Payload peristiwa untuk beberapa pesan baru. Jenis acara: |
message_batch_updated_event_data |
Payload peristiwa untuk beberapa pesan yang diperbarui. Jenis acara: |
message_batch_deleted_event_data |
Payload peristiwa untuk beberapa pesan yang dihapus. Jenis acara: |
space_updated_event_data |
Payload peristiwa untuk update ruang. Jenis acara: |
space_batch_updated_event_data |
Payload peristiwa untuk beberapa update pada ruang. Jenis acara: |
membership_created_event_data |
Payload peristiwa untuk keanggotaan baru. Jenis acara: |
membership_updated_event_data |
Payload peristiwa untuk keanggotaan yang diperbarui. Jenis acara: |
membership_deleted_event_data |
Payload peristiwa untuk keanggotaan yang dihapus. Jenis acara: |
membership_batch_created_event_data |
Payload peristiwa untuk beberapa keanggotaan baru. Jenis acara: |
membership_batch_updated_event_data |
Payload peristiwa untuk beberapa keanggotaan yang diperbarui. Jenis acara: |
membership_batch_deleted_event_data |
Payload peristiwa untuk beberapa keanggotaan yang dihapus. Jenis acara: |
reaction_created_event_data |
Payload peristiwa untuk reaksi baru. Jenis acara: |
reaction_deleted_event_data |
Payload peristiwa untuk reaksi yang dihapus. Jenis acara: |
reaction_batch_created_event_data |
Payload peristiwa untuk beberapa reaksi baru. Jenis acara: |
reaction_batch_deleted_event_data |
Payload peristiwa untuk beberapa reaksi yang dihapus. Jenis acara: |
SpaceReadState
Status baca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang telah dibaca dan belum dibaca.
Kolom | |
---|---|
name |
Nama resource dari status operasi baca ruang. Format: |
last_read_time |
Opsional. Waktu saat status baca ruang pengguna diperbarui. Biasanya ini berkaitan dengan stempel waktu pesan terakhir yang dibaca, atau stempel waktu yang ditentukan oleh pengguna untuk menandai posisi terakhir dibaca dalam ruang. |
SpaceUpdatedEventData
Payload peristiwa untuk ruang yang diupdate.
Jenis acara: google.workspace.chat.space.v1.updated
Kolom | |
---|---|
space |
Ruang yang diperbarui. |
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 ada rangkaian pesan yang cocok.
Kolom | |
---|---|
name |
Nama resource thread. Contoh: |
thread_key |
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 |
ThreadReadState
Status baca pengguna dalam rangkaian pesan, digunakan untuk mengidentifikasi pesan yang sudah dibaca dan belum dibaca.
Kolom | |
---|---|
name |
Nama resource dari status pembacaan thread. Format: |
last_read_time |
Waktu saat status pembacaan thread pengguna diperbarui. Biasanya ini berkaitan dengan stempel waktu pesan yang terakhir dibaca dalam rangkaian pesan. |
UpdateMembershipRequest
Pesan permintaan untuk memperbarui keanggotaan.
Kolom | |
---|---|
membership |
Wajib. Keanggotaan yang akan diperbarui. Hanya kolom yang ditentukan oleh |
update_mask |
Wajib. Jalur kolom yang akan diperbarui. Pisahkan beberapa nilai dengan koma atau gunakan Jalur kolom yang didukung saat ini:
|
use_admin_access |
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 |
UpdateMessageRequest
Permintaan untuk memperbarui pesan.
Kolom | |
---|---|
message |
Wajib. Pesan dengan kolom diperbarui. |
update_mask |
Wajib. Jalur kolom yang akan diperbarui. Pisahkan beberapa nilai dengan koma atau gunakan Jalur kolom yang didukung saat ini:
|
allow_missing |
Opsional. Jika |
UpdateSpaceReadStateRequest
Pesan permintaan untuk UpdateSpaceReadState API.
Kolom | |
---|---|
space_read_state |
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 opsi berikut:
Format: users/{pengguna}/spaces/{space}/spaceReadState |
update_mask |
Wajib. Jalur kolom yang akan diperbarui. Jalur kolom yang didukung saat ini:
Saat Untuk menandai ruang sebagai telah dibaca, tetapkan |
UpdateSpaceRequest
Permintaan untuk memperbarui satu ruang.
Kolom | |
---|---|
space |
Wajib. Ruang dengan kolom yang akan diperbarui. |
update_mask |
Wajib. Jalur kolom yang diperbarui, dipisahkan koma jika ada beberapa. Anda dapat memperbarui kolom berikut untuk ruang:
|
use_admin_access |
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 Beberapa nilai |
Pengguna
Pengguna di Google Chat. Saat ditampilkan sebagai output dari permintaan, jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, output untuk resource User
hanya mengisi name
dan type
pengguna.
Kolom | |
---|---|
name |
Nama resource untuk Format: Untuk
|
display_name |
Hanya output. Nama tampilan pengguna. |
domain_id |
ID unik domain Google Workspace pengguna. |
type |
Jenis pengguna. |
is_anonymous |
Hanya output. Saat |
Jenis
Enum | |
---|---|
TYPE_UNSPECIFIED |
Nilai default untuk enum. JANGAN GUNAKAN. |
HUMAN |
Pengguna manusia. |
BOT |
Pengguna aplikasi Chat. |
UserMentionMetadata
Metadata anotasi untuk sebutan pengguna (@).
Kolom | |
---|---|
user |
Pengguna menyebutkan. |
type |
Jenis sebutan pengguna. |
Jenis
Enum | |
---|---|
TYPE_UNSPECIFIED |
Nilai default untuk enum. Jangan gunakan. |
ADD |
Menambahkan pengguna ke ruang. |
MENTION |
Menyebut pengguna dalam ruang. |
WidgetMarkup
Widget adalah elemen UI yang menyajikan teks dan gambar.
Kolom | |
---|---|
buttons[] |
Daftar tombol. Tombol juga berstatus |
Kolom union data . WidgetMarkup hanya dapat memiliki salah satu item berikut. Anda dapat menggunakan beberapa kolom WidgetMarkup untuk menampilkan lebih banyak item. data hanya dapat berupa salah satu dari yang berikut: |
|
text_paragraph |
Tampilkan paragraf teks dalam widget ini. |
image |
Tampilkan gambar dalam widget ini. |
key_value |
Tampilkan item nilai kunci dalam widget ini. |
Tombol
Tombol. Dapat berupa tombol teks atau tombol gambar.
Kolom | |
---|---|
Kolom union
|
|
text_button |
Tombol dengan teks dan tindakan |
image_button |
Tombol dengan gambar dan tindakan |
FormAction
Tindakan formulir menjelaskan perilaku saat formulir dikirimkan. Misalnya, Anda dapat memanggil Apps Script untuk menangani formulir.
Kolom | |
---|---|
action_method_name |
Nama metode digunakan untuk mengidentifikasi bagian formulir mana yang memicu pengiriman formulir. Informasi ini dipantulkan kembali ke aplikasi Chat sebagai bagian dari peristiwa klik kartu. Anda dapat menggunakan nama metode yang sama untuk beberapa elemen yang memicu perilaku umum. |
parameters[] |
Daftar parameter tindakan. |
ActionParameter
Daftar parameter string yang akan disediakan saat metode tindakan dipanggil. Misalnya, pertimbangkan tiga tombol tidur sebentar: penundaan sekarang, tunda satu hari, tunda minggu depan. Anda mungkin menggunakan action method = snooze()
, dengan meneruskan jenis penundaan dan waktu penundaan dalam daftar parameter string.
Kolom | |
---|---|
key |
Nama parameter untuk skrip tindakan. |
value |
Nilai parameter. |
Ikon
Kumpulan ikon yang didukung.
Enum | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
Gambar
Gambar yang ditentukan oleh URL dan dapat memiliki tindakan onclick
.
Kolom | |
---|---|
image_url |
URL gambar. |
on_click |
Tindakan |
aspect_ratio |
Rasio aspek gambar ini (lebar dan tinggi). Kolom ini memungkinkan Anda mencadangkan tinggi yang tepat untuk gambar selagi menunggu gambar dimuat. Hal ini tidak dimaksudkan untuk mengganti rasio aspek bawaan gambar. Jika tidak disetel, server akan mengisinya dengan melakukan pengambilan data gambar. |
ImageButton
Tombol gambar dengan tindakan onclick
.
Kolom | |
---|---|
on_click |
Tindakan |
name |
Nama |
Kolom union icons . Ikon dapat ditentukan oleh Icon enum atau URL. icons hanya dapat berupa salah satu dari yang berikut: |
|
icon |
Ikon yang ditetapkan oleh |
icon_url |
Ikon yang ditentukan oleh URL. |
KeyValue
Elemen UI berisi kunci (label) dan nilai (konten). Elemen ini juga dapat berisi beberapa tindakan seperti tombol onclick
.
Kolom | |
---|---|
top_label |
Teks label atas. Teks berformat didukung. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. |
content |
Teks konten. Teks berformat didukung dan selalu diperlukan. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. |
content_multiline |
Jika konten harus berupa multibaris. |
bottom_label |
Teks label bawah. Teks terformat didukung. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace. |
on_click |
Tindakan |
Kolom union icons . Setidaknya salah satu ikon, top_label dan bottom_label harus ditentukan. icons hanya dapat berupa salah satu dari yang berikut: |
|
icon |
Nilai enum yang diganti dengan Chat API dengan gambar ikon yang sesuai. |
icon_url |
Ikon yang ditentukan oleh URL. |
Kolom union control . Widget kontrol. Anda dapat menetapkan button atau switch_widget , tetapi tidak keduanya. control hanya dapat berupa salah satu dari yang berikut: |
|
button |
Tombol yang dapat diklik untuk memicu tindakan. |
OnClick
Tindakan onclick
(misalnya, membuka link).
Kolom | |
---|---|
Kolom union
|
|
action |
Tindakan formulir akan dipicu oleh tindakan |
open_link |
Tindakan |
OpenLink
Link yang membuka jendela baru.
Kolom | |
---|---|
url |
URL yang akan dibuka. |
TextButton
Tombol dengan teks dan tindakan onclick
.
Kolom | |
---|---|
text |
Teks tombol. |
on_click |
Tindakan |
TextParagraph
Paragraf teks. Teks terformat didukung. Untuk informasi selengkapnya tentang memformat teks, lihat Memformat teks di aplikasi Google Chat dan Memformat teks di Add-on Google Workspace.
Kolom | |
---|---|
text |
|