本指南介绍了如何使用 Message
资源的 list
方法
使用 Google Chat API,查看聊天室中可过滤的分页消息列表。
在 Chat API 中,Chat 消息由
Message
资源。
Chat 用户只能发送包含文字的消息,
聊天应用可以使用许多其他即时通讯功能,包括
显示静态或交互式界面,从
以及以私密方式传递消息。详细了解消息功能
功能的详细信息,请参阅
Google Chat 消息概览。
前提条件
Python
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- 设置您的环境:
<ph type="x-smartling-placeholder">
- </ph>
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- 安装 Python Google API 客户端库。
- <ph type="x-smartling-placeholder"></ph>
为桌面应用创建 OAuth 客户端 ID 凭据。为了运行此示例中的示例,
指南中,将凭据保存为名为
client_secrets.json
的 JSON 文件, 本地目录中。
- <ph type="x-smartling-placeholder"></ph> 选择支持用户身份验证的授权范围。
列出消息
列出带有 用户身份验证, 请在请求中传递以下内容:
- 指定
chat.messages.readonly
或chat.messages
授权范围。 - 调用
list
方法 在Message
资源。
以下示例列出了在 Chat 聊天室中发送 2023 年 3 月 16 日:
Python
- 在您的工作目录中,创建一个名为
chat_messages_list.py
的文件。 在
chat_messages_list.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 lists messages in a space sent after March 16, 2023. ''' # 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().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints the list of messages. print(result) if __name__ == '__main__': main()
在代码中,将
SPACE
替换为聊天室名称, 您可以从spaces.list
方法 或通过聊天室网址发送。在您的工作目录中,构建并运行该示例:
python3 chat_messages_list.py
Chat API 会返回在指定聊天室中发送的消息列表
2023 年 3 月 16 日之后如果请求中没有任何消息,
Chat API 响应返回一个空对象。使用
REST/HTTP 接口,则响应包含一个空的 JSON 对象 {}
。