Panduan ini menjelaskan cara menggunakan metode list()
di resource Membership
Google Chat API untuk mencantumkan anggota di ruang sebagai daftar keanggotaan yang dapat difilter dan diberi nomor halaman di ruang.
- Mencantumkan keanggotaan dengan autentikasi aplikasi akan mencantumkan keanggotaan di ruang yang memiliki akses ke aplikasi Chat, tetapi mengecualikan keanggotaan aplikasi Chat, termasuk keanggotaan aplikasi Chat itu sendiri.
- Mencantumkan langganan dengan autentikasi pengguna akan mencantumkan langganan di ruang yang dapat diakses oleh pengguna terautentikasi.
- Mencantumkan keanggotaan sebagai administrator Google Workspace dengan autentikasi pengguna menggunakan hak istimewa administrator akan mencantumkan keanggotaan di semua ruang di organisasi Google Workspace Anda.
Resource Membership
mewakili apakah pengguna manusia atau aplikasi Google Chat diundang ke, menjadi bagian dari, atau tidak ada di ruang.
Prasyarat
Node.js
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Library Klien Cloud Node.js.
- Buat kredensial akses berdasarkan cara Anda ingin melakukan autentikasi dalam permintaan Google Chat API:
- Untuk mengautentikasi sebagai pengguna Chat,
buat kredensial client ID
OAuth dan simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal Anda. - Untuk mengautentikasi sebagai aplikasi Chat,
buat kredensial akun layanan dan simpan kredensial sebagai file JSON bernama
credentials.json
.
- Untuk mengautentikasi sebagai pengguna Chat,
buat kredensial client ID
OAuth dan simpan kredensial sebagai file JSON bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
- Ruang Google Chat tempat pengguna terautentikasi atau aplikasi Chat yang melakukan panggilan adalah anggota. Untuk mengautentikasi sebagai aplikasi Chat, tambahkan aplikasi Chat ke ruang.
Python
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Library Klien Cloud Python.
- Buat kredensial akses berdasarkan cara Anda ingin melakukan autentikasi dalam permintaan Google Chat API:
- Untuk mengautentikasi sebagai pengguna Chat,
buat kredensial client ID
OAuth dan simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal Anda. - Untuk mengautentikasi sebagai aplikasi Chat,
buat kredensial akun layanan dan simpan kredensial sebagai file JSON bernama
credentials.json
.
- Untuk mengautentikasi sebagai pengguna Chat,
buat kredensial client ID
OAuth dan simpan kredensial sebagai file JSON bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
- Ruang Google Chat tempat pengguna terautentikasi atau aplikasi Chat yang melakukan panggilan adalah anggota. Untuk mengautentikasi sebagai aplikasi Chat, tambahkan aplikasi Chat ke ruang.
Java
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Library Klien Cloud Java.
- Buat kredensial akses berdasarkan cara Anda ingin melakukan autentikasi dalam permintaan Google Chat API:
- Untuk mengautentikasi sebagai pengguna Chat,
buat kredensial client ID
OAuth dan simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal Anda. - Untuk mengautentikasi sebagai aplikasi Chat,
buat kredensial akun layanan dan simpan kredensial sebagai file JSON bernama
credentials.json
.
- Untuk mengautentikasi sebagai pengguna Chat,
buat kredensial client ID
OAuth dan simpan kredensial sebagai file JSON bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
- Ruang Google Chat tempat pengguna terautentikasi atau aplikasi Chat yang melakukan panggilan adalah anggota. Untuk mengautentikasi sebagai aplikasi Chat, tambahkan aplikasi Chat ke ruang.
Apps Script
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Buat project Apps Script mandiri, dan aktifkan Layanan Chat Lanjutan.
- Dalam panduan ini, Anda harus menggunakan autentikasi pengguna atau aplikasi. Untuk mengautentikasi sebagai aplikasi Chat, buat kredensial akun layanan. Untuk mengetahui langkah-langkahnya, lihat Mengautentikasi dan memberikan otorisasi sebagai aplikasi Google Chat.
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
- Ruang Google Chat tempat pengguna terautentikasi atau aplikasi Chat yang melakukan panggilan adalah anggota. Untuk mengautentikasi sebagai aplikasi Chat, tambahkan aplikasi Chat ke ruang.
Mencantumkan anggota di ruang dengan autentikasi pengguna
Untuk mencantumkan pengguna, Google Grup, dan aplikasi Chat di ruang yang dapat diakses oleh pengguna terautentikasi, teruskan hal berikut dalam permintaan Anda:
- Dengan
autentikasi pengguna,
tentukan cakupan
otorisasi
chat.memberships.readonly
atauchat.memberships
. - Panggil
metode
ListMemberships()
. - Untuk menampilkan daftar Google Grup, tetapkan parameter kueri
showGroups
ketrue
.
Contoh berikut mencantumkan anggota Google Grup, manusia, dan aplikasi yang terlihat oleh pengguna yang diautentikasi.
Node.js
Python
Java
Apps Script
Untuk menjalankan contoh ini, ganti SPACE_NAME
dengan ID dari kolom name
ruang. Anda bisa mendapatkan ID dengan memanggil metode
ListSpaces()
atau dari URL ruang.
Google Chat API menampilkan daftar anggota Google Grup, manusia, dan aplikasi dari ruang yang ditentukan.
Mencantumkan anggota di ruang dengan autentikasi aplikasi
Untuk mencantumkan pengguna dan aplikasi Chat di ruang yang dapat diakses oleh aplikasi yang diautentikasi, teruskan hal berikut dalam permintaan Anda:
- Dengan
autentikasi aplikasi,
tentukan cakupan otorisasi
chat.bot
. - Panggil
metode
ListMemberships()
. - Untuk menampilkan daftar Google Grup, tetapkan parameter kueri
showGroups
ketrue
.
Contoh berikut mencantumkan anggota ruang manusia (bukan pengelola ruang) yang terlihat oleh aplikasi Chat:
Node.js
Python
Java
Apps Script
Untuk menjalankan contoh ini, ganti SPACE_NAME
dengan ID dari kolom name
ruang. Anda bisa mendapatkan ID dengan memanggil metode
ListSpaces()
atau dari URL ruang.
Google Chat API menampilkan daftar anggota ruang manusia (tidak termasuk pengelola ruang) dari ruang yang ditentukan.
Mencantumkan anggota sebagai administrator Google Workspace
Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metode ListMemberships()
untuk mencantumkan langganan untuk ruang apa pun di organisasi Google Workspace Anda. Chat API hanya menampilkan
keanggotaan tentang pengguna—baik internal maupun eksternal—atau Google Grup dari organisasi
Anda, sehingga menghapus keanggotaan untuk aplikasi Chat apa pun.
Untuk memanggil metode ini sebagai administrator Google Workspace, lakukan hal berikut:
- Panggil metode menggunakan autentikasi pengguna, dan tentukan cakupan otorisasi yang mendukung pemanggilan metode menggunakan hak istimewa administrator.
- Dalam permintaan Anda, tentukan parameter kueri berikut:
- Tetapkan
useAdminAccess
ketrue
. - Untuk menampilkan hanya pengguna, tetapkan
filter
untukmember.type
sama denganHUMAN
. - Untuk menampilkan pengguna dan grup, tetapkan
filter
untukmember.type
yang tidak sama denganBOT
AND
showGroups
sama dengantrue
.
- Tetapkan
Untuk mengetahui informasi selengkapnya dan contoh, lihat Mengelola ruang Google Chat sebagai administrator Google Workspace.
Menyesuaikan penomoran halaman atau memfilter daftar
Untuk mencantumkan langganan, teruskan parameter kueri berikut untuk menyesuaikan penomoran halaman, atau memfilter, langganan yang tercantum:
pageSize
: Jumlah maksimum langganan yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, maksimal 100 ruang akan ditampilkan. Nilai maksimumnya adalah 1.000; nilai yang lebih dari 1.000 akan otomatis diubah menjadi 1.000.pageToken
: Token halaman, diterima dari panggilan list spaces sebelumnya. Berikan token 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 terduga.filter
: Filter kueri. Memerlukan autentikasi pengguna. Untuk mengetahui detail kueri yang didukung, lihat referensiListMembershipsRequest
.
Topik terkait
- Mendapatkan detail tentang langganan pengguna atau aplikasi Chat.
- Undang atau tambahkan pengguna atau aplikasi Chat ke ruang.
- Memperbarui keanggotaan pengguna di ruang Google Chat.
- Menghapus pengguna atau aplikasi Chat dari ruang.