Package google.chat.v1

Ruang mode impor.

ContextualAddOnMarkup

Jenis ini tidak memiliki kolom.

Markup bagi developer untuk menentukan konten AddOn kontekstual.

Kartu

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

Kolom
`header`	`CardHeader` Header kartu. Header biasanya berisi judul dan gambar.
`sections[]`	`Section` Bagian dipisahkan oleh garis pemisah.
`card_actions[]`	`CardAction` Tindakan kartu ini.
`name`	`string` Nama kartu.

CardAction

Tindakan kartu adalah tindakan yang terkait dengan kartu. Untuk kartu invoice, tindakan umumnya adalah: menghapus invoice, mengirim invoice melalui email, atau membuka 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 menggunakan satu baris. Jika hanya judul yang ditentukan, judul tersebut akan menggunakan kedua baris.
`subtitle`	`string` Subjudul header kartu.
`image_style`	`ImageStyle` Jenis gambar (misalnya, batas persegi atau batas lingkaran).
`image_url`	`string` URL gambar di header kartu.

ImageStyle

Enum
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Batas persegi.
`AVATAR`	Batas lingkaran.

Bagian

Bagian berisi kumpulan widget yang dirender (secara vertikal) sesuai 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 mengetahui 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

Wajib. Emoji kustom yang akan dibuat.

CreateMembershipRequest

Pesan permintaan untuk membuat keanggotaan.

Kolom

parent

string

Wajib. Nama resource ruang tempat keanggotaan akan dibuat.

Format: spaces/{space}

membership

Wajib. Relasi keanggotaan yang akan dibuat.

Kolom memberType harus berisi pengguna dengan kolom user.name dan user.type yang 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 melakukan autentikasi sebagai pengguna, cakupan otorisasi chat.memberships diperlukan.
Saat melakukan autentikasi sebagai aplikasi, cakupan otorisasi chat.app.memberships diperlukan.
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 di 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.

Mengundang pengguna eksternal ke organisasi Workspace yang memiliki ruang 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 ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

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

Memerlukan cakupan OAuth 2.0 chat.admin.memberships.

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

CreateMessageNotificationOptions

Opsi untuk perilaku notifikasi saat pesan diposting.

Kolom

notification_type

NotificationType

Jenis notifikasi untuk pesan.

NotificationType

Opsi jenis notifikasi untuk pesan.

Enum

NOTIFICATION_TYPE_NONE Perilaku default. Perilaku notifikasi mirip dengan saat pengguna manusia mengirim pesan menggunakan UI Chat: tidak ada notifikasi yang dikirim ke pengirim manusia.

NOTIFICATION_TYPE_FORCE_NOTIFY

Paksa beri tahu penerima. Tindakan ini akan mengabaikan setelan notifikasi ruang pengguna dan setelan Jangan Ganggu Chat. Opsi ini tidak mengabaikan setelan Jangan Ganggu di tingkat perangkat.

Memerlukan autentikasi aplikasi.

NOTIFICATION_TYPE_SILENT

Jangan beri tahu penerima, dan jangan tandai pesan sebagai belum dibaca. Perilaku ini mirip dengan pengguna yang membisukan percakapan atau mengaktifkan Jangan Ganggu Chat.

Memerlukan autentikasi aplikasi.

CreateMessagePinRequest

Pesan permintaan untuk membuat penyematan pesan.

Kolom

parent

string

Wajib. Ruang induk tempat pin pesan akan dibuat. Format: spaces/{space}

message_pin

MessagePin

Wajib. MessagePin yang akan dibuat.

CreateMessageRequest

Membuat pesan.

Kolom
`parent`	`string` Wajib. Nama resource ruang tempat pesan akan dibuat. Format: `spaces/{space}`
`message`	`Message` Wajib. Isi pesan.
`thread_key (deprecated)`	`string` Item ini tidak digunakan lagi. 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 unik untuk permintaan ini. Sebaiknya gunakan UUID acak. Menentukan ID permintaan akan membuat permintaan menjadi idempoten, yang memastikan bahwa beberapa permintaan identik dengan ID permintaan yang sama hanya akan menghasilkan satu pesan yang dibuat. Permintaan berikutnya dengan ID permintaan yang sama akan menampilkan pesan yang ada dan tidak memperbarui pesan, meskipun detail yang diminta berbeda dari status saat ini. Untuk menggunakan kolom ini secara efektif: Pastikan permintaan berikutnya identik dan menggunakan kredensial autentikasi yang sama dengan permintaan asli. Jika pesan sudah dibuat dengan ID permintaan yang diberikan, permintaan akan menampilkan pesan tersebut. Perhatikan bahwa pesan yang ditampilkan mungkin tidak terisi sepenuhnya; API akan menggemakan pesan dalam permintaan Anda dengan nama resource yang ditetapkan sistem terisi. Untuk mengambil metadata terbaru untuk pesan, panggil `GetMessage`. Menggunakan kembali ID permintaan yang ada dengan pengguna terautentikasi yang berbeda akan menghasilkan error.
`message_reply_option`	`MessageReplyOption` Opsional. Menentukan apakah pesan memulai rangkaian pesan atau membalasnya. Hanya didukung di ruang yang diberi nama. Saat merespons interaksi pengguna, kolom ini akan diabaikan. Untuk interaksi dalam rangkaian pesan, balasan akan 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 dalam nama resource pesan (direpresentasikan dalam kolom `name` pesan). Nilai untuk kolom ini harus memenuhi persyaratan berikut: Diawali dengan `client-`. Misalnya, `client-custom-name` adalah ID kustom yang valid, tetapi `custom-name` tidak valid. Berisi hingga 63 karakter dan hanya huruf kecil, angka, dan tanda hubung. Bersifat unik dalam ruang. Aplikasi Chat tidak dapat menggunakan ID kustom yang sama untuk pesan yang berbeda. Untuk mengetahui detailnya, lihat Memberi nama pesan.
`create_message_notification_options`	`CreateMessageNotificationOptions` Opsional. Mengontrol perilaku notifikasi saat pesan diposting. Untuk mempelajari lebih lanjut, lihat Memaksa notifikasi atau mengirim pesan senyap.

MessageReplyOption

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

Enum
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	Default. Memulai rangkaian pesan baru. Jika opsi ini digunakan, `thread ID` atau `thread_key` yang disertakan akan diabaikan.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	Membuat pesan sebagai balasan untuk 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 untuk 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

Wajib. Reaksi yang akan dibuat.

CreateSectionRequest

Pesan permintaan untuk membuat bagian.

Kolom

parent

string

Wajib. Nama resource induk tempat bagian dibuat.

Format: users/{user}

section

Wajib. Bagian yang akan dibuat.

CreateSpaceRequest

Permintaan untuk membuat ruang bernama tanpa anggota.

Kolom

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 true.

Jika Anda menerima pesan error ALREADY_EXISTS, coba displayName lain. 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 akan membuat permintaan menjadi idempoten, yang memastikan bahwa beberapa permintaan identik dengan ID permintaan yang sama hanya akan menghasilkan satu ruang yang dibuat. Permintaan berikutnya dengan ID permintaan yang sama akan menampilkan ruang yang ada dan tidak memperbarui ruang, meskipun detail yang diminta berbeda dari status saat ini.

Untuk menggunakan kolom ini secara efektif:

Pastikan permintaan berikutnya identik dan menggunakan kredensial autentikasi yang sama dengan permintaan asli.
Jika ruang sudah dibuat dengan ID permintaan yang diberikan, permintaan akan menampilkan ruang tersebut. Perhatikan bahwa ruang yang ditampilkan mungkin tidak terisi sepenuhnya; API akan menggemakan ruang dalam permintaan Anda dengan nama resource yang ditetapkan sistem terisi. Untuk mengambil metadata terbaru untuk ruang, panggil GetSpace.
Menggunakan kembali ID permintaan yang ada dengan pengguna terautentikasi yang berbeda akan menghasilkan 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. Wajib diisi saat emoji kustom dibuat, hanya output jika tidak. Nama emoji harus diawali dan diakhiri dengan titik dua, harus menggunakan huruf kecil, dan hanya boleh 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 sementara untuk emoji kustom, yang valid selama minimal 10 menit. Perhatikan bahwa kolom 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 berukuran kurang dari 256 KB dan dimensi gambar harus persegi serta berukuran antara 64 dan 500 piksel. Pembatasan dapat berubah sewaktu-waktu.

filename

string

Wajib. Hanya input. Nama file gambar.

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

CustomEmojiMetadata

Metadata anotasi untuk emoji kustom.

Kolom

custom_emoji

Emoji kustom.

CustomStatus

Merepresentasikan status kustom pengguna di Google Chat. Status ini mencakup pesan teks singkat dengan emoji opsional yang ditetapkan pengguna untuk memberikan konteks lebih lanjut tentang ketersediaannya.

Kolom
`text`	`string` Wajib. Teks status kustom. ID ini akan berupa string dengan panjang maksimum 64.
`emoji`	`Emoji` Wajib. Emoji status kustom. Hanya emoji Unicode yang didukung; emoji kustom tidak didukung.
Kolom union `expiration`. Waktu habis masa berlaku status kustom. Waktu ini dapat ditentukan sebagai stempel waktu absolut atau durasi time-to-live. `expiration` hanya dapat berupa salah satu dari berikut:
`expire_time`	`Timestamp` Stempel waktu saat masa berlaku status kustom berakhir.
`ttl`	`Duration` Hanya input. Durasi time-to-live setelah status kustom berakhir.

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 keanggotaan dalam ruang.

Kolom

name

string

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

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

Saat menghapus keanggotaan 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 ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang melakukan panggilan 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.

DeleteMessagePinRequest

Pesan permintaan untuk menghapus sematan pesan.

Kolom

name

string

Wajib. Nama resource pin pesan yang akan dihapus. Format: spaces/{space}/messagePins/{message_pin}

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 dalam rangkaian pesan tersebut. Jika false, jika pesan memiliki balasan berangkai, penghapusan akan gagal.

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

DeleteReactionRequest

Menghapus reaksi pada pesan.

Kolom

name

string

Wajib. Nama reaksi yang akan dihapus.

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

DeleteSectionRequest

Pesan permintaan untuk menghapus bagian.

Kolom

name

string

Wajib. Nama bagian yang akan dihapus.

Format: users/{user}/sections/{section}

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 ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang melakukan panggilan 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 jika delete_time ditetapkan.

Kolom

deletion_type

DeletionType

Menunjukkan siapa yang menghapus pesan.

DeletionType

