Memperbarui pesan

Panduan ini menjelaskan cara menggunakan metode patch pada resource Message Google Chat API untuk memperbarui pesan teks atau kartu di ruang. Perbarui untuk mengubah atribut pesan, seperti isi pesannya, atau . Anda juga dapat menambahkan pesan teks ke pada pesan kartu, atau menambahkan kartu ke pesan teks.

Chat API juga mendukung Metode update, tetapi kami sangat menyarankan untuk memanggil Metode patch karena menggunakan permintaan HTTP PATCH saat update menggunakan Permintaan HTTP PUT. Untuk mempelajari lebih lanjut, lihat Bagian PATCH dan PUT AIP-134.

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.

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 di Google Chat API permintaan:
    • 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, lalu simpan kredensial sebagai file JSON yang bernama credentials.json.
• Pilih cakupan otorisasi berdasarkan apakah Anda ingin melakukan autentikasi sebagai pengguna atau Aplikasi Chat.

Memperbarui pesan teks, atau menambahkan awalan pesan teks ke pesan kartu, dengan autentikasi pengguna

Untuk memperbarui pesan teks dengan autentikasi pengguna, lulus hal berikut dalam permintaan Anda:

• Cakupan otorisasi chat.messages.
• name pesan yang akan diperbarui.
• updateMask='text'
• body yang menentukan pesan yang diperbarui.

Jika pesan yang diperbarui adalah pesan kartu, lalu pesan teks akan ditambahkan ke pesan kartu (yang akan terus ditampilkan).

Berikut cara memperbarui pesan teks, atau tambahkan pesan teks ke pesan kartu dengan autentikasi pengguna:

Python

1. Di direktori kerja, buat file bernama chat_update_text_message_user.py.

2. Sertakan kode berikut di chat_update_text_message_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 updates 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)
   
       # Update a Chat message.
       result = chat.spaces().messages().patch(
   
         # The message to update, and the updated message.
         #
         # 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',
         updateMask='text',
         body={'text': 'Updated message!'}
   
       ).execute()
   
       # Prints details about the updated message.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. Dalam kode, ganti kode berikut:

   • SPACE: nama ruang, yang bisa Anda dapatkan dari tindakan Metode spaces.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.

4. Dalam direktori kerja, build dan jalankan contoh:

   python3 chat_update_text_message_user.py
   

Memperbarui SMS, atau menambahkan awalan pesan teks ke pesan kartu, dengan autentikasi aplikasi

Untuk memperbarui pesan teks dengan autentikasi aplikasi, teruskan hal berikut dalam permintaan Anda:

• Cakupan otorisasi chat.bot.
• name pesan yang akan diperbarui.
• updateMask='text'
• body yang menentukan pesan yang diperbarui.

Jika pesan yang diperbarui adalah pesan kartu, lalu pesan teks akan ditambahkan ke pesan kartu (yang akan terus ditampilkan).

Berikut cara memperbarui pesan teks ke pesan teks, atau menambah pesan teks ke pesan kartu dengan autentikasi aplikasi:

Python

1. Di direktori kerja, buat file bernama chat_update_text_message_app.py.

2. Sertakan kode berikut di chat_update_text_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)
   
   # Update a Chat message.
   result = chat.spaces().messages().patch(
   
     # The message to update, and the updated message.
     #
     # 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',
     updateMask='text',
     body={'text': 'Updated message!'}
   
   ).execute()
   
   # Print Chat API's response in your command line interface.
   print(result)
   

3. Dalam kode, ganti kode berikut:

   • SPACE: nama ruang, yang bisa Anda dapatkan dari tindakan Metode spaces.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.

4. Dalam direktori kerja, build dan jalankan contoh:

   python3 chat_update_text_message_app.py
   

Memperbarui pesan kartu, atau menambahkan pesan kartu ke pesan teks

Untuk memperbarui pesan kartu, teruskan hal berikut dalam permintaan Anda:

• Cakupan otorisasi chat.bot. Memperbarui pesan kartu memerlukan autentikasi aplikasi.
• name pesan yang akan diperbarui.
• updateMask='cardsV2'
• body yang menentukan pesan yang diperbarui.

Jika pesan yang diperbarui adalah pesan teks, lalu kartu ditambahkan ke pesan teks (yang terus ditampilkan). Jika pesan terbaru itu sendiri adalah kartu, berarti kartu yang ditampilkan diperbarui.

Berikut cara memperbarui pesan menjadi pesan kartu:

Python

1. Di direktori kerja, buat file bernama chat_update_card_message.py.

2. Sertakan kode berikut di chat_update_card_message.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)
   
   # Update a Chat message.
   result = chat.spaces().messages().patch(
   
     # The message to update, and the updated message.
     #
     # 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',
     updateMask='cardsV2',
     body=
     {
       'cardsV2': [{
         'cardId': 'updateCardMessage',
         'card': {
           'header': {
             'title': 'An Updated Card Message!',
             'subtitle': 'Updated with Chat REST API',
             'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
             'imageType': 'CIRCLE'
           },
           'sections': [
             {
               'widgets': [
                 {
                   'buttonList': {
                     'buttons': [
                       {
                         'text': 'Read the docs!',
                         'onClick': {
                           'openLink': {
                             'url': 'https://developers.google.com/chat'
                           }
                         }
                       }
                     ]
                   }
                 }
               ]
             }
           ]
         }
       }]
     }
   
   ).execute()
   
   # Print Chat API's response in your command line interface.
   print(result)
   

3. Dalam kode, ganti kode berikut:

   • SPACE: nama ruang, yang bisa Anda dapatkan dari tindakan Metode spaces.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.

4. Dalam direktori kerja, build dan jalankan contoh:

   python3 chat_update_card_message.py
   

Chat API menampilkan instance Message yang merinci pesan yang diperbarui.

Memperbarui pesan dengan beberapa jalur kolom secara bersamaan

Saat pesan diperbarui, Anda dapat memperbarui beberapa jalur kolom pesan di baik. Misalnya, dalam permintaan pesan pembaruan, Anda bisa menentukan perubahan pada jalur kolom text dan cardsv2 secara bersamaan, yang memperbarui teks dan kartu pesan. Jika pesan hanya menyertakan teks tanpa kartu, maka kartu ditambahkan ke pesan. Untuk informasi selengkapnya tentang jalur kolom yang didukung, lihat Parameter updateMask.

Untuk memperbarui text dan card sebuah pesan dengan autentikasi pengguna, teruskan hal berikut dalam permintaan Anda:

• Cakupan otorisasi chat.messages.
• name pesan yang akan diperbarui.

• updateMask yang menentukan jalur kolom pesan yang akan diperbarui, dipisahkan dengan koma: updateMask='text', 'cardsV2'.

• body yang menentukan pesan yang diupdate, termasuk semua kolom yang diupdate .

Berikut adalah cara memperbarui jalur kolom text dan cardsV2 dalam kirim pesan dengan autentikasi pengguna:

Python

1. Di direktori kerja, buat file bernama chat_update_text_message_user.py.

2. Sertakan kode berikut di chat_update_text_message_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 updates 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)
   
       # Update a Chat message.
       result = chat.spaces().messages().patch(
   
         # The message to update, and the updated message.
         #
         # 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',
         updateMask='text,cardsV2',
         body=
         {'text': 'Updated message!',
               'cardsV2': [{
                 'cardId': 'updateCardMessage',
                 'card': {
                   'header': {
                     'title': 'An Updated Card Message!',
                     'subtitle': 'Updated with Chat REST API',
                     'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
                     'imageType': 'CIRCLE'
                   },
                   'sections': [
                     {
                       'widgets': [
                         {
                           'buttonList': {
                             'buttons': [
                               {
                                 'text': 'Read the docs!',
                                 'onClick': {
                                   'openLink': {
                                     'url': 'https://developers.google.com/chat'
                                   }
                                 }
                               }
                             ]
                           }
                         }
                       ]
                     }
                   ]
                 }
               }]
         }
   
       ).execute()
   
       # Prints details about the updated message.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. Dalam kode, ganti kode berikut:

   • SPACE: nama ruang, yang bisa Anda dapatkan dari tindakan Metode spaces.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.

4. Dalam direktori kerja, build dan jalankan contoh:

   python3 chat_update_text_message_user.py
   

Topik terkait

• Memformat pesan.
• Menghapus pesan.
• Mendapatkan detail tentang pesan.
• Mencantumkan pesan dalam ruang.
• Mengirim pesan.