با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک برنامه خط فرمان پایتون ایجاد کنید که درخواست هایی را به Google Chat API ارسال می کند.
Quickstarts نحوه راه‌اندازی و اجرای برنامه‌ای را توضیح می‌دهد که Google Workspace API را فراخوانی می‌کند. این شروع سریع از یک رویکرد احراز هویت ساده استفاده می کند که برای یک محیط آزمایشی مناسب است. برای یک محیط تولید، توصیه می‌کنیم قبل از انتخاب اعتبارنامه‌های دسترسی مناسب برای برنامه‌تان، درباره احراز هویت و مجوز یاد بگیرید.
این شروع سریع از کتابخانه های سرویس گیرنده API توصیه شده Google Workspace برای رسیدگی به برخی از جزئیات جریان احراز هویت و مجوز استفاده می کند.
اهداف
محیط خود را تنظیم کنید.
کتابخانه مشتری را نصب کنید.
نمونه را تنظیم کنید
نمونه را اجرا کنید.
پیش نیازها
برای اجرای این شروع سریع، به پیش نیازهای زیر نیاز دارید:
اگر از یک پروژه Google Cloud جدید برای تکمیل این شروع سریع استفاده می‌کنید، صفحه رضایت OAuth را پیکربندی کنید. اگر قبلاً این مرحله را برای پروژه Cloud خود انجام داده اید، به بخش بعدی بروید.
اگر قبلاً آن را پیکربندی کرده اید ، می توانید تنظیمات صفحه رضایت OAuth زیر را در نام تجاری ، مخاطب و دسترسی به داده پیکربندی کنید. اگر پیامی دیدید که می گوید هنوز پیکربندی نشده است ، روی شروع کلیک کنید:
در قسمت اطلاعات برنامه ، در نام برنامه ، نامی برای برنامه وارد کنید.
در ایمیل پشتیبانی کاربر ، آدرس ایمیل پشتیبانی را انتخاب کنید که در صورت داشتن رضایت، کاربران بتوانند با شما تماس بگیرند.
روی Next کلیک کنید.
در قسمت Audience ، Internal را انتخاب کنید.
روی Next کلیک کنید.
در قسمت اطلاعات تماس ، آدرس ایمیلی را وارد کنید که در آن می‌توانید از هرگونه تغییر در پروژه خود مطلع شوید.
در حال حاضر، می توانید از افزودن دامنه ها صرف نظر کنید. در آینده، وقتی برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، باید نوع کاربر را به خارجی تغییر دهید. سپس محدوده های مجوز مورد نیاز برنامه خود را اضافه کنید. برای کسب اطلاعات بیشتر، راهنمای کامل Configure OAuth رضایت را ببینید.
مجوز اعتبار برای یک برنامه دسکتاپ
برای احراز هویت کاربران نهایی و دسترسی به داده های کاربر در برنامه خود، باید یک یا چند شناسه مشتری OAuth 2.0 ایجاد کنید. شناسه مشتری برای شناسایی یک برنامه واحد در سرورهای OAuth Google استفاده می شود. اگر برنامه شما روی چندین پلتفرم اجرا می شود، باید برای هر پلتفرم یک شناسه مشتری جداگانه ایجاد کنید.
در قسمت نام ، نامی را برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
روی ایجاد کلیک کنید.
اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.
فایل JSON دانلود شده را به عنوان credentials.json ذخیره کنید و فایل را به دایرکتوری کاری خود منتقل کنید.
برنامه Google Chat را پیکربندی کنید
برای تماس با Google Chat API، باید یک برنامه Google Chat را پیکربندی کنید. برای هر درخواست نوشتن، Google Chat برنامه Google Chat را در رابط کاربری با استفاده از اطلاعات زیر نسبت می دهد.
در کنسول Google Cloud، به صفحه پیکربندی Chat API بروید:
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()
نمونه را اجرا کنید
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3quickstart.py
اولین باری که نمونه را اجرا می‌کنید، از شما می‌خواهد دسترسی را مجاز کنید:
اگر قبلاً وارد حساب Google خود نشده اید، هنگامی که از شما خواسته شد وارد شوید. اگر به چندین حساب وارد شده اید، یک حساب را برای استفاده از مجوز انتخاب کنید.
روی Accept کلیک کنید.
برنامه پایتون شما اجرا می شود و Google Chat API را فرا می خواند.
اطلاعات مجوز در سیستم فایل ذخیره می شود، بنابراین دفعه بعد که کد نمونه را اجرا می کنید، از شما درخواست مجوز نمی شود.
تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2025-08-21 بهوقت ساعت هماهنگ جهانی."],[[["\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/)"]]