Siapa yang menghapus pesan dan cara pesan tersebut dihapus. Nilai lainnya mungkin ditambahkan pada masa mendatang. Lihat Mengedit atau menghapus pesan di Google Chat untuk mengetahui detail tentang kapan pesan dapat dihapus.

Enum
`DELETION_TYPE_UNSPECIFIED`	Nilai ini tidak digunakan.
`CREATOR`	Pengguna menghapus pesannya sendiri.
`SPACE_OWNER`	Pemilik atau pengelola menghapus pesan.
`ADMIN`	Administrator Google Workspace menghapus pesan. Administrator dapat menghapus pesan apa pun dalam ruang, termasuk pesan yang dikirim oleh anggota ruang atau aplikasi Chat.
`APP_MESSAGE_EXPIRY`	Aplikasi Chat menghapus pesannya sendiri saat masa berlakunya berakhir.
`CREATOR_VIA_APP`	Aplikasi Chat menghapus pesan atas nama pembuat (menggunakan autentikasi pengguna).
`SPACE_OWNER_VIA_APP`	Aplikasi Chat menghapus pesan atas nama pengelola ruang (menggunakan autentikasi pengguna).
`SPACE_MEMBER`	Anggota ruang menghapus pesan. Pengguna dapat menghapus pesan yang dikirim oleh aplikasi.

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 memanggil atau mengirimkan dialog. Menampilkan status dan pesan kepada pengguna, jika perlu. Misalnya, jika terjadi error atau keberhasilan.

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

dialog

Dialog

Hanya input. Dialog untuk permintaan.

DoNotDisturbMetadata

Metadata yang terkait dengan status ketersediaan DO_NOT_DISTURB, yang menentukan kapan status ditetapkan akan berakhir.

Kolom

expiration_time

Timestamp

Hanya output. Stempel waktu hingga pengguna harus ditandai sebagai JANGAN_GANGGU. Tanggal ini dapat ditetapkan maksimal 1 tahun ke depan.

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 merujuk ke file Google Drive.

mime_type

string

Jenis MIME resource Google Drive yang ditautkan.

Elemen

Elemen adalah komponen tambahan yang mungkin atau mungkin tidak terkait dengan teks pesan yang diberikan selama pembuatan pesan.

Kolom

cited_sources[]

CitedSource

Daftar sumber yang akan ditampilkan di bawah pesan sebagai link footer. Hal ini tidak direferensikan secara inline. Untuk referensi inline, gunakan citations.

citations[]

Citation

Daftar kutipan inline yang dirujuk dalam teks pesan (melalui tag <chat-citation>) yang dirender sebagai kartu informasi interaktif.

ElementsImage

Objek yang mengenkapsulasi berbagai cara untuk merepresentasikan gambar. Representasi yang saat ini didukung: - Gambar yang diambil dari URI. Representasi tambahan mungkin akan didukung pada masa mendatang.

Kolom

Kolom union image. Wajib. Salah satu representasi gambar yang didukung. image hanya dapat berupa salah satu dari berikut:

image_uri

string

Wajib. URI yang dapat diakses secara publik untuk gambar.

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 diwakili oleh string unicode.

custom_emoji

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 melakukan autentikasi sebagai pengguna, Anda dapat menggunakan email sebagai alias untuk {user}. Misalnya, users/example@gmail.com dengan example@gmail.com adalah email pengguna Google Chat.

FindGroupChatsRequest

Permintaan untuk mendapatkan ruang chat grup berdasarkan resource pengguna.

Kolom
`users[]`	`string` Opsional. Nama resource semua pengguna manusia dalam chat grup dengan pengguna yang melakukan panggilan. Aplikasi Chat tidak dapat disertakan dalam permintaan. Jumlah maksimum pengguna yang dapat ditentukan dalam satu permintaan adalah `49`. Format: `users/{user}`, dengan `{user}` adalah `id` untuk orang dari People API, atau `id` untuk pengguna di Directory API. Misalnya, untuk menemukan semua chat grup dengan pengguna yang menelepon dan dua pengguna lainnya, dengan ID profil People API `123456789` dan `987654321`, Anda dapat menggunakan `users/123456789` dan `users/987654321`. Anda juga dapat menggunakan email tersebut sebagai alias untuk `{user}`. Misalnya, `users/example@gmail.com` dengan `example@gmail.com` adalah email pengguna Google Chat.
`page_size`	`int32` Opsional. Jumlah maksimum ruang yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini. Jika tidak ditentukan, maksimal 10 ruang akan ditampilkan. Nilai maksimumnya adalah 30. Jika Anda menggunakan nilai lebih dari 30, nilai tersebut akan otomatis diubah menjadi 30. Nilai negatif akan menampilkan error `INVALID_ARGUMENT`.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan sebelumnya untuk menemukan chat grup. Berikan parameter ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan harus sesuai dengan panggilan yang menyediakan token. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak diharapkan.
`space_view`	`SpaceView` Jenis tampilan ruang yang diminta. Jika tidak ditetapkan, setelan defaultnya adalah `SPACE_VIEW_RESOURCE_NAME_ONLY`. Permintaan yang menentukan `SPACE_VIEW_EXPANDED` harus menyertakan cakupan yang memungkinkan pembacaan data ruang, misalnya, https://www.googleapis.com/auth/chat.spaces atau https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

Respons yang berisi ruang chat grup dengan pengguna yang menelepon dan pengguna yang diminta.

Kolom

spaces[]

Daftar ruang 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 akan ada halaman berikutnya.

ForwardedMetadata

Metadata tentang ruang sumber tempat pesan diteruskan.

Kolom

space

string

Hanya output. Nama resource ruang sumber. Format: spaces/{space}

space_display_name

string

Hanya output. Nama tampilan ruang atau DM sumber pada saat penerusan. Untuk SPACE, ini adalah nama ruang. Untuk DIRECT_MESSAGE, ini adalah nama peserta lain (misalnya, "Pengguna A"). Untuk GROUP_CHAT, ini adalah nama yang dibuat berdasarkan nama depan anggota, dibatasi hingga 5 termasuk kreator (misalnya, "Pengguna A, Pengguna B").

GetAttachmentRequest

Permintaan untuk mendapatkan lampiran.

Kolom

name

string

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

GetAvailabilityRequest

Pesan permintaan untuk metode GetAvailability.

Kolom

name

string

Wajib. Nama resource ketersediaan yang akan diambil.

Format: users/{user}/availability

{user} adalah ID untuk Pengguna di People API atau Admin SDK Directory API. Misalnya, users/123456789.

Alamat email pengguna atau me juga dapat digunakan sebagai alias untuk merujuk ke pemanggil. Misalnya, users/user@example.com atau users/me.

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 keanggotaan yang akan diambil.

Untuk mendapatkan keanggotaan aplikasi itu sendiri dengan menggunakan autentikasi pengguna, Anda dapat menggunakan spaces/{space}/members/app.

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 ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang melakukan panggilan 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 keanggotaan 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.

markup_syntax

MarkupSyntax

Opsional. Menentukan sintaksis output yang diinginkan untuk kolom formatted_text pesan Chat.

GetSpaceEventRequest

Pesan permintaan untuk mendapatkan peristiwa ruang.

Kolom

name

string

Wajib. Nama resource acara ruang.

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

GetSpaceNotificationSettingRequest

Pesan permintaan untuk mendapatkan setelan notifikasi ruang. Hanya mendukung pengambilan 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 pengambilan status baca untuk pengguna yang menelepon.

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

Alias me. Misalnya, users/me/spaces/{space}/spaceReadState.
Alamat email Workspace-nya. Misalnya, users/user@example.com/spaces/{space}/spaceReadState.
ID pengguna mereka. 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 ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang melakukan panggilan 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 baca rangkaian pesan yang akan diambil.

Hanya mendukung pengambilan status baca untuk pengguna yang menelepon.

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

Alias me. Misalnya, users/me/spaces/{space}/threads/{thread}/threadReadState.
Alamat email Workspace-nya. Misalnya, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.
ID pengguna mereka. 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 Grup Google.

Merepresentasikan grup di Cloud Identity Groups API.

Format: groups/{group}

HistoryState

Status histori untuk pesan dan ruang. Menentukan durasi penyimpanan pesan dan rangkaian percakapan setelah dibuat.

Enum
`HISTORY_STATE_UNSPECIFIED`	Nilai default. Jangan gunakan.
`HISTORY_OFF`	Histori nonaktif. Pesan dan rangkaian pesan disimpan selama 24 jam.
`HISTORY_ON`	Histori aktif. Aturan retensi Vault organisasi menentukan durasi penyimpanan pesan dan rangkaian pesan.

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 maksimum 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 daftar emoji kustom sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

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

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 memanggil atau tidak.

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

creator("users/me")

Kueri yang tidak valid akan ditolak dengan error INVALID_ARGUMENT.

ListCustomEmojisResponse

Respons untuk mencantumkan emoji kustom.

Kolom

custom_emojis[]

Daftar yang tidak diurutkan. Daftar emoji kustom.

next_page_token

string

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

ListMembershipsRequest

Pesan permintaan untuk mencantumkan keanggotaan.

Kolom
`parent`	`string` Wajib. Nama resource ruang yang daftar keanggotaannya akan diambil. Format: spaces/{space}
`page_size`	`int32` Opsional. Jumlah maksimum keanggotaan yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 100 keanggotaan akan ditampilkan. Nilai maksimumnya adalah 1000. Jika Anda menggunakan nilai lebih dari 1.000, nilai tersebut akan otomatis diubah menjadi 1.000. Nilai negatif akan menampilkan error `INVALID_ARGUMENT`.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan sebelumnya untuk mencantumkan keanggotaan. Berikan parameter ini untuk mengambil halaman selanjutnya. 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 diharapkan.
`filter`	`string` Opsional. Filter kueri. Anda dapat memfilter keanggotaan berdasarkan peran (`role`) dan jenis (`member.type`) anggota. Untuk memfilter menurut 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 berdasarkan peran atau jenis, gunakan operator `OR`. `member.type = "HUMAN"` atau `member.type != "BOT"` diperlukan jika `use_admin_access` ditetapkan ke true. Filter jenis keanggotaan 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 akan ditolak oleh server dengan error `INVALID_ARGUMENT`.
`show_groups`	`bool` Opsional. Jika `true`, juga menampilkan keanggotaan yang terkait dengan `Google Group`, selain jenis keanggotaan lainnya. Jika `filter` ditetapkan, keanggotaan `Google Group` yang tidak cocok dengan kriteria filter tidak akan ditampilkan.
`show_invited`	`bool` Opsional. Jika `true`, juga menampilkan keanggotaan yang terkait dengan anggota `invited`, selain jenis keanggotaan lainnya. Jika filter ditetapkan, keanggotaan `invited` yang tidak cocok dengan kriteria filter tidak akan ditampilkan. Saat ini memerlukan autentikasi pengguna.
`use_admin_access`	`bool` Opsional. Jika `true`, metode ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna. Pengguna yang melakukan panggilan 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 keanggotaan ruang.

