Method: spaces.members.list

Mencantumkan langganan di ruang. Untuk mengetahui contohnya, lihat Mencantumkan pengguna dan aplikasi Google Chat di ruang. Mencantumkan keanggotaan dengan autentikasi aplikasi akan mencantumkan keanggotaan di ruang yang dapat diakses oleh aplikasi Chat, tetapi mengecualikan keanggotaan aplikasi Chat, termasuk keanggotaan aplikasi Chat itu sendiri. Keanggotaan listingan dengan Autentikasi pengguna mencantumkan keanggotaan dalam ruang yang dapat diakses oleh pengguna terautentikasi.

Mendukung jenis autentikasi berikut:

Permintaan HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource ruang yang akan mengambil daftar keanggotaan.

Format: spaces/{space}

Parameter kueri

Parameter
pageSize

integer

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

Jika tidak ditentukan, maksimal 100 langganan 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 sebelumnya untuk mencantumkan langganan. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.
filter

string

Opsional. Filter kueri.

Anda dapat memfilter langganan menurut peran (role) dan jenis anggota (member.type).

Untuk memfilter berdasarkan 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" wajib ada saat useAdminAccess ditetapkan ke benar (true). Filter jenis anggota 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 ditolak oleh server dengan error INVALID_ARGUMENT.
showGroups

boolean

Opsional. Jika true, juga menampilkan langganan yang terkait dengan Google Group, selain jenis langganan lainnya. Jika filter ditetapkan, keanggotaan Google Group yang tidak cocok dengan kriteria filter tidak akan ditampilkan.
showInvited

boolean

Opsional. Jika true, juga menampilkan langganan yang terkait dengan pelanggan invited, selain jenis langganan lainnya. Jika filter ditetapkan, langganan invited yang tidak cocok dengan kriteria filter tidak akan ditampilkan.

Saat ini memerlukan autentikasi pengguna.
useAdminAccess

boolean

Opsional. Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk mencantumkan langganan ruang.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Kolom
memberships[]

object (Membership)

Daftar yang tidak diurutkan. Daftar langganan di halaman yang diminta (atau pertama).
nextPageToken

string

Token yang dapat Anda kirim 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.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.