本指南将介绍如何使用
get()
方法(针对 Google Chat API 的 Message
资源),以返回有关
短信或卡片消息
在 Chat API 中,Chat 消息由 Message
资源表示。Chat 用户只能发送包含文字的消息,
聊天应用可以使用许多其他即时通讯功能,包括
显示静态或交互式界面,从
以及以私密方式传递消息。详细了解消息功能
功能的详细信息,请参阅
Google Chat 消息概览。
前提条件
Node.js
- 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- 安装 Node.js Cloud 客户端库。
- 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请按以下步骤操作:
创建 OAuth 客户端 ID
凭据,然后将凭据保存为名为
client_secrets.json
复制到您的本地目录。 - 如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据,并将凭据保存为名为
credentials.json
的 JSON 文件。
- 如需以 Chat 用户身份进行身份验证,请按以下步骤操作:
创建 OAuth 客户端 ID
凭据,然后将凭据保存为名为
- <ph type="x-smartling-placeholder"></ph> 选择授权范围取决于您是想以用户身份还是 Chat 应用。
- 一个 Google Chat 聊天室,其中经过身份验证的用户或 呼叫 Chat 应用是成员。如需以 Chat 应用的身份进行身份验证,请将 Chat 应用添加到聊天室。
Python
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 安装 Python Cloud 客户端库。
- 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
client_secrets.json
的 JSON 文件,保存到本地目录中。 - 如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据,并将凭据保存为名为
credentials.json
的 JSON 文件。
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
- 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证,选择授权范围。
- 已通过身份验证的用户或发起调用的 Chat 应用所属的 Google Chat 聊天室。如需以 Chat 应用的身份进行身份验证,请将 Chat 应用添加到聊天室。
Java
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 安装 Java Cloud 客户端库。
- 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请按以下步骤操作:
创建 OAuth 客户端 ID
凭据,然后将凭据保存为名为
client_secrets.json
复制到您的本地目录。 - 如需以 Chat 应用的身份进行身份验证,请执行以下操作:
创建服务账号
凭据,然后将凭据保存为名为
credentials.json
。
- 如需以 Chat 用户身份进行身份验证,请按以下步骤操作:
创建 OAuth 客户端 ID
凭据,然后将凭据保存为名为
- <ph type="x-smartling-placeholder"></ph> 选择授权范围取决于您是想以用户身份还是 Chat 应用。
- 一个 Google Chat 聊天室,其中经过身份验证的用户或 呼叫 Chat 应用是成员。要以 聊天应用,请添加 Chat 扩展应用。
Apps 脚本
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 创建一个独立的 Apps 脚本项目,然后开启高级聊天服务。
- 在本指南中,您必须使用用户身份验证或应用身份验证。如需以 Chat 应用的身份进行身份验证,请创建 服务账号凭据。如需了解具体步骤,请参阅以 Google Chat 应用身份进行身份验证和授权。
- 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证,选择授权范围。
- 一个 Google Chat 聊天室,其中经过身份验证的用户或 呼叫 Chat 应用是成员。如需以 Chat 应用的身份进行身份验证,请将 Chat 应用添加到聊天室。
<ph type="x-smartling-placeholder">
获取包含用户身份验证信息的消息
使用 用户身份验证, 请在请求中传递以下内容:
- 指定
chat.messages.readonly
或chat.messages
授权范围。 - 调用
GetMessage()
方法。 - 将
name
设置为要获取的消息的资源名称。
以下示例使用 用户身份验证:
Node.js
Python
Java
Apps 脚本
如需运行此示例,请替换以下内容:
SPACE_NAME
:聊天室的 IDname
。 可通过调用ListSpaces()
方法或聊天室的网址来执行此操作。MESSAGE_NAME
:消息的 IDname
。 您可以在创建 与 Chat API 异步发送消息,或使用 自定义名称 分配给消息。
Chat API 会返回一个 Message
实例,其中详细说明了指定消息。
获取包含应用身份验证信息的消息
使用 应用身份验证, 请在请求中传递以下内容:
- 指定
chat.bot
授权范围。 - 调用
GetMessage()
方法。 - 将
name
设置为要获取的消息的资源名称。
以下示例使用 应用身份验证:
Node.js
Python
Java
Apps 脚本
如需运行此示例,请替换以下内容:
SPACE_NAME
:聊天室的 IDname
。 您可以通过调用ListSpaces()
方法或从聊天室的网址中获取 ID。MESSAGE_NAME
:消息的name
中的 ID。您可以通过以下方式获取 ID:使用 Chat API 异步创建消息后返回的响应正文,或者使用在创建消息时分配给消息的自定义名称。
Chat API 会返回一个 Message
实例,其中详细说明了指定消息。