Kolom

memberships[]

Daftar yang tidak diurutkan. Daftar keanggotaan 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 akan ada halaman berikutnya.

ListMessagePinsRequest

Pesan permintaan untuk menyematkan pesan listingan.

Kolom

parent

string

Wajib. Ruang induk yang memiliki kumpulan item yang disematkan Format: spaces/{space}

page_size

int32

Opsional. Jumlah maksimum pin pesan yang ditampilkan. Layanan mungkin menampilkan pesan yang lebih sedikit dari nilai ini. Nilai maksimumnya adalah 100. Jika Anda menggunakan nilai lebih dari 100, nilai tersebut akan otomatis diubah menjadi 100. Jika tidak ditentukan, paling banyak 100 pin pesan akan ditampilkan. Nilai negatif akan menampilkan error INVALID_ARGUMENT.

page_token

string

Opsional. Token halaman yang diterima dari panggilan list message pins sebelumnya. Berikan parameter ini untuk mengambil halaman selanjutnya.

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 diharapkan.

ListMessagePinsResponse

Pesan respons untuk mencantumkan pin pesan.

Kolom

message_pins[]

MessagePin

Pesan yang disematkan dari ruang yang ditentukan.

next_page_token

string

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

ListMessagesRequest

Mencantumkan pesan di ruang yang ditentukan, yang penggunanya adalah anggota.

Kolom
`parent`	`string` Wajib. Nama resource ruang yang pesannya akan dicantumkan. Format: `spaces/{space}`
`page_size`	`int32` Opsional. Jumlah maksimum pesan yang ditampilkan. Layanan mungkin menampilkan pesan yang lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 25 yang akan ditampilkan. Nilai maksimumnya adalah 1000. Jika Anda menggunakan nilai lebih dari 1.000, nilai tersebut akan otomatis diubah menjadi 1.000. Nilai negatif akan menampilkan error `INVALID_ARGUMENT`.
`page_token`	`string` Opsional. Token halaman yang diterima dari panggilan daftar pesan sebelumnya. Berikan parameter ini untuk mengambil halaman selanjutnya. 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 diharapkan.
`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 petik 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 akan ditolak oleh server dengan error `INVALID_ARGUMENT`.
`order_by`	`string` Opsional. Cara daftar pesan diurutkan. Tentukan nilai untuk mengurutkan berdasarkan operasi pengurutan. Nilai operasi pengurutan yang valid adalah sebagai berikut: `ASC` untuk urutan menaik. `DESC` untuk menurun. Urutan 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.
`markup_syntax`	`MarkupSyntax` Opsional. Menentukan sintaksis output yang diinginkan untuk kolom `formatted_text` pesan Chat.

ListMessagesResponse

Pesan respons untuk mencantumkan pesan.

Kolom

messages[]

Daftar pesan.

next_page_token

string

Anda dapat mengirim token sebagai pageToken untuk mengambil halaman hasil berikutnya. Jika kosong, tidak akan 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 maksimum 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 selanjutnya. Saat melakukan penomoran halaman, nilai filter harus sesuai dengan panggilan yang memberikan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak diharapkan.
`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 dari beberapa emoji atau pengguna, gabungkan kolom 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 akan ditolak dengan error `INVALID_ARGUMENT`.

ListReactionsResponse

Respons terhadap permintaan daftar reaksi.

Kolom

reactions[]

Daftar reaksi di halaman yang diminta (atau pertama).

next_page_token

string

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

ListSectionItemsRequest

Pesan permintaan untuk mencantumkan item bagian.

