Package google.chat.v1

Indeks

ChatService

Memungkinkan developer membuat aplikasi dan integrasi Chat di Google Chat Platform.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.import

Untuk informasi selengkapnya, lihat Panduan otorisasi.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Membuat emoji kustom.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.customemojis

Untuk informasi selengkapnya, lihat Panduan otorisasi.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Membuat langganan untuk aplikasi Chat yang melakukan panggilan, pengguna, atau Grup Google. Membuat langganan untuk aplikasi Chat lain tidak didukung. Saat membuat langganan, jika kebijakan penerimaan otomatis anggota yang ditentukan dinonaktifkan, anggota tersebut akan diundang, dan harus menerima undangan ruang sebelum bergabung. Jika tidak, pembuatan langganan akan menambahkan anggota langsung ke ruang yang ditentukan.

Mendukung jenis autentikasi berikut:

Untuk contoh penggunaan, lihat:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Untuk informasi selengkapnya, lihat Panduan otorisasi.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Membuat pesan di ruang Google Chat. Untuk contoh, lihat Mengirim pesan.

Metode create() memerlukan autentikasi pengguna atau autentikasi aplikasi. Chat mengatribusikan pengirim pesan secara berbeda, bergantung pada jenis autentikasi yang Anda gunakan dalam permintaan.

Gambar berikut menunjukkan cara Chat mengatribusikan pesan saat Anda menggunakan autentikasi aplikasi. Chat menampilkan aplikasi Chat sebagai pengirim pesan. Konten pesan dapat berisi teks (text), kartu (cardsV2), dan widget aksesori (accessoryWidgets).

Pesan dikirim dengan autentikasi aplikasi

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 (text).

Pesan yang dikirim dengan autentikasi pengguna

Ukuran pesan maksimum, termasuk konten pesan, adalah 32.000 byte.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Untuk informasi selengkapnya, lihat Panduan otorisasi.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Membuat reaksi dan menambahkannya ke pesan. Hanya emoji unicode yang didukung. Sebagai contoh, lihat Menambahkan reaksi ke pesan.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Untuk informasi selengkapnya, lihat Panduan otorisasi.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Membuat ruang. Dapat digunakan untuk membuat ruang bernama, atau chat grup di Import mode. Untuk mengetahui contohnya, lihat Membuat ruang.

Mendukung jenis autentikasi berikut:

Saat mengautentikasi sebagai aplikasi, kolom space.customer harus ditetapkan dalam permintaan.

Langganan ruang saat pembuatannya bergantung pada apakah ruang dibuat di Import mode:

  • Mode impor: Tidak ada anggota yang dibuat.
  • Semua mode lainnya: Pengguna yang menelepon ditambahkan sebagai anggota. Ini adalah:
    • Aplikasi itu sendiri saat menggunakan autentikasi aplikasi.
    • Pengguna manusia saat menggunakan autentikasi pengguna.

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

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Untuk informasi selengkapnya, lihat Panduan otorisasi.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Menghapus emoji kustom.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.customemojis

Untuk informasi selengkapnya, lihat Panduan otorisasi.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Menghapus langganan. Untuk contohnya, lihat Menghapus pengguna atau aplikasi Google Chat dari ruang.

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Untuk informasi selengkapnya, lihat Panduan otorisasi.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Menghapus pesan. Untuk contoh, lihat Menghapus pesan.

Mendukung jenis autentikasi berikut:

Saat menggunakan autentikasi aplikasi, permintaan hanya dapat menghapus pesan yang dibuat oleh aplikasi Chat yang melakukan panggilan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Untuk informasi selengkapnya, lihat Panduan otorisasi.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Menghapus reaksi terhadap pesan. Hanya emoji unicode yang didukung. Untuk contoh, lihat Menghapus reaksi.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Untuk informasi selengkapnya, lihat Panduan otorisasi.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Menghapus ruang bernama. Selalu melakukan penghapusan beruntun, yang berarti bahwa resource turunan ruang—seperti pesan yang diposting di ruang dan keanggotaan di ruang—juga akan dihapus. Untuk contoh, lihat Menghapus ruang.

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Untuk informasi selengkapnya, lihat Panduan otorisasi.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Menampilkan pesan langsung yang ada dengan pengguna yang ditentukan. Jika tidak ada ruang pesan langsung yang ditemukan, error 404 NOT_FOUND akan ditampilkan. Untuk contoh, lihat Menemukan pesan langsung.

Dengan autentikasi aplikasi, menampilkan ruang pesan langsung antara pengguna yang ditentukan dan aplikasi Chat yang memanggil.

Dengan autentikasi pengguna, menampilkan ruang pesan langsung antara pengguna yang ditentukan dan pengguna yang diautentikasi.

// Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Mendapatkan metadata lampiran pesan. Data lampiran diambil menggunakan media API. Sebagai contoh, lihat Mendapatkan metadata tentang lampiran pesan. Memerlukan autentikasi aplikasi.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.bot

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Menampilkan detail tentang emoji kustom.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Menampilkan detail tentang langganan. Untuk mengetahui contohnya, lihat Mendapatkan detail tentang langganan pengguna atau aplikasi Google Chat.

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Menampilkan detail tentang pesan. Untuk contohnya, lihat Mendapatkan detail tentang pesan.

Mendukung jenis autentikasi berikut:

Catatan: Mungkin menampilkan pesan dari anggota atau ruang yang diblokir.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Menampilkan detail tentang ruang. Untuk contohnya, lihat Mendapatkan detail tentang ruang.

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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 Message yang diperbarui dalam payload peristiwa.

Catatan: Kolom permissionSettings tidak ditampilkan dalam objek Ruang dari data peristiwa Ruang untuk permintaan ini.

Memerlukan autentikasi pengguna. Untuk mendapatkan peristiwa, pengguna yang diautentikasi harus menjadi anggota ruang.

Untuk mengetahui contohnya, lihat Mendapatkan detail tentang peristiwa dari ruang Google Chat.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Mendapatkan setelan status notifikasi ruang.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Menampilkan detail tentang status baca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang telah dibaca dan belum dibaca. Untuk mengetahui contohnya, lihat Mendapatkan detail tentang status baca ruang pengguna.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Menampilkan detail tentang status baca pengguna dalam rangkaian pesan, yang digunakan untuk mengidentifikasi pesan yang telah dibaca dan belum dibaca. Untuk mengetahui contohnya, lihat Mendapatkan detail tentang status baca rangkaian pesan pengguna.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Mencantumkan emoji kustom yang terlihat oleh pengguna terautentikasi.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Mencantumkan langganan di ruang. Untuk mengetahui contohnya, lihat Mencantumkan pengguna dan aplikasi Google Chat di ruang. Mencantumkan keanggotaan dengan autentikasi aplikasi akan mencantumkan keanggotaan di ruang yang dapat diakses oleh aplikasi Chat, tetapi mengecualikan keanggotaan aplikasi Chat, termasuk keanggotaan aplikasi Chat itu sendiri. Mencantumkan langganan dengan Autentikasi pengguna akan mencantumkan langganan di ruang yang dapat diakses oleh pengguna yang diautentikasi.

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Mencantumkan pesan di 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, {}. Untuk contoh, lihat Mencantumkan pesan.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Mencantumkan reaksi terhadap pesan. Sebagai contoh, lihat Mencantumkan reaksi untuk pesan.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Mencantumkan peristiwa dari ruang Google Chat. Untuk setiap peristiwa, payload berisi versi terbaru resource Chat. Misalnya, jika Anda mencantumkan peristiwa tentang anggota ruang baru, server akan menampilkan resource Membership yang berisi detail keanggotaan terbaru. Jika anggota baru dihapus selama periode yang diminta, payload peristiwa akan berisi resource Membership kosong.

