此页面由 Cloud Translation API 翻译。

使用 Google Chat API 发送消息

本指南介绍如何调用 Google Chat API 的 messages.create() 方法执行以下任何操作：

发送包含文本、卡片和互动微件的消息。
向特定 Chat 用户私下发送消息。
发起或回复消息串。
为消息命名，以便在其他 Chat API 中指定请求。

除了调用 messages.create() 方法之外，Chat 扩展应用可以创建和发送消息来回复用户互动，如发布用户在将 Chat 应用添加到空间。在响应互动时，Chat 扩展应用可以使用消息功能的类型，包括互动对话框和链接预览界面。为了回复用户，Chat 应用会返回无需调用 Chat API 即可同步处理消息。学习内容有关如何发送消息来响应互动的信息，请参阅在 Google Chat 应用中接收和回复互动信息。

Chat 如何显示和归因使用 Chat API 创建的消息

您可以使用以下代码调用 messages.create() 方法：应用身份验证和用户身份验证。 Chat 对消息发送者的界定有所不同具体取决于您使用的身份验证类型。

以 Chat 应用的身份进行身份验证时， Chat 应用发送消息。

使用应用身份验证调用 messages.create() 方法。 — **图 1**：通过应用身份验证，Chat 应用消息内容。为表明发送者不是真人，Chat 会在其名称旁边显示 `App`。

您作为用户进行身份验证后，Chat 应用会将。Chat 还会将 Chat 应用通过显示消息名称来发送消息

使用用户身份验证调用 messages.create() 方法。 — **图 2**：通过用户身份验证，用户发送消息，Chat 会显示聊天应用名称。

身份验证类型还决定了哪些消息传递功能和界面您可以包含在消息中的名称借助应用身份验证聊天应用可以发送包含富文本、基于卡片的界面和交互式小部件。由于 Chat 用户只能在消息中发送短信，因此您可以使用用户身份验证创建邮件时仅包含文本。详细了解消息功能功能的详细信息，请参阅 Google Chat 消息概览。

本指南介绍了如何使用这两种身份验证类型来发送邮件使用 Chat API。

前提条件

Python

Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号： Google Chat。

Python 3.6 或更高版本
pip 软件包管理工具
最新的 Google 客户端库。若要安装或更新这些应用在命令行界面中运行以下命令：
```
pip3 install --upgrade google-api-python-client google-auth-oauthlib
```

设置您的环境： <ph type="x-smartling-placeholder">
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API，指定一个名称，图标和说明。
- 根据您希望在 Google Chat API 中进行身份验证的方式创建访问凭据请求： <ph type="x-smartling-placeholder">
  - 如需以 Chat 用户身份进行身份验证，请按以下步骤操作：创建 OAuth 客户端 ID 凭据，然后将凭据保存为名为 client_secrets.json 复制到您的本地目录。
  - 如需以 Chat 应用的身份进行身份验证，请执行以下操作：创建服务账号凭据，然后将凭据保存为名为 credentials.json。
<ph type="x-smartling-placeholder"></ph> 选择授权范围取决于您是想以用户身份还是 Chat 应用。

一个 Google Chat 聊天室，其中经过身份验证的用户或呼叫 Chat 应用是成员。要以聊天应用，请添加 Chat 扩展应用。

代表用户发送短信

本部分介绍了如何使用用户身份验证。借助用户身份验证，邮件内容只能包含文本并且必须省略仅适用于聊天应用，包括卡片界面和交互式微件。

通过用户身份验证发送消息 — **图 3.** Chat 应用可通过以下应用发送短信：。

若要使用用户身份验证调用 messages.create()，您必须指定以下字段：

授权范围此方法支持用户身份验证。以下示例使用 chat.messages.create 范围。
Space资源。通过身份验证的用户必须是空间。
Message 要创建的资源。要定义消息的内容，您必须在代码中添加 text 字段。

您还可以选择添加以下内容：

messageId 字段，可让您为消息命名以便在其他 API 请求中使用。
thread.threadKey 和 messageReplyOption 字段发起或回复讨论帖。如果聊天室没有使用线程处理，系统会忽略此字段。

如需代表用户发送短信，请按以下步骤操作：

Python

在您的工作目录中，创建一个名为 chat_create_message_user.py。