Kolom
`parent`	`string` Wajib. Induk, yang merupakan nama resource bagian yang memiliki koleksi item bagian ini. Hanya mendukung item bagian listingan untuk pengguna yang melakukan panggilan. Saat Anda memfilter menurut ruang, gunakan karakter pengganti `-` untuk menelusuri semua bagian. Misalnya, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`
`page_size`	`int32` Opsional. Jumlah maksimum item bagian yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 10 item bagian akan ditampilkan. Nilai maksimumnya adalah 100. Jika Anda menggunakan nilai lebih dari 100, nilai tersebut akan otomatis diubah menjadi 100. Nilai negatif akan menampilkan error `INVALID_ARGUMENT`.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan list section items sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. 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 diharapkan.
`filter`	`string` Opsional. Filter kueri. Saat ini hanya mendukung pemfilteran menurut ruang. Misalnya, `space = spaces/{space}`. Kueri yang tidak valid akan ditolak dengan error `INVALID_ARGUMENT`.

ListSectionItemsResponse

Pesan respons untuk mencantumkan item bagian.

Kolom

section_items[]

SectionItem

Item bagian dari bagian yang ditentukan.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListSectionsRequest

Pesan permintaan untuk mencantumkan bagian.

Kolom

parent

string

Wajib. Induk, yang merupakan nama resource pengguna yang memiliki kumpulan bagian ini. Hanya mendukung pencantuman bagian untuk pengguna yang melakukan panggilan. Untuk merujuk ke pengguna yang melakukan panggilan, tetapkan salah satu hal berikut:

Alias me. Misalnya, users/me.
Alamat email Workspace-nya. Misalnya, users/user@example.com.
ID pengguna mereka. Misalnya, users/123456789.

Format: users/{user}

page_size

int32

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

Jika tidak ditentukan, paling banyak 10 bagian akan ditampilkan.

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

Nilai negatif akan menampilkan error INVALID_ARGUMENT.

page_token

string

Opsional. Token halaman, yang diterima dari panggilan list sections sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

ListSectionsResponse

Pesan respons untuk mencantumkan bagian.

Kolom

sections[]

Bagian dari pengguna yang ditentukan.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListSpaceEventsRequest

Pesan permintaan untuk mencantumkan peristiwa 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 jumlah yang lebih sedikit dari nilai ini. Nilai negatif akan menampilkan error `INVALID_ARGUMENT`.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan peristiwa ruang daftar sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk mencantumkan peristiwa ruang harus sesuai dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak diharapkan.
`filter`	`string` Wajib. Filter kueri. Anda harus menentukan minimal satu jenis peristiwa (`event_type`) menggunakan operator memiliki `:`. Untuk memfilter menurut beberapa jenis peristiwa, gunakan operator `OR`. Hilangkan jenis peristiwa batch dalam 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`. Atau, Anda juga dapat memfilter berdasarkan waktu mulai (`start_time`) dan waktu berakhir (`end_time`): `start_time`: Stempel waktu eksklusif untuk mulai mencantumkan peristiwa ruang. Anda dapat mencantumkan peristiwa yang terjadi hingga 28 hari yang lalu. Jika tidak ditentukan, mencantumkan peristiwa ruang dari 28 hari terakhir. `end_time`: Stempel waktu inklusif hingga peristiwa ruang dicantumkan. Jika tidak ditentukan, mencantumkan peristiwa hingga waktu permintaan. Untuk menentukan waktu mulai atau berakhir, gunakan operator sama dengan `=` dan format dalam RFC-3339. Untuk memfilter berdasarkan `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 akan ditolak oleh server dengan error `INVALID_ARGUMENT`.

ListSpaceEventsResponse

Pesan respons untuk mencantumkan peristiwa ruang.

Kolom

space_events[]

SpaceEvent

Hasil ditampilkan dalam urutan kronologis (peristiwa terlama ditampilkan 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 ruang yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini.

Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan.

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

Nilai negatif akan menampilkan error INVALID_ARGUMENT.

page_token

string

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

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

filter

string

Opsional. Filter kueri.

Anda dapat memfilter ruang berdasarkan 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 akan ditolak oleh server dengan error INVALID_ARGUMENT.

ListSpacesResponse

Respons untuk permintaan daftar ruang.

Kolom

spaces[]

MembershipCreatedEventData

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 akan ada halaman berikutnya.

MarkAsActiveRequest

Pesan permintaan untuk metode MarkAsActive.

Kolom
`name`	`string` Wajib. Nama resource ketersediaan yang akan ditandai sebagai aktif. Format: users/{user}/availability `{user}` adalah ID untuk Pengguna di People API atau Admin SDK Directory API. Misalnya, `users/123456789`. Alamat email pengguna atau `me` juga dapat digunakan sebagai alias untuk merujuk ke pemanggil. Misalnya, `users/user@example.com` atau `users/me`.
Kolom union `expiration`. Masa berlaku untuk status ketersediaan ACTIVE. Pengguna akan ditandai sebagai Tidak Ada setelah masa berlaku habis. Jika masa berlaku tidak ditentukan, status ACTIVE akan berakhir 30 menit dari waktu saat ini. `expiration` hanya dapat berupa salah satu dari berikut:
`expire_time`	`Timestamp` Stempel waktu absolut saat status ACTIVE berakhir.
`ttl`	`Duration` Durasi dari waktu saat ini hingga status ACTIVE berakhir. Penggunaan TTL yang singkat dapat secara efektif mereset status pengguna agar didasarkan pada aktivitas setelah durasi singkat ini.

MarkAsAwayRequest

Pesan permintaan untuk metode MarkAsAway.

Kolom

name

string

Wajib. Nama resource ketersediaan yang akan ditandai sebagai tidak di tempat. Format: users/{user}/availability

{user} adalah ID untuk Pengguna di People API atau Admin SDK Directory API. Misalnya, users/123456789.

Alamat email pengguna atau me juga dapat digunakan sebagai alias untuk merujuk ke pemanggil. Misalnya, users/user@example.com atau users/me.

MarkAsDoNotDisturbRequest

Pesan permintaan untuk metode MarkAsDoNotDisturb.

Kolom
`name`	`string` Wajib. Nama resource ketersediaan yang akan ditandai sebagai Jangan Ganggu. Format: users/{user}/availability `{user}` adalah ID untuk Pengguna di People API atau Admin SDK Directory API. Misalnya, `users/123456789`. Alamat email pengguna atau `me` juga dapat digunakan sebagai alias untuk merujuk ke pemanggil. Misalnya, `users/user@example.com` atau `users/me`.
Kolom union `expiration`. Wajib. Masa berlaku untuk status ketersediaan mode Jangan Ganggu. Pengguna akan ditandai sebagai Pergi setelah masa berlaku habis. Waktu ini dapat ditetapkan maksimal 1 tahun dari waktu saat ini. `expiration` hanya dapat berupa salah satu dari berikut:
`expire_time`	`Timestamp` Stempel waktu absolut saat status DND berakhir.
`ttl`	`Duration` Durasi dari waktu saat ini hingga status DND berakhir.

MarkupSyntax

Menentukan sintaksis markup yang digunakan untuk memformat teks pesan Chat. Berlaku untuk kolom text dari resource Message.

Enum
`MARKUP_SYNTAX_UNSPECIFIED`	Menampilkan nilai yang tidak ditentukan.
`MARKUP_SYNTAX_CHAT`	Menggunakan sintaksis markup Google Chat. Lihat https://developers.google.com/workspace/chat/format-messages#format-texts untuk mengetahui informasi selengkapnya.
`MARKUP_SYNTAX_MARKDOWN`	Menggunakan sintaksis Markdown. Sintaksis ini didasarkan pada spesifikasi CommonMark, dengan ekstensi tambahan. Lihat https://developers.google.com/workspace/chat/format-messages#format-texts untuk mengetahui informasi selengkapnya.

MatchedUrl

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

Kolom

url

string

Hanya output. URL yang cocok.

MeetSpaceLinkData

Data untuk link ruang Meet.

Kolom

meeting_code

string

Kode rapat ruang Meet yang ditautkan.

type

Type

Menunjukkan jenis ruang Meet.

huddle_status

HuddleStatus

Opsional. Hanya output. Jika Meet adalah Diskusi Singkat, menunjukkan status diskusi singkat. Jika tidak, nilai ini tidak ditetapkan.

HuddleStatus

Status diskusi singkat

Enum
`HUDDLE_STATUS_UNSPECIFIED`	Nilai default untuk enum. Jangan gunakan.
`STARTED`	Diskusi singkat telah dimulai.
`ENDED`	Diskusi singkat telah berakhir. Dalam hal ini, URI dan ID ruang Meet tidak akan valid lagi.
`MISSED`	Huddle tidak terjawab. Dalam hal ini, URI dan ID ruang Meet tidak akan valid lagi.

Jenis

Jenis ruang Meet.

Enum
`TYPE_UNSPECIFIED`	Nilai default untuk enum. Jangan gunakan.
`MEETING`	Ruang Meet adalah rapat.
`HUDDLE`	Ruang Meet adalah diskusi singkat.

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 keanggotaan, 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 keanggotaan, seperti saat anggota bergabung atau diundang untuk bergabung ke ruang. Kolom ini hanya output, kecuali jika digunakan untuk mengimpor keanggotaan 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 keanggotaan historis di ruang mode impor.
`affiliation`	`Affiliation` Hanya output. Hubungan pengguna dengan organisasi Workspace yang memiliki ruang. Di ruang yang dimiliki oleh akun konsumen, afiliasi semua anggota adalah `EXTERNAL`.
Kolom union `memberType`. Anggota yang terkait dengan keanggotaan ini. Jenis anggota lainnya mungkin didukung pada masa mendatang. `memberType` hanya dapat berupa salah satu dari berikut:
`member`	`User` Opsional. Pengguna atau aplikasi Google Chat yang terkait dengan keanggotaan. Jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, output hanya akan mengisi kolom pengguna `name` dan `type` untuk pengguna internal dan eksternal, kecuali jika mereka adalah anggota ruang atau memiliki afinitas sebelumnya, seperti percakapan pesan langsung (DM), dengan pengguna yang menelepon.
`group_member`	`Group` Opsional. Grup Google yang sesuai dengan keanggotaan. Membaca atau mengubah keanggotaan untuk Google Grup memerlukan autentikasi pengguna.

Afiliasi

Mewakili afiliasi pengguna dengan organisasi Google Workspace yang memiliki ruang. Enum ini mungkin memiliki lebih banyak nilai yang ditambahkan pada masa mendatang.

Enum
`AFFILIATION_UNSPECIFIED`	Nilai default. Nilai ini tidak digunakan.
`INTERNAL`	Akun yang dikelola oleh organisasi Google Workspace yang sama dengan pemilik ruang.
`EXTERNAL`	Akun di luar organisasi Google Workspace yang memiliki ruang (misalnya, akun konsumen, atau akun yang dikelola oleh organisasi Workspace lain).
`MANAGED_EXTERNAL`	Akun yang dikelola oleh organisasi Workspace yang memiliki ruang, tetapi disediakan untuk pengguna yang berada di luar organisasi (misalnya, Pengguna tamu). Untuk mempelajari tamu lebih lanjut, lihat https://support.google.com/chat/answer/16997417.

MembershipRole

Mewakili tindakan yang diizinkan pengguna di ruang Chat. Nilai enum lainnya mungkin akan ditambahkan pada masa mendatang.

Enum
`MEMBERSHIP_ROLE_UNSPECIFIED`	Nilai default. Untuk `users`: mereka bukan anggota ruang, tetapi dapat diundang. Untuk `Google Groups`: mereka selalu diberi peran ini (nilai enum lain mungkin digunakan di masa mendatang).
`ROLE_MEMBER`	Anggota ruang. Di UI Chat, peran ini disebut Anggota. Pengguna memiliki izin dasar, seperti mengirim pesan ke ruang. Pengelola dan pemilik dapat memberikan izin tambahan kepada anggota di ruang, termasuk: Menambahkan atau menghapus anggota. Mengubah detail ruang. Mengaktifkan atau menonaktifkan histori. Sebut semua orang dalam ruang dengan `@all`. Mengelola aplikasi Chat dan webhook yang diinstal di ruang. Dalam pesan langsung dan percakapan grup tanpa nama, semua orang memiliki peran ini.
`ROLE_MANAGER`	Pemilik ruang. Di UI Chat, peran ini disebut Pemilik. Pengguna memiliki serangkaian izin ruang lengkap untuk mengelola ruang, termasuk: Mengubah peran anggota lain di ruang menjadi anggota, pengelola, atau pemilik. Menghapus ruang. Hanya didukung di `SpaceType.SPACE` (ruang bernama). Untuk mempelajari lebih lanjut, lihat Mempelajari lebih lanjut peran Anda sebagai pemilik atau pengelola ruang.
`ROLE_ASSISTANT_MANAGER`	Pengelola ruang. Di UI Chat, peran ini disebut Pengelola. Pengguna memiliki semua izin dasar `ROLE_MEMBER`, dan dapat diberi subset izin administratif oleh pemilik. Secara default, pengelola memiliki semua izin pemilik, kecuali kemampuan untuk: Menghapus ruang. Menjadikan anggota ruang lain sebagai pemilik. Mengubah peran pemilik. Secara default, izin pengelola mencakup, tetapi tidak terbatas pada: Menjadikan anggota lain sebagai pengelola. Menghapus pesan dalam ruang. Mengelola izin ruang. Menerima notifikasi untuk permintaan bergabung ke ruang jika pengelola memiliki izin "mengelola anggota" di setelan ruang. Membuat ruang dapat ditemukan. Hanya didukung di `SpaceType.SPACE` (ruang bernama). Untuk mempelajari lebih lanjut, lihat Mengelola setelan ruang.

MembershipState

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

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

MembershipBatchCreatedEventData

Payload peristiwa untuk beberapa keanggotaan baru.

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

Kolom

memberships[]

Daftar langganan baru.

MembershipBatchDeletedEventData

Payload peristiwa untuk beberapa keanggotaan yang dihapus.

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

Kolom

memberships[]

MembershipDeletedEventData

Daftar langganan yang dihapus.

MembershipBatchUpdatedEventData

Payload peristiwa untuk beberapa keanggotaan yang diperbarui.

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

Kolom

memberships[]

MembershipUpdatedEventData

Daftar keanggotaan yang diperbarui.

MembershipCreatedEventData

Payload peristiwa untuk keanggotaan baru.

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

Kolom

membership

Langganan baru.

MembershipDeletedEventData

Payload peristiwa untuk keanggotaan yang dihapus.

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

Kolom

membership

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

MembershipUpdatedEventData

Payload peristiwa untuk keanggotaan yang diperbarui.

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

Kolom

membership

MessageCreatedEventData

Keanggotaan 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 Anda 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 melakukan autentikasi sebagai pengguna, output hanya akan mengisi kolom pengguna `name` dan `type` untuk pengguna internal dan eksternal, kecuali jika mereka adalah anggota ruang atau memiliki afinitas sebelumnya, seperti percakapan pesan langsung (DM), dengan pengguna yang menelepon.
`create_time`	`Timestamp` Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu pembuatan pesan. 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 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 pesan teks biasa. Link pertama ke gambar, video, atau halaman web akan menghasilkan chip pratinjau. Anda juga dapat menyebut pengguna Google Chat dengan@, 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 mengomunikasikan pemformatan. Kolom ini mungkin tidak mencakup semua format yang terlihat di UI, tetapi mencakup hal berikut: Sintaksis markup untuk tebal, miring, coret, monospace, blok monospace, daftar berbutir, dan kutipan blok. 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 menyeringai. Item daftar berbutir menggunakan tanda bintang (``)—misalnya, ` item`. Untuk mengetahui informasi selengkapnya, lihat Melihat format teks yang dikirim dalam pesan
`cards[] (deprecated)`	`Card` Item ini tidak digunakan lagi. Tidak digunakan lagi: Gunakan `cards_v2` sebagai gantinya. Kartu interaktif, kaya, dan berformat 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. Aplikasi Chat dapat membuat kartu dengan autentikasi aplikasi. Sebagai bagian dari Program Pratinjau Developer, jika aplikasi Chat Anda melakukan autentikasi sebagai pengguna, aplikasi tersebut dapat membuat pesan kartu. Jika aplikasi Chat Anda bukan bagian dari Program Pratinjau Developer, aplikasi tersebut tidak dapat membuat kartu dengan autentikasi pengguna. Untuk mempelajari cara membuat pesan yang berisi kartu, lihat Mengirim pesan. Mendesain dan melihat pratinjau kartu dengan Card Builder. Membuka Card Builder
`annotations[]`	`Annotation` Hanya output. Anotasi dapat dikaitkan dengan isi pesan teks biasa atau dengan chip yang tertaut ke resource Google Workspace seperti Google Dokumen atau Spreadsheet dengan `start_index` dan `length` bernilai 0.
`thread`	`Thread` Rangkaian pesan yang berisi pesan tersebut. Untuk contoh penggunaan, lihat Memulai atau membalas rangkaian pesan.
`space`	`Space` Hanya output. Jika aplikasi Chat Anda melakukan autentikasi 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 kolom pesan Chat `text` yang cocok dengan pola pratinjau link. Untuk mengetahui informasi selengkapnya, lihat Link pratinjau.
`thread_reply`	`bool` Hanya output. Jika `true`, pesan tersebut adalah respons dalam rangkaian balasan. Jika `false`, pesan akan terlihat dalam percakapan tingkat teratas ruang sebagai pesan pertama rangkaian pesan atau pesan tanpa balasan dalam rangkaian pesan. Jika ruang tidak mendukung balasan dalam rangkaian pesan, kolom ini selalu `false`.
`silent`	`bool` Hanya output. Apakah ini pesan senyap. Pesan senyap adalah pesan yang notifikasi push-nya disembunyikan oleh Chat untuk penerima.
`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 menghilangkan hal berikut: Lampiran Untuk mengetahui detailnya, lihat Mengirim pesan secara pribadi.
`deletion_metadata`	`DeletionMetadata` Hanya output. Informasi tentang pesan yang dihapus. Pesan akan dihapus jika `delete_time` ditetapkan.
`quoted_message_metadata`	`QuotedMessageMetadata` Opsional. Informasi tentang pesan yang dikutip oleh pesan lain. Saat membuat pesan, Anda dapat mengutip pesan dalam rangkaian pesan yang sama, atau mengutip pesan root untuk membuat pesan root baru. Namun, Anda tidak dapat mengutip balasan pesan dari rangkaian pesan yang berbeda. Saat memperbarui pesan, Anda tidak dapat menambahkan atau mengganti kolom `quotedMessageMetadata`, tetapi Anda dapat menghapusnya. Untuk contoh penggunaan, lihat Mengutip pesan lain.
`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.
`elements`	`Elements` Opsional. Elemen adalah komponen tambahan yang disediakan selama pembuatan pesan yang mungkin atau mungkin tidak terkait dengan bagian tertentu dari teks pesan. Hal ini berbeda dengan anotasi, yang hanya berupa output dan menawarkan informasi tambahan yang terkait dengan fragmen pesan atau seluruh teks pesan. Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu.
`markup_syntax`	`MarkupSyntax` Opsional. Menentukan cara server menafsirkan konten kolom `text` pesan.

MessageBatchCreatedEventData

Payload peristiwa untuk beberapa pesan baru.

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

Kolom

messages[]

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

Pesan baru.

MessageDeletedEventData

Payload peristiwa untuk pesan yang dihapus.

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

Kolom

message

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

MessagePin

Sematkan di pesan Chat. Untuk mengetahui informasi selengkapnya, lihat Menyematkan pesan.

Kolom

name

string

ID. Nama resource pin pesan. Format: spaces/{space}/messagePins/{message_pin} Komponen ID resource cocok dengan komponen ID resource pesan. Misalnya, pesan dengan spaces/AAA/messages/bbb.ccc sesuai dengan pin pesan dengan nama resource spaces/AAA/messagePins/bbb.ccc.

message

string

Wajib. Tidak dapat diubah. Nama resource pesan yang disematkan. Format: spaces/{space}/messages/{message}

MessageUpdatedEventData

Payload peristiwa untuk pesan yang diperbarui.

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

Kolom

message

Pesan yang diperbarui.

MoveSectionItemRequest

Pesan permintaan untuk memindahkan item bagian ke bagian lain.

Kolom

name

string

Wajib. Nama resource item bagian yang akan dipindahkan.

Format: users/{user}/sections/{section}/items/{item}

target_section

string

Wajib. Nama resource bagian yang akan menjadi tujuan pemindahan item bagian.

Format: users/{user}/sections/{section}

MoveSectionItemResponse

Pesan respons untuk memindahkan item bagian.

Kolom

section_item

SectionItem

Item bagian yang diperbarui.

PositionSectionRequest

Pesan permintaan untuk memosisikan bagian.

Kolom
`name`	`string` Wajib. Nama resource bagian yang akan diposisikan. Format: `users/{user}/sections/{section}`
Kolom union `position`. Wajib. Posisi baru bagian. `position` hanya dapat berupa salah satu dari berikut:
`sort_order`	`int32` Opsional. Posisi absolut bagian dalam daftar bagian. Posisi harus lebih besar dari 0. Jika posisi lebih besar dari jumlah bagian, bagian tersebut akan ditambahkan ke akhir daftar. Operasi ini menyisipkan bagian pada posisi yang ditentukan dan menggeser bagian asli pada posisi tersebut, dan bagian di bawahnya, ke posisi berikutnya.
`relative_position`	`Position` Opsional. Posisi relatif bagian dalam daftar bagian.

Posisi

Posisi bagian.

Enum
`POSITION_UNSPECIFIED`	Posisi tidak ditentukan.
`START`	Awal daftar bagian.
`END`	Akhir daftar bagian.

PositionSectionResponse

Pesan respons untuk memosisikan bagian.

Kolom

section

ReactionCreatedEventData

Bagian yang diperbarui.

QuotedMessageMetadata

Informasi tentang pesan yang dikutip oleh pesan lain.

Saat memperbarui pesan, Anda tidak dapat menambahkan atau mengganti kolom quotedMessageMetadata, tetapi Anda dapat menghapusnya.

Untuk contoh penggunaan, lihat Mengutip pesan lain.

Kolom
`name`	`string` Wajib. Nama resource pesan yang dikutip. Format: `spaces/{space}/messages/{message}`
`last_update_time`	`Timestamp` Wajib. Stempel waktu saat pesan yang dikutip dibuat atau saat pesan yang dikutip terakhir diperbarui. Jika pesan diedit, gunakan kolom ini, `last_update_time`. Jika pesan tidak pernah diedit, gunakan `create_time`. Jika `last_update_time` tidak cocok dengan versi terbaru pesan yang dikutip, permintaan akan gagal.
`quote_type`	`QuoteType` Opsional. Menentukan jenis kutipan. Jika tidak ditetapkan, setelan defaultnya adalah REPLY di jalur baca/tulis pesan untuk kompatibilitas mundur.
`quoted_message_snapshot`	`QuotedMessageSnapshot` Hanya output. Snapshot konten pesan yang dikutip.
`forwarded_metadata`	`ForwardedMetadata` Hanya output. Metadata tentang ruang sumber pesan yang dikutip. Hanya diisi untuk jenis kuotasi FORWARD.

QuoteType

Jenis kutipan dari pesan yang dikutip.

Enum

QUOTE_TYPE_UNSPECIFIED Dilindungi Undang-Undang. Nilai ini tidak digunakan.

REPLY

Jika quote_type adalah REPLY, Anda dapat melakukan hal berikut:

Jika membalas dalam rangkaian pesan, Anda dapat mengutip pesan lain dalam rangkaian pesan tersebut.
Jika Anda membuat pesan utama, Anda dapat mengutip pesan utama lain di ruang tersebut.

FORWARD

Jika quote_type adalah FORWARD, Anda dapat mengutip:

Pesan dari ruang lain.
Balasan pesan dari rangkaian pesan lain di ruang yang sama.

QuotedMessageSnapshot

Memberikan ringkasan konten pesan yang dikutip pada saat pengutipan atau penerusan

Kolom
`sender`	`string` Hanya output. Nama penulis pesan yang dikutip. Diisi untuk jenis kutipan REPLY & FORWARD.
`text`	`string` Hanya output. Snapshot konten teks pesan yang dikutip.
`formatted_text`	`string` Hanya output. Berisi pesan yang dikutip `text` dengan markup yang ditambahkan untuk mendukung format kaya seperti hyperlink,emoji kustom, markup, dll. Hanya diisi untuk jenis kutipan FORWARD.
`annotations[]`	`Annotation` Hanya output. Anotasi yang diuraikan dari isi teks pesan yang dikutip. Hanya diisi untuk jenis kuotasi FORWARD.
`attachments[]`	`Attachment` Hanya output. Lampiran yang merupakan bagian dari pesan yang dikutip. Ini adalah salinan metadata lampiran pesan yang dikutip. Hanya diisi untuk jenis kuotasi FORWARD.

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[]

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

Reaksi baru.

ReactionDeletedEventData

Payload peristiwa untuk reaksi yang dihapus.

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

Kolom

reaction

Reaksi yang dihapus.

ReplaceMessageCardsRequest

Pesan permintaan untuk metode API ReplaceMessageCards.

Kolom

name

string

Wajib. Nama resource pesan.

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

cards_v2[]

CardWithId

Opsional. Array kartu yang akan disertakan dalam pesan. Kartu ini akan menggantikan kartu pesan yang ada. Jika kosong, kartu asli yang disertakan dalam pesan akan dihapus.

ReplaceMessageCardsResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk ReplaceMessageCards API.

RichLinkMetadata

Link lengkap ke referensi. Link lengkap dapat dikaitkan dengan isi pesan teks biasa atau mewakili chip yang tertaut ke resource Google Workspace seperti Google Dokumen atau Spreadsheet dengan start_index dan length bernilai 0.

Kolom
`uri`	`string` URI link ini.
`rich_link_type`	`RichLinkType` Jenis link lengkap.
Kolom union `data`. Data untuk referensi tertaut. `data` hanya dapat berupa salah satu dari berikut:
`drive_link_data`	`DriveLinkData` Data untuk link drive.
`chat_space_link_data`	`ChatSpaceLinkData` Data untuk link ruang chat.
`meet_space_link_data`	`MeetSpaceLinkData` Data untuk link ruang Meet.
`calendar_event_link_data`	`CalendarEventLinkData` Data untuk link acara Kalender.

RichLinkType

Jenis link lengkap. Jenis lainnya mungkin ditambahkan pada masa mendatang.

Enum
`RICH_LINK_TYPE_UNSPECIFIED`	Nilai default untuk enum. Jangan gunakan.
`DRIVE_FILE`	Jenis link lengkap Google Drive.
`CHAT_SPACE`	Jenis link lengkap ruang Chat. Misalnya, chip cerdas ruang.
`GMAIL_MESSAGE`	Jenis link lengkap pesan Gmail. Secara khusus, chip Gmail dari Bagikan ke Chat. API ini hanya mendukung pembacaan pesan dengan link lengkap GMAIL_MESSAGE.
`MEET_SPACE`	Jenis link lengkap pesan Meet. Misalnya, chip Meet.
`CALENDAR_EVENT`	Jenis link lengkap pesan Kalender. Misalnya, chip Kalender.

SearchMessageResult

Satu item hasil dari penelusuran pesan.

Kolom

message

Pesan yang cocok.

space_mute_setting

MuteSetting

Setelan bisukan pengguna yang memanggil untuk ruang tempat pesan diposting. Aplikasi pemanggil dapat menggunakan informasi ini untuk memutuskan cara memproses pesan, bergantung pada apakah ruang dibisukan untuk pengguna atau tidak.

Hanya ditampilkan jika tampilan permintaan adalah SEARCH_MESSAGES_VIEW_FULL dan kredensial panggilan menyertakan cakupan otorisasi berikut:

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

read

bool

Menunjukkan apakah pesan yang cocok dibaca oleh pengguna yang memanggil.

Hanya ditampilkan jika tampilan permintaan adalah SEARCH_MESSAGES_VIEW_FULL dan kredensial panggilan menyertakan salah satu cakupan otorisasi berikut:

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

SearchMessagesRequest

Pesan permintaan untuk menelusuri pesan.

Kolom
`parent`	`string` Wajib. Nama resource ruang yang akan ditelusuri. Untuk menelusuri semua ruang yang dapat diakses pengguna, tetapkan kolom ini ke `spaces/-`. Menggunakan nilai lain untuk `parent` akan menghasilkan error `INVALID_ARGUMENT`. Untuk membatasi penelusuran ke satu atau beberapa ruang, gunakan `space.name` atau `space.display_name` di `filter`.
`filter`	`string` Wajib. Kueri penelusuran. Kueri dapat menentukan satu atau beberapa kata kunci penelusuran, yang digunakan untuk memfilter hasil, Anda juga dapat memfilter hasil menggunakan kolom pesan berikut: `create_time`: Menerima stempel waktu dalam format RFC-3339 dan operator perbandingan yang didukung adalah: `<` dan `>=`. `sender.name`: Nama resource pengirim (`users/{user}`). Hanya mendukung `=`. Anda dapat menggunakan email tersebut sebagai alias untuk `{user}`. Misalnya, `users/example@gmail.com`, dengan `example@gmail.com` adalah email pengguna Google Chat. `space.name`: Nama resource ruang tempat pesan diposting. (`spaces/{space}`). Hanya mendukung `=`. Jika filter ini tidak disetel, penelusuran akan dilakukan di semua pesan langsung dan ruang yang dapat diakses pengguna sebagai anggota ruang. `space.display_name`: Mendukung operator `:` (memiliki) dan memfilter ruang berdasarkan kecocokan sebagian nama tampilannya. Hasil dibatasi hingga lima kecocokan ruang teratas. Misalnya, `space.display_name:Project` menelusuri pesan di lima ruang teratas yang berisi kata "Project" dalam nama tampilannya. `space.space_type`: Jenis ruang. Hanya mendukung `=`. Misalnya, `space.space_type="DIRECT_MESSAGE"` hanya menampilkan pesan dari pesan langsung. Nilai yang mungkin adalah `DIRECT_MESSAGE`, `GROUP_CHAT`, dan `SPACE`. `attachment`: Mendukung operator `:` (memiliki) untuk memeriksa keberadaan lampiran. Jika `attachment:` ditentukan, hanya pesan yang memiliki setidaknya satu lampiran yang akan ditampilkan. `annotations.user_mentions.user.name`: Nama resource pengguna yang disebutkan (`users/{user}`). Hanya mendukung `:` (memiliki). Misalnya: `annotations.user_mentions.user.name:"users/1234567890"` hanya menampilkan pesan yang berisi sebutan untuk pengguna yang ditentukan. Atau, alias `me` dapat digunakan untuk memfilter pesan yang menyebutkan pengguna pemanggil, misalnya: `annotations.user_mentions.user.name:users/me`. Anda juga dapat menggunakan email sebagai alias untuk `{user}`, misalnya, `users/example@gmail.com`. Untuk pemfilteran lanjutan, fungsi berikut juga tersedia: `has_link()`: Hanya menampilkan pesan yang memiliki setidaknya satu hyperlink dalam teks pesan. `is_unread()`: Memfilter pesan yang telah dibaca oleh pengguna yang menelepon. Penggunaan filter `space.display_name` atau `space.space_type` mengharuskan kredensial panggilan menyertakan salah satu cakupan otorisasi berikut: `https://www.googleapis.com/auth/chat.spaces.readonly` `https://www.googleapis.com/auth/chat.spaces` Penggunaan filter `is_unread()` mengharuskan kredensial panggilan menyertakan salah satu cakupan otorisasi berikut: `https://www.googleapis.com/auth/chat.users.readstate.readonly` `https://www.googleapis.com/auth/chat.users.readstate` Di berbagai kolom, hanya operator `AND` yang didukung. Contoh yang valid adalah `sender.name = "users/1234567890" AND is_unread()`. Kata `AND` bersifat opsional dan tersirat jika dihilangkan. Misalnya, `sender.name = "users/1234567890" is_unread()` valid dan setara dengan contoh sebelumnya. Contoh yang tidak valid adalah `sender.name = "users/1234567890" OR is_unread()` karena `OR` tidak didukung di antara kolom yang berbeda. Di antara bidang yang sama: `create_time` hanya mendukung `AND`, dan hanya dapat digunakan untuk merepresentasikan interval, seperti `create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"`. `sender.name` hanya mendukung operator `OR`, misalnya: `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`. `space.name` hanya mendukung operator `OR`, misalnya: `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`. `space.display_name` mendukung operator `AND` dan `OR`, tetapi tidak mendukung kombinasi keduanya. Misalnya: `space.display_name:Project AND space.display_name:Tasks` menampilkan pesan yang ada di ruang dengan nama tampilan yang berisi `Project` dan `Tasks`, sedangkan `space.display_name:Project OR space.display_name:Tasks` menampilkan pesan yang ada di ruang dengan nama tampilan yang berisi `Project` atau `Tasks` atau keduanya. `space.space_type` hanya mendukung operator `OR`, misalnya: `space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"`. `annotations.user_mentions.user.name` mendukung operator `AND` dan `OR`, tetapi tidak mendukung kombinasi keduanya. Misalnya: `annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321"` hanya menampilkan pesan yang menyebutkan kedua pengguna, sedangkan `annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321"` menampilkan pesan yang menyebutkan salah satu atau kedua pengguna. Tanda kurung diperlukan untuk memperjelas prioritas operator saat menggabungkan operator `AND` dan `OR` dalam kueri yang sama. Contoh: `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`. Jika tidak, tanda kurung bersifat opsional. Contoh kueri berikut valid: `"Pending reports" AND create_time >= "2023-01-01T00:00:00Z" sender.name = "users/example@gmail.com" annotations.user_mentions.user.name:"users/0987654321" attachment:* AND space.name = "spaces/ABCDEFGH" tasks AND is_unread() AND sender.name = "users/1234567890" "things to do" "urgent" (sender.name = "users/1234567890") AND (create_time < "2023-05-01T00:00:00Z") tasks AND space.name = "spaces/ABCDEFGH" AND has_link() "project one" is_unread() space.display_name:Project tasks` Panjang kueri maksimum adalah 1.000 karakter. Kueri yang tidak valid akan ditolak oleh server dengan error `INVALID_ARGUMENT`.
`page_size`	`int32` Opsional. Jumlah hasil maksimum yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 25 yang akan ditampilkan. Nilai maksimumnya adalah 100. Jika Anda menggunakan nilai lebih dari 100, nilai tersebut akan otomatis diubah menjadi 100.
`page_token`	`string` Opsional. Token, yang diterima dari panggilan pesan penelusuran sebelumnya. Berikan parameter ini untuk mengambil halaman selanjutnya. 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 diharapkan.
`order_by`	`string` Opsional. Cara pengurutan daftar hasil. Atribut yang didukung untuk pengurutan adalah: `create_time`: Mengurutkan hasil berdasarkan waktu pembuatan pesan. Nilai default. `relevance`: Mengurutkan hasil berdasarkan relevansi. ( Pratinjau Developer) Urutan defaultnya adalah `create_time desc`. Hanya satu urutan per kueri (`create_time` atau `relevance`) yang didukung. Hanya urutan menurun (`desc`) yang didukung, dan harus ditentukan setelah atribut urutan.
`markup_syntax`	`MarkupSyntax` Opsional. Menentukan sintaksis output yang diinginkan untuk kolom `formatted_text` pesan Chat.
`view`	`SearchMessagesView` Opsional. Menentukan jenis tampilan hasil penelusuran yang akan ditampilkan. Defaultnya adalah `SEARCH_MESSAGES_VIEW_BASIC`.

