Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Tạo một ứng dụng dòng lệnh Python đưa ra yêu cầu đến Google Chat API.
Hướng dẫn bắt đầu nhanh giải thích cách thiết lập và chạy một ứng dụng gọi một API Google Workspace. Hướng dẫn bắt đầu nhanh này sử dụng phương pháp xác thực đơn giản phù hợp với môi trường kiểm thử. Đối với môi trường phát hành công khai, bạn nên tìm hiểu về xác thực và uỷ quyền trước khi chọn thông tin đăng nhập để truy cập phù hợp với ứng dụng của bạn.
Hướng dẫn bắt đầu nhanh này sử dụng các thư viện ứng dụng API được đề xuất của Google Workspace để xử lý một số thông tin chi tiết về quy trình xác thực và uỷ quyền.
Mục tiêu
Thiết lập môi trường.
Cài đặt thư viện ứng dụng.
Thiết lập mẫu.
Chạy mẫu.
Điều kiện tiên quyết
Để chạy hướng dẫn bắt đầu nhanh này, bạn cần có các điều kiện tiên quyết sau:
Nếu bạn đang sử dụng một dự án mới trên Google Cloud để hoàn tất hướng dẫn bắt đầu nhanh này, hãy định cấu hình màn hình đồng ý OAuth. Nếu bạn đã hoàn tất bước này cho dự án trên Cloud, hãy chuyển sang phần tiếp theo.
Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn menu>>Thương hiệu.
Nếu đã định cấu hình , bạn có thể định cấu hình các chế độ cài đặt sau đây cho Màn hình đồng ý OAuth trong phần Thương hiệu, Đối tượng và Quyền truy cập vào dữ liệu. Nếu bạn thấy thông báo chưa được định cấu hình, hãy nhấp vào Bắt đầu:
Trong phần Thông tin về ứng dụng, hãy nhập tên cho ứng dụng trong mục Tên ứng dụng.
Trong phần Email hỗ trợ người dùng, hãy chọn một địa chỉ email hỗ trợ mà người dùng có thể liên hệ với bạn nếu họ có thắc mắc về sự đồng ý của mình.
Nhấp vào Tiếp theo.
Trong phần Đối tượng người xem, hãy chọn Nội bộ.
Nhấp vào Tiếp theo.
Trong phần Thông tin liên hệ, hãy nhập Địa chỉ email để bạn có thể nhận thông báo về mọi thay đổi đối với dự án của mình.
Hiện tại, bạn có thể bỏ qua bước thêm phạm vi. Trong tương lai, khi tạo một ứng dụng để sử dụng bên ngoài tổ chức Google Workspace, bạn phải thay đổi Loại người dùng thành Bên ngoài. Sau đó, hãy thêm các phạm vi uỷ quyền mà ứng dụng của bạn yêu cầu. Để tìm hiểu thêm, hãy xem hướng dẫn đầy đủ về cách Định cấu hình sự đồng ý của OAuth.
Uỷ quyền thông tin đăng nhập cho một ứng dụng máy tính
Để xác thực người dùng cuối và truy cập vào dữ liệu người dùng trong ứng dụng của mình, bạn cần tạo một hoặc nhiều Mã ứng dụng OAuth 2.0. Mã ứng dụng khách được dùng để xác định một ứng dụng duy nhất cho các máy chủ OAuth của Google. Nếu ứng dụng của bạn chạy trên nhiều nền tảng, bạn phải tạo một mã nhận dạng ứng dụng riêng cho mỗi nền tảng.
Trong bảng điều khiển Google Cloud, hãy chuyển đến phần Trình đơn menu>>Ứng dụng.
Nhấp vào Loại ứng dụng>Ứng dụng dành cho máy tính.
Trong trường Name (Tên), hãy nhập tên cho thông tin đăng nhập. Tên này chỉ xuất hiện trong Google Cloud Console.
Nhấp vào Tạo.
Thông tin xác thực mới tạo sẽ xuất hiện trong phần "Mã ứng dụng OAuth 2.0".
Lưu tệp JSON đã tải xuống dưới dạng credentials.json rồi di chuyển tệp đó vào thư mục làm việc của bạn.
Định cấu hình ứng dụng Google Chat
Để gọi Google Chat API, bạn phải định cấu hình một ứng dụng Google Chat. Đối với mọi yêu cầu ghi, Google Chat sẽ phân bổ ứng dụng Google Chat trong giao diện người dùng bằng cách sử dụng thông tin sau.
Trong Google Cloud Console, hãy chuyển đến trang Configuration (Cấu hình) của Chat API:
Trong phần Thông tin về ứng dụng, hãy nhập những thông tin sau:
Trong trường Tên ứng dụng, hãy nhập Chat API quickstart app.
Trong trường URL hình đại diện, hãy nhập https://developers.google.com/chat/images/quickstart-app-avatar.png.
Trong trường Description (Nội dung mô tả), hãy nhập Quickstart for calling the Chat API.
Trong phần Tính năng tương tác, hãy nhấp vào nút bật/tắt Bật tính năng tương tác để chuyển sang trạng thái tắt nhằm vô hiệu hoá các tính năng tương tác cho ứng dụng Chat.
from__future__importprint_functionimportos.pathfromgoogle.auth.transport.requestsimportRequestfromgoogle.oauth2.credentialsimportCredentialsfromgoogle_auth_oauthlib.flowimportInstalledAppFlowfromgoogle.appsimportchat_v1asgoogle_chat# If modifying these scopes, delete the file token.json.SCOPES=['https://www.googleapis.com/auth/chat.spaces.readonly']defmain():"""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.ifos.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.ifnotcredsornotcreds.valid:ifcredsandcreds.expiredandcreds.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 runwithopen('token.json','w')astoken:token.write(creds.to_json())try:# Create a clientclient=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 requestpage_result=client.list_spaces(request)# Handle the response. Iterating over page_result will yield results and# resolve additional pages automatically.forresponseinpage_result:print(response)exceptExceptionaserror:# TODO(developer) - Handle errors from Chat API.print(f'An error occurred: {error}')if__name__=='__main__':main()
Chạy mẫu
Trong thư mục làm việc, hãy tạo và chạy mẫu:
python3quickstart.py
Khi bạn chạy mẫu lần đầu tiên, mẫu sẽ nhắc bạn uỷ quyền truy cập:
Nếu bạn chưa đăng nhập vào Tài khoản Google, hãy đăng nhập khi được nhắc. Nếu bạn đã đăng nhập vào nhiều tài khoản, hãy chọn một tài khoản để dùng cho việc uỷ quyền.
Nhấp vào Chấp nhận.
Ứng dụng Python của bạn chạy và gọi Google Chat API.
Thông tin uỷ quyền được lưu trữ trong hệ thống tệp, vì vậy, vào lần tiếp theo chạy mã mẫu, bạn sẽ không được nhắc uỷ quyền.
[[["Dễ hiểu","easyToUnderstand","thumb-up"],["Giúp tôi giải quyết được vấn đề","solvedMyProblem","thumb-up"],["Khác","otherUp","thumb-up"]],[["Thiếu thông tin tôi cần","missingTheInformationINeed","thumb-down"],["Quá phức tạp/quá nhiều bước","tooComplicatedTooManySteps","thumb-down"],["Đã lỗi thời","outOfDate","thumb-down"],["Vấn đề về bản dịch","translationIssue","thumb-down"],["Vấn đề về mẫu/mã","samplesCodeIssue","thumb-down"],["Khác","otherDown","thumb-down"]],["Cập nhật lần gần đây nhất: 2025-08-21 UTC."],[[["\u003cp\u003eThis quickstart demonstrates how to create a Python command-line application that utilizes the Google Chat API to list available spaces.\u003c/p\u003e\n"],["\u003cp\u003eBefore running the sample, you'll need to set up your environment, which includes enabling the Google Chat API, configuring the OAuth consent screen, authorizing credentials, and configuring a Google Chat app.\u003c/p\u003e\n"],["\u003cp\u003eThe sample uses the Google client library for Python to handle authentication and interaction with the API; you'll need to install the necessary libraries using pip.\u003c/p\u003e\n"],["\u003cp\u003eAfter configuring the sample code provided, you can run it to authenticate and make requests to the Google Chat API, such as listing spaces based on specified filters.\u003c/p\u003e\n"],["\u003cp\u003eFor production environments, it's recommended to learn more about authentication, authorization, and appropriate access credentials in the provided links before implementing your own applications.\u003c/p\u003e\n"]]],["This content outlines how to set up and run a Python command-line application that interacts with the Google Chat API. Key actions include: enabling the Google Chat API in a Google Cloud project, configuring the OAuth consent screen and client ID, creating a Google Chat app, and installing the necessary client libraries. A `quickstart.py` file is then configured with code, and the sample is run via `python3 quickstart.py`. The first run requires authorizing access through a Google account, with subsequent runs automatically using stored credentials.\n"],null,["Create a Python command-line application that makes requests to the\nGoogle Chat API.\n\nQuickstarts explain how to set up and run an app that calls a\nGoogle Workspace API. This quickstart uses a\nsimplified authentication approach that is appropriate for a testing\nenvironment. For a production environment, we recommend learning about\n[authentication and authorization](/workspace/guides/auth-overview)\nbefore\n[choosing the access credentials](/workspace/guides/create-credentials#choose_the_access_credential_that_is_right_for_you)\nthat are appropriate for your app.\n\nThis quickstart uses Google Workspace's recommended API client libraries\nto handle some details of the authentication and authorization flow.\n\nObjectives\n\n- Set up your environment.\n- Install the client library.\n- Set up the sample.\n- Run the sample.\n\nPrerequisites\n\nTo run this quickstart, you need the following prerequisites:\n\n- Python 3.10.7 or greater\n- The [pip](https://pypi.python.org/pypi/pip) package management tool\n- [A Google Cloud project](/workspace/guides/create-project).\n\n\n- A Business or Enterprise [Google Workspace](//support.google.com/a/answer/6043576) account with access to [Google Chat](//workspace.google.com/products/chat/).\n\n\u003cbr /\u003e\n\nSet up your environment\n\nTo complete this quickstart, set up your environment.\n\nEnable the API Before using Google APIs, you need to turn them on in a Google Cloud project. You can turn on one or more APIs in a single Google Cloud project.\n\n- In the Google Cloud console, enable the Google Chat API.\n\n [Enable the API](https://console.cloud.google.com/flows/enableapi?apiid=chat.googleapis.com)\n\nConfigure the OAuth consent screen\n\nIf you're using a new Google Cloud project to complete this quickstart, configure\nthe OAuth consent screen. If you've already\ncompleted this step for your Cloud project, skip to the next section.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Branding** .\n\n [Go to Branding](https://console.cloud.google.com/auth/branding)\n2. If you have already configured the Google Auth platform, you can configure the following OAuth Consent Screen settings in [Branding](https://console.cloud.google.com/auth/branding), [Audience](https://console.cloud.google.com/auth/audience), and [Data Access](https://console.cloud.google.com/auth/scopes). If you see a message that says **Google Auth platform not configured yet** , click **Get Started**:\n 1. Under **App Information** , in **App name**, enter a name for the app.\n 2. In **User support email**, choose a support email address where users can contact you if they have questions about their consent.\n 3. Click **Next**.\n 4. Under **Audience** , select **Internal**.\n 5. Click **Next**.\n 6. Under **Contact Information** , enter an **Email address** where you can be notified about any changes to your project.\n 7. Click **Next**.\n 8. Under **Finish** , review the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy) and if you agree, select **I agree to the Google API Services: User Data Policy**.\n 9. Click **Continue**.\n 10. Click **Create**.\n3. For now, you can skip adding scopes. In the future, when you create an app for use outside of your Google Workspace organization, you must change the **User type** to **External** . Then add the authorization scopes that your app requires. To learn more, see the full [Configure OAuth consent](/workspace/guides/configure-oauth-consent) guide.\n\nAuthorize credentials for a desktop application To authenticate end users and access user data in your app, you need to create one or more OAuth 2.0 Client IDs. A client ID is used to identify a single app to Google's OAuth servers. If your app runs on multiple platforms, you must create a separate client ID for each platform.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Clients** .\n\n [Go to Clients](https://console.cloud.google.com/auth/clients)\n2. Click **Create Client**.\n3. Click **Application type** \\\u003e **Desktop app**.\n4. In the **Name** field, type a name for the credential. This name is only shown in the Google Cloud console.\n5. Click **Create** .\n\n\n The newly created credential appears under \"OAuth 2.0 Client IDs.\"\n6. Save the downloaded JSON file as `credentials.json`, and move the file to your working directory.\n\nConfigure the Google Chat app\n\nTo call the Google Chat API, you must configure a\nGoogle Chat app. For any write requests, Google Chat\nattributes the Google Chat app in the UI using\nthe following information.\n\n1. In the Google Cloud console, go to the Chat API **Configuration** page:\n\n [Go to Chat API Configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)\n2. Under **Application info**, enter the following information:\n\n 1. In the **App name** field, enter `Chat API quickstart app`.\n 2. In the **Avatar URL** field, enter `https://developers.google.com/chat/images/quickstart-app-avatar.png`.\n 3. In the **Description** field, enter `Quickstart for calling the Chat API`.\n3. Under **Interactive features** , click the **Enable interactive features**\n toggle to the off position to disable interactive features for the\n Chat app.\n\n4. Click **Save**.\n\nInstall the Google client library\n\n- Install the Google client library for Python:\n\n pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib\n\nConfigure the sample\n\n1. In your working directory, create a file named `quickstart.py`.\n2. Include the following code in `quickstart.py`:\n\n\n chat/quickstart/quickstart.py \n [View on GitHub](https://github.com/googleworkspace/python-samples/blob/main/chat/quickstart/quickstart.py) \n\n ```python\n from __future__ import print_function\n\n import os.path\n\n from google.auth.transport.requests import Request\n from google.oauth2.credentials import Credentials\n from google_auth_oauthlib.flow import InstalledAppFlow\n from google.apps import chat_v1 as google_chat\n\n\n # If modifying these scopes, delete the file token.json.\n SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']\n\n\n def main():\n \"\"\"Shows basic usage of the Google Chat API.\n \"\"\"\n creds = None\n # The file token.json stores the user's access and refresh tokens, and is\n # created automatically when the authorization flow completes for the first\n # time.\n if os.path.exists('token.json'):\n creds = Credentials.from_authorized_user_file('token.json', SCOPES)\n # If there are no (valid) credentials available, let the user log in.\n if not creds or not creds.valid:\n if creds and creds.expired and creds.refresh_token:\n creds.refresh(Request())\n else:\n flow = InstalledAppFlow.from_client_secrets_file(\n 'credentials.json', SCOPES)\n creds = flow.run_local_server(port=0)\n # Save the credentials for the next run\n with open('token.json', 'w') as token:\n token.write(creds.to_json())\n\n try:\n # Create a client\n client = google_chat.ChatServiceClient(\n credentials = creds,\n client_options = {\n \"scopes\" : SCOPES\n }\n )\n\n # Initialize request argument(s)\n request = google_chat.ListSpacesRequest(\n # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)\n filter = 'space_type = \"SPACE\"'\n )\n\n # Make the request\n page_result = client.list_spaces(request)\n\n # Handle the response. Iterating over page_result will yield results and\n # resolve additional pages automatically.\n for response in page_result:\n print(response)\n except Exception as error:\n # TODO(developer) - Handle errors from Chat API.\n print(f'An error occurred: {error}')\n\n\n if __name__ == '__main__':\n main()\n ```\n\n \u003cbr /\u003e\n\n \u003cbr /\u003e\n\nRun the sample\n\n1. In your working directory, build and run the sample:\n\n python3 quickstart.py\n\n\u003c!-- --\u003e\n\n2. The first time you run the sample, it prompts you to authorize access:\n 1. If you're not already signed in to your Google Account, sign in when prompted. If you're signed in to multiple accounts, select one account to use for authorization.\n 2. Click **Accept**.\n\n\n Your Python application runs and calls the Google Chat API.\n\n\n Authorization information is stored in the file system, so the next time you run the sample\n code, you aren't prompted for authorization.\n\nNext steps\n\n- [Client library documentation](https://googleapis.dev/python/google-apps-chat/latest/)"]]