Memerlukan autentikasi pengguna. Untuk mencantumkan peristiwa, pengguna terautentikasi harus menjadi anggota ruang.

Untuk contohnya, lihat Mencantumkan peristiwa dari ruang Google Chat.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Mencantumkan ruang yang anggotanya adalah pemanggil. Chat grup dan DM tidak akan dicantumkan hingga pesan pertama dikirim. Untuk contoh, lihat Mencantumkan ruang.

Mendukung jenis autentikasi berikut:

Untuk mencantumkan semua ruang bernama menurut organisasi Google Workspace, gunakan metode spaces.search() menggunakan hak istimewa administrator Workspace.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Untuk informasi selengkapnya, lihat Panduan otorisasi.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Menampilkan daftar ruang di organisasi Google Workspace berdasarkan penelusuran administrator.

Memerlukan autentikasi pengguna dengan hak istimewa administrator. Dalam permintaan, tetapkan use_admin_access ke true.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya. 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 langganan dengan membership.member.name yang sesuai. Untuk menambahkan pengguna manusia, gunakan users/{user}, dengan {user} dapat berupa alamat email untuk pengguna. Untuk pengguna di organisasi Workspace yang sama, {user} juga dapat berupa id untuk orang dari People API, atau id untuk pengguna di Directory API. Misalnya, jika ID profil Orang People API untuk user@example.com adalah 123456789, Anda dapat menambahkan pengguna ke ruang dengan menetapkan membership.member.name ke users/user@example.com atau users/123456789.

Untuk menentukan grup Google yang akan ditambahkan, tambahkan keanggotaan dengan membership.group_member.name yang sesuai. Untuk menambahkan atau mengundang grup Google, gunakan groups/{group}, dengan {group} adalah id untuk grup dari Cloud Identity Groups API. Misalnya, Anda dapat menggunakan Cloud Identity Groups lookup API untuk mengambil ID 123456789 untuk email grup group@example.com, lalu Anda dapat menambahkan grup ke ruang dengan menetapkan membership.group_member.name ke groups/123456789. Email grup tidak didukung, dan Google Grup hanya dapat ditambahkan sebagai anggota di ruang bernama.

Untuk ruang bernama atau chat grup, 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 tepat satu langganan untuk mewakili pengguna manusia. Jika satu pengguna memblokir pengguna lainnya, permintaan akan gagal dan DM tidak akan dibuat.

Untuk membuat DM antara pengguna yang melakukan panggilan dan aplikasi yang melakukan panggilan, tetapkan Space.singleUserBotDm ke true dan jangan tentukan langganan apa pun. Anda hanya dapat menggunakan metode ini untuk menyiapkan DM dengan aplikasi panggilan. Untuk menambahkan aplikasi panggilan sebagai anggota ruang atau DM yang ada antara dua pengguna manusia, lihat Mengundang atau menambahkan pengguna atau aplikasi ke ruang.

Jika DM sudah ada di antara dua pengguna, meskipun salah satu pengguna memblokir pengguna lainnya pada saat permintaan dibuat, DM yang ada akan ditampilkan.

Ruang dengan balasan berangkai tidak didukung. Jika Anda menerima pesan error ALREADY_EXISTS saat menyiapkan ruang, coba displayName yang berbeda. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Untuk informasi selengkapnya, lihat Panduan otorisasi.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Memperbarui langganan. Untuk mengetahui contohnya, lihat Memperbarui keanggotaan pengguna di ruang.

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

Untuk informasi selengkapnya, lihat Panduan otorisasi.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Memperbarui pesan. Ada perbedaan antara metode patch dan update. Metode patch menggunakan permintaan patch, sedangkan metode update menggunakan permintaan put. Sebaiknya gunakan metode patch. Untuk contoh, lihat Memperbarui pesan.

Mendukung jenis autentikasi berikut:

Saat menggunakan autentikasi aplikasi, permintaan hanya dapat memperbarui pesan yang dibuat oleh aplikasi Chat yang melakukan panggilan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Untuk informasi selengkapnya, lihat Panduan otorisasi.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Memperbarui ruang. Untuk mengetahui contohnya, lihat Memperbarui ruang.

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

Mendukung jenis autentikasi berikut:

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Untuk informasi selengkapnya, lihat Panduan otorisasi.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Memperbarui setelan status notifikasi ruang.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Untuk informasi selengkapnya, lihat Panduan otorisasi.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Memperbarui status baca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang telah dibaca dan belum dibaca. Untuk mengetahui contohnya, lihat Memperbarui status baca ruang pengguna.

Memerlukan autentikasi pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.users.readstate

Untuk informasi selengkapnya, lihat Panduan otorisasi.

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

ButtonList

Daftar tombol.

ActionResponse

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

Kolom
type

ResponseType

Hanya input. Jenis respons aplikasi Chat.

url

string

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

dialog_action

DialogAction

Hanya input. Respons terhadap peristiwa interaksi yang terkait dengan dialog. Harus disertai dengan ResponseType.Dialog.

updated_widget

UpdatedWidget

Hanya input. Respons widget yang diperbarui.

ResponseType

Jenis respons aplikasi Chat.

Enum
TYPE_UNSPECIFIED Jenis default yang ditangani sebagai NEW_MESSAGE.
NEW_MESSAGE Posting sebagai pesan baru dalam topik.
UPDATE_MESSAGE Perbarui pesan aplikasi Chat. Hal ini hanya diizinkan pada peristiwa CARD_CLICKED dengan jenis pengirim pesan BOT.
UPDATE_USER_MESSAGE_CARDS Memperbarui kartu pada pesan pengguna. Hal ini hanya diizinkan sebagai respons terhadap peristiwa MESSAGE dengan URL yang cocok, atau peristiwa CARD_CLICKED dengan jenis pengirim pesan HUMAN. Teks diabaikan.
REQUEST_CONFIG Minta autentikasi atau konfigurasi tambahan kepada pengguna secara pribadi.
DIALOG Menampilkan dialog.
UPDATE_WIDGET Kueri opsi pelengkapan otomatis teks widget.

SelectionItems

Daftar hasil pelengkapan otomatis widget.

Kolom
items[]

SelectionItem

Array objek SelectionItem.

UpdatedWidget

Respons widget yang diperbarui. Digunakan untuk memberikan opsi pelengkapan otomatis untuk widget.

Kolom
widget

string

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

Kolom union updated_widget. Widget diperbarui sebagai respons terhadap tindakan pengguna. updated_widget hanya dapat berupa salah satu dari berikut:
suggestions

SelectionItems