SearchMessagesView

Jenis tampilan yang didukung untuk hasil penelusuran parsial.

Enum
`SEARCH_MESSAGES_VIEW_UNSPECIFIED`	Nilai default / tidak ditetapkan. API akan ditetapkan secara default ke tampilan BASIC.
`SEARCH_MESSAGES_VIEW_BASIC`	Hanya menyertakan pesan yang cocok dalam hasil, tetapi tidak menyertakan metadata tambahan. Nilai ini merupakan default.
`SEARCH_MESSAGES_VIEW_FULL`	Menyertakan semua yang ada dalam hasil: pesan yang cocok dan metadata tambahan.

SearchMessagesResponse

Pesan respons untuk menelusuri pesan.

Kolom

results[]

SearchMessageResult

Daftar hasil penelusuran yang cocok dengan kueri.

next_page_token

string

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

SearchSpacesRequest

Permintaan untuk menelusuri daftar ruang berdasarkan kueri.

Kolom
`use_admin_access`	`bool` Jika `true`, metode ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna. Pengguna yang melakukan panggilan 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`.
`page_size`	`int32` Jumlah maksimum ruang yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini. Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan. Nilai maksimumnya adalah 1.000 jika `useAdminAccess` ditetapkan ke `true`. Jika tidak, nilai maksimumnya adalah 100. Jika Anda menggunakan nilai yang lebih besar dari nilai maksimum, nilai tersebut akan otomatis diubah ke nilai maksimum.
`page_token`	`string` Token, yang diterima dari panggilan ruang penelusuran sebelumnya. Berikan parameter ini untuk mengambil halaman selanjutnya. 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 diharapkan.
`query`	`string` Wajib. Kueri penelusuran. Anda dapat menelusuri menggunakan parameter berikut jika `useAdminAccess` ditetapkan ke `true`: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` Jika `useAdminAccess` ditetapkan ke `false`: `display_name` `external_user_allowed` `space_type` `create_time` dan `last_active_time` menerima stempel waktu dalam format RFC-3339 dan operator perbandingan yang didukung adalah: `=`, `<`, `>`, `<=`, `>=`. `customer` wajib ada jika `useAdminAccess` ditetapkan ke `true`, dan digunakan untuk menunjukkan pelanggan mana yang akan diambil ruangnya. `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 akan dicocokkan dengan awalan tanpa membedakan 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`. Jika `useAdminAccess` ditetapkan ke `false`, `display_name` diperlukan untuk mengambil hasil yang bermakna. Jika tidak, perilaku defaultnya adalah menampilkan respons kosong. `external_user_allowed` menerima `true` atau `false`. `space_history_state` hanya menerima nilai dari kolom `historyState` resource `space`. `space_type` wajib diisi 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 jika `useAdminAccess` ditetapkan ke `true`: 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") Contoh kueri berikut valid jika `useAdminAccess` ditetapkan ke `false`: `display_name:"Hello World" AND space_type = "SPACE" (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE" (external_user_allowed = "true" AND space_type = "SPACE") // Returns an empty response. (external_user_allowed = "true" AND display_name:"Hello" AND space_type = "SPACE")` Panjang kueri maksimum adalah 1.000 karakter. Kueri yang tidak valid akan ditolak oleh server dengan error `INVALID_ARGUMENT`.
`order_by`	`string` Opsional. Cara pengurutan daftar ruang. Atribut yang didukung untuk pengurutan 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 mana pun di ruang ini. `create_time` — Menunjukkan waktu pembuatan ruang. Jika `useAdminAccess` adalah `false`, hanya `create_time` dan `relevance` yang didukung untuk pengurutan. Hanya `DESC` yang didukung untuk kolom ini dalam penelusuran non-admin. Nilai operasi pengurutan yang valid adalah: `ASC` untuk urutan menaik. Nilai default. `DESC` untuk menurun. Sintaksis yang didukung saat `useAdminAccess` ditetapkan ke `true`: `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` Jika `useAdminAccess` ditetapkan ke `false`: `create_time DESC` `relevance DESC` ( Pratinjau Developer)

