Les guides de démarrage rapide expliquent comment configurer et exécuter une application qui appelle une API Google Workspace.
Les démarrages rapides Google Workspace utilisent les bibliothèques clientes de l'API pour gérer certains détails du flux d'authentification et d'autorisation. Nous vous recommandons d'utiliser les bibliothèques clientes pour vos propres applications. Ce guide de démarrage rapide utilise une approche d'authentification simplifiée, adaptée à un environnement de test. Pour un environnement de production, nous vous recommandons de vous familiariser avec l'authentification et l'autorisation avant de choisir les identifiants d'accès appropriés pour votre application.
Créer une application de ligne de commande Python qui envoie des requêtes à l'API Google Chat
Objectifs
- configurer votre environnement ;
- Installez la bibliothèque cliente.
- Configurez l'exemple.
- Exécutez l'exemple.
Prérequis
Pour exécuter ce guide de démarrage rapide, vous devez disposer des conditions préalables suivantes:
- Python 3.10.7 ou version ultérieure
- L'outil de gestion de paquets pip
- Un projet Google Cloud.
- Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.
Configurer votre environnement
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.
Configurer l'écran d'autorisation OAuth
Si vous utilisez un nouveau projet Google Cloud pour suivre cet atelier Qwik Start, configurez l'écran d'autorisation OAuth et ajoutez-vous en tant qu'utilisateur test. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.
- Dans la console Google Cloud, accédez à Menu > API et services > Écran de consentement OAuth.
- Pour Type d'utilisateur, sélectionnez Interne, puis cliquez sur Créer.
- Remplissez le formulaire d'inscription de l'application, puis cliquez sur Enregistrer et continuer.
Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. À l'avenir, lorsque vous créerez une application pour une utilisation en dehors de votre organisation Google Workspace, vous devrez définir le type d'utilisateur sur Externe, puis ajouter les niveaux d'autorisation requis par votre application.
- Consultez le récapitulatif d'enregistrement de votre application. Pour y apporter des modifications, cliquez sur Modifier. Si l'enregistrement de l'application semble correct, cliquez sur Revenir au tableau de bord.
Autoriser des 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 > API et services > Identifiants.
- Cliquez sur Créer des identifiants > ID client OAuth.
- Cliquez sur Type d'application > Application pour ordinateur.
- 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. L'écran "Client OAuth créé" s'affiche, avec votre nouvel ID client et votre nouveau code secret.
- Cliquez sur OK. Les identifiants nouvellement créés s'affichent sous ID client OAuth 2.0.
- Enregistrez le fichier JSON téléchargé sous le nom
credentials.json
, puis déplacez-le dans votre répertoire de travail.
Configurer l'application Google Chat
Pour appeler l'API Google Chat, vous devez configurer une application Google Chat. Pour toutes les requêtes 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 App name (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
.
- Dans le champ App name (Nom de l'application), saisissez
Sous Fonctionnalités interactives, cliquez sur le bouton d'activation/de désactivation 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:
pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib
Configurer l'exemple
- Dans votre répertoire de travail, créez un fichier nommé
quickstart.py
. Incluez le code suivant dans
quickstart.py
:
Exécuter l'exemple
Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 quickstart.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 pour l'autorisation.
- Cliquez sur Accepter.
Votre application Python exécute et appelle l'API Google Chat.
Les informations d'autorisation sont stockées dans le système de fichiers. Par conséquent, la prochaine fois que vous exécuterez l'exemple de code, vous ne serez pas invité à vous authentifier.