Daftar hasil pelengkapan otomatis widget

ActionStatus

Merepresentasikan status untuk permintaan guna memanggil atau mengirimkan dialog.

Kolom
status_code

Code

Kode status.

user_facing_message

string

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

Annotation

Hanya output. Anotasi yang terkait dengan isi teks biasa 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

AnnotationType

Jenis anotasi ini.

length

int32

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

start_index

int32

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

UserMentionMetadata

Metadata sebutan pengguna.

slash_command

SlashCommandMetadata

Metadata untuk perintah garis miring.

AnnotationType

Jenis anotasi.

Enum
ANNOTATION_TYPE_UNSPECIFIED Nilai default untuk enum. Jangan gunakan.
USER_MENTION Pengguna disebutkan.
SLASH_COMMAND Perintah garis miring dipanggil.

AttachedGif

Gambar GIF yang ditentukan oleh URL.

Kolom
uri

string

Hanya output. URL yang menghosting gambar GIF.

Lampiran

Lampiran di Google Chat.

Kolom
name

string

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

content_name

string

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

content_type

string

Hanya output. Jenis konten (jenis MIME) file.

thumbnail_uri

string

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

download_uri

string

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

source

Source

Hanya output. Sumber lampiran.

Kolom union data_ref. Referensi data ke lampiran. data_ref hanya dapat berupa salah satu dari berikut:
attachment_data_ref

AttachmentDataRef

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

drive_data_ref

DriveDataRef

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 diupload ke Chat.

AttachmentDataRef

Referensi ke data lampiran.

Kolom
resource_name

string

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

attachment_upload_token

string

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

CardWithId

Kartu dalam pesan Google Chat.

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

Buat desain dan lihat pratinjau kartu dengan Pembuat Kartu.

Membuka Pembuat Kartu

Kolom
card_id

string

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

card

Card

Kartu. Ukuran maksimum adalah 32 KB.

ChatSpaceLinkData

Data untuk link ruang Chat.

Kolom
space

string

Ruang resource ruang Chat tertaut.

Format: spaces/{space}

thread

string

Rangkaian pesan resource ruang Chat tertaut.

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

message

string

Pesan resource ruang Chat tertaut.

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

CompleteImportSpaceRequest

Pesan permintaan untuk menyelesaikan proses impor ruang.

Kolom
name

string

Wajib. Nama resource ruang mode impor.

Format: spaces/{space}

CompleteImportSpaceResponse

Pesan respons untuk menyelesaikan proses impor ruang.

Kolom
space

Space

Ruang mode impor.

ContextualAddOnMarkup

Jenis ini tidak memiliki kolom.

Markup untuk developer guna menentukan konten AddOn kontekstual.

Kartu

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

Kolom
header

CardHeader

Header kartu. Header biasanya berisi judul dan gambar.

sections[]

Section

Bagian dipisahkan oleh pemisah garis.

card_actions[]

CardAction

Tindakan kartu ini.

name

string

Nama kartu.

CardAction

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

Tidak didukung oleh aplikasi Google Chat.

Kolom
action_label

string

Label yang digunakan untuk ditampilkan di item menu tindakan.

on_click

OnClick

Tindakan onclick untuk item tindakan ini.

CardHeader

Kolom
title

string

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

subtitle

string

Subjudul header kartu.

image_style

ImageStyle

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

image_url

string

URL gambar di header kartu.

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Batas persegi.
AVATAR Batas melingkar.

Bagian

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

Kolom
header

string

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

widgets[]

WidgetMarkup

Bagian harus berisi minimal satu widget.

CreateCustomEmojiRequest

Permintaan untuk membuat emoji kustom.

Kolom
custom_emoji

CustomEmoji

Wajib. Emoji kustom yang akan dibuat.

CreateMembershipRequest

Pesan permintaan untuk membuat keanggotaan.

Kolom
parent

string

Wajib. Nama resource ruang yang akan dibuat keanggotaannya.

Format: spaces/{space}

membership

Membership

Wajib. Hubungan keanggotaan yang akan dibuat.

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

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

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

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

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

Untuk mengundang pengguna yang bukan anggota organisasi Workspace yang memiliki ruang, Anda memerlukan autentikasi pengguna.

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

use_admin_access

bool

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

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

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

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

CreateMessageRequest

Membuat pesan.

Kolom
parent

string

Wajib. Nama resource ruang tempat membuat pesan.

Format: spaces/{space}

message

Message

Wajib. Isi pesan.

thread_key
(deprecated)

string

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

request_id

string

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

message_reply_option

MessageReplyOption

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

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

message_id

string

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

Nilai untuk kolom ini harus memenuhi persyaratan berikut:

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

Untuk mengetahui detailnya, lihat Memberi nama pesan.

MessageReplyOption

Menentukan cara membalas pesan. Negara bagian lainnya mungkin ditambahkan di masa mendatang.

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Default. Memulai rangkaian pesan baru. Penggunaan opsi ini akan mengabaikan thread ID atau thread_key yang disertakan.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Membuat pesan sebagai balasan ke rangkaian pesan yang ditentukan oleh thread ID atau thread_key. Jika gagal, pesan akan memulai rangkaian pesan baru.
REPLY_MESSAGE_OR_FAIL Membuat pesan sebagai balasan ke rangkaian pesan yang ditentukan oleh thread ID atau thread_key. 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

string

Wajib. Pesan tempat reaksi dibuat.

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

reaction

Reaction

Wajib. Reaksi yang akan dibuat.

CreateSpaceRequest

Permintaan untuk membuat ruang bernama tanpa anggota.

Kolom
space

Space

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

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

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

request_id

string

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

CustomEmoji

Merepresentasikan emoji kustom.

Kolom
name

string

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

Format: customEmojis/{customEmoji}

uid

string

Hanya output. Kunci unik untuk resource emoji kustom.

emoji_name

string

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

Diperlukan saat emoji kustom dibuat, hanya output jika tidak.

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

Contoh: :valid-emoji-name:

temporary_image_uri

string

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

payload

CustomEmojiPayload

Opsional. Hanya input. Data payload. Diperlukan saat emoji kustom dibuat.

CustomEmojiPayload

Data payload untuk emoji kustom.

Kolom
file_content

bytes

Wajib. Hanya input. Gambar yang digunakan untuk emoji kustom.

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

filename

string

Wajib. Hanya input. Nama file gambar.

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

DeleteCustomEmojiRequest

Permintaan untuk menghapus emoji kustom.

Kolom
name

string

Wajib. Nama resource emoji kustom yang akan dihapus.

Format: customEmojis/{customEmoji}

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

DeleteMembershipRequest

Permintaan untuk menghapus langganan di ruang.

Kolom
name

string

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

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

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

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

use_admin_access

bool

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

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

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

Menghapus keanggotaan aplikasi di ruang tidak didukung menggunakan akses admin.

DeleteMessageRequest

Permintaan untuk menghapus pesan.

Kolom
name

string

Wajib. Nama resource pesan.

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

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

force

bool

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

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

DeleteReactionRequest

Menghapus reaksi terhadap pesan.

Kolom
name

string

Wajib. Nama reaksi yang akan dihapus.

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