在 chat_create_message_user.py 中添加以下代码：

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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.create"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then creates a text message in a Chat space.
    '''

    # Start with no credentials.
    creds = None

    # 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().create(

        # The space to create the message in.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE',

        # Optional. Sets custom ID for the message to use in other requests.
        messageId='client-myfirstusermessage',

        # The text message to create.
        body={
          'text': '👋 🌎Hello world! Text messages can contain things like:\n\n'

          + '* Hyperlinks 🔗\n'
          + '* Emojis 😄🎉\n'
          + '* Mentions of other Chat users `@` \n\n'

          'For details, see the <https://developers.google.com/workspace/chat/format-messages|Chat API developer documentation>.'
      }

    ).execute()

    # Prints details about the created message.
    print(result)

if __name__ == '__main__':
    main()

将 SPACE 替换为聊天室的 ID name 字段。可通过调用 spaces.list() 方法或者通过聊天室网址添加

在您的工作目录中，构建并运行该示例：
```
python3 chat_create_message_user.py
```
如果系统提示您提供网址，请打开该网址以授权 Chat 扩展应用。请求。

Chat 应用创建消息，经过身份验证的用户用户在聊天室中发布消息。在命令行界面中， Chat API 会返回新 Message 资源。

以 Chat 应用的身份发送消息

本部分介绍如何发送包含文本、卡片和交互式配件微件应用身份验证。

通过应用身份验证发送消息 — **图 4.** Chat 应用会向以下应用发送消息：卡片和一个配件按钮

若要使用应用身份验证调用 messages.create()，您必须指定以下字段：

chat.bot 授权范围。
Space资源。Chat 应用必须聊天室成员。
Message 要创建的资源要定义消息的内容，您可以在富文本 (text), 一个或多个卡片接口 (cardsV2), 或者两者兼有

您还可以选择添加以下内容：

要包含的 accessoryWidgets 字段邮件底部的互动按钮。
privateMessageViewer 字段向指定用户以私密方式发送消息。
messageId 字段，可让您为消息命名以便在其他 API 请求中使用。
thread.threadKey 和 messageReplyOption 字段发起或回复讨论帖。如果聊天室没有使用线程处理，系统会忽略此字段。

邮件（包括任何文字或卡片）的大小上限为 32,000 字节。如要发送超出此大小的消息，您的 Chat 扩展应用必须改为发送多条消息。

如要发送通过 Chat 应用发布且包含以下内容的消息：邮件底部还有一张卡片和一个可点击的按钮请按以下步骤操作：

Python

在您的工作目录中，创建一个名为 chat_create_message_app.py。

在 chat_create_message_app.py 中添加以下代码：

from apiclient.discovery import build
from google.oauth2 import service_account

# 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', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Specify the Chat space where the message is posted. Obtain the ID
# from the resource name, or from the space's URL.
SPACE = 'spaces/SPACE'

# Create a Chat message.
result = chat.spaces().messages().create(

    # The Chat space.
    parent=SPACE,

    # Optional. Sets custom ID for the message to use in other requests.
    messageId='client-myfirstappmessage',

    # The message to create with text, a card, and a button at the
    # bottom of the message.
    body=
    {
      'text': '👋 🌎Hello world! I created this message by calling the Chat API\'s `messages.create()` method.',
      'cardsV2': [{
        'cardId': 'myCardId',
        'card': {
          'header': {
            'title': 'About this message',
            'imageUrl': 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg',
            'imageType': 'CIRCLE'
          },
        "sections": [
            {
            "header": "Contents",
            "widgets": [
                {
                "textParagraph": {
                    "text": "🔡 <b>Text</b> which can include hyperlinks 🔗, emojis 😄🎉, and @mentions 🗣️."
                }},
                {
                "textParagraph": {
                    "text": "🖼️ A <b>card</b> to display visual elements and request information such as text 🔤, dates and times 📅, and selections ☑️."
                }},
                {
                "textParagraph": {
                    "text": "👉🔘 An <b>accessory widget</b> which adds a button to the bottom of a message."
                }},
              ]
            },
            {
            "header": "What's next",
            "collapsible": True,
            "widgets": [
                {
                "textParagraph": {
                    "text": "❤️ <a href='https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions/create'>Add a reaction</a>."
                }},
                {
                "textParagraph": {
                    "text": "🔄 <a href='https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/patch'>Update</a> or ❌ <a href='https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/delete'>delete</a> the message."
                }},
                {
                "textParagraph": {
                    "text": '💡 <b>Pro tip</b>: To specify the message in other API requests, use its custom name: <i>' + SPACE + '/messages/client-myfirstappmessage</i>.'
                }}
              ]
            }
          ]}
      }],
      "accessoryWidgets":
      [
          {
              "buttonList":
              {
                  "buttons":
                  [
                      {
                          "text": "View documentation",
                          "altText": "Opens a new browser tab and navigates to the Google Chat developer documentation website.",
                          "icon":
                          {
                              "material_icon":
                              {
                                  "name": "link"
                              }
                          },
                          "onClick":
                          {
                              "openLink":
                              {
                                  "url": "https://developers.google.com/workspace/chat/create-messages"
                              }
                          }
                      }
                  ]
              }
          }
      ]
    }

).execute()

print(result)

将 SPACE 替换为聊天室的 ID name 字段。可通过调用 spaces.list() 方法或者通过聊天室网址添加

在您的工作目录中，构建并运行该示例：
```
python3 chat_create_message_app.py
```

Chat 应用会创建消息并在空间。在您的命令行界面中，Chat API 会返回使用 Message 资源。

在邮件底部添加互动微件

在上一部分中的代码示例中， Chat 应用消息在称为配件微件。配件微件。您可以使用这些微件用户可通过多种方式与您的消息互动，包括：

对消息的准确性或满意度进行评分。
报告消息或 Chat 应用存在的问题。
打开指向相关内容（例如文档）的链接。
在 Chat 应用中关闭或延后类似消息特定时间段内的效果

如需添加配件微件，请添加 accessoryWidgets[] 字段，然后指定所需的一个或多个微件。

下图显示了将包含配件微件的短信，以便用户对自己的体验进行评分使用 Chat 应用。

下面显示了使用两个配件按钮。当用户点击某个按钮时，函数（例如 doUpvote）处理交互：


 "text": "Rate your experience with this Chat app.",
 "accessoryWidgets": [
   {
     "buttonList": {
       "buttons": [
         {
           "icon": {
             "material_icon": {
               "name": "thumb_up"
             }
           },
           "color": {
             "red": 0,
             "blue": 255,
             "green": 0
           },
           "onClick": {
             "action": {
               "function": "doUpvote",
             }
           }
         },
         {
           "icon": {
             "material_icon": {
               "name": "thumb_down"
             }
           },
           "color": {
             "red": 0,
             "blue": 255,
             "green": 0
           },
           "onClick": {
             "action": {
               "function": "doDownvote",
             }
           }
         }
       ]
     }
   }
 ]

私下发送消息

聊天应用可以私下发送消息消息仅对聊天室中的特定用户可见。当聊天应用会发送一条私信会显示一个标签，通知用户相应邮件仅对他们可见。

要使用 Chat API 以私密方式发送消息，请指定 privateMessageViewer 字段。要指定用户，请将值设置为 User 资源，代表 Chat 用户。您还可以使用 name 字段的 User 资源，如以下示例所示：

{
    "text": "Hello private world!",
    "privateMessageViewer": {
      "name": "users/USER_ID"
    }
}

替换 USER_ID 用户的唯一 ID，例如 12345678987654321 或 hao@cymbalgroup.com。如需详细了解如何指定用户，请参阅识别并指定 Google Chat 用户。

要以私密方式发送消息，您必须在请求中省略以下内容：

附件
配件微件

在消息串中发起或回复消息

对于使用话题的聊天室：您可以指定新消息是发起会话还是回复现有线程

默认情况下，您使用 Chat API 创建的消息会发起新的线程。为方便识别该会话并稍后回复，您可以指定一个线程键：

在请求正文中，指定 thread.threadKey 字段。
指定查询参数 messageReplyOption 以确定如果该键已存在会发生什么情况。

如需创建回复现有会话的消息，请执行以下操作：

在您的请求正文中，添加 thread 字段。如果已设置，您可以指定 threadKey 创建的所有文件否则，您必须使用 name 线程。
指定查询参数 messageReplyOption。

以下 JSON 显示了文本消息的请求正文示例，使用键 helloWorldThread 发起或回复会话：

   {
     'thread': {
      'threadKey': 'helloWorldThread',
     },
     'text': '👋 🌎Hello world!'
   }

为消息命名

如需在将来的 API 调用中检索或指定消息，您可以为消息命名方法是在 messages.create() 请求中设置 messageId 字段。通过为消息命名，您可以指定消息，而无需存储消息的资源名称中系统分配的 ID（以 name 字段）。

例如，如需使用 get() 方法检索消息，您可以使用资源名称指定要检索的消息。资源名称为格式为 spaces/{space}/messages/{message}，其中 {message} 表示系统分配的 ID 或您在创建消息。

要命名消息，请在 messageId 字段。messageId 字段用于设置 clientAssignedMessageId Message 资源的指定字段。

您只能在创建消息时为其命名。您不能命名或修改现有消息的自定义 ID。自定义 ID 必须符合以下要求要求：

以 client- 开头。例如，client-custom-name 是有效的自定义但 custom-name 不是。
最多包含 63 个字符，且只能包含小写字母、数字和连字符。
在聊天室中是唯一的。Chat 应用无法使用为不同的消息使用相同的自定义 ID。

问题排查

当 Google Chat 应用或 card 会返回错误，聊天界面会显示一条内容为“出了点问题”的消息。或“无法处理您的请求”。有时，Chat 界面不会显示任何错误消息，但 Chat 应用或卡片会产生意外结果；例如，卡片消息。

虽然 Chat 界面中可能不会显示错误消息，提供描述性错误消息和日志数据，以帮助您修正错误启用 Chat 应用的错误日志记录时。如需观看方面的帮助，请参阅排查并修正 Google Chat 错误。

使用 Google Chat API 发送消息

Chat 如何显示和归因使用 Chat API 创建的消息

前提条件

Python

代表用户发送短信

Python

以 Chat 应用的身份发送消息

Python

在邮件底部添加互动微件

私下发送消息

在消息串中发起或回复消息

为消息命名

问题排查

相关主题