此页面由 Cloud Translation API 翻译。

Python 快速入门

创建一个向 Google Chat API 发出请求的 Python 命令行应用。

快速入门介绍了如何设置和运行调用 Google Workspace API 的应用。本快速入门使用一种简化的身份验证方法，该方法适用于测试环境。对于生产环境，我们建议您先了解身份验证和授权，然后再选择适合您应用的访问凭据。

本快速入门使用 Google Workspace 推荐的 API 客户端库来处理身份验证和授权流程的一些细节。

目标

设置环境。
安装客户端库。
设置示例。
运行示例。

前提条件

如需运行本快速入门，您需要满足以下前提条件：

Python 3.10.7 或更高版本
pip 软件包管理工具
Google Cloud 项目。

拥有可访问 Google Chat 的 Google Workspace 商务版或企业版账号。

设置环境

如需完成本快速入门，请设置您的环境。

启用 API

在使用 Google API 之前，您需要在 Google Cloud 项目中将其开启。您可以在单个 Google Cloud 项目中启用一个或多个 API。

在 Google Cloud 控制台中，启用 Google Chat API。

启用 API

配置 OAuth 权限请求页面

如果您要使用新的 Google Cloud 项目完成本快速入门，请配置 OAuth 同意屏幕。如果您已为 Cloud 项目完成此步骤，请跳至下一部分。

在 Google Cloud 控制台中，依次前往菜单 > Google Auth platform > 品牌推广。
前往“品牌推广”
如果您已配置 Google Auth platform，则可以在品牌、受众群体和数据访问中配置以下 OAuth 权限请求页面设置。如果您看到一条消息，指出Google Auth platform 尚未配置，请点击开始：

在应用信息下，在应用名称中输入应用的名称。
在用户支持电子邮件中，选择一个支持电子邮件地址，以便用户在对自己的同意情况有疑问时与您联系。
点击下一步。
在受众群体下，选择内部。
点击下一步。
在联系信息下，输入一个电子邮件地址，以便您接收有关项目变更的通知。
点击下一步。
在完成部分，查看 Google API 服务用户数据政策，如果您同意该政策，请选择我同意《Google API 服务：用户数据政策》。
点击继续。
点击创建。

目前，您可以跳过添加范围的步骤。未来，如果您创建的应用供 Google Workspace 组织以外的用户使用，则必须将用户类型更改为外部。然后，添加应用所需的授权范围。如需了解详情，请参阅完整的配置 OAuth 同意指南。

为桌面应用授权凭据

如需对最终用户进行身份验证并访问应用中的用户数据，您需要创建一个或多个 OAuth 2.0 客户端 ID。客户端 ID 用于向 Google 的 OAuth 服务器标识单个应用。如果您的应用在多个平台上运行，您必须为每个平台分别创建客户端 ID。

在 Google Cloud 控制台中，依次前往“菜单”图标 > Google Auth platform > 客户端。
前往“客户”页面
点击创建客户端。
依次点击应用类型 > 桌面应用。
在名称字段中，输入凭据的名称。此名称仅在 Google Cloud 控制台中显示。
点击创建。
新创建的凭据会显示在“OAuth 2.0 客户端 ID”下。
将下载的 JSON 文件另存为 credentials.json，然后将该文件移动到您的工作目录。

配置 Google Chat 应用

如需调用 Google Chat API，您必须配置 Google Chat 应用。对于任何写入请求，Google Chat 都会使用以下信息在界面中归因 Google Chat 应用。

在 Google Cloud 控制台中，前往 Chat API 配置页面：

前往“Chat API 配置”页面
在应用信息下，输入以下信息：
1. 在应用名称字段中，输入 Chat API quickstart app。
2. 在头像网址字段中，输入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
3. 在说明字段中，输入 Quickstart for calling the Chat API。
在互动功能下，点击启用互动功能切换开关，将其切换到关闭位置，以停用 Chat 应用的互动功能。
点击保存。

安装 Google 客户端库

安装 Python 版 Google 客户端库：

pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib

配置示例

在工作目录中，创建一个名为 quickstart.py 的文件。

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

chat/quickstart/quickstart.py

在 GitHub 上查看

from __future__ import print_function

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from google.apps import chat_v1 as google_chat


# If modifying these scopes, delete the file token.json.
SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']


def main():
    """Shows basic usage of the Google Chat API.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.json', 'w') as token:
            token.write(creds.to_json())

    try:
        # Create a client
        client = google_chat.ChatServiceClient(
            credentials = creds,
            client_options = {
                "scopes" : SCOPES
            }
        )

        # Initialize request argument(s)
        request = google_chat.ListSpacesRequest(
            # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
            filter = 'space_type = "SPACE"'
        )

        # Make the request
        page_result = client.list_spaces(request)

        # Handle the response. Iterating over page_result will yield results and
        # resolve additional pages automatically.
        for response in page_result:
            print(response)
    except Exception as error:
        # TODO(developer) - Handle errors from Chat API.
        print(f'An error occurred: {error}')


if __name__ == '__main__':
    main()

运行示例

在工作目录中，构建并运行示例：
```
python3 quickstart.py
```

首次运行该示例时，系统会提示您授权访问：
1. 如果您尚未登录 Google 账号，请在系统提示时登录。如果您登录了多个账号，请选择一个账号用于授权。
2. 点击接受。
您的 Python 应用运行并调用 Google Chat API。

授权信息存储在文件系统中，因此下次运行示例代码时，系统不会提示您进行授权。

后续步骤

在 API 探索器中试用 Google Workspace API

客户端库文档

Python 快速入门 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

目标