DeleteSpaceRequest

Permintaan untuk menghapus ruang.

Kolom
name

string

Wajib. Nama resource ruang yang akan dihapus.

Format: spaces/{space}

use_admin_access

bool

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

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

Memerlukan cakupan OAuth 2.0 chat.admin.delete.

DeletionMetadata

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

Kolom
deletion_type

DeletionType

Menunjukkan siapa yang menghapus pesan.

DeletionType

Siapa yang menghapus pesan dan bagaimana pesan tersebut dihapus. Nilai lainnya mungkin ditambahkan di masa mendatang.

Enum
DELETION_TYPE_UNSPECIFIED Nilai ini tidak digunakan.
CREATOR Pengguna menghapus pesannya sendiri.
SPACE_OWNER Pemilik ruang telah menghapus pesan.
ADMIN Admin Google Workspace menghapus pesan tersebut.
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

Card

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

DialogAction

Berisi dialog dan kode status permintaan.

Kolom
action_status

ActionStatus

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

Kolom union action. Tindakan yang akan dilakukan. action hanya dapat berupa salah satu dari berikut:
dialog

Dialog

Hanya input. Dialog untuk permintaan.

DriveDataRef

Referensi ke data lampiran drive.

Kolom
drive_file_id

string

ID untuk file drive. Gunakan dengan Drive API.

DriveLinkData

Data untuk link Google Drive.

Kolom
drive_data_ref

DriveDataRef

DriveDataRef yang mereferensikan file Google Drive.

mime_type

string

Jenis mime resource Google Drive tertaut.

Emoji

Emoji yang digunakan sebagai reaksi terhadap pesan.

Kolom
Kolom union content. Wajib. Konten emoji. content hanya dapat berupa salah satu dari berikut:
unicode

string

Opsional. Emoji dasar yang direpresentasikan oleh string unicode.

custom_emoji

CustomEmoji

Hanya output. Emoji kustom.

EmojiReactionSummary

Jumlah orang yang bereaksi terhadap pesan dengan emoji tertentu.

Kolom
emoji

Emoji

Hanya output. Emoji yang terkait dengan reaksi.

reaction_count

int32

Hanya output. Jumlah total reaksi yang menggunakan emoji terkait.

FindDirectMessageRequest

Permintaan untuk mendapatkan ruang pesan langsung berdasarkan resource pengguna.

Kolom
name

string

Wajib. Nama resource pengguna untuk menemukan pesan langsung.

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

GetAttachmentRequest

Permintaan untuk mendapatkan lampiran.

Kolom
name

string

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

GetCustomEmojiRequest

Permintaan untuk menampilkan satu emoji kustom.

Kolom
name

string

Wajib. Nama resource emoji kustom.

Format: customEmojis/{customEmoji}

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

GetMembershipRequest

Permintaan untuk mendapatkan keanggotaan ruang.

Kolom
name

string

Wajib. Nama resource langganan yang akan diambil.

Untuk mendapatkan langganan aplikasi sendiri dengan menggunakan autentikasi pengguna, Anda dapat menggunakan spaces/{space}/members/app secara opsional.

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

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

use_admin_access

bool

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

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

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

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

GetMessageRequest

Permintaan untuk mendapatkan pesan.

Kolom
name

string

Wajib. Nama resource pesan.

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

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

GetSpaceEventRequest

Pesan permintaan untuk mendapatkan peristiwa ruang.

Kolom
name

string

Wajib. Nama resource peristiwa ruang.

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

GetSpaceNotificationSettingRequest

Pesan permintaan untuk mendapatkan setelan notifikasi ruang. Hanya mendukung mendapatkan setelan notifikasi untuk pengguna yang menelepon.

Kolom
name

string

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

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

GetSpaceReadStateRequest

Pesan permintaan untuk GetSpaceReadState API.

Kolom
name

string

Wajib. Nama resource status baca ruang yang akan diambil.

Hanya mendukung mendapatkan status baca untuk pengguna yang memanggil.

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

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

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

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

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

GetSpaceRequest

Permintaan untuk menampilkan satu ruang.

Kolom
name

string

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

Format: spaces/{space}

use_admin_access

bool

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

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

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

GetThreadReadStateRequest

Pesan permintaan untuk GetThreadReadStateRequest API.

Kolom
name

string

Wajib. Nama resource status pembacaan thread yang akan diambil.

Hanya mendukung mendapatkan status baca untuk pengguna yang memanggil.

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

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

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

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

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

Grup

Google Grup di Google Chat.

Kolom
name

string

Nama resource untuk Google Grup.

Merepresentasikan grup di Cloud Identity Groups API.

Format: groups/{group}

HistoryState

Status histori untuk pesan dan ruang. Menentukan berapa lama pesan dan rangkaian pesan percakapan disimpan 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 pesan dan rangkaian pesan disimpan.

ListCustomEmojisRequest

Permintaan untuk menampilkan daftar emoji kustom.

Kolom
page_size

int32

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

page_token

string

Opsional. (Jika melanjutkan dari kueri sebelumnya.)

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

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

filter

string

Opsional. Filter kueri.

Mendukung pemfilteran menurut kreator.

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

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

creator("users/me")

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

ListCustomEmojisResponse

Respons terhadap daftar emoji kustom.

Kolom
custom_emojis[]

CustomEmoji

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

next_page_token

string

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

ListMembershipsRequest

Pesan permintaan untuk listingan langganan.

Kolom
parent

string

Wajib. Nama resource ruang yang akan mengambil daftar keanggotaan.

Format: spaces/{space}

page_size

int32

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

Jika tidak ditentukan, maksimal 100 langganan akan ditampilkan.

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

Nilai negatif menampilkan error INVALID_ARGUMENT.

page_token

string

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

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

filter

string

Opsional. Filter kueri.

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

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

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

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

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

Misalnya, kueri berikut valid:

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

member.type != "BOT"

Kueri berikut tidak valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

show_groups

bool

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

show_invited

bool

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

Saat ini memerlukan autentikasi pengguna.

use_admin_access

bool

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

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

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

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

ListMembershipsResponse

Respons untuk mencantumkan langganan ruang.

Kolom
memberships[]

Membership

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

next_page_token

string

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

ListMessagesRequest

Mencantumkan pesan di ruang yang ditentukan, yang merupakan anggota pengguna.

Kolom
parent

string

Wajib. Nama resource ruang tempat pesan akan dicantumkan.

Format: spaces/{space}

page_size

int32

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

Jika tidak ditentukan, maksimal 25 akan ditampilkan.

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

Nilai negatif menampilkan error INVALID_ARGUMENT.

page_token

string

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

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

filter

string

Opsional. Filter kueri.

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

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

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

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

Misalnya, kueri berikut valid:

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

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

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

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

thread.name = spaces/AAAAAAAAAAA/threads/123

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

order_by

string

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

  • ASC untuk menaik.

  • DESC untuk menurun.

Pengurutan defaultnya adalah create_time ASC.

show_deleted

bool

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

ListMessagesResponse

Pesan respons untuk listingan pesan.

Kolom
messages[]

Message

Daftar pesan.

next_page_token

string

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

ListReactionsRequest

