Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Créez une application de ligne de commande Python qui envoie des requêtes à l'API Google Chat.
Les guides de démarrage rapide expliquent comment configurer et exécuter une application qui appelle une API Google Workspace. Ce guide de démarrage rapide utilise une approche d'authentification simplifiée qui convient à un environnement de test. Pour un environnement de production, nous vous recommandons de vous renseigner sur l'authentification et l'autorisation avant de choisir les identifiants d'accès adaptés à votre application.
Ce guide de démarrage rapide utilise les bibliothèques clientes d'API recommandées de Google Workspace pour gérer certains détails du flux d'authentification et d'autorisation.
Objectifs
configurer votre environnement ;
Installez la bibliothèque cliente.
Configurez l'échantillon.
Exécutez l'exemple.
Prérequis
Pour exécuter ce guide de démarrage rapide, vous devez remplir les conditions préalables suivantes :
Pour suivre ce guide de démarrage rapide, configurez votre environnement.
Activer l'API
Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.
Dans la console Google Cloud, activez l'API Google Chat.
Si vous utilisez un nouveau projet Google Cloud pour effectuer ce démarrage rapide, configurez l'écran d'autorisation OAuth. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.
Dans la console Google Cloud, accédez à Menu menu>>Branding.
Si vous avez déjà configuré , vous pouvez configurer les paramètres de l'écran d'autorisation OAuth suivants dans Branding, Audience et Accès aux données. Si le message pas encore configuré s'affiche, cliquez sur Commencer :
Sous Informations sur l'application, dans Nom de l'application, saisissez le nom de l'application.
Dans Adresse e-mail d'assistance utilisateur, sélectionnez une adresse e-mail d'assistance que les utilisateurs pourront contacter s'ils ont des questions sur leur consentement.
Cliquez sur Suivant.
Sous Audience, sélectionnez Interne.
Cliquez sur Suivant.
Sous Coordonnées, saisissez une adresse e-mail à laquelle vous pourrez être informé de toute modification apportée à votre projet.
Pour l'instant, vous pouvez ignorer l'ajout de portées. À l'avenir, lorsque vous créerez une application à utiliser en dehors de votre organisation Google Workspace, vous devrez définir le type d'utilisateur sur Externe. Ajoutez ensuite les niveaux d'autorisation dont votre application a besoin. Pour en savoir plus, consultez le guide complet Configurer le consentement OAuth.
Autoriser les identifiants pour une application de bureau
Pour authentifier les utilisateurs finaux et accéder aux données utilisateur dans votre application, vous devez créer un ou plusieurs ID client OAuth 2.0. Un ID client sert à identifier une application unique auprès des serveurs OAuth de Google. Si votre application s'exécute sur plusieurs plates-formes, vous devez créer un ID client distinct pour chacune d'elles.
Dans la console Google Cloud, accédez à Menu menu>>Clients.
Cliquez sur Type d'application>Application de bureau.
Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
Cliquez sur Créer.
Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".
Enregistrez le fichier JSON téléchargé sous le nom credentials.json, puis déplacez-le vers votre répertoire de travail.
Configurer l'application Google Chat
Pour appeler l'API Google Chat, vous devez configurer une application Google Chat. Pour toute requête d'écriture, Google Chat attribue l'application Google Chat dans l'UI à l'aide des informations suivantes.
Dans la console Google Cloud, accédez à la page Configuration de l'API Chat :
Sous Informations sur l'application, saisissez les informations suivantes :
Dans le champ Nom de l'application, saisissez Chat API quickstart app.
Dans le champ URL de l'avatar, saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
Dans le champ Description, saisissez Quickstart for calling the Chat API.
Sous Fonctionnalités interactives, cliquez sur le bouton Activer les fonctionnalités interactives pour désactiver les fonctionnalités interactives de l'application Chat.
Cliquez sur Enregistrer.
Installer la bibliothèque cliente Google
Installez la bibliothèque cliente Google pour Python :
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()
Exécuter l'exemple
Dans votre répertoire de travail, compilez et exécutez l'exemple :
python3quickstart.py
La première fois que vous exécutez l'exemple, vous êtes invité à autoriser l'accès :
Si vous n'êtes pas encore connecté à votre compte Google, connectez-vous lorsque vous y êtes invité. Si vous êtes connecté à plusieurs comptes, sélectionnez-en un à utiliser pour l'autorisation.
Cliquez sur Accepter.
Votre application Python s'exécute et appelle l'API Google Chat.
Les informations d'autorisation sont stockées dans le système de fichiers. La prochaine fois que vous exécuterez l'exemple de code, vous ne serez pas invité à fournir une autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/21 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 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,["# Python quickstart\n\nCreate 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\n- Set up your environment.\n- Install the client library.\n- Set up the sample.\n- Run the sample.\n\nPrerequisites\n-------------\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-----------------------\n\nTo complete this quickstart, set up your environment.\n\n### Enable the API\n\nBefore 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\n### Configure 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\n### Authorize credentials for a desktop application\n\nTo 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\n### Configure 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\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--------------------\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--------------\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\n- [Client library documentation](https://googleapis.dev/python/google-apps-chat/latest/)"]]