SearchSpacesResponse

Respons dengan daftar ruang yang sesuai dengan permintaan penelusuran ruang.

Kolom
`spaces[] (deprecated)`	`Space` Item ini tidak digunakan lagi. Tidak digunakan lagi: Gunakan kolom `results` baru sebagai gantinya. Halaman ruang yang diminta. Kolom ini hanya akan diisi jika `useAdminAccess` ditetapkan ke `true` dan tidak digunakan lagi dan diganti dengan kolom `results` baru.
`next_page_token`	`string` Token yang dapat digunakan untuk mengambil halaman berikutnya. Jika kolom ini kosong, tidak akan ada halaman berikutnya. Hanya diisi jika `useAdminAccess` ditetapkan ke `true`.
`total_size`	`int32` Jumlah total ruang yang cocok dengan kueri, di semua halaman. Jika hasilnya lebih dari 10.000 ruang, nilai ini adalah perkiraan. Hanya diisi jika `useAdminAccess` ditetapkan ke `true`.
`results[]`	`SearchSpaceResult` Hanya output. Daftar hasil penelusuran yang cocok dengan kueri.

SearchSpaceResult

Satu item hasil dari penelusuran ruang.

Kolom

space

Hanya output. Ruang yang cocok.

Bagian

Merepresentasikan bagian di Google Chat. Bagian membantu pengguna mengatur ruang mereka. Ada dua jenis bagian:

Bagian Sistem: Ini adalah bagian standar yang dikelola oleh Google Chat. Nama resource-nya tetap, dan tidak dapat dibuat, dihapus, atau diubah display_name-nya. Contohnya mencakup:
- users/{user}/sections/default-direct-messages
- users/{user}/sections/default-spaces
- users/{user}/sections/default-apps
Rubrik Khusus: Ini adalah rubrik yang dibuat dan dikelola oleh pengguna. Membuat rubrik khusus menggunakan CreateSection memerlukan display_name. Rubrik khusus dapat diperbarui menggunakan UpdateSection dan dihapus menggunakan DeleteSection.

Kolom
`name`	`string` ID. Nama resource bagian. Untuk bagian sistem, ID bagian adalah string konstan: DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` DEFAULT_SPACES: `users/{user}/sections/default-spaces` DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`
`display_name`	`string` Opsional. Nama tampilan bagian. Hanya diisi untuk bagian jenis `CUSTOM_SECTION`. Mendukung hingga 80 karakter. Wajib diisi saat membuat `CUSTOM_SECTION`.
`sort_order`	`int32` Hanya output. Urutan bagian dalam kaitannya dengan bagian lain. Bagian dengan nilai `sort_order` yang lebih rendah akan muncul sebelum bagian dengan nilai yang lebih tinggi.
`type`	`SectionType` Wajib. Jenis bagian.

SectionType

Jenis bagian.

Enum
`SECTION_TYPE_UNSPECIFIED`	Jenis bagian tidak ditentukan.
`CUSTOM_SECTION`	Rubrik khusus.
`DEFAULT_DIRECT_MESSAGES`	Bagian default yang berisi DIRECT_MESSAGE antara dua pengguna manusia atau ruang GROUP_CHAT yang bukan bagian dari bagian kustom mana pun.
`DEFAULT_SPACES`	Ruang default yang bukan milik rubrik khusus mana pun.
`DEFAULT_APPS`	Bagian default yang berisi aplikasi terinstal pengguna.

SectionItem

Item bagian yang ditentukan pengguna. Ini digunakan untuk mewakili item bagian, seperti ruang, yang dikelompokkan dalam satu bagian.

Kolom

name

string

ID. Nama resource item bagian.

Format: users/{user}/sections/{section}/items/{item}

Kolom union item. Wajib. Item bagian. item hanya dapat berupa salah satu dari berikut:

space

string

Opsional. Nama resource ruang.

Format: spaces/{space}

SetUpSpaceRequest

Meminta untuk membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya.

Kolom

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 lain. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

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

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

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

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

request_id

string

Untuk menggunakan kolom ini secara efektif:

Pastikan permintaan berikutnya identik dan menggunakan kredensial autentikasi yang sama dengan permintaan asli.
Jika ruang sudah dibuat dengan ID permintaan yang diberikan, permintaan akan menampilkan ruang tersebut. Perhatikan bahwa ruang yang ditampilkan mungkin tidak terisi sepenuhnya; API akan menggemakan ruang dalam permintaan Anda dengan nama resource yang ditetapkan sistem terisi. Untuk mengambil metadata terbaru untuk ruang, panggil GetSpace.
Menggunakan kembali ID permintaan yang ada dengan pengguna terautentikasi yang berbeda akan menghasilkan error.

memberships[]

AccessPermissionSetting

Opsional. Pengguna atau grup Google Chat yang akan diundang untuk bergabung ke ruang. Hilangkan pengguna yang memanggil, karena mereka ditambahkan secara otomatis.