Mencantumkan reaksi terhadap pesan.

Kolom
parent

string

Wajib. Pesan yang diberi reaksi oleh pengguna.

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

page_size

int32

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

page_token

string

Opsional. (Jika melanjutkan dari kueri sebelumnya.)

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

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

filter

string

Opsional. Filter kueri.

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

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

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

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

Misalnya, kueri berikut valid:

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

Kueri berikut tidak valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

ListReactionsResponse

Respons terhadap permintaan reaksi daftar.

Kolom
reactions[]

Reaction

Daftar reaksi di halaman yang diminta (atau pertama).

next_page_token

string

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

ListSpaceEventsRequest

Pesan permintaan untuk listingan acara ruang.

Kolom
parent

string

Wajib. Nama resource ruang Google Chat tempat peristiwa terjadi.

Format: spaces/{space}.

page_size

int32

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

Nilai negatif menampilkan error INVALID_ARGUMENT.

page_token

string

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

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

filter

string

Wajib. Filter kueri.

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

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

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

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

Misalnya, kueri berikut valid:

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

Kueri berikut tidak valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

ListSpaceEventsResponse

Pesan respons untuk listingan peristiwa ruang.

Kolom
space_events[]

SpaceEvent

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

next_page_token

string

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

ListSpacesRequest

Permintaan untuk mencantumkan ruang tempat pemanggil menjadi anggota.

Kolom
page_size

int32

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

Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan.

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

Nilai negatif menampilkan error INVALID_ARGUMENT.

page_token

string

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

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

filter

string

Opsional. Filter kueri.

Anda dapat memfilter ruang menurut jenis ruang (space_type).

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

Misalnya, kueri berikut valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

ListSpacesResponse

Respons untuk permintaan daftar ruang.

Kolom
spaces[]

Space

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

next_page_token

string

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

MatchedUrl

URL yang cocok dalam pesan Chat. Aplikasi Chat dapat melihat pratinjau URL yang cocok. Untuk mengetahui informasi selengkapnya, lihat Melihat pratinjau link.

Kolom
url

string

Hanya output. URL yang cocok.

Langganan

Merepresentasikan hubungan keanggotaan di Google Chat, seperti apakah pengguna atau aplikasi Chat diundang ke, menjadi bagian dari, atau tidak ada di ruang.

Kolom
name

string

ID. Nama resource langganan, yang ditetapkan oleh server.

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

state

MembershipState

Hanya output. Status keanggotaan.

role

MembershipRole

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

Kolom ini hanya dapat digunakan sebagai input di UpdateMembership.

create_time

Timestamp

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

delete_time

Timestamp

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

Kolom union memberType. Anggota yang terkait dengan langganan ini. Jenis anggota lainnya mungkin didukung di masa mendatang. memberType hanya dapat berupa salah satu dari berikut:
member

User

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

group_member

Group

Opsional. Grup Google yang sesuai dengan keanggotaan.

Membaca atau mengubah keanggotaan untuk Google Grup memerlukan autentikasi pengguna.

MembershipRole

Merepresentasikan tindakan yang diizinkan pengguna di ruang Chat. Nilai enum lainnya mungkin ditambahkan di masa mendatang.

Enum
MEMBERSHIP_ROLE_UNSPECIFIED Nilai default. Untuk users: mereka bukan anggota ruang, tetapi dapat diundang. Untuk Google Groups: peran ini selalu ditetapkan (nilai enum lainnya mungkin akan digunakan pada masa mendatang).
ROLE_MEMBER Anggota ruang. Pengguna memiliki izin dasar, seperti mengirim pesan ke ruang. Dalam percakapan 1:1 dan percakapan grup tanpa nama, semua orang memiliki peran ini.
ROLE_MANAGER Pengelola ruang. Pengguna memiliki semua izin dasar serta izin administratif yang memungkinkan mereka mengelola ruang, seperti menambahkan atau menghapus anggota. Hanya didukung di SpaceType.SPACE.

MembershipState

Menentukan hubungan anggota dengan ruang. Status keanggotaan lainnya mungkin didukung di masa mendatang.

Enum
MEMBERSHIP_STATE_UNSPECIFIED Nilai default. Jangan gunakan.
JOINED Pengguna ditambahkan ke ruang, dan dapat berpartisipasi dalam ruang tersebut.
INVITED Pengguna diundang untuk bergabung ke ruang, tetapi belum bergabung.
NOT_A_MEMBER Pengguna bukan anggota ruang dan tidak memiliki undangan yang menunggu keputusan untuk bergabung ke ruang.

MembershipBatchCreatedEventData

Payload peristiwa untuk beberapa langganan baru.

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

Kolom
memberships[]

MembershipCreatedEventData

Daftar langganan baru.

MembershipBatchDeletedEventData

Payload peristiwa untuk beberapa langganan yang dihapus.

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

Kolom
memberships[]

MembershipDeletedEventData

Daftar langganan yang dihapus.

MembershipBatchUpdatedEventData

Payload peristiwa untuk beberapa langganan yang diperbarui.

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

Kolom
memberships[]

MembershipUpdatedEventData

Daftar langganan yang diperbarui.

MembershipCreatedEventData

Payload peristiwa untuk langganan baru.

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

Kolom
membership

Membership

Langganan baru.

MembershipDeletedEventData

Payload peristiwa untuk langganan yang dihapus.

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

Kolom
membership

Membership

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

MembershipUpdatedEventData

Payload peristiwa untuk langganan yang diperbarui.

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

Kolom
membership

Membership

Langganan yang diperbarui.

Pesan

Pesan di ruang Google Chat.

Kolom
name

string

ID. Nama resource pesan.

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

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

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

sender

User

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

create_time

Timestamp

Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu pesan dibuat. Kolom ini hanya output, kecuali jika digunakan di 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

Timestamp

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

delete_time

Timestamp

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

text

string

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

Untuk mempelajari cara membuat pesan teks, lihat Mengirim pesan.

formatted_text

string

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

  • Sintaksis markup untuk tebal, miring, coret, monospace, blok monospace, dan daftar berbutir.

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

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

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

Untuk informasi selengkapnya, lihat Melihat pemformatan teks yang dikirim dalam pesan

cards[]
(deprecated)

Card

Tidak digunakan lagi: Gunakan cards_v2 sebagai gantinya.

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

cards_v2[]

CardWithId

Opsional. Array kartu.

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

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

Buat desain dan lihat pratinjau kartu dengan Pembuat Kartu.

Membuka Pembuat Kartu

annotations[]

Annotation

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

thread

Thread

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

space

Space

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

fallback_text

string

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

action_response

ActionResponse

Hanya input. Parameter yang dapat digunakan aplikasi Chat untuk mengonfigurasi cara responsnya diposting.

argument_text

string

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

slash_command

SlashCommand

Hanya output. Informasi perintah garis miring, jika ada.

attachment[]

Attachment

Opsional. Lampiran yang diupload pengguna.

matched_url

MatchedUrl

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

thread_reply

bool

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

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

client_assigned_message_id

string

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 messageId saat Anda membuat pesan. Untuk mengetahui detailnya, lihat Memberi nama pesan.

emoji_reaction_summaries[]

