Panduan ini menjelaskan cara menggunakan metode get
pada resource Message
di Google Chat API untuk menampilkan detail tentang pesan teks atau kartu.
Resource
Message
merepresentasikan pesan
teks
atau
kartu
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
- Python 3.6 atau yang lebih baru
- Alat pengelolaan paket pip
Library klien Google terbaru untuk Python. Untuk menginstal atau mengupdatenya, jalankan perintah berikut di antarmuka command line Anda:
pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client
Aplikasi Chat yang dipublikasikan. Untuk membuat dan memublikasikan aplikasi Chat, lihat Mem-build aplikasi Google Chat.
Otorisasi dikonfigurasi untuk aplikasi Chat. Mendapatkan pesan mendukung kedua metode autentikasi:
- Autentikasi pengguna, dengan cakupan otorisasi
chat.messages.readonly
atauchat.messages
, bisa mendapatkan pesan yang dapat diakses pengguna. - Autentikasi aplikasi, dengan cakupan otorisasi
chat.bot
, bisa mendapatkan pesan yang dikirim ke aplikasi.
- Autentikasi pengguna, dengan cakupan otorisasi
Menerima 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 menerima 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
:import os.path from google.auth.transport.requests import Request from google.oauth2.credentials import Credentials from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.errors import HttpError # 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 created membership. print(result) if __name__ == '__main__': main()
Dalam kode, ganti kode berikut:
SPACE
: nama ruang, yang dapat Anda peroleh dari metodespaces.list
di Chat API, atau dari URL ruang.MESSAGE
: nama pesan, yang dapat Anda peroleh dari isi respons yang ditampilkan setelah membuat pesan secara asinkron dengan Chat API, atau dengan nama kustom yang ditetapkan ke pesan saat pembuatan.
Di direktori kerja Anda, build dan jalankan contoh:
python3 chat_message_get_user.py
Chat API menampilkan instance
Message
yang menjelaskan pesan yang ditentukan.
Menerima 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 menerima 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 httplib2 import Http from oauth2client.service_account import ServiceAccountCredentials from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name( 'credentials.json', SCOPES) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http())) # 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 pesan diposting, yang dapat Anda peroleh dari metodespaces.list
di Chat API, atau dari URL ruang.MESSAGE
: nama pesan, yang dapat Anda peroleh dari isi respons yang ditampilkan setelah membuat pesan secara asinkron dengan Chat API, atau dengan nama kustom yang ditetapkan ke pesan saat pembuatan.
Di direktori kerja Anda, build dan jalankan contoh:
python3 chat_get_message_app.py
Chat API menampilkan instance
Message
yang menjelaskan pesan yang ditentukan.
Topik terkait
- Memformat pesan.
- Menghapus pesan.
- Mencantumkan pesan dalam ruang.
- Memperbarui pesan.
- Mengirim pesan.