Method: spaces.list

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

Mendukung jenis autentikasi berikut:

  • Autentikasi aplikasi dengan cakupan otorisasi:

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

  • Autentikasi pengguna dengan salah satu cakupan otorisasi berikut:

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

Untuk mencantumkan semua ruang bernama 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 maksimum spasi yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan.

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

Nilai negatif menampilkan error INVALID_ARGUMENT.
pageToken

string

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

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

string

Opsional. Filter kueri.

Anda dapat memfilter ruang menurut jenis ruang (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 ruang di halaman yang diminta (atau pertama). Catatan: Kolom permissionSettings tidak ditampilkan dalam objek Ruang untuk permintaan daftar.
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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.