Panduan ini menjelaskan cara menggunakan metode delete
pada resource Message
Google Chat API untuk menghapus pesan teks atau kartu.
Di Chat API, pesan Chat direpresentasikan oleh
Referensi Message
.
Meskipun pengguna Chat hanya dapat
mengirim pesan yang berisi teks,
Aplikasi chat dapat menggunakan banyak fitur pesan lainnya, termasuk
menampilkan antarmuka pengguna yang statis atau interaktif, mengumpulkan informasi dari
pengguna, dan mengirim
pesan secara pribadi. Untuk mempelajari fitur pesan lebih lanjut
yang tersedia untuk Chat API, lihat
Ringkasan pesan Google Chat.
Dengan autentikasi aplikasi, Anda dapat menggunakan metode ini untuk menghapus pesan yang Aplikasi Chat terkirim. Dengan autentikasi pengguna, Anda dapat dapat menggunakan metode ini untuk menghapus pesan yang dikirim pengguna yang terautentikasi. Jika pengguna adalah pengelola ruang untuk ruang tersebut, Anda juga dapat menghapus yang dikirim oleh anggota ruang lainnya. Untuk informasi selengkapnya, lihat Pelajari tentang peran Anda sebagai Pengelola Ruang.
Prasyarat
Python
- Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- 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 bernama
client_secrets.json
ke direktori lokal.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Menghapus pesan dengan autentikasi pengguna
Untuk menghapus pesan dengan autentikasi pengguna, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.messages
. - Panggil
Metode
delete
di ResourceMessage
. - Setel
name
ke nama resource pesan yang akan dihapus.
Contoh berikut menghapus pesan dengan autentikasi pengguna:
Python
- Di direktori kerja, buat file bernama
chat_message_delete_user.py
. Sertakan kode berikut di
chat_message_delete_user.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"] def main(): ''' Authenticates with Chat API via user credentials, then deletes a message. ''' # 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().delete( # The message to delete. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints response to the Chat API call. # When deleting a message, the response body is empty. print(result) if __name__ == '__main__': main()
Dalam kode, ganti kode berikut:
SPACE
: nama ruang, yang bisa Anda dapatkan dari tindakan Metodespaces.list
di Chat API, atau dari URL ruang.MESSAGE
: nama pesan, yang bisa Anda dapatkan dari isi respons yang ditampilkan setelah membuat pesan secara asinkron dengan Chat API, atau dengan nama khusus ditetapkan ke pesan pada saat pembuatan.
Dalam direktori kerja, build dan jalankan contoh:
python3 chat_message_delete_user.py
Jika berhasil, isi respons akan kosong, yang menunjukkan bahwa pesan telah dihapus.
Menghapus pesan dengan autentikasi aplikasi
Untuk menghapus pesan dengan autentikasi aplikasi, teruskan berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.bot
. - Panggil
Metode
delete
pada resourceMessage
. - Setel
name
ke nama resource pesan yang akan dihapus.
Contoh berikut menghapus pesan dengan autentikasi aplikasi:
Python
- Di direktori kerja, buat file bernama
chat_delete_message_app.py
. Sertakan kode berikut di
chat_delete_message_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Delete a Chat message. result = chat.spaces().messages().delete( # The message to delete. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE' ).execute() # Print Chat API's response in your command line interface. # When deleting a message, the response body is empty. print(result)
Dalam kode, ganti kode berikut:
SPACE
:name
ruang tempat yang diposting, yang dapat Anda peroleh dari Metodespaces.list
di Chat API, atau dari URL ruang.MESSAGE
: nama pesan, yang bisa Anda dapatkan dari isi respons yang ditampilkan setelah membuat pesan secara asinkron dengan Chat API, atau dengan nama khusus ditetapkan ke pesan pada saat pembuatan.
Dalam direktori kerja, build dan jalankan contoh:
python3 chat_delete_message_app.py
Jika berhasil, isi respons akan kosong, yang menunjukkan bahwa pesan telah dihapus.
Topik terkait
- Memformat pesan.
- Mendapatkan detail tentang pesan.
- Mencantumkan pesan dalam ruang.
- Memperbarui pesan.
- Mengirim pesan.