EmojiReactionSummary

Hanya output. Daftar ringkasan reaksi emoji pada pesan.

private_message_viewer

User

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

Untuk mengetahui detailnya, lihat Mengirim pesan secara pribadi.

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

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

attached_gifs[]

AttachedGif

Hanya output. Gambar GIF yang dilampirkan ke pesan.

accessory_widgets[]

AccessoryWidget

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

Membuat pesan dengan widget aksesori memerlukan autentikasi aplikasi.

MessageBatchCreatedEventData

Payload peristiwa untuk beberapa pesan baru.

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

Kolom
messages[]

MessageCreatedEventData

Daftar pesan baru.

MessageBatchDeletedEventData

Payload peristiwa untuk beberapa pesan yang dihapus.

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

Kolom
messages[]

MessageDeletedEventData

Daftar pesan yang dihapus.

MessageBatchUpdatedEventData

Payload peristiwa untuk beberapa pesan yang diperbarui.

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

Kolom
messages[]

MessageUpdatedEventData

Daftar pesan yang diperbarui.

MessageCreatedEventData

Payload peristiwa untuk pesan baru.

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

Kolom
message

Message

Pesan baru.

MessageDeletedEventData

Payload peristiwa untuk pesan yang dihapus.

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

Kolom
message

Message

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

MessageUpdatedEventData

Payload peristiwa untuk pesan yang diperbarui.

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

Kolom
message

Message

Pesan yang diperbarui.

QuotedMessageMetadata

Informasi tentang pesan yang dikutip.

Kolom
name

string

Hanya output. Nama resource pesan yang dikutip.

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

last_update_time

Timestamp

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

Reaksi

Reaksi terhadap pesan.

Kolom
name

string

ID. Nama resource reaksi.

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

user

User

Hanya output. Pengguna yang membuat reaksi.

emoji

Emoji

Wajib. Emoji yang digunakan dalam reaksi.

ReactionBatchCreatedEventData

Payload peristiwa untuk beberapa reaksi baru.

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

Kolom
reactions[]

ReactionCreatedEventData

Daftar reaksi baru.

ReactionBatchDeletedEventData

Payload peristiwa untuk beberapa reaksi yang dihapus.

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

Kolom
reactions[]

ReactionDeletedEventData

Daftar reaksi yang dihapus.

ReactionCreatedEventData

Payload peristiwa untuk reaksi baru.

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

Kolom
reaction

Reaction

Reaksi baru.

ReactionDeletedEventData

Payload peristiwa untuk reaksi yang dihapus.

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

Kolom
reaction

Reaction

Reaksi yang dihapus.

RichLinkMetadata

Link lengkap ke resource.

Kolom
uri

string

URI link ini.

Kolom union data. Data untuk resource tertaut. data hanya dapat berupa salah satu dari berikut:

RichLinkType

Jenis link multimedia. Jenis lainnya mungkin ditambahkan di masa mendatang.

Enum
DRIVE_FILE Jenis link kaya Google Drive.
CHAT_SPACE Jenis link lengkap ruang Chat. Misalnya, smart chip ruang.

SearchSpacesRequest

Permintaan untuk menelusuri daftar ruang berdasarkan kueri.

Kolom
use_admin_access

bool

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

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

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

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

page_size

int32

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

Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan.

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

page_token

string

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

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

query

string

Wajib. Kueri penelusuran.

Anda dapat menelusuri menggunakan parameter berikut:

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

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

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

display_name hanya menerima operator HAS (:). Teks yang akan dicocokkan pertama-tama akan ditokenisasi menjadi token dan setiap token dicocokkan dengan awalan tanpa mempertimbangkan huruf besar/kecil dan secara independen sebagai substring di mana saja dalam display_name ruang. Misalnya, Fun Eve cocok dengan Fun event atau The evening was fun, tetapi tidak cocok dengan notFun event atau even.

external_user_allowed menerima true atau false.

space_history_state hanya menerima nilai dari kolom historyState dari resource space.

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

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

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

Contoh kueri berikut valid:

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

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

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

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

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

string

Opsional. Cara daftar ruang diurutkan.

Atribut yang didukung untuk diurutkan adalah:

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

Nilai operasi pengurutan yang valid adalah:

  • ASC untuk menaik. Nilai default.

  • DESC untuk menurun.

Sintaksis yang didukung adalah:

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

SearchSpacesResponse

Respons dengan daftar ruang yang sesuai dengan permintaan ruang penelusuran.

Kolom
spaces[]

Space

Halaman ruang yang diminta.

next_page_token

string

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

total_size

int32

Jumlah total ruang yang cocok dengan kueri, di semua halaman. Jika hasilnya lebih dari 10.000 spasi, nilai ini adalah estimasi.

SetUpSpaceRequest

Permintaan untuk membuat ruang dan menambahkan pengguna tertentu ke dalamnya.

Kolom
space

Space

Wajib. Kolom Space.spaceType wajib diisi.

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

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

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

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

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

request_id

string

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

memberships[]

Membership

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

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

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

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

Opsional saat menetapkan Space.spaceType ke SPACE.

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

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

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

SlashCommand

Perintah garis miring di Google Chat.

Kolom
command_id

int64

ID perintah garis miring yang dipanggil.

SlashCommandMetadata

Metadata anotasi untuk perintah garis miring (/).

Kolom
bot

User

Aplikasi Chat yang perintahnya dipanggil.

type

Type

Jenis perintah garis miring.

command_name

string

Nama perintah garis miring yang dipanggil.

command_id

int64

ID perintah dari perintah garis miring yang dipanggil.

triggers_dialog

bool

Menunjukkan apakah perintah garis miring ditujukan untuk dialog.

Jenis

Enum
TYPE_UNSPECIFIED Nilai default untuk enum. Jangan gunakan.
ADD Menambahkan aplikasi Chat ke ruang.
INVOKE Memanggil 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

string

ID. Nama resource ruang.

Format: spaces/{space}

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

type
(deprecated)

Type

Hanya output. Tidak digunakan lagi: Gunakan space_type sebagai gantinya. Jenis ruang.

space_type

SpaceType

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

single_user_bot_dm

bool

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

threaded
(deprecated)

bool

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

display_name

string

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

Untuk pesan langsung, kolom ini mungkin kosong.

Mendukung maksimal 128 karakter.

external_user_allowed

bool

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

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

Untuk ruang yang ada, kolom ini hanya output.

space_threading_state

SpaceThreadingState

Hanya output. Status rangkaian pesan di ruang Chat.

space_details

SpaceDetails

Opsional. Detail tentang ruang, termasuk deskripsi dan aturan.

space_history_state

HistoryState

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

import_mode

bool

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

Membuat ruang di Import Mode memerlukan autentikasi pengguna.

create_time

Timestamp

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

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

Hanya diisi dalam output jika spaceType adalah GROUP_CHAT atau SPACE.

last_active_time

Timestamp

Hanya output. Stempel waktu pesan terakhir dalam ruang.

admin_installed

bool

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

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

membership_count

MembershipCount

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

access_settings

AccessSettings

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

space_uri

string

Hanya output. URI untuk pengguna agar dapat mengakses ruang.

