Method: spaces.list

Mencantumkan ruang tempat pemanggil menjadi anggota. Chat grup dan DM tidak dicantumkan hingga pesan pertama dikirim. Sebagai contoh, lihat Daftar ruang.

Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna.

Mencantumkan ruang yang terlihat oleh pemanggil atau pengguna yang diautentikasi. Chat grup dan DM tidak dicantumkan hingga pesan pertama dikirim.

Untuk menampilkan daftar semua ruang yang telah diberi nama menurut organisasi Google Workspace, gunakan metode spaces.search() menggunakan hak istimewa administrator Workspace.

Permintaan HTTP

GET https://chat.googleapis.com/v1/spaces

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
pageSize

integer

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

Jika tidak ditentukan, maksimal 100 spasi akan ditampilkan.

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

Nilai negatif menampilkan error INVALID_ARGUMENT.
pageToken

string

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

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

string

Opsional. Filter kueri.

Anda dapat memfilter ruang berdasarkan jenis ruang (spaceType).

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

Misalnya, kueri berikut valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk permintaan daftar ruang.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Kolom
spaces[]

object (Space)

Daftar spasi di halaman yang diminta (atau pertama).
nextPageToken

string

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

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.