Panduan ini menjelaskan cara menggunakan metode
create()
pada resource Membership
Google Chat API untuk mengundang atau menambahkan pengguna,
Grup Google, atau aplikasi Chat ke ruang yang juga dikenal sebagai
membuat keanggotaan. Saat membuat keanggotaan, jika anggota yang ditentukan menonaktifkan kebijakan terima otomatis, anggota tersebut akan diundang, dan harus menerima undangan ruang sebelum bergabung. Jika tidak, pembuatan keanggotaan akan menambahkan anggota langsung ke ruang yang ditentukan.
Jika Anda adalah administrator Google Workspace, Anda dapat menambahkan pengguna, Google Grup, atau aplikasi Chat ke ruang mana pun di organisasi Google Workspace Anda.
Resource
Membership
menunjukkan 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.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi 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 melakukan autentikasi sebagai pengguna Chat,
buat kredensial ID klien OAuthdan simpan kredensial sebagai file JSON bernama
credentials.json
ke direktori lokal Anda. - Untuk mengautentikasi sebagai aplikasi Chat,
buat kredensial
akun layanan dan simpan kredensial sebagai file JSON bernama
credentials.json
.
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat kredensial ID klien OAuthdan simpan kredensial sebagai file JSON bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
Python
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Python Cloud Client Library.
- Buat kredensial akses berdasarkan cara Anda ingin melakukan autentikasi dalam permintaan Google Chat API:
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat kredensial ID klien OAuthdan simpan kredensial sebagai file JSON bernama
credentials.json
ke direktori lokal Anda. - Untuk mengautentikasi sebagai aplikasi Chat,
buat kredensial
akun layanan dan simpan kredensial sebagai file JSON bernama
credentials.json
.
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat kredensial ID klien OAuthdan simpan kredensial sebagai file JSON bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
Java
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Java Cloud Client Library.
- Buat kredensial akses berdasarkan cara Anda ingin melakukan autentikasi dalam permintaan Google Chat API:
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat kredensial ID klien OAuthdan simpan kredensial sebagai file JSON bernama
credentials.json
ke direktori lokal Anda. - Untuk mengautentikasi sebagai aplikasi Chat,
buat kredensial
akun layanan dan simpan kredensial sebagai file JSON bernama
credentials.json
.
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat kredensial ID klien OAuthdan simpan kredensial sebagai file JSON bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
Apps Script
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Buat project Apps Script mandiri, dan aktifkan Advanced Chat Service.
- Dalam panduan ini, Anda harus menggunakan autentikasi pengguna atau aplikasi. Untuk melakukan autentikasi sebagai aplikasi Chat, buat kredensial akun layanan. Untuk mengetahui langkah-langkahnya, lihat Mengautentikasi dan mengizinkan sebagai aplikasi Google Chat.
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin mengautentikasi sebagai pengguna atau aplikasi Chat.
Mengundang atau menambahkan pengguna ke ruang sebagai pengguna
Untuk mengundang atau menambahkan pengguna ke ruang dengan autentikasi pengguna, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.memberships
. - Panggil
metode
CreateMembership()
. - Teruskan
parent
sebagai nama resource ruang tempat membuat keanggotaan. - Teruskan
membership
sebagai instanceMembership
dengan kolommember
yang ditetapkan dengan:- Kolom
type
ditetapkan keHUMAN
. - Kolom
name
disetel keusers/{user}
dengan{user}
adalah orang yang ingin Anda tambahkan ke ruang. Untuk menentukan pengguna Chat, ganti{user}
dengan salah satu opsi berikut:- ID untuk
orang
di People API. Misalnya, jika People API
person
resourceName
adalahpeople/123456789
, maka gunakan nilaiusers/123456789
. - ID untuk pengguna di Directory API.
- Alamat email pengguna. Misalnya,
users/222larabrown@gmail.com
atauusers/larabrown@cymbalgroup.com
. Jika pengguna menggunakan Akun Google atau milik organisasi Google Workspace lain, Anda harus menggunakan alamat emailnya.
- ID untuk
orang
di People API. Misalnya, jika People API
person
- Kolom
Contoh berikut menambahkan pengguna ke ruang dengan autentikasi pengguna:
Node.js
Python
Java
Apps Script
Untuk menjalankan contoh, ganti berikut ini:
SPACE_NAME
: ID dariname
ruang. Anda bisa mendapatkan ID dengan memanggil metodeListSpaces()
atau dari URL ruang.USER_NAME
: ID pengguna.
Chat API menampilkan instance
Membership
yang menjelaskan keanggotaan pengguna yang dibuat.
Mengundang atau menambahkan grup Google ke ruang
Untuk mengundang atau menambahkan Grup Google ke ruang dengan autentikasi pengguna (Autentikasi aplikasi tidak mendukung pengundangan atau penambahan Grup Google ke ruang), teruskan berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.memberships
. - Panggil
metode
CreateMembership()
. - Teruskan
parent
sebagai nama resource ruang tempat membuat keanggotaan. - Teruskan
membership
sebagai instanceMembership
dengan kolomname
darigroupMember
ditetapkan kegroups/{group}
dengan{group}
adalah ID grup yang ingin Anda buat keanggotaannya. ID grup dapat diambil menggunakan Cloud Identity API.
Google Grup tidak dapat ditambahkan ke chat grup atau pesan langsung, tetapi hanya ke ruang bernama.
Contoh berikut menambahkan grup ke ruang bernama dengan autentikasi pengguna:
Node.js
Python
Java
Apps Script
Untuk menjalankan contoh, ganti berikut ini:
SPACE_NAME
: ID dariname
ruang. Anda bisa mendapatkan ID dengan memanggil metodeListSpaces()
atau dari URL ruang.GROUP_NAME
: ID grup.
Chat API menampilkan instance
Membership
yang menjelaskan keanggotaan pengguna yang dibuat.
Menambahkan aplikasi Chat ke ruang
Aplikasi Chat tidak dapat menambahkan aplikasi lain sebagai anggota ke ruang. Untuk menambahkan aplikasi Chat ke ruang atau pesan langsung antara dua pengguna manusia, teruskan hal berikut dalam permintaan Anda dengan autentikasi pengguna (Autentikasi aplikasi tidak mendukung pengiriman undangan atau penambahan aplikasi Chat ke ruang):
- Tentukan cakupan otorisasi
chat.memberships.app
. - Panggil
metode
CreateMembership()
. - Teruskan
parent
sebagai nama resource ruang tempat membuat keanggotaan. - Teruskan
membership
sebagai instanceMembership
dengan kolommember
yang ditetapkan dengan:- Kolom
type
ditetapkan keBOT
. - Kolom
name
ditetapkan keusers/app
; alias yang merepresentasikan aplikasi yang memanggil Chat API.
- Kolom
Contoh berikut menambahkan aplikasi Chat ke ruang:
Node.js
Python
Java
Apps Script
Untuk menjalankan sampel, ganti SPACE_NAME
dengan ID dari
name
ruang.
Anda bisa mendapatkan ID dengan memanggil metode
ListSpaces()
atau dari URL ruang.
Chat API menampilkan instance
Membership
yang menjelaskan keanggotaan pengguna yang dibuat.
Mengundang atau menambahkan pengguna ke ruang sebagai aplikasi Chat
Autentikasi aplikasi memerlukan persetujuan administrator satu kali.
Untuk mengundang atau menambahkan pengguna ke ruang dengan autentikasi aplikasi, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.app.memberships
. - Panggil
metode
create
pada resourcemembership
. - Tetapkan
parent
ke nama resource ruang tempat membuat keanggotaan. - Setel
member
keusers/{user}
dengan{user}
adalah orang yang ingin Anda buat langganannya, dan merupakan:- ID untuk
orang
di People API. Misalnya, jika
resourceName
person People API adalahpeople/123456789
, tetapkanmembership.member.name
keusers/123456789
. - ID untuk pengguna di Directory API.
- Alamat email pengguna. Misalnya,
users/222larabrown@gmail.com
atauusers/larabrown@cymbalgroup.com
. Jika pengguna menggunakan Akun Google atau milik organisasi Google Workspace lain, Anda harus menggunakan alamat emailnya.
- ID untuk
orang
di People API. Misalnya, jika
Membuat kunci API
Untuk memanggil metode Developer Preview API, Anda harus menggunakan versi pratinjau developer non-publik dari dokumen penemuan API. Untuk mengautentikasi permintaan, Anda harus meneruskan kunci API.
Untuk membuat Kunci API, buka project Google Cloud aplikasi Anda dan lakukan hal berikut:
- Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create credentials > API key.
- Kunci API baru Anda akan ditampilkan.
- Klik Salin untuk menyalin kunci API Anda untuk digunakan dalam kode aplikasi Anda. Kunci API juga dapat ditemukan di bagian "Kunci API" pada kredensial project Anda.
- Klik Batasi kunci untuk memperbarui setelan lanjutan dan membatasi penggunaan kunci API Anda. Untuk mengetahui detail selengkapnya, lihat Menerapkan pembatasan kunci API.
Menulis skrip yang memanggil Chat API
Contoh berikut menambahkan pengguna ke ruang dengan autentikasi aplikasi:
Python
- Di direktori kerja Anda, buat file bernama
chat_membership_app_create.py
. Sertakan kode berikut di
chat_membership_app_create.py
:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then adds a user to a Chat space by creating a membership. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().members().create( # The space in which to create a membership. parent = 'spaces/SPACE', # Specify which user the membership is for. body = { 'member': { 'name':'users/USER', 'type': 'HUMAN' } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
Dalam kode, ganti kode berikut:
API_KEY
: kunci API yang Anda buat untuk membangun endpoint layanan untuk Chat API.SPACE
: nama ruang, yang dapat Anda peroleh dari metodespaces.list
di Chat API, atau dari URL ruang.USER
: ID pengguna.
Di direktori kerja Anda, buat dan jalankan sampel:
python3 chat_membership_app_create.py
Menambahkan pengguna atau Google Grup ke ruang sebagai administrator Google Workspace
Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metode create()
untuk menambahkan pengguna, Grup Google, atau aplikasi Chat ke ruang mana pun di
organisasi Google Workspace Anda.
Untuk memanggil metode ini sebagai administrator Google Workspace, lakukan hal berikut:
- Panggil metode menggunakan autentikasi pengguna, dan tentukan cakupan otorisasi yang mendukung panggilan metode menggunakan hak istimewa administrator.
- Dalam permintaan Anda, tentukan parameter kueri
useAdminAccess
ketrue
.
Untuk mengetahui informasi dan contoh selengkapnya, lihat Mengelola ruang Google Chat sebagai administrator Google Workspace.
Batasan dan pertimbangan
- Dengan Autentikasi aplikasi,
aplikasi Chat dapat mengundang atau menambahkan pengguna, tetapi tidak
Grup Google atau aplikasi Chat. Untuk menambahkan dirinya sendiri, aplikasi Chat harus menggunakan
autentikasi pengguna
dengan cakupan otorisasi
chat.memberships
.
Topik terkait
- Mendapatkan detail tentang keanggotaan pengguna atau aplikasi Chat.
- Mencantumkan anggota dalam ruang.
- Perbarui keanggotaan pengguna di ruang Google Chat.
- Menghapus pengguna atau aplikasi Chat dari ruang.