Set ini saat ini mengizinkan hingga 49 keanggotaan (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 (menambahkan 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 keanggotaan 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 diisi saat menetapkan Space.spaceType ke GROUP_CHAT, bersama dengan minimal dua keanggotaan.

Wajib diisi saat menetapkan Space.spaceType ke DIRECT_MESSAGE dengan pengguna manusia, bersama dengan tepat satu keanggotaan.

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

SlashCommand

Metadata tentang perintah garis miring di Google Chat.

Kolom

command_id

int64

ID perintah garis miring.

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 ruangnya adalah `AAAAAAAAA`.
`type (deprecated)`	`Type` Item ini tidak digunakan lagi. 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. Hanya output untuk penggunaan lain.
`single_user_bot_dm`	`bool` Opsional. Apakah ruang tersebut merupakan DM antara aplikasi Chat dan satu orang.
`threaded (deprecated)`	`bool` Item ini tidak digunakan lagi. Hanya output. Tidak digunakan lagi: Gunakan `spaceThreadingState` sebagai gantinya. Apakah pesan di ruang ini diatur dalam rangkaian pesan.
`display_name`	`string` Opsional. Nama tampilan ruang. Diperlukan saat membuat ruang dengan `spaceType` dari `SPACE`. Jika Anda menerima pesan error `ALREADY_EXISTS` saat membuat ruang atau memperbarui `displayName`, coba `displayName` lain. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini. Untuk pesan langsung, kolom ini mungkin kosong. Mendukung hingga 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 pengguna Google Chat mana pun. 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 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 pembuatan ruang. Kolom ini hanya output, kecuali jika digunakan di ruang mode impor. Untuk ruang mode impor, tetapkan kolom ini ke stempel waktu historis saat ruang dibuat di sumber untuk mempertahankan waktu pembuatan asli. Hanya diisi dalam output jika `spaceType` adalah `GROUP_CHAT` atau `SPACE`.
`last_active_time`	`Timestamp` Hanya output. Stempel waktu pesan terakhir di 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 oleh admin, aplikasi Chat Anda harus memiliki fitur pesan langsung.
`membership_count`	`MembershipCount` Hanya output. Jumlah keanggotaan yang diikuti, dikelompokkan menurut jenis keanggotaan. Diisi jika `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 bagi pengguna untuk 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 berlaku ini 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. Aplikasi pribadi juga dapat menggunakan alias `customers/my_customer` untuk membuat ruang di organisasi Google Workspace yang sama dengan aplikasi. Kolom ini tidak diisi untuk pesan langsung (DM) atau saat ruang dibuat oleh pengguna non-Google Workspace.
Kolom union `space_permission_settings`. Merepresentasikan setelan izin ruang. Hanya diisi jika `space_type` adalah `SPACE`. `space_permission_settings` hanya dapat berupa salah satu dari hal berikut:
`predefined_permission_settings`	`PredefinedPermissionSettings` Opsional. Hanya input. Setelan izin ruang yang telah ditetapkan, hanya dimasukkan saat membuat ruang. Jika kolom tidak ditetapkan, ruang kolaborasi akan dibuat. Setelah Anda membuat ruang, setelan akan diisi di kolom `PermissionSettings`. Menetapkan setelan izin standar mendukung: Autentikasi aplikasi dengan persetujuan administrator dengan cakupan `chat.app.spaces` atau `chat.app.spaces.create`. Autentikasi pengguna
`permission_settings`	`PermissionSettings` Opsional. Setelan izin ruang untuk ruang yang ada. Input untuk memperbarui setelan izin ruang yang tepat, yang akan menggantikan setelan izin yang ada. Output mencantumkan setelan izin saat ini. Pembacaan dan pembaruan setelan izin mendukung: Autentikasi aplikasi dengan persetujuan administrator dengan cakupan `chat.app.spaces`. Hanya diisi dan dapat ditetapkan saat aplikasi Chat membuat ruang. Autentikasi pengguna

AccessPermissionSetting

Setelan izin akses.

Kolom

principals[]

Principal

Opsional. Daftar yang tidak diurutkan. Akun utama yang diizinkan untuk izin ini.

AccessPermissionSettings

Mengakses setelan izin untuk ruang.

Kolom

discover_space_setting

Opsional. Setelan izin akses untuk menemukan ruang.

join_space_setting

AccessPermissionSetting

Opsional. Setelan izin akses untuk bergabung ke ruang.

view_space_membership_setting

AccessPermissionSetting

Opsional. Setelan izin akses untuk melihat keanggotaan ruang. Harus ditentukan bersama dengan PermissionSettings.view_space_membership dalam mask update dan isi permintaan saat memperbarui siapa yang dapat melihat keanggotaan ruang. Saat memberikan akses lihat kepada audiens target, Anda juga harus memberikan PermissionSettings.view_space_membership kepada semua anggota dalam permintaan yang sama. Untuk menghapus audiens target yang ada (misalnya, untuk membatasi akses lihat hanya untuk pengelola ruang atau asisten pengelola), tentukan AccessPermissionSetting kosong (tanpa principals).

AccessSettings

Merepresentasikan setelan akses ruang.

Kolom

access_state

AccessState

Hanya output. Menunjukkan status akses ruang.

audience

string

Opsional. Nama resource audiens target 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 satu per satu ke ruang yang dapat mengaksesnya. Untuk mengetahui detailnya, lihat Membuat ruang dapat ditemukan oleh audiens target.

Format: audiences/{audience}

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

Membaca dukungan audiens target:

Autentikasi pengguna
Autentikasi aplikasi dengan persetujuan administrator dengan cakupan chat.app.spaces.

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

Menetapkan audiens target memerlukan autentikasi pengguna.

access_permission_settings

AccessPermissionSettings

Opsional. Setelan izin akses untuk ruang.

Untuk menetapkan audiens target saat membuat ruang, tentukan kolom accessSettings.audience dalam permintaan Anda.

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 individual oleh pengguna lain atau Google Workspace Administrator yang dapat menemukan dan mengakses ruang.

DISCOVERABLE

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

Pembuatan ruang yang dapat ditemukan memerlukan autentikasi pengguna.

MembershipCount

Menampilkan 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 karena memiliki keanggotaan dalam 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 pemilik ruang (ROLE_MANAGER) memiliki izin ini.

members_allowed

bool

Opsional. Apakah anggota ruang dasar (ROLE_MEMBER) memiliki izin ini.

assistant_managers_allowed

bool

Opsional. Apakah pengelola ruang ROLE_ASSISTANT_MANAGER) 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 di ruang.
`reply_messages`	`PermissionSetting` Opsional. Setelan untuk membalas pesan dalam ruang.
`view_space_membership`	`PermissionSetting` Opsional. Setelan untuk melihat keanggotaan ruang. Harus ditentukan bersama dengan `AccessPermissionSettings.view_space_membership_setting` dalam mask update dan isi permintaan saat memperbarui siapa yang dapat melihat keanggotaan ruang. Saat membatasi akses lihat untuk peran tertentu (misalnya, hanya pengelola ruang atau asisten pengelola), tentukan izin peran yang diinginkan di sini dan berikan `AccessPermissionSettings.view_space_membership_setting` kosong dalam permintaan yang sama. Jika audiens target dikonfigurasi di `AccessPermissionSettings.view_space_membership_setting`, setelan ini harus diberikan kepada semua anggota.

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.

Akun utama

Akun utama yang mewakili entitas yang diberi akses.

Kolom

Kolom union principal_type. Jenis akun utama. principal_type hanya dapat berupa salah satu dari berikut:

audience

Audience

Audiens.

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 4.096 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`	Dilindungi Undang-Undang.
`THREADED_MESSAGES`	Ruang yang mendukung rangkaian pesan. Saat merespons pesan, pengguna dapat membalas dalam rangkaian pesan, yang membuat respons mereka tetap dalam konteks pesan asli.
`GROUPED_MESSAGES`	Ruang bernama tempat percakapan diatur berdasarkan topik. Topik dan balasannya dikelompokkan bersama.
`UNTHREADED_MESSAGES`	Ruang yang tidak mendukung rangkaian pesan. Status rangkaian pesan ruang ini hanya digunakan untuk kasus khusus, termasuk: Chat rapat dinamis yang rangkaian pesannya sengaja dinonaktifkan. Percakapan grup lama yang dibuat sebelum tahun 2022.

SpaceType

Jenis ruang. Diperlukan saat membuat atau memperbarui ruang. Hanya output untuk penggunaan lain.

Enum
`SPACE_TYPE_UNSPECIFIED`	Dilindungi Undang-Undang.
`SPACE`	Tempat pengguna 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 seseorang dan aplikasi Chat.

Jenis

Tidak digunakan lagi: Gunakan SpaceType sebagai gantinya.

Enum
`TYPE_UNSPECIFIED`	Dilindungi Undang-Undang.
`ROOM`	Percakapan antara dua orang atau lebih.
`DM`	Pesan Langsung 1:1 antara manusia dan aplikasi Chat, dengan semua pesan bersifat datar. Perhatikan bahwa ini tidak termasuk 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 acara ruang. Format: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Waktu 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 keanggotaan: Langganan baru: `google.workspace.chat.membership.v1.created` Langganan diperbarui: `google.workspace.chat.membership.v1.updated` Keanggotaan dihapus: `google.workspace.chat.membership.v1.deleted` Beberapa langganan baru: `google.workspace.chat.membership.v1.batchCreated` Beberapa keanggotaan 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 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 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 keanggotaan baru. Jenis peristiwa: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Payload peristiwa untuk keanggotaan yang diperbarui. Jenis peristiwa: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Payload peristiwa untuk keanggotaan yang dihapus. Jenis peristiwa: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Payload peristiwa untuk beberapa keanggotaan baru. Jenis peristiwa: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Payload peristiwa untuk beberapa keanggotaan yang diperbarui. Jenis peristiwa: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Payload peristiwa untuk beberapa keanggotaan 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 penonaktifan notifikasi ruang.

MuteSetting

Jenis setelan penonaktifan notifikasi ruang.

Enum
`MUTE_SETTING_UNSPECIFIED`	Dilindungi Undang-Undang.
`UNMUTED`	Pengguna akan menerima notifikasi untuk ruang berdasarkan setelan notifikasi.
`MUTED`	Pengguna tidak akan menerima notifikasi apa pun untuk ruang, terlepas dari setelan notifikasi.

NotificationSetting

Jenis setelan notifikasi. Jenis lainnya mungkin didukung pada masa mendatang.

Enum
`NOTIFICATION_SETTING_UNSPECIFIED`	Dilindungi Undang-Undang.
`ALL`	Notifikasi dipicu oleh @sebutan, rangkaian pesan yang diikuti, pesan pertama dari rangkaian pesan baru. Semua rangkaian pesan baru otomatis diikuti, kecuali jika pengguna berhenti mengikutinya secara manual.
`MAIN_CONVERSATIONS`	Notifikasi dipicu oleh @sebutan, rangkaian pesan yang diikuti, pesan pertama dari rangkaian pesan baru. Tidak tersedia untuk pesan langsung personal.
`FOR_YOU`	Notifikasi dipicu oleh @sebutan, rangkaian pesan yang diikuti. Tidak tersedia untuk pesan langsung personal.
`OFF`	Notifikasi nonaktif.

SpaceReadState

Status baca pengguna dalam ruang, yang digunakan untuk mengidentifikasi pesan yang sudah 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, stempel waktu ini sesuai dengan stempel waktu pesan terakhir yang dibaca, atau stempel waktu yang ditentukan oleh pengguna untuk menandai posisi terakhir yang dibaca di ruang.

SpaceUpdatedEventData

Payload peristiwa untuk ruang yang diperbarui.

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

Kolom

space

Ruang yang diperbarui.

SpaceView

Tampilan yang menentukan kolom mana yang harus diisi pada resource Space. Untuk memastikan kompatibilitas dengan rilis mendatang, sebaiknya kode Anda memperhitungkan nilai tambahan.

Enum
`SPACE_VIEW_UNSPECIFIED`	Nilai default / tidak ditetapkan.
`SPACE_VIEW_RESOURCE_NAME_ONLY`	Hanya mengisi nama resource Ruang.
`SPACE_VIEW_EXPANDED`	Mengisi kolom resource Ruang. Catatan: kolom `permissionSettings` tidak akan diisi. Permintaan yang menentukan SPACE_VIEW_EXPANDED harus menyertakan cakupan yang memungkinkan pembacaan data ruang, misalnya, https://www.googleapis.com/auth/chat.spaces atau https://www.googleapis.com/auth/chat.spaces.readonly.

Rangkaian pesan

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

Jika Anda 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 rangkaian pesan.

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 dalam 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 rangkaian pesan.

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

last_read_time

Timestamp

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

UpdateAvailabilityRequest

Pesan permintaan untuk metode UpdateAvailability.

Kolom

availability

Availability

Wajib. Ketersediaan yang akan diperbarui.

update_mask

Wajib. Daftar kolom yang akan diperbarui. Satu-satunya kolom yang dapat diperbarui adalah custom_status.

UpdateMembershipRequest

Pesan permintaan untuk memperbarui keanggotaan.

Kolom

membership

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

update_mask

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 ini akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang melakukan panggilan 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

Wajib. Pesan dengan kolom yang diperbarui.

update_mask

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

Jalur kolom yang saat ini didukung:

text
attachment
cards (Memerlukan autentikasi aplikasi.)
cards_v2 (Memerlukan autentikasi aplikasi.)
accessory_widgets (Memerlukan autentikasi aplikasi.)
quoted_message_metadata (Hanya mengizinkan penghapusan pesan yang dikutip.)

allow_missing

bool

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

UpdateSectionRequest

Pesan permintaan untuk memperbarui bagian.

Kolom

section

Wajib. Bagian yang akan diperbarui.

update_mask

SpaceNotificationSetting

Wajib. Mask untuk menentukan kolom yang akan diperbarui.

Jalur kolom yang saat ini didukung:

display_name

UpdateSpaceNotificationSettingRequest

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

Kolom

space_notification_setting

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

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 menelepon.

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

Alias me. Misalnya, users/me/spaces/{space}/spaceReadState.
Alamat email Workspace-nya. Misalnya, users/user@example.com/spaces/{space}/spaceReadState.
ID pengguna mereka. Misalnya, users/123456789/spaces/{space}/spaceReadState.

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

update_mask

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

last_read_time

Jika last_read_time lebih awal dari 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) daripada waktu pembuatan pesan terbaru. last_read_time dipaksa untuk cocok dengan waktu pembuatan pesan terbaru. Perhatikan bahwa status baca ruang hanya memengaruhi status baca pesan yang terlihat dalam percakapan tingkat teratas ruang. Balasan dalam rangkaian pesan tidak terpengaruh oleh stempel waktu ini, dan mengandalkan status baca rangkaian pesan.

UpdateSpaceRequest

Permintaan untuk memperbarui satu ruang.

Kolom

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