import_mode_expire_time

Timestamp

Hanya output. Waktu saat ruang akan otomatis dihapus oleh sistem jika tetap dalam mode impor.

Setiap ruang yang dibuat dalam mode impor harus keluar dari mode ini sebelum waktu habis masa berlakunya menggunakan spaces.completeImport.

Kolom ini hanya diisi untuk ruang yang dibuat dengan mode impor.

customer

string

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

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

Untuk DM, kolom ini tidak diisi.

Kolom union space_permission_settings. Merepresentasikan setelan izin ruang. Hanya diisi jika space_type adalah SPACE.

Memerlukan autentikasi pengguna. space_permission_settings hanya dapat berupa salah satu dari berikut:

predefined_permission_settings

PredefinedPermissionSettings

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

permission_settings

PermissionSettings

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

AccessSettings

Merepresentasikan setelan akses ruang.

Kolom
access_state

AccessState

Hanya output. Menunjukkan status akses ruang.

audience

string

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

Format: audiences/{audience}

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

Membaca target audiens mendukung:

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

Menetapkan audiens target memerlukan autentikasi pengguna.

AccessState

Merepresentasikan status akses ruang.

Enum
ACCESS_STATE_UNSPECIFIED Status akses tidak diketahui atau tidak didukung di 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.
DISCOVERABLE

Pengelola ruang telah memberikan akses ke ruang kepada target audiens. Pengguna atau Google Grup yang telah ditambahkan atau diundang ke ruang satu per satu juga dapat menemukan dan mengakses ruang tersebut. Untuk mempelajari lebih lanjut, lihat Membuat ruang dapat ditemukan oleh pengguna tertentu.

Membuat ruang yang dapat ditemukan memerlukan autentikasi pengguna.

MembershipCount

Merepresentasikan jumlah keanggotaan ruang, yang dikelompokkan ke dalam kategori.

Kolom
joined_direct_human_user_count

int32

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

joined_group_count

int32

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

PermissionSetting

Merepresentasikan setelan izin ruang.

Kolom
managers_allowed

bool

Opsional. Apakah pengelola ruang memiliki izin ini.

members_allowed

bool

Opsional. Apakah anggota non-pengelola memiliki izin ini.

PermissionSettings

Setelan izin yang dapat Anda tentukan saat memperbarui ruang bernama yang ada.

Untuk menetapkan setelan izin saat membuat ruang, tentukan kolom PredefinedPermissionSettings dalam permintaan Anda.

Kolom
manage_members_and_groups

PermissionSetting

Opsional. Setelan untuk mengelola anggota dan grup di ruang.

modify_space_details

PermissionSetting

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

toggle_history

PermissionSetting

Opsional. Setelan untuk mengaktifkan dan menonaktifkan histori ruang.

use_at_mention_all

PermissionSetting

Opsional. Setelan untuk menggunakan @semua di ruang.

manage_apps

PermissionSetting

Opsional. Setelan untuk mengelola aplikasi di ruang.

manage_webhooks

PermissionSetting

Opsional. Setelan untuk mengelola webhook di ruang.

post_messages

PermissionSetting

Hanya output. Setelan untuk memposting pesan dalam ruang.

reply_messages

PermissionSetting

Opsional. Setelan untuk membalas pesan dalam ruang.

PredefinedPermissionSettings

Setelan izin standar yang hanya dapat Anda tentukan saat membuat ruang bernama. Setelan lainnya mungkin ditambahkan di masa mendatang. Untuk mengetahui detail tentang setelan izin untuk ruang bernama, lihat Mempelajari ruang.

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Tidak ditentukan. Jangan gunakan.
COLLABORATION_SPACE Setelan untuk menjadikan ruang sebagai ruang kolaborasi tempat semua anggota dapat memposting pesan.
ANNOUNCEMENT_SPACE Setelan untuk menjadikan ruang sebagai ruang pengumuman tempat hanya pengelola ruang yang dapat memposting pesan.

SpaceDetails

Detail tentang ruang, termasuk deskripsi dan aturan.

Kolom
description

string

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

Mendukung hingga 150 karakter.

guidelines

string

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 merespons pesan, pengguna dapat membalas dalam rangkaian pesan, yang akan 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. Diperlukan saat membuat atau memperbarui ruang. Output hanya untuk penggunaan lain.

Enum
SPACE_TYPE_UNSPECIFIED Direservasi.
SPACE Tempat 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 antara orang dan aplikasi Chat.

Jenis

Tidak digunakan lagi: Gunakan SpaceType sebagai gantinya.

Enum
TYPE_UNSPECIFIED Direservasi.
ROOM Percakapan antara dua orang atau lebih.
DM Pesan Langsung 1:1 antara manusia dan aplikasi Chat, dengan semua pesan bersifat datar. Perhatikan bahwa hal ini tidak mencakup pesan langsung antara dua orang.

SpaceBatchUpdatedEventData

Payload peristiwa untuk beberapa pembaruan pada ruang.

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

Kolom
spaces[]

SpaceUpdatedEventData

Daftar ruang yang diperbarui.

SpaceEvent

Peristiwa yang mewakili perubahan atau aktivitas di ruang Google Chat. Untuk mempelajari lebih lanjut, lihat Bekerja dengan peristiwa dari Google Chat.

Kolom
name

string

Nama resource peristiwa ruang.

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

event_time

Timestamp

Waktu saat peristiwa terjadi.

event_type

string

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

Jenis peristiwa yang didukung untuk pesan:

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

Jenis peristiwa yang didukung untuk langganan:

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

Jenis peristiwa yang didukung untuk reaksi:

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

Jenis peristiwa yang didukung tentang ruang:

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

Kolom union payload.

payload hanya dapat berupa salah satu dari hal berikut:

message_created_event_data

MessageCreatedEventData

Payload peristiwa untuk pesan baru.

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

message_updated_event_data

MessageUpdatedEventData

Payload peristiwa untuk pesan yang diperbarui.

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

message_deleted_event_data

MessageDeletedEventData

Payload peristiwa untuk pesan yang dihapus.

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

message_batch_created_event_data

MessageBatchCreatedEventData

Payload peristiwa untuk beberapa pesan baru.

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

Payload peristiwa untuk beberapa pesan yang diperbarui.

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

Payload peristiwa untuk beberapa pesan yang dihapus.

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

space_updated_event_data

SpaceUpdatedEventData

Payload peristiwa untuk pembaruan ruang.

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Payload peristiwa untuk beberapa pembaruan pada ruang.

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

membership_created_event_data

MembershipCreatedEventData

Payload peristiwa untuk langganan baru.

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

membership_updated_event_data

MembershipUpdatedEventData

Payload peristiwa untuk langganan yang diperbarui.

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

membership_deleted_event_data

MembershipDeletedEventData

Payload peristiwa untuk langganan yang dihapus.

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

Payload peristiwa untuk beberapa langganan baru.

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Payload peristiwa untuk beberapa langganan yang diperbarui.

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Payload peristiwa untuk beberapa langganan yang dihapus.

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

reaction_created_event_data

ReactionCreatedEventData

Payload peristiwa untuk reaksi baru.

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

reaction_deleted_event_data

