Panduan ini menjelaskan cara menggunakan metode list
pada resource Message
Google Chat API untuk melihat daftar pesan yang diberi nomor halaman dan dapat difilter dalam ruang.
Tujuan
Referensi Message
mewakili
teks
atau
kartu
untuk mengirim pesan di Google Chat. Anda dapat
create
, get
, update
, atau delete
pesan di Google Chat API dengan memanggil
metode yang sesuai. Untuk mempelajari pesan teks dan kartu lebih lanjut, lihat
Ringkasan pesan Google Chat.
Prasyarat
Python
- Sebuah Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- Python 3.6 atau yang lebih baru
- Alat pengelolaan paket pip
- Library klien Google terbaru. Untuk menginstal atau memperbaruinya,
jalankan perintah berikut di antarmuka command line Anda:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Menyiapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
-
Membuat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan
sampel dalam
panduan, simpan kredensial sebagai file JSON (
client_secrets.json
) ke direktori lokal.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Mencantumkan pesan
Untuk melihat daftar pesan dengan autentikasi pengguna, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.messages.readonly
atauchat.messages
. - Panggil
Metode
list
di ResourceMessage
.
Contoh berikut mencantumkan pesan di ruang Chat yang dikirim setelah 16 Maret 2023:
Python
- Di direktori kerja, buat file bernama
chat_messages_list.py
. Sertakan kode berikut di
chat_messages_list.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists messages in a space sent after March 16, 2023. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().messages().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints the list of messages. print(result) if __name__ == '__main__': main()
Dalam kode, ganti
SPACE
dengan nama ruang, yang yang dapat diperoleh dari Metodespaces.list
di Chat API, atau dari URL ruang.Dalam direktori kerja, build dan jalankan contoh:
python3 chat_messages_list.py
Chat API menampilkan daftar pesan yang dikirim di ruang yang ditentukan
setelah 16 Maret 2023. Jika tidak ada pesan dari permintaan,
Respons Chat API menampilkan objek kosong. Saat menggunakan
Antarmuka REST/HTTP, responsnya berisi objek JSON kosong, {}
.
Topik terkait
- Memformat pesan.
- Menghapus pesan.
- Mendapatkan detail tentang pesan.
- Memperbarui pesan.
- Mengirim pesan.