Mendapatkan detail tentang pesan

Panduan ini menjelaskan cara menggunakan metode get pada resource Message Google Chat API untuk menampilkan detail tentang pesan teks atau kartu.

Resource Message mewakili 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-oauthlib
  • Project Google Cloud dengan Google Chat API yang diaktifkan dan dikonfigurasi. Untuk mengetahui langkah-langkahnya, 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 atau chat.messages, bisa mendapatkan pesan yang dapat diakses pengguna.
    • Autentikasi aplikasi, dengan cakupan otorisasi chat.bot, dapat menerima pesan yang dikirim ke aplikasi.

Mendapatkan pesan dengan autentikasi pengguna

Untuk mendapatkan detail tentang pesan dengan autentikasi pengguna, teruskan informasi berikut dalam permintaan Anda:

  • Tentukan cakupan otorisasi chat.messages.readonly atau chat.messages.
  • Panggil metode get di resource Message.
  • Setel name ke nama resource pesan yang akan didapatkan.

Contoh berikut mendapatkan pesan berisi autentikasi pengguna:

Python

  1. Di direktori kerja Anda, buat file bernama chat_message_get_user.py.

  2. 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 created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. Dalam kode, ganti kode berikut:

    • SPACE: nama ruang, yang dapat Anda peroleh dari metode spaces.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 khusus yang ditetapkan ke pesan pada saat pembuatan.

  4. Di direktori kerja Anda, buat dan jalankan contoh:

    python3 chat_message_get_user.py

Chat API menampilkan instance Message yang menjelaskan pesan yang ditentukan.

Mendapatkan pesan dengan autentikasi aplikasi

Untuk mendapatkan detail tentang pesan dengan autentikasi aplikasi, teruskan informasi berikut dalam permintaan Anda:

  • Tentukan cakupan otorisasi chat.bot.
  • Panggil metode get di resource Message.
  • Setel name ke nama resource pesan yang akan didapatkan.

Contoh berikut menerima pesan dengan autentikasi aplikasi:

Python

  1. Di direktori kerja Anda, buat file bernama chat_get_message_app.py.

  2. 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)

  3. Dalam kode, ganti kode berikut:

    • SPACE: name ruang tempat pesan diposting, yang dapat Anda peroleh dari metode spaces.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 khusus yang ditetapkan ke pesan pada saat pembuatan.

  4. Di direktori kerja Anda, buat dan jalankan contoh:

    python3 chat_get_message_app.py

Chat API menampilkan instance Message yang menjelaskan pesan yang ditentukan.