ReactionDeletedEventData

Payload peristiwa untuk reaksi yang dihapus.

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

reaction_batch_created_event_data

ReactionBatchCreatedEventData

Payload peristiwa untuk beberapa reaksi baru.

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Payload peristiwa untuk beberapa reaksi yang dihapus.

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

SpaceNotificationSetting

Setelan notifikasi pengguna di ruang.

Kolom
name

string

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

notification_setting

NotificationSetting

Setelan notifikasi.

mute_setting

MuteSetting

Setelan bisukan notifikasi ruang.

MuteSetting

Jenis setelan bisukan notifikasi ruang.

Enum
MUTE_SETTING_UNSPECIFIED Direservasi.
UNMUTED Pengguna akan menerima notifikasi untuk ruang berdasarkan setelan notifikasi.
MUTED Pengguna tidak akan menerima notifikasi apa pun untuk ruang tersebut, terlepas dari setelan notifikasinya.

NotificationSetting

Jenis setelan notifikasi.

Enum
NOTIFICATION_SETTING_UNSPECIFIED Direservasi.
ALL Notifikasi dipicu oleh @sebutan, rangkaian pesan yang diikuti, pesan pertama dari rangkaian pesan baru. Semua rangkaian pesan baru akan otomatis diikuti, kecuali jika dibatalkan secara manual oleh pengguna.
MAIN_CONVERSATIONS Notifikasi dipicu oleh @sebutan, rangkaian pesan yang diikuti, pesan pertama dari rangkaian pesan baru. Tidak tersedia untuk pesan langsung 1:1.
FOR_YOU Notifikasi dipicu oleh @sebutan, rangkaian pesan yang diikuti. Tidak tersedia untuk pesan langsung 1:1.
OFF Notifikasi nonaktif.

SpaceReadState

Status baca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang telah dibaca dan belum dibaca.

Kolom
name

string

Nama resource status baca ruang.

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

last_read_time

Timestamp

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

SpaceUpdatedEventData

Payload peristiwa untuk ruang yang diperbarui.

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

Kolom
space

Space

Ruang yang diperbarui.

Rangkaian pesan

Rangkaian pesan di ruang Google Chat. Untuk contoh penggunaan, lihat Memulai atau membalas rangkaian pesan.

Jika menentukan rangkaian pesan saat membuat pesan, Anda dapat menetapkan kolom messageReplyOption untuk menentukan apa yang terjadi jika tidak ada rangkaian pesan yang cocok.

Kolom
name

string

ID. Nama resource thread.

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

thread_key

string

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

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

ThreadReadState

Status baca pengguna dalam rangkaian pesan, yang digunakan untuk mengidentifikasi pesan yang telah dibaca dan belum dibaca.

Kolom
name

string

Nama resource status baca thread.

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

last_read_time

Timestamp

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

UpdateMembershipRequest

Pesan permintaan untuk memperbarui keanggotaan.

Kolom
membership

Membership

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

update_mask

FieldMask

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

Jalur kolom yang saat ini didukung:

  • role
use_admin_access

bool

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

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

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

Permintaan untuk memperbarui pesan.

Kolom
message

Message

Wajib. Pesan dengan kolom yang diperbarui.

update_mask

FieldMask

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

Jalur kolom yang saat ini didukung:

allow_missing

bool

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

UpdateSpaceNotificationSettingRequest

Permintaan untuk memperbarui setelan notifikasi ruang. Hanya mendukung pembaruan setelan notifikasi untuk pengguna yang menelepon.

Kolom
space_notification_setting

SpaceNotificationSetting

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

update_mask

FieldMask

Wajib. Jalur kolom yang didukung: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

Pesan permintaan untuk UpdateSpaceReadState API.

Kolom
space_read_state

SpaceReadState

Wajib. Status baca ruang dan kolom yang akan diperbarui.

Hanya mendukung pembaruan status baca untuk pengguna yang memanggil.

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

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

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

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

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

update_mask

FieldMask

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

  • last_read_time

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

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

UpdateSpaceRequest

Permintaan untuk memperbarui satu ruang.

Kolom
space

Space

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

update_mask

FieldMask

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

Anda dapat memperbarui kolom berikut untuk ruang:

space_details: Memperbarui deskripsi ruang. Mendukung hingga 150 karakter.

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

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

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

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

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

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

bool

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

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

Memerlukan cakupan OAuth 2.0 chat.admin.spaces.

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

Pengguna

Pengguna di Google Chat. Saat ditampilkan sebagai output dari permintaan, jika aplikasi Chat Anda diautentikasi sebagai pengguna, output untuk resource User hanya akan mengisi name dan type pengguna.

Kolom
name

string

Nama resource untuk user Google Chat.

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

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

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

  • id untuk pengguna di Admin SDK Directory API.

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

display_name

string

Hanya output. Nama tampilan pengguna.

domain_id

string

ID unik domain Google Workspace pengguna.

type

Type

Jenis pengguna.

is_anonymous

bool

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

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

User

Pengguna yang disebutkan.

type

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 menampilkan teks dan gambar.

Kolom
buttons[]

Button

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

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 hal berikut:
text_paragraph

TextParagraph

Menampilkan paragraf teks di widget ini.

image

Image

Menampilkan gambar di widget ini.

key_value

KeyValue

Menampilkan item nilai kunci di widget ini.

Tombol

Tombol. Dapat berupa tombol teks atau tombol gambar.

Kolom

Kolom union type.

type hanya dapat berupa salah satu dari hal berikut:

text_button

TextButton

Tombol dengan teks dan tindakan onclick.

image_button

ImageButton

Tombol dengan gambar dan tindakan onclick.

FormAction

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

Kolom
action_method_name

string

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

parameters[]

ActionParameter

Daftar parameter tindakan.

ActionParameter

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

Kolom
key

string

Nama parameter untuk skrip tindakan.

value

string

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

string

URL gambar.

on_click

OnClick

Tindakan onclick.

aspect_ratio

double

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

ImageButton

Tombol gambar dengan tindakan onclick.

Kolom
on_click

OnClick

Tindakan onclick.

name

string

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

Kolom union icons. Ikon dapat ditentukan oleh Icon enum atau URL. icons hanya dapat berupa salah satu dari hal berikut:
icon

Icon

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

icon_url

string

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

string

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

content

string

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

content_multiline

bool

Jika konten harus berupa multibaris.

bottom_label

string

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

on_click

OnClick

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

Kolom union icons. Setidaknya satu ikon, top_label, dan bottom_label harus ditentukan. icons hanya dapat berupa salah satu dari hal berikut:
icon

Icon

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

icon_url

string

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 hal berikut:
button

Button

Tombol yang dapat diklik untuk memicu tindakan.

OnClick

Tindakan onclick (misalnya, membuka link).

Kolom

Kolom union data.

data hanya dapat berupa salah satu dari hal berikut:

action

FormAction

Tindakan formulir dipicu oleh tindakan onclick ini jika ditentukan.

TextButton

Tombol dengan teks dan tindakan onclick.

Kolom
text

string

Teks tombol.

on_click

OnClick

Tindakan onclick tombol.

TextParagraph

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

Kolom
text

string