删除邮件

本指南介绍了如何使用 Message 资源的 delete 方法 使用 Google Chat API 删除文本或卡片消息。

通过 Message 资源 代表 文本 或 卡片 消息。您可以 在 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 授权范围。
  • 调用 delete 方法 在 Message 资源。
  • 将 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：聊天室名称，您可以从中获取 该 spaces.list 方法 或通过聊天室网址发送。
    • MESSAGE：消息名称，您可以获取 从异步创建消息后返回的响应正文中 或者通过 自定义名称 分配给消息。

  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 该消息会发布，您可以从 spaces.list 方法 或通过聊天室网址发送。
    • MESSAGE：消息名称，您可以获取 从异步创建消息后返回的响应正文中 或者通过 自定义名称 分配给消息。

  4. 在您的工作目录中，构建并运行该示例：

    python3 chat_delete_message_app.py

如果成功，响应正文为空，这表示消息 已删除。