Method: spaces.list

Mencantumkan ruang tempat pemanggil menjadi anggota. Chat grup dan DM tidak tercantum hingga pesan pertama dikirim. Untuk mengetahui contohnya, lihat Mencantumkan ruang.

Memerlukan autentikasi. Mendukung autentikasi aplikasi dan autentikasi pengguna.

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

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 spasi akan ditampilkan.

Nilai maksimum 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 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.

Memerlukan autentikasi pengguna.

Anda dapat memfilter ruang menurut jenis ruang (spaceType).

Untuk memfilter berdasarkan 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 ini valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

Dengan autentikasi aplikasi, kolom ini diabaikan dan kueri akan selalu menampilkan semua spasi. Namun, Chat API masih memvalidasi sintaksis kueri, sehingga kueri yang tidak valid tetap ditolak.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

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