刪除留言

本指南說明如何在 Google Chat API 的 Message 資源上使用 delete 方法，刪除文字或資訊卡訊息。

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-auth
  • 已啟用並設定 Google Chat API 的 Google Cloud 專案。如需詳細步驟，請參閱「建構 Google Chat 應用程式」。

  • 已為 Chat 應用程式設定授權。刪除訊息時，您可以選用以下兩種驗證方法：

    • 具有 chat.messages 授權範圍的使用者驗證可刪除該使用者建立的訊息。如果你是聊天室管理員，或許可以刪除其他訊息。詳情請參閱「瞭解聊天室管理員角色」。
    • 應用程式驗證具有 chat.bot 授權範圍，能夠刪除該應用程式使用服務帳戶建立的訊息。

刪除具備使用者驗證機制的訊息

如要刪除具有使用者驗證的訊息，請在要求中傳遞以下內容：

  • 指定 chat.messages 授權範圍。
  • 呼叫 Message 資源上的 delete 方法。
  • 將 name 設為要刪除的訊息的資源名稱。

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

Python

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

  2. 在 chat_message_delete_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 deletes 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().delete(

        # The message to delete.
        #
        # 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 response to the Chat API call.
    # When deleting a message, the response body is empty.
    print(result)

if __name__ == '__main__':
    main()

  3. 請在程式碼中替換下列內容：

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

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

    python3 chat_message_delete_user.py

如果成功，回應主體會是空白的，表示訊息已遭刪除。

刪除提供應用程式驗證機制的訊息

如要刪除含有應用程式驗證的訊息，請在要求中傳遞以下內容：

以下範例刪除含有應用程式驗證的訊息：

Python

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

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

# Delete a Chat message.
result = chat.spaces().messages().delete(

  # The message to delete.
  #
  # 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.
# When deleting a message, the response body is empty.
print(result)

  3. 請在程式碼中替換下列內容：

    • SPACE：訊息張貼所在的聊天室 name，您可以從 Chat API 的 spaces.list 方法或聊天室網址取得。
    • MESSAGE：訊息名稱。使用 Chat API 以非同步方式建立訊息後，可以從回應主體取得的訊息名稱，或使用在建立訊息時指派給訊息的自訂名稱。

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

    python3 chat_delete_message_app.py

如果成功，回應主體會是空白的，表示訊息已遭刪除。