Method: spaces.list

Mencantumkan ruang tempat penelepon tersebut menjadi anggota. Chat dan DM grup tidak dicantumkan hingga pesan pertama dikirim. Untuk contoh, lihat Mencantumkan ruang.

Memerlukan autentikasi. Sepenuhnya mendukung autentikasi akun layanan dan autentikasi pengguna memerlukan cakupan otorisasi chat.spaces atau chat.spaces.readonly.

Mencantumkan ruang yang dapat dilihat oleh pemanggil atau pengguna yang diautentikasi. Chat dan DM grup tidak dicantumkan 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 yang lebih dari 1.000, nilai 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 penomoran halaman, nilai filter harus cocok dengan panggilan yang memberikan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak terduga.
filter

string

Opsional. Filter kueri.

Memerlukan autentikasi pengguna.

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 bagi 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 yang memiliki error INVALID_ARGUMENT.

Dengan autentikasi akun layanan, kolom ini diabaikan dan kueri selalu menampilkan semua spasi. Namun, Chat API tetap memvalidasi sintaksis kueri dengan akun layanan, 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 akan 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.