Panduan ini menjelaskan cara menggunakan metode get
pada resource Message
Google Chat API untuk menampilkan detail pesan teks atau kartu.
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.
- Buat kredensial akses berdasarkan cara Anda ingin melakukan autentikasi dalam permintaan Google Chat API:
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat client ID OAuth
kredensial, lalu simpan kredensial sebagai file JSON yang bernama
client_secrets.json
ke direktori lokal Anda. - Untuk melakukan autentikasi sebagai aplikasi Chat, buat akun layanan kredensial.
- Untuk melakukan autentikasi sebagai pengguna Chat,
buat client ID OAuth
kredensial, lalu simpan kredensial sebagai file JSON yang bernama
- Pilih cakupan otorisasi berdasarkan apakah Anda ingin melakukan autentikasi sebagai pengguna atau Aplikasi Chat.
Mendapatkan pesan dengan autentikasi pengguna
Untuk mendapatkan detail tentang pesan dengan autentikasi pengguna, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.messages.readonly
atauchat.messages
. - Panggil
Metode
get
di ResourceMessage
. - Setel
name
ke nama resource pesan yang akan didapatkan.
Contoh berikut mendapatkan pesan dengan autentikasi pengguna:
Python
- Di direktori kerja, buat file bernama
chat_message_get_user.py
. Sertakan kode berikut di
chat_message_get_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.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets 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().get( # The message to get. # # 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 details about the message. 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_get_user.py
Chat API menampilkan instance
Message
yang merinci pesan tertentu.
Mendapatkan pesan dengan autentikasi aplikasi
Untuk mendapatkan detail tentang pesan dengan autentikasi aplikasi, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.bot
. - Panggil
Metode
get
di ResourceMessage
. - Setel
name
ke nama resource pesan yang akan didapatkan.
Contoh berikut mendapatkan pesan dengan autentikasi aplikasi:
Python
- Di direktori kerja, buat file bernama
chat_get_message_app.py
. Sertakan kode berikut di
chat_get_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) # Get a Chat message. result = chat.spaces().messages().get( # The message to get. # # 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. 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_get_message_app.py
Chat API menampilkan instance
Message
yang merinci pesan tertentu.
Topik terkait
- Memformat pesan.
- Menghapus pesan.
- Mencantumkan pesan dalam ruang.
- Memperbarui pesan.
- Mengirim pesan.