取得訊息的詳細資料

本指南說明如何在 Google Chat API 的 Message 資源上使用 get 方法，傳回文字或資訊卡訊息的詳細資料。

Message 資源代表 Google Chat 中的文字或資訊卡訊息。您可以呼叫對應的方法，在 Google Chat API 中 create、get、update 或 delete 訊息。如要進一步瞭解文字和資訊卡訊息，請參閱「Google Chat 訊息總覽」。

必要條件

Python

  • Python 3.6 或更高版本
  • pip 套件管理工具

  • 最新的 Python 專用 Google 用戶端程式庫。如要安裝或更新，請在指令列介面中執行下列指令：

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • 已啟用並設定 Google Chat API 的 Google Cloud 專案。相關步驟請參閱「建構 Google Chat 應用程式」。

  • 已為 Chat 應用程式設定授權。取得訊息支援這兩種驗證方法：

    • 使用者驗證：若為 chat.messages.readonly 或 chat.messages 授權範圍，則可取得使用者可存取的訊息。
    • 應用程式驗證為 chat.bot 授權範圍，可以取得傳送至應用程式的訊息。

透過使用者驗證機制接收訊息

如要透過使用者驗證取得訊息的詳細資料，請在要求中傳入以下內容：

  • 指定 chat.messages.readonly 或 chat.messages 授權範圍。
  • 呼叫 Message 資源上的 get 方法。
  • 將 name 設為要取得訊息的資源名稱。

以下範例會取得含有使用者驗證的訊息：

Python

  1. 在工作目錄中，建立名為 chat_message_get_user.py 的檔案。

  2. 在 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. 在程式碼中，替換以下內容：

    • SPACE：聊天室名稱，您可以透過 Chat API 的 spaces.list 方法或聊天室網址取得。
    • MESSAGE：訊息名稱。您可以透過 Chat API 以非同步方式建立訊息後傳回的回應主體取得此名稱，或是在建立時指派給該訊息的自訂名稱。

  4. 在工作目錄中，建構並執行範例：

    python3 chat_message_get_user.py

Chat API 會傳回 Message 的執行個體，詳細說明指定訊息。

接收應用程式驗證訊息

如要透過應用程式驗證取得訊息的詳細資料，請在要求中傳入以下內容：

  • 指定 chat.bot 授權範圍。
  • 呼叫 Message 資源上的 get 方法。
  • 將 name 設為要取得訊息的資源名稱。

以下範例會取得含有應用程式驗證的訊息：

Python

  1. 在工作目錄中，建立名為 chat_get_message_app.py 的檔案。

  2. 在 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. 在程式碼中，替換以下內容：

    • SPACE：發布訊息的聊天室的 name，您可以透過 Chat API 的 spaces.list 方法或聊天室網址取得。

    • MESSAGE：訊息名稱。您可以透過 Chat API 以非同步方式建立訊息後傳回的回應主體取得此名稱，或是在建立時指派給該訊息的自訂名稱。

  4. 在工作目錄中，建構並執行範例：

    python3 chat_get_message_app.py

Chat API 會傳回 Message 的執行個體，詳細說